Sign in
Entities

getEntityV2

Gets Entity by id.

Supports hydrate and fields parameters to control the shape of the response.

get/v2/entity/{slug}/{id}

Path parameters

idstring uuid required

Entity id

slugstring required

URL-friendly identifier for the entity schema

Example:contact

Entity Type

Query parameters

hydrateboolean

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

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

When true, applies pending changeset proposed values in-place on the response entity. The response includes both the hydrated values and the raw _changesets field. Does not mutate stored data — pure read-time transform.

Response

Success

_idstring uuid required
_orgstring required

Organization Id the entity belongs to

_schemastring required

URL-friendly identifier for the entity schema

_titlestring nullable required

Title of entity

_tagsstring[] nullable
_created_atstring date-time nullable required
_updated_atstring date-time nullable required
_deleted_atstring date-time nullable
_purposestring[] nullable
_purpose_namestring[] nullable

Automatically computed purpose names from _purpose attribute

_manifeststring[] nullable

Manifest ID used to create/update the entity

_changesetsobject nullable

Pending attribute changesets for attributes configured with external or approval edit mode.

The value shape is Changeset (proposed_value, created_at, edit_mode, ...) and is what :apply / :dismiss operate on.

Read-only via normal entity PATCH/PUT operations — those handlers strip _changesets from request bodies. Use the changeset management endpoints to mutate this field.

Example response

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_org": "123",
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_schema": "contact",
  "_tags": [
    "example",
    "mock"
  ],
  "_created_at": "2021-02-09T12:41:43.662Z",
  "_updated_at": "2021-02-09T12:41:43.662Z",
  "_acl": {
    "view": [
      "org:456",
      "org:789"
    ],
    "edit": [
      "org:456"
    ],
    "delete": [
      "org:456"
    ]
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Changes