GET /api/v1/profile/metadata/{dataModelName}
Retrieves detailed metadata for a specific profile data model object in your Data Cloud instance. This endpoint returns information about fields, data types, and available indexes for the specified object.
- HTTP Method: GET
- Availability: Data Cloud v1.0, Salesforce v51.0
- format: REST
- URI:
/api/v1/profile/metadata/{dataModelName}
Parameter | Type | Description |
---|---|---|
dataModelName | string | Required. The unique identifier of the data model object. Example: Individual__dlm |
The response includes a data model object containing:
name
: The unique identifier of the data model objectdisplayName
: The human-readable name of the data model objectcategory
: The category of the data model object (for example, PROFILE)fields
: Array of field objects with name, type, and other propertiesindexes
: Array of index objects showing available lookup fieldsrelationships
: Array of relationship objects showing connections to other entities
- The response includes detailed metadata for the specified data model object only
- All fields and indexes available for the object are included in the response
- 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