GET /api/v1/profile/{dataModelName}

Queries profile data from a specific data model object in your Data Cloud instance. This endpoint allows you to retrieve records based on search filters and field specifications.

  • HTTP Method: GET
  • Availability: Data Cloud v1.0, Salesforce v51.0
  • format: REST
  • URI: /api/v1/profile/{dataModelName}
ParameterTypeDescription
dataModelNamestringRequired. The unique identifier of the data model object. Example: Individual__dlm
ParameterTypeDescription
fieldsstringComma-separated list of fields to include in the response. If this parameter isn't specified, up to 10 arbitrary fields are returned. Example: FirstName__c,LastName__c
filtersstringFilter criteria in the format [field=value]. Example: [FirstName__c=John]
limitintegerMaximum number of records to return. Default: 49,999. Example: 1000
offsetintegerNumber of records to skip before returning results. Example: 100
orderbystringField to sort results by. Use - prefix for descending order. Example: LastName__c,-FirstName__c

The response includes:

  • data: Array of record objects containing the requested data
  • done: boolean indicating if all results have been returned
  • You must explicitly specify fields to retrieve more than 10 fields
  • Only AND logical operator and equality comparator are supported
  • Date/time fields must use the format: YYYY-MM-DD HH:MM:SS
  • The response is limited to 49,999 records per request
  • Use pagination (limit/offset) for retrieving large datasets