Listar Organizações
Use este endpoint para consultar os detalhes de todas as Organizações que você criou.
Nota: o filtro metadata é mutuamente exclusivo com os filtros legal_name e doing_business_as. Combinar metadata com qualquer um deles retorna um erro 400.
Cabeçalhos
O tipo de mídia do recurso. O valor recomendado é application/json.
Um identificador único utilizado para rastrear e acompanhar cada requisição.
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
O número máximo de itens a incluir na resposta. Máx: 100
1 <= x <= 100O 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.
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.
A ordem utilizada para classificar os resultados.
asc, desc O número da página que você deseja consultar.
x >= 1Filtra 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).
256Filtra organizações por nome fantasia. Busca por prefixo (case-insensitive, máx. 256 caracteres).
256Filtra organizações por status. Os valores aceitos são ACTIVE ou INACTIVE (em maiúsculas, correspondência exata).
ACTIVE, INACTIVE Filtra organizações por número do documento legal (correspondência exata).

