GET /api/v1/metadata

Retrieves metadata about all entities, including Calculated Insights, Engagement, Profile, and other entities, and their relationships to other objects. For Data Lake Objects and Data Model Objects, the API response includes information about key qualifier fields. For each field, the API response includes the name of the associated key qualifier field.

• HTTP Method: GET
• Availability: Data Cloud v1.0, Salesforce API version 51.0 and later
• Format: REST
• URI: /api/v1/metadata/

Parameter	Type	Description
entityType	string	The requested metadata entity type. By default, this parameter includes all of the available types. Acceptable values: DataLakeObject, DataModelObject, and CalculatedInsight
entityCategory	string	The requested metadata entity category. By default, this parameter includes all of the available categories. It isn't applicable for Calculated Insight entities. Acceptable values: Profile, Engagement, and Related
entityName	string	The name of the requested metadata entity. By default, this parameter includes all of the available categories and an exhaustive list of entities. Example: UnifiedIndividual__dlm

The response includes:

• metadata: Array of entity objects containing:
  • fields: Array of field objects with:
    • name: Field name
    • displayName: Human-readable field name
    • type: Field data type
    • keyQualifier: Associated key qualifier field (if applicable)
  • indexes: Array of index objects
  • category: Entity category
  • name: Entity name
  • displayName: Human-readable entity name
  • relationships: Array of relationship objects
  • primaryKeys: Array of primary key objects

• The API follows REST standards for consistency
• All responses are in JSON format
• Error responses include detailed error messages
• The API supports filtering by entity type, category, and name
• Key qualifier fields are included for Data Lake Objects and Data Model Objects