API ESSENTIALS

Data models

Understand response fields, types and data visibility.

Response envelope

A successful identity request returns an object under data. Properties describe the authenticated user and current workspace.

{ "data": { … } }object

Identity model GET /me

data.userobject

The identity behind the credential.

data.workspace_idstring

The workspace used for this request.

data.channelstring

How the request was authenticated.

data.permissionsobject

The user’s permission map for this workspace.

Reading a field definition

Each field lists its type, required status, allowed values and nested structure. The full catalog requires API access.

Data visibility

API access follows workspace permissions. Approval does not make every record visible. The identity response helps you confirm the user and workspace before reading resource data.

Identity responseSelected fields

{
  "data": {
    "user": {
      "id": "6a1f0f0e-1111-4a5a-9c3b-9f4b7f4a2b10",
      "email": "you@org.com"
    },
    "workspace_id": "ef0a094f-2222-4bd4-8a1e-33d2b1c0a001",
    "channel": "api_key"
  }
}

Selected identity fields with fictional data.

API access required

Full endpoint and model details need workspace approval.

Get API access