Relations

getRelationsV2

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/v2/entity/{slug}/{id}/relations

Path parameters

slugstring required

URL-friendly identifier for the entity schema

Example:contact

Entity Type

idstring uuid required

Entity id

hydrateboolean

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

querystring

Input to filter search results

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

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"
]

Success

hitsnumber

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