Skip to main content
GET
Listar workspaces

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de ruta

organization_id
string
requerido

El identificador único de la organización

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

Parámetros de consulta

page
integer
predeterminado:1

Número de página (predeterminado: 1)

per_page
integer
predeterminado:100

Elementos por página (predeterminado: 100, max.: 100)

Rango requerido: 1 <= x <= 100
sort
string

Expresión de ordenación con el formato :asc|desc. En modo agregado, solo acepta campos de group_by o aliases agregados (count, <function>_<field>).

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

Lista separada por comas de campos de respuesta a incluir.

Maximum string length: 2048
aggregate
string

Agrupa y calcula agregaciones sobre Workspaces. Debe enviarse como cadena JSON con group_by (array de campos de contrato) y aggregates (array de objetos { field, function }). field puede ser "*" solo cuando function es "count". Valores permitidos para function: count, sum, avg, min, max. El parámetro aggregate no puede combinarse con fields. En modo agregado, sort solo puede ordenar por campos de group_by o por salidas agregadas (count, function_campo).

Maximum string length: 1024
filters
string

Filtre Workspaces por uno o más criterios. Proporcione un objeto JSON con condiciones de filtro. Puede filtrar por cualquier campo devuelto en la respuesta; use los mismos nombres de campo y las mismas formas de valor que en la respuesta. Use operadores de comparación (eq, ne, gt, gte, lt, lte, in, nin, contains, startsWith, endsWith, between) y combine múltiples condiciones con operadores lógicos (and, or). Longitud máxima: 5120 caracteres.

Maximum string length: 5120

Respuesta

Lista paginada de Workspaces recuperada correctamente.

has_next
boolean
requerido
data
object[]
requerido