Workspace
Every token belongs to a single workspace. These endpoints describe that workspace.
Endpoints
| Method | Path | Permission | Description |
|---|---|---|---|
| GET | /workspace | workspace:read | The token's workspace |
| GET | /workspaces | workspace:read | The token's workspace as a one-item collection (not paginated) |
| GET | /workspace/members | workspace:read | Workspace members (not paginated) |
| GET | /workspace/invitations | workspace:read | Pending invitations (not paginated) |
The workspace object
{
"data": {
"id": 4,
"name": "Acme",
"slug": "acme",
"settings": {},
"created_at": "...",
"updated_at": "..."
}
}GET /workspaces is a compatibility list endpoint. An API token cannot discover or switch to another workspace, even when its creator belongs to several workspaces. Workspace creation, switching and invitation acceptance are browser account actions and are not available through workspace-scoped REST tokens.
Members
{
"data": [
{ "id": 1, "name": "Alice Martin", "email": "alice@acme.com", "role": "admin", "permissions": [], "joined_at": "...", "is_owner": true }
]
}role is owner, admin or member. Use the member id for the assigned_to field on CRM deals and tasks.
The members collection is intentionally not paginated because workspace membership is plan-limited.
Invitations
{
"data": [
{ "id": 8, "email": "bob@acme.com", "role": "member", "permissions": [], "expires_at": "...", "is_expired": false, "created_at": "..." }
]
}The pending invitations collection is intentionally not paginated because workspace membership is plan-limited.
To invite or remove members, go to Settings → Workspace in the app.