Skip to main content
GET
Listar espaços de trabalho

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

organization_id
string
obrigatório

O identificador único da organização

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$

Parâmetros de consulta

page
integer
padrão:1

Número da página (padrão: 1)

per_page
integer
padrão:100

Itens por página (padrão: 100, max.: 100)

Intervalo obrigatório: 1 <= x <= 100
sort
string

Expressão de ordenação no formato :asc|desc. No modo agregado, só aceita campos de group_by ou aliases agregados (count, <function>_<field>).

Pattern: ^([a-z_]+):(asc|desc)$
fields
string

Lista separada por vírgulas de campos de resposta a incluir.

Maximum string length: 2048
aggregate
string

Agrupe e calcule agregações sobre Workspaces. Deve ser enviado como string JSON com group_by (array de campos do contrato) e aggregates (array de objetos { field, function }). field pode ser "*" somente quando function é "count". Valores permitidos para function: count, sum, avg, min, max. O parâmetro aggregate não pode ser combinado com fields. No modo agregado, sort só pode ordenar por campos de group_by ou por saídas agregadas (count, function_campo).

Maximum string length: 1024
filters
string

Filtre Workspaces por um ou mais critérios. Forneça um objeto JSON com condições de filtro. Pode filtrar por qualquer campo retornado na resposta; usar os mesmos nomes de campo e formas de valor que na resposta. Use operadores de comparação (eq, ne, gt, gte, lt, lte, in, nin, contains, startsWith, endsWith, between) e combine múltiplas condições com operadores lógicos (and, or). Comprimento máximo: 5120 caracteres.

Maximum string length: 5120

Resposta

Lista paginada de Workspaces recuperada corretamente.

has_next
boolean
obrigatório
data
object[]
obrigatório