v1

latestOpenAPI 3.1.02026-08-04147764567.0 KB
customObjects

Get only the relationship fields of a custom object

Returns the same CustomObjectDetailsDto shape as getCustomObject, but customData is restricted to relationship reference keys only — scalar, dropdown, date, and other non-relationship fields are omitted. Each objectType.sections[*].fieldIds list is filtered to retain only the field IDs that correspond to relationship field definitions; empty sections are preserved so the UI gets a stable section layout.

Useful when a caller needs to display a CO's links to other entities without paying the cost of resolving the full custom_data payload.

get/api/v1/custom-objects/by-id/{id}/relationships

Path parameters

idinteger required

Workspace ID (numeric). Find yours under Settings → Workspace.

Headers

X-Api-Keystring required
X-Workspace-Idstring

Response

Successful response

CustomObjectsGetapiV1CustomObjectsByIdIdRelationshipsResponse200 required

Empty response body