v4
latestOpenAPI 3.0.22026-07-3188146256.6 KBgetRelationsV2
Returns 1st level direct relations for an entity with pagination.
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.
Path parameters
URL-friendly identifier for the entity schema
Entity Type
Entity id
Query parameters
When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
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.
Input to filter search results
When true, includes reverse relations in response (other entities pointing to this entity)
Starting page number
Number of results to return per page
List of entity fields to include or exclude in the response
Use ! to exclude fields, e.g. !_id to exclude the _id field.
Globbing and globstart (**) is supported for nested fields.
List of entity fields to include in results
[ "_id", "_title", "first_name", "account", "!account.*._files", "**._product" ]
Response
Success
Example response
{
"hits": 1,
"relations": [
{
"_schema": "contact"
}
]
}