Pular para o conteúdo principal
GET
Listar Organizações

Cabeçalhos

Content-Type
string

O tipo de mídia do recurso. O valor recomendado é application/json.

X-Request-Id
string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Authorization
string

Token JWT bearer para autenticação. Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: Bearer <token>

Parâmetros de consulta

limit
integer
padrão:10

O número máximo de itens a incluir na resposta. Máx: 100

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

O início do período que você deseja consultar. start_date e end_date são tudo-ou-nada: fornecer apenas um retorna 400. Se ambos forem omitidos, é usada uma janela padrão do último 1 mês.

end_date
string

O fim do período que você deseja consultar. start_date e end_date são tudo-ou-nada: fornecer apenas um retorna 400. Se ambos forem omitidos, é usada uma janela padrão do último 1 mês.

sort_order
enum<string>
padrão:asc

A ordem utilizada para classificar os resultados.

Opções disponíveis:
asc,
desc
page
integer
padrão:1

O número da página que você deseja consultar.

Intervalo obrigatório: x >= 1
metadata.key
string

Filtra por metadata usando notação de ponto. Substitua key pelo nome do seu campo de metadata (ex.: metadata.costCenter=BR_11101997).

Filtra organizações por razão social. Busca por prefixo (case-insensitive, máx. 256 caracteres).

Maximum string length: 256
doing_business_as
string

Filtra organizações por nome fantasia. Busca por prefixo (case-insensitive, máx. 256 caracteres).

Maximum string length: 256
status
enum<string>

Filtra organizações por status. Os valores aceitos são ACTIVE ou INACTIVE (em maiúsculas, correspondência exata).

Opções disponíveis:
ACTIVE,
INACTIVE

Filtra organizações por número do documento legal (correspondência exata).

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

items
object[]
page
integer

O número de páginas retornadas.

limit
integer

O número máximo de itens incluídos na resposta.