Saltar al contenido principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
segments
Listar Segmentos
curl --request GET \
  --url https://onboarding.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/segments \
  --header 'Content-Type: <content-type>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": {
        "code": "<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
}

Headers

​
Authorization
string

Token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el Access Manager.

​
Content-Type
string
required

Tipo de medio del recurso. Debe ser application/json.

​
X-Request-Id
string<uuid>

Identificador único usado para rastrear cada solicitud.

Path Parameters

​
organization_id
string<uuid>
required

Identificador único de la organización asociada al ledger.

​
ledger_id
string<uuid>
required

Identificador único del ledger asociado.

Query Parameters

​
limit
string

Número máximo de elementos que se incluirán en la respuesta. Máx.: 100

​
start_date
string

Inicio del período que deseas recuperar. Debes incluir también el parámetro end_date.

​
end_date
string

Fin del período que deseas recuperar. Debes incluir también el parámetro start_date.

​
sort_order
string

Orden utilizado para clasificar los resultados.

​
page
string

Número de página que deseas obtener.

​
metadata.key
string

Metadatos que debería tener la entidad.

Response

Indica que la solicitud se realizó correctamente y la respuesta contiene los datos esperados.

​
items
object[]
​
page
integer

Número de páginas devueltas.

​
limit
integer

Número máximo de elementos incluidos en la respuesta.