Clarify APIList workspaces
Returns every workspace the signed-in user belongs to as a JSON:API list with `links` and `meta`, in one page. Requires a user access token sent as `Authorization: Bearer <token>`; an API key gets 401 because it belongs to one workspace.
Authorization
bearer User access token authentication. Every endpoint accepts it, and endpoints that act as a person accept only it. Send a WorkOS access token in the Authorization header as: Bearer <token>.
In: header
Response Body
application/json
curl -X GET "https://example.com/workspaces"{ "links": { "next": null, "prev": null }, "meta": { "total_records": 1, "total_pages": 1, "offset": 0, "limit": 500 }, "data": [ { "type": "workspace", "id": "3b9f6c2e-8d1a-4f5e-9c7b-2a4d6e8f0c13", "attributes": { "slug": "acme", "name": "Acme Corp", "organization_id": "org_01HXYZACMECORP0000000000", "created_at": "2026-01-15T09:30:00.000Z" } } ]}Get a workspace
Returns a single workspace as a JSON:API resource, including the WorkOS organization ID used to mint an access token for it.
Rename a workspace
Changes the workspace display name and returns the updated JSON:API resource. The slug never changes. Requires an admin signed in with a user access token.