Get Workspace

Returns the details of the workspace associated with the authenticated API key.

GET /v1/workspace

workspace:read

Request Examples

curl

curl -X GET https://xqr.co/api/v1/workspace \
  -H "Authorization: Bearer xqr_pk_a1b2c3d4.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

TypeScript

const response = await fetch("https://xqr.co/api/v1/workspace", {
  headers: {
    Authorization: "Bearer xqr_pk_a1b2c3d4.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  },
});

const { data } = await response.json();
console.log(data.name); // "My Workspace"

Python

import httpx

response = httpx.get(
    "https://xqr.co/api/v1/workspace",
    headers={
        "Authorization": "Bearer xqr_pk_a1b2c3d4.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    },
)

data = response.json()["data"]
print(data["name"])  # "My Workspace"

Response

200 OK

The workspace object.

{
  "data": {
    "id": "ws_a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "My Workspace",
    "description": "Production workspace for marketing campaigns",
    "plan": "pro",
    "created_at": "2026-01-15T09:00:00Z"
  },
  "meta": {
    "request_id": "req_5e6f7a8b9c0d1e23",
    "rate_limit": {
      "limit": 600,
      "remaining": 599,
      "reset": 1742572800
    }
  }
}