Query Customer Profile Information with Profile API

Data Cloud Profile API calls are used to look up and search customer profile information. These API calls can be included in your external web or mobile apps to look up customer profile information.

Using Data Cloud Profile API calls, you can build the complete Data Cloud pages by retrieving the Profile info along with computed engagement insights.

The calls only support the data model objects in the profile category, such as Individual, Contact Point Email, Unified Individual, and Contact Point Address. They also support retrieving the computed attributes related to the Individual field. For example, the computed value of the total sales quantity in the last 6 months for a customer profile.

These calls do NOT support the engagement category data model objects like Sales Order.

Data Cloud Profile API calls follow the REST standard specification.

Unified profile objects that are filtered on the index column have accelerated response rates. Other Profile category objects can’t guarantee a faster response.

Note

Key Properties

You must explicitly specify the fields you want to retrieve, or only the data from the first 10 alphabetically sorted fields or attributes of the entity will be included in your response. This restriction of 10 fields doesn’t apply when you explicitly mention the field names.
You can retrieve a maximum of 50 fields.
Only the AND logical operator and equality comparator operator are supported.
There are no limits on the number of filters you can have in your query.
The default return limit is 49,999 rows. A max limit of 49,999 is allowed.

For date and time fields, use the format:

1Date/DateTime BirthDate__c=1990-07-12 00:00:00

Call Reference

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}

Connected App Setup

Your orgs must be provisioned with Data Cloud licenses and the users must be assigned to appropriate roles for having full access to objects in the Data Cloud. Refer to User Roles and Permission Sets in Data Cloud before setting up the Connected App.

Important

Set Up a Connected App to discover new insights about your customers.

Acquire and Exchange Your Access Token for Data Cloud

Refer to Getting Started page to acquire the token.

Troubleshooting

If you receive the User hasn't approved this consumer yet error message, double-check the following configuration parameters:

Make sure you have Users may self-authorize in the connected app configuration.
Make sure you select refresh_token scope and AT LEAST one other scope apart from this (not counting custom scopes).
In the self-authorization URL, set the scope parameter value as api refresh_token cdpquery cdpprofile.
The first time you call the self-authorization URL, you must respond to a consent page asking for permission for each of the scopes you requested in the URL.

Data Cloud Developer Guide