List Workspaces

List active workspaces available to the calling credential with opaque cursor pagination. A personal API key or OAuth token sees accessible workspaces that permit user-held API credentials; a workspace API key sees only its bound workspace.

OAuth scope: api:read.

GET/api/v2/workspaces
X-API-Key<token>

Sua API key do Studio, pessoal ou com escopo de workspace. Gere uma em Settings e depois API Keys. As operações que rejeitam API keys de workspace dizem isso na própria descrição.

Em: header

Parâmetros de query

sortBy?string

Campo usado para ordenar o resultado. A ordenação por name diferencia maiúsculas de minúsculas e segue a collation do armazenamento, então não conte com uma ordem que ignore maiúsculas e minúsculas.

Padrão"createdAt"
Valor em"name" | "createdAt" | "updatedAt"
sortOrder?string

Direção da ordenação.

Padrão"desc"
Valor em"asc" | "desc"
limit?integer

Maximum workspaces to return per page. Must be a whole number from 1 to 100. Defaults to 50.

Padrão50
Intervalo1 <= value <= 100
cursor?string

Cursor opaco da página anterior. Devolva-o com a mesma ordenação e os mesmos filtros; apenas limit pode mudar. Altere qualquer outra coisa e a paginação precisa recomeçar sem cursor.

Tamanho1 <= length

Corpo da resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://agent-studio.seeyu.ai/api/v2/workspaces" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",
      "name": "Engineering",
      "color": "#33C482",
      "logoUrl": null,
      "memberCount": 14,
      "createdAt": "2026-01-15T10:30:00.000Z",
      "updatedAt": "2026-06-20T14:02:11.000Z"
    }
  ],
  "nextCursor": null
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}