> ## 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. # Listar Organizaciones > Utilice este endpoint para recuperar los detalles de todas las Organizaciones que ha creado. **Nota:** el filtro `metadata` es mutuamente excluyente con los filtros `legal_name` y `doing_business_as`. Combinar `metadata` con cualquiera de ellos devuelve un error `400`. ## OpenAPI ````yaml es/openapi/v3-current/ledger.yaml get /v1/organizations openapi: 3.1.0 info: title: API de Midaz Ledger description: >- Referencia completa de la API para los servicios de Midaz Ledger, incluyendo gestión de organizaciones, operaciones de ledger, activos, segmentos, portafolios, cuentas, tipos de cuenta, transacciones, operaciones, saldos, rutas de operación, rutas de transacción e índices de metadatos. version: 3.7.8 servers: - url: https://ledger.sandbox.lerian.net security: [] tags: - name: Organizations API - name: Ledgers API - name: Assets API - name: Segments API - name: Portfolios API - name: Account Types API - name: Accounts API - name: Balances API - name: Transactions API - name: Operations API - name: Operation Routes API - name: Transaction Routes API - name: Metadata Indexes API - name: Holders API - name: Instruments API - name: Billing Packages API - name: Packages API - name: Billing Calculation API - name: Estimation API - name: Encryption API - name: Protection API - name: Asset Rates API paths: /v1/organizations: get: tags: - Organizations API summary: Listar Organizaciones description: >- Utilice este endpoint para recuperar los detalles de todas las Organizaciones que ha creado. **Nota:** el filtro `metadata` es mutuamente excluyente con los filtros `legal_name` y `doing_business_as`. Combinar `metadata` con cualquiera de ellos devuelve un error `400`. parameters: - $ref: '#/components/parameters/ContentType' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Authorization' - name: limit in: query description: 'El número máximo de elementos a incluir en la respuesta. Máx: 100' required: false example: 10 schema: type: integer default: 10 minimum: 1 maximum: 100 - name: start_date in: query description: >- El inicio del período que desea recuperar. start_date y end_date son todo o nada: proporcionar solo uno devuelve 400. Si se omiten ambos, se utiliza una ventana predeterminada del último 1 mes. required: false example: '2021-01-01' schema: type: string - name: end_date in: query description: >- El final del período que desea recuperar. start_date y end_date son todo o nada: proporcionar solo uno devuelve 400. Si se omiten ambos, se utiliza una ventana predeterminada del último 1 mes. required: false example: '2025-01-01' schema: type: string - name: sort_order in: query description: El orden utilizado para ordenar los resultados. required: false example: asc schema: type: string default: asc enum: - asc - desc - name: page in: query description: El número de página que desea recuperar. required: false example: 1 schema: type: integer default: 1 minimum: 1 - name: metadata.key in: query description: >- Filtrar por metadatos usando notación de puntos. Reemplaza `key` con el nombre de tu campo de metadatos (p. ej. `metadata.costCenter=BR_11101997`). required: false example: mymetadata schema: type: string - name: legal_name in: query description: >- Filtrar organizaciones por razón social. Búsqueda por prefijo (sin distinción de mayúsculas, máx. 256 caracteres). required: false example: Lerian schema: type: string maxLength: 256 - name: doing_business_as in: query description: >- Filtrar organizaciones por nombre comercial. Búsqueda por prefijo (sin distinción de mayúsculas, máx. 256 caracteres). required: false example: Midaz schema: type: string maxLength: 256 - name: status in: query description: >- Filtrar organizaciones por estado. Los valores aceptados son `ACTIVE` o `INACTIVE` (mayúsculas, coincidencia exacta). required: false schema: type: string enum: - ACTIVE - INACTIVE - name: legal_document in: query description: >- Filtrar organizaciones por número de documento legal (coincidencia exacta). required: false schema: type: string responses: '200': description: >- Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados. content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/CreateOrganizationResponse' page: type: integer description: El número de páginas devueltas. limit: type: integer description: El número máximo de elementos incluidos en la respuesta. headers: {} '400': description: '' content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0079: $ref: '#/components/examples/Error0079' Error0080: $ref: '#/components/examples/Error0080' Error0081: $ref: '#/components/examples/Error0081' Error0083: $ref: '#/components/examples/Error0083' '401': description: No autorizado content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0041: $ref: '#/components/examples/Error0041' Error0042: $ref: '#/components/examples/Error0042' '403': description: Prohibido content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0043: $ref: '#/components/examples/Error0043' '500': description: Error Interno del Servidor content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0046: $ref: '#/components/examples/Error0046' components: parameters: ContentType: name: Content-Type in: header description: >- El tipo de medio del recurso. El valor recomendado es `application/json`. required: false example: application/json schema: type: string XRequestId: name: X-Request-Id in: header description: Un identificador único utilizado para rastrear y seguir cada solicitud. required: false example: 019c96a0-0a98-7287-9a31-786e0809c769 schema: type: string format: uuid Authorization: name: Authorization in: header required: false schema: type: string description: > Token JWT bearer para autenticación. Requerido cuando `PLUGIN_AUTH_ENABLED=true` (obligatorio en despliegues multiinquilino). Opcional en el modo OSS de inquilino único predeterminado. Formato: `Bearer ` schemas: CreateOrganizationResponse: type: object properties: id: type: string format: uuid description: El identificador único de la Organización. legalName: type: string description: La razón social de la Organización. maxLength: 256 parentOrganizationId: type: - string - 'null' description: El identificador único de la Organización matriz. format: uuid doingBusinessAs: type: - string - 'null' maxLength: 256 description: El nombre comercial de la Organización. legalDocument: type: string description: >- Identificación fiscal oficial, número de registro de la empresa u otra identificación legal. maxLength: 256 example: '123456789012345' status: $ref: '#/components/schemas/StatusOrganization' address: $ref: '#/components/schemas/AddressOrganization' metadata: $ref: '#/components/schemas/Metadata' createdAt: type: string format: date-time description: Fecha y hora de creación (UTC). updatedAt: type: string format: date-time description: Fecha y hora de la última actualización (UTC). deletedAt: type: - string - 'null' format: date-time description: Fecha y hora de la eliminación lógica, si aplica (UTC). ErrorFormat: type: object description: El mensaje de error de respuesta. required: - code - title - message properties: code: type: string description: Un identificador único y estable para el error. title: type: string description: Un breve resumen del problema. message: type: string description: Orientación detallada para resolver el error. entityType: type: string description: >- El tipo de entidad a la que se refiere el error (p. ej. organization, ledger, account, transaction). Opcional. fields: type: object additionalProperties: true description: Información adicional sobre los campos que causaron el error. StatusOrganization: type: object description: Un objeto que contiene información sobre el estado. properties: code: type: string maxLength: 100 description: El nombre del estado. description: type: - string - 'null' maxLength: 256 description: La descripción del estado. AddressOrganization: type: object required: - line1 - zipCode - city - state - country description: >- Un objeto que contiene información sobre la dirección de la Organización. properties: line1: type: string description: >- La primera línea de la dirección. Normalmente se utiliza para indicar el nombre de la calle y el número del edificio. line2: type: string description: >- La segunda línea de la dirección. Normalmente se utiliza para indicar cualquier complemento, como el número del apartamento. zipCode: type: string description: El código postal (solo números). city: type: string description: El nombre de la ciudad donde está establecida la Organización. state: type: string description: >- La abreviatura de dos letras que representa el Estado donde se encuentra la Organización. country: description: >- El código de dos letras (ISO 3166-1 alpha2) que representa el país donde se encuentra la Organización. type: string description: type: string maxLength: 100 description: >- Una etiqueta descriptiva para la dirección (por ejemplo, "Casa", "Oficina", "Facturación"). Metadata: type: object additionalProperties: oneOf: - type: string maxLength: 2000 - type: number - type: boolean description: >- Un objeto que contiene pares clave-valor para agregar como metadatos, donde el campo `name` es la clave y el campo `value` es el valor. Por ejemplo, para agregar un Centro de Costo, use `'costCenter': 'BR_11101997'`. **Restricciones:** las claves deben tener como máximo 100 caracteres; los valores de cadena de texto, como máximo 2000 caracteres. No se permiten objetos anidados (los valores deben ser cadena de texto, número o booleano), la estructura no puede exceder una profundidad máxima de 10, y se permite un máximo de 100 claves. examples: Error0079: value: code: 79 title: Date Range Exceeds Limit Error message: >- The range between 'initialDate' and 'finalDate' exceeds the permitted limit of {{limit}} months. Please adjust the dates and try again. summary: Date Range Exceeds Limit Error Error0080: value: code: 80 title: Pagination Limit Exceeded message: >- The pagination limit exceeds the maximum allowed of {{pageLimit}} items per page. Please verify the limit and try again. summary: Pagination Limit Exceeded Error0081: value: code: 81 title: Invalid Sort Order message: >- The 'sort_order' field must be 'asc' or 'desc'. Please provide a valid sort order and try again. summary: Invalid Sort Order Error0083: value: code: 83 title: Invalid Date Range Error message: >- Both 'initialDate' and 'finalDate' fields are required and must be in the 'yyyy-mm-dd' format. Please provide valid dates and try again. summary: Invalid Date Range Error Error0041: summary: Token Missing value: code: '0041' title: Token Missing message: >- A valid token must be provided in the request header. Please include a token and try again. Error0042: summary: Invalid Token value: code: '0042' title: Invalid Token message: >- The provided token is expired, invalid or malformed. Please provide a valid token and try again. Error0043: summary: Insufficient Privileges value: code: '0043' title: Insufficient Privileges message: >- You do not have the necessary permissions to perform this action. Please contact your administrator if you believe this is an error. Error0046: summary: Internal Server Error value: code: '0046' title: Internal Server Error message: >- The server encountered an unexpected error. Please try again later or contact support. ````