Customer 360 Audiences API Developer Guide

Quick Start
Customer 360 Audiences Web SDK
Customer 360 Audiences Mobile SDK
Customer 360 Audiences Metadata API
Customer 360 Audiences Profile API Library
GET /api/v1/profile/metadata
GET /api/v1/profile/metadata/{dataModelName}
GET /api/v1/profile/{dataModelName}
GET /api/v1/profile/{dataModelName}/{Id}
GET /api/v1/profile/{dataModelName}/{Id}/{childDataModelName}
GET /api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}
Customer 360 Audiences Query API Library
Customer 360 Audiences Calculated Insights API Library
PDF

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 360 Audiences 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
Id string Required. The value of the primary/secondary key field. Defaults to primary key when not specified. Example: John
searchKey string The name of the key field, if a field other than the primary key is used. Example: FirstName__c
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
limit int The numbers of records to be returned. Example: 10
filters string A set of comma-separated equality expressions, within square brackets. Example: [FirstName__c=DON]

Examples

Request
1http://{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}

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