Account
Every call needs Authorization: Bearer <key>. 1 call:
The signed-in user, their memberships and permissions
GET /v1/me
Needs a user session. With X-Workspace-Id, current and permissions describe that workspace.
Headers
| Name | Type | Required | Description |
|---|---|---|---|
x-workspace-id | string | No | Workspace for session (JWT) callers. API keys carry their own workspace. |
Response 200
| Field | Type | Description |
|---|---|---|
current | object or null | |
current.org_id | string | Organisation id (org_...). |
current.role | enum | One of: owner, admin, billing, manager, agent, developer, analyst. |
current.workspace_id | string | Workspace id (ws_...). |
feature_flags | object | |
memberships | object[] | |
memberships[].org | object | |
memberships[].org.id | string | Organisation id (org_...). |
memberships[].org.name | string | |
memberships[].org.plan | enum | One of: pilot, growth, enterprise. |
memberships[].org.slug | string | |
memberships[].org.status | enum | One of: onboarding, live, paused, suspended, offboarded. |
memberships[].org.timezone | string | The organisation's IANA time zone, used for analytics days and weeks. |
memberships[].role | enum | One of: owner, admin, billing, manager, agent, developer, analyst. |
memberships[].status | enum | One of: active, invited, suspended. |
memberships[].team_id | string (uuid) or null | |
memberships[].workspace | object | |
memberships[].workspace.id | string | Workspace id (ws_...). |
memberships[].workspace.is_default | boolean | |
memberships[].workspace.name | string | |
permissions | object or null | |
permissions.agents | enum or null | One of: F, V, O. |
permissions.analytics | enum or null | One of: F, V, O. |
permissions.audit | enum or null | One of: F, V, O. |
permissions.billing | enum or null | One of: F, V, O. |
permissions.compliance | enum or null | One of: F, V, O. |
permissions.contacts | enum or null | One of: F, V, O. |
permissions.contacts.export | enum or null | One of: F, V, O. |
permissions.conversations | enum or null | One of: F, V, O. |
permissions.developers | enum or null | One of: F, V, O. |
permissions.home | enum or null | One of: F, V, O. |
permissions.lines | enum or null | One of: F, V, O. |
permissions.outreach | enum or null | One of: F, V, O. |
permissions.security | enum or null | One of: F, V, O. |
permissions.team | enum or null | One of: F, V, O. |
permissions.workflows | enum or null | One of: F, V, O. |
user | object | |
user.avatar_url | string or null | |
user.email | string | |
user.full_name | string or null | |
user.id | string (uuid) | The signed-in user. |
Errors: 400, 401, 403, 404, 409, 413, 415, 429, 500. See errors for the shape and codes.