Listar Tables

Listar as tables de um workspace com filtro opcional por pasta, busca, ordenação e um envelope de cursor opaco. Uma árvore de pastas do workspace com mais de 10.000 pastas é um 413.

GET/api/v2/tables

Authorization

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

workspaceId*string

Workspace cujas tables devem ser listadas.

Tamanho1 <= length <= 128
scope?string

Which lifecycle set to list: active (default) for live tables, archived for tables a delete archived and a table restore can bring back. folderPath resolves against active folders only, so pairing it with scope=archived returns an empty page when the containing folder was archived too.

Padrão"active"
Valor em"active" | "archived"
folderPath?Folder path input

Restrict results to tables in this folder. Unknown folder paths contribute no matches.

Tamanholength <= 4096
search?string

Correspondência de substring com o nome do recurso, sem diferenciar maiúsculas de minúsculas.

Tamanho1 <= length <= 200
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"asc"
Valor em"asc" | "desc"
limit?integer

Máximo de tables a retornar por página. Valores fora de 1–1000 são truncados e ajustados para dentro desse intervalo em vez de rejeitados. O padrão é 100.

Padrão100
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

application/json

curl -X GET "https://agent-studio.seeyu.ai/api/v2/tables?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "id": "string",
      "webUrl": "http://example.com",
      "name": "string",
      "description": "string",
      "ownerEmail": "owner@example.com",
      "schema": {
        "columns": [
          {
            "id": "string",
            "name": "string",
            "type": "string",
            "required": false,
            "unique": false,
            "workflowGroupId": "string",
            "options": [
              {
                "id": "string",
                "name": "string"
              }
            ],
            "multiple": true,
            "currencyCode": "string"
          }
        ]
      },
      "rowCount": 0,
      "maxRows": 0,
      "folderPath": "string",
      "locks": {
        "schemaLocked": true,
        "insertLocked": true,
        "updateLocked": true,
        "deleteLocked": true
      },
      "job": {
        "id": "string",
        "type": "import",
        "status": "running",
        "rowsProcessed": 0,
        "error": "string"
      },
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "nextCursor": "string"
}
{
  "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": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}
{
  "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"
  }
}
GETListar LinhasGETListar Pastas