Pular para o conteúdo principal
GET
/
v1
/
organizations
Listar Organizações
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations
{ "items": [ { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "legalName": "<string>", "parentOrganizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "doingBusinessAs": "<string>", "legalDocument": "123456789012345", "status": "<unknown>", "address": { "line1": "<string>", "zipCode": "<string>", "city": "<string>", "state": "<string>", "country": "<string>", "line2": "<string>", "description": "<string>" }, "metadata": {}, "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "deletedAt": "2023-11-07T05:31:56Z" } ], "page": 123, "limit": 123 }

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Cabeçalhos

​
Content-Type
string

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

​
Authorization
string

O token de autorização. Este cabeçalho é obrigatório se o seu ambiente tiver Access Manager habilitado.

​
X-Request-Id
string<uuid>

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

Parâmetros de consulta

​
limit
string

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

​
start_date
string

O início do período que você deseja consultar. Você também deve incluir o end_date.

​
end_date
string

O fim do período que você deseja consultar. Você também deve incluir o start_date.

​
sort_order
string

A ordem utilizada para classificar os resultados.

​
page
string

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

​
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).

​
legal_name
string

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, blocked ou inactive.

Opções disponíveis:
active,
blocked,
inactive
​
legal_document
string

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.