Get an object definition
Learn more about how to retrieve the configuration definition for a specific object type using the Configuration API.
Use the Configration to retrieve the full configuration definition for a specific type within a supported object type. By default, the response includes inherited properties from base types. To exclude inherited properties, set the inheritance query parameter to false.
HTTP method and endpoint
Use the following HTTP method and endpoint path to submit the request:
GET {TenantURL}/configuration/{objectType}/{typeName}?inheritance=true|falseThe following table describes the endpoint path parameters.
| Name | Required | Description |
|---|---|---|
| TenantURL | Yes | The base URL for your tenant. |
| objectType | Yes, for the general object type endpoint | The configuration object type that contains the definition to retrieve. Supported values for this endpoint are entityTypes, groupTypes, relationTypes, graphTypes, interactionTypes, changeRequestTypes, and categoryTypes. This endpoint does not support sources.Note: Only one changeRequestType can be configured at a time. |
| typeName | Yes | The name of the specific type definition to retrieve. |
Request headers
Include the following header in the request.
| Name | Required | Description |
|---|---|---|
| Authorization | Yes | Access token used to authenticate the tenant request. |
Query parameters
The following table describes the query parameters.
| Name | Required | Description |
|---|---|---|
| inheritance | No | Determines whether inherited fields from base types are included in the response. Accepted values are true and false. Default: true. |
Example request
The following example retrieves the configuration definition for the Individual entity type and includes inherited properties.
GET {TenantURL}/configuration/entityTypes/Individual?inheritance=true
Authorization: <access_token>The following example retrieves the configuration definition for the ReviewRequest change request type.
GET {TenantURL}/configuration/changeRequestTypes/ReviewRequest?inheritance=true
Authorization: <access_token>Example response
The exact response payload depends on the requested object type and type name. The following examples show the response pattern for successful and error outcomes.
Successful response
HTTP/1.1 200 OK
Content-Type: application/json
<configuration definition for the requested type>Error response
HTTP/1.1 400 Bad Request
Content-Type: application/json
<TYPE_IS_NOT_FOUND>