Manage configuration by object type
Learn how to retrieve, update, and delete individual configuration object types using the Configuration API.
Overview
You can retrieve, update, or delete configuration of specific objects using the Configuration API. These endpoints provide granular control over tenant-level configuration objects without needing to operate on the full configuration payload.
The following object types are supported:
sourcesentityTypesgroupTypesrelationTypesgraphTypesinteractionTypescategoryTypes- Granular APIs are supported only withtypeName-
changeRequestTypes- Granular APIs are supported only withtypeName
GET all objects of specific object type
GET /configuration/{objectType}?inheritance=true|falseReturns the full configuration definition for the specified object type. You can choose whether to retrieve inherited properties from base types.
Parameters
| Name | Required | Description |
|---|---|---|
| objectType | Yes | The object type listed above. |
| inheritance | No | Whether to include inherited fields from base types. Default: true. |
Responses
- 200 OK: Returns the object type definition.
- 400 TYPE_IS_NOT_FOUND: The specified type does not exist
GET an object definition
GET /configuration/{objectType}/{typeName}?inheritance=true|falseReturns the full configuration definition for the specified type name. You can choose whether to retrieve inherited properties from base types.
Parameters
| Name | Required | Description |
|---|---|---|
| objectType | Yes | The object type listed above. |
| typeName | Yes | The name of the type to retrieve. typeName is not supported for 'sources' objectType |
| inheritance | No | Whether to include inherited fields from base types. Default: true. |
Responses
- 200 OK: Returns the object type definition.
- 400 TYPE_IS_NOT_FOUND: The specified type does not exist
Update an object definition
PUT /configuration/{objectType}/{typeName}Updates the configuration for a specified object type. You can update a definition only when inheritance is disabled for that type.
Permissions
Requires UPDATE permission for the specified type (see access control below).
Responses
- 200 OK: Returns the updated object definition
- 400 TYPE_IS_NOT_FOUND: Type doesn't exist
- 400 VALIDATION_ERROR: Payload is invalid or incompatible
Delete an object definition
DELETE /configuration/{objectType}/{typeName}Deletes the specified object type if it exists and is not in use.
Permissions
Requires DELETE access for the object type.
Responses
- 204 No Content: Deletion successful
- 400 TYPE_IS_NOT_FOUND: Type doesn't exist
Access control rules
Access checks use the existing Configuration API access model. The following object types enforce permission checks:
| Object type | Access control |
|---|---|
| entityTypes | READ, UPDATE, DELETE |
| relationTypes | READ, UPDATE, DELETE |
| groupTypes | Not enforced |
| graphTypes | Not enforced |
| interactionTypes | Not enforced |
| categoryTypes | Not enforced |