Retrieve Custom Objects for Account: /accounts/{account_id}/custom_objects
Purpose
This API retrieves all custom objects that are linked to a specific account. Custom objects represent user-defined data structures associated with accounts, allowing flexible, extendable data modeling.
Use Case
Organizations often need to store additional structured data related to their accounts such as inspection records, certification details, or preferences that don't fit standard fields.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_id | string | Unique identifier of the account being queried. |
Query Parameters
This endpoint does not accept any query parameters.
Request Body
This endpoint does not required any Request Body.
Response
The response contains a list of all custom objects associated with the given account. Each object includes identifying metadata and a link to view or manage its values.
Response Body
{
"custom_objects": [
{
"uuid": "{{custom_object_uuid}}",
"name": "{{custom_object_name}}",
"entity": "{{associated_entity}}",
"type": "{{relationship_type}}",
"values": "{{custom_object_values_link}}"
}
]
}
| Attribute | Type | Description |
|---|---|---|
| uuid | string | Unique identifier of the custom object. |
| name | string | Display name of the custom object. |
| entity | string | Entity type the object is attached to (example: account, form, etc.). |
| type | string | Relationship type (example: one_to_one, one_to_many). |
| values | string | URL to access or retrieve values associated with the custom object instance. |
Retrieve Custom Object Instance: /accounts/{account_id}/custom_objects/{custom_object_uuid}
Purpose
Retrieve the full details of a specific custom object instance that belongs to a given account.
Use Case
Used when you need to fetch a particular custom object instance (example: stored data for a specific field form or custom entity) associated with an account. This is essential for displaying or managing dynamic custom data structures related to accounts.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_id | String | The unique ID of the account. |
| custom_object_uuid | String | The UUID of the custom object instance. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The API returns a custom object containing its uuid, creator info, link, version, and a list of dynamic attributes with name-value pairs. This allows you to retrieve the metadata and actual data of the custom object instance.
Response Body
{
"custom_object": {
"uuid": "{{custom_object_uuid}}",
"created_by": "{{creator_name}}",
"created_on": "{{creation_timestamp}}",
"last_updated_by": "{{last_updater_name}}",
"last_updated_on": "{{last_update_timestamp}}",
"link": "{{custom_object_api_link}}",
"version": "{{object_version}}",
"attributes": [
{
"name": "{{attribute_name}}",
"value": "{{attribute_value}}"
}
]
}
}
| Attribute | Type | Description |
|---|---|---|
| uuid | String | Unique identifier of the custom object instance. |
| created_by | String | Username or ID of the user who created this instance. |
| created_on | String | ISO timestamp when the instance was created. |
| last_updated_by | String | Username or ID of the last user who updated the instance (if any). |
| last_updated_on | String | ISO timestamp when the instance was last updated (if any). |
| link | String | Direct API link to this custom object instance. |
| version | String | Version of the custom object instance (may be empty if versioning is unused). |
| attributes | Array | List of key-value pairs representing the custom attributes of the object. |