Query Customer Profile Information

The Profile API provides a powerful way to query and analyze customer profile information in Data Cloud. This API allows you to retrieve profile data, metadata, and computed insights for your customers.

• Profile Data Access: Retrieve information about customer profiles, including individual data, contact points, and addresses
• Computed Insights: Access calculated attributes and insights related to customer profiles
• Flexible Querying: Search and filter profile data using various criteria
• Hierarchical Data: Access related profile data through parent-child relationships
• Accelerated Response: Unified profile objects with index column filtering provide faster response times

• Data Cloud licenses must be provisioned for your org
• Users must have appropriate roles and permissions assigned
• Authentication requires a valid access token
• Connected App must be properly configured

• Maximum of 50 fields can be retrieved per request
• Default return limit is 49,999 rows
• Only AND logical operator and equality comparator are supported
• No limit on the number of filters in a query
• Date/time fields must use the format: YYYY-MM-DD HH:MM:SS

• GET /api/v1/profile/metadata

  • Retrieves metadata for all profile data model objects
  • Returns field definitions and categories

• GET /api/v1/profile/metadata/{dataModelName}

  • Retrieves metadata for a specific profile data model object
  • Returns field definitions, data types, and available indexes

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

  • Queries profile data based on search filters
  • Returns matching profile records

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

  • Retrieves specific profile records by ID
  • Supports primary and secondary key lookups

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

  • Retrieves profile data with related child objects
  • Supports hierarchical data access

• GET /api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}

  • Retrieves profile data with computed insights
  • Returns calculated attributes and metrics

• Profile API calls only support data model objects in the profile category
• Engagement category data model objects are not supported
• Unified profile objects with index column filtering have accelerated response rates
• You must explicitly specify fields to retrieve more than 10 fields
• The API follows REST standards for consistency and ease of use

• User Roles and Permission Sets in Data Cloud
• Set Up a Connected App
• Getting Started with Data Cloud API
• API Limits for Profile, Query, and Calculated Insights