ReferenceWorkspaces

List workspaces

Returns every workspace in the tenant, plus which one is currently active.

The active workspace determines the default memory for calls that do not name one explicitly.

GET
/api/v1/workspaces

Authorization

ApiKeyAuth
x-api-key<token>

A platform key (ck_live_…). Mint one in the console under Settings → API Keys.

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/workspaces"
{  "workspaces": [    {      "workspace_id": "string",      "tenant_id": "string",      "name": "string",      "description": "string",      "slug": "string",      "is_default": true,      "primary_memory_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "active_workspace_id": "string",  "default_workspace_id": "string"}
Was this page helpful?
Report an issue