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 are not found.

Syntax

HTTP method: GET
Availability: Customer Data Platform v1.0, Salesforce v51.0
Formats: REST
URI: /api/v1/profile/{dataModelName}/{Id}

Request Parameters

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. Not specifying this parameter will return an arbitrary set of fields. 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	Number of rows to skip before starting to return. Example: 100 This field is available in API version 52.0 and later.
orderby	string	Comma separated values to sort the result-set 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

Examples

Request

1https://{TSE}.360a.salesforce.com/api/v1/profile/{dataModelName}/{Id}

Response

1{
2  "data": [
3    {
4      "GenderId__c": "F",
5      "Id__c": "05d01a06-0c61-3990-808d-2aa602dd3e7f",
6      "Occupation__c": "Staffing",
7      "FirstName__c": "Don"
8    },
9    {
10      "GenderId__c": "M",
11      "Id__c": "11bcc846-1a80-3293-8cc4-3449835d8d4c",
12      "Occupation__c": "Operational",
13      "FirstName__c": "Don"
14    },
15    {
16      "GenderId__c": "M",
17      "Id__c": "18213566-df86-34a8-97aa-2cb75b70ae3b",
18      "Occupation__c": "Organizational",
19      "FirstName__c": "Don"
20    }
21  ],
22  "done": false
23}

HTTP Responses

Response	Reason
200 OK	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	Attribute name used in fields/filter parameter does not exist.
500 Server Error	Internal error

Customer Data Platform Developer Guide

GET /api/v1/profile/{dataModelName}/{Id}

Syntax

Request Parameters

Examples

HTTP Responses