Sign in

v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB
Relations

getRelationsV3

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.

get/v3/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) It gets overriden by mode query parameter.

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"
]
mode'direct' | 'reverse' | 'both'

Options to determine how relations will be included in the result. It overrides the include_reverse query param. Explanation of possible options:

  • direct: include relations to which the searched entity refers
  • reverse: include relations that refer to the entity you are looking for
  • both: both direct and reverse relations
fieldsstring[]

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"
]
include_deleted'true' | 'false' | 'only'

Whether to include deleted entities in the search results

  • true: include deleted entities
  • false: exclude deleted entities
  • only: include only deleted entities

By default, no deleted entities are included in the search results.

Whether to include relations to/from deleted entities

  • true: include relations to/from deleted entities
  • false: exclude relations to/from deleted entities (default)
  • only: include only relations to/from deleted entities

Response

Success

hitsnumber

Example response

{
  "hits": 1,
  "relations": [
    {
      "_schema": "contact"
    }
  ]
}