GET /api/v1/profile/{dataModelName}/{Id}
Returns data model objects based on search indexes and filters. Use this API call to retrieve the object record based on the primary key or secondary keys. Returns an empty list when records aren’t found.
- HTTP method
GET
- Availability
Data Cloud v1.0, Salesforce v51.0
- Formats
REST
- URI
/api/v1/profile/{dataModelName}/{Id}
| Field Name | Field Type | Description |
|---|---|---|
| dataModelName | string | Required. Data model object API name. Example: UnifiedIndividual__dlm |
| fields | string | Optional. Distinct comma-separated name of fields that you want to include in the result. Example: Id__c,FirstName__c,GenderId__c,Occupation__c |
| filters | string | A set of comma-separated equality expressions within square brackets. Example: [FirstName__c=DON] |
| Id | string | Required. The value of the primary/secondary key field. Defaults to primary key when not specified. Example: John |
| limit | int | The numbers of records to be returned. Example: 10 |
| offset | int | The number of rows to skip before starting to return. Example: 100. This field is available in API version 52.0 and later. |
| orderby | string | A list of comma-separated values to sort the results in ascending or descending order. Example: GenderId__c ASC, Occupation__c DESC. This field is available in API version 52.0 and later. |
| searchKey | string | The name of the key field, if a field other than the primary key is used. Example: FirstName__c |
- Request
- Response
| Response | Reason |
|---|---|
| 200 OK | The callback successfully verified. |
| 400 Bad Request | Invalid request. |
| 403 Forbidden | Failed to pass authorization. |
| 404 Not Found | Incorrect callback ID, verification key, or both. |
| 422 Unprocessable Entity | The attribute name used in the fields or filters parameter doesn’t exist. |
| 500 Server Error | Internal error. |