GET /api/v1/profile/metadata

Retrieves metadata for all accessible profile data model objects in your Data Cloud instance. This endpoint returns detailed information about fields, data types, and categories for each profile object.

  • HTTP Method: GET
  • Availability: Data Cloud v1.0, Salesforce v51.0
  • format: REST
  • URI: /api/v1/profile/metadata

The response includes an array of data model objects, each containing:

  • name: The unique identifier of the data model object
  • displayName: The human-readable name of the data model object
  • category: The category of the data model object (for example, PROFILE)
  • fields: Array of field objects with name, type, and other properties
  • indexes: Array of index objects showing available lookup fields
  • relationships: Array of relationship objects showing connections to other entities
  • The response includes all profile data model objects available to the authenticated user
  • Each object's metadata includes all available fields and indexes
  • The category field indicates the type of data model object
  • Indexes show which fields can be used for efficient lookups
  • Field types include STRING, NUMBER, DATE, boolean, and more