Pular para o conteúdo principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
Listar Ledgers
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers \
  --header 'Content-Type: <content-type>'
{ "items": [ { "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "status": "<unknown>", "metadata": {}, "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "deletedAt": "2023-11-07T05:31:56Z" } ], "page": 123, "limit": 123 }

Cabeçalhos

​
Authorization
string

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

​
Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

​
X-Request-Id
string<uuid>

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

Parâmetros de caminho

​
organization_id
string
obrigatório

O identificador único da Organização associada ao Ledger.

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

Qualquer Metadata que a entidade deve possuir.

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.