Saltar al contenido principal
GET
/
v1
/
organizations
Listar Organizaciones
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.

Encabezados

Content-Type
string

El tipo de medio del recurso. El valor recomendado es application/json.

Authorization
string

El token de autorización. Este encabezado es requerido si su entorno tiene Access Manager habilitado.

X-Request-Id
string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

Parámetros de consulta

limit
string

El número máximo de elementos a incluir en la respuesta. Máx: 100

start_date
string

El inicio del período que desea recuperar. También debe incluir el end_date.

end_date
string

El fin del período que desea recuperar. También debe incluir el start_date.

sort_order
string

El orden utilizado para ordenar los resultados.

page
string

El número de página que desea recuperar.

metadata.key
string

Filtrar por metadatos usando notación de puntos. Reemplaza key con el nombre de tu campo de metadatos (p. ej. metadata.costCenter=BR_11101997).

Filtrar organizaciones por razón social. Búsqueda por prefijo (sin distinción de mayúsculas, máx. 256 caracteres).

Maximum string length: 256
doing_business_as
string

Filtrar organizaciones por nombre comercial. Búsqueda por prefijo (sin distinción de mayúsculas, máx. 256 caracteres).

Maximum string length: 256
status
enum<string>

Filtrar organizaciones por estado. Los valores aceptados son active, blocked o inactive.

Opciones disponibles:
active,
blocked,
inactive

Filtrar organizaciones por número de documento legal (coincidencia exacta).

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

items
object[]
page
integer

El número de páginas devueltas.

limit
integer

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