Get all objects of a specific object type
Learn more about how to retrieve all configuration objects for a specific object type using the Configuration API.
Use the Configuration to retrieve the full configuration definition for 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}?inheritance=true|falseThe following table describes the endpoint path parameters.
| Name | Required | Description |
|---|---|---|
| TenantURL | Yes | The base URL of your tenant. |
| objectType | Yes | The configuration object type to retrieve. Supported values are entityTypes, attributeTypes, hierarchyTypes, relationTypes, groupTypes, graphTypes, roles, interactionTypes, sources, groupingTypes, categoryTypes, and changeRequestTypes.Note: Only one changeRequestType can be configured at a time. |
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 all entityTypes and includes inherited properties.
GET {TenantURL}/configuration/entityTypes?inheritance=true Authorization: <access_token>Example response
The exact response payload depends on the requested object type. 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 object type>Error response
HTTP/1.1 400 Bad Request Content-Type: application/json <TYPE_IS_NOT_FOUND>