v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB

Relations

getRelations

Returns 1st level direct relations for an entity.

You can control whether to return the full entity or just the relation item with the ?hydrate query param.

Reverse relations i.e. entities referring to this entity are included with the ?include_reverse query param.

get/v1/entity/{slug}/{id}/relations

Path parameters

slugstring required

URL-friendly identifier for the entity schema

Example:contact

Entity Type

idstring uuid required

Entity id

Query parameters

hydrateboolean

When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.

anonymizeboolean

When true, anonymizes PII in the response: identifiers (names, emails, phone numbers, IBANs) are replaced with deterministic pseudonyms (stable within an org), addresses are generalized to postal code / city / country, and well-known free-text fields (e.g. note content) are redacted.

Useful for AI agents and data analysis use cases that must not access personal data.

Anonymization is forced (regardless of this parameter) when the access token was created with anonymize: true.

include_reverseboolean

When true, includes reverse relations in response (other entities pointing to this entity)

frominteger

Starting page number

sizeinteger

Number of results to return per page

include_schemasEntitySlug[]

Filter results to only include schemas

[
  "contact"
]

exclude_schemasEntitySlug[]

Filter results to exclude schemas

[
  "contact"
]

Response

Success

Example response

[
  {
    "_schema": "contact"
  }
]