> ## 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 Organizações > Use este endpoint para consultar os detalhes de todas as Organizações que você criou. **Nota:** o filtro `metadata` é mutuamente exclusivo com os filtros `legal_name` e `doing_business_as`. Combinar `metadata` com qualquer um deles retorna um erro `400`. ## OpenAPI ````yaml pt/openapi/v3-current/ledger.yaml get /v1/organizations openapi: 3.1.0 info: title: API Midaz Ledger description: >- Referência completa da API para serviços do Midaz Ledger incluindo gerenciamento de organizações, operações de ledger, ativos, segmentos, portfolios, contas, tipos de conta, transações, operações, saldos, rotas de operação, rotas de transação e índices de metadata. version: 3.7.8 servers: - url: https://ledger.sandbox.lerian.net security: [] tags: - name: API de Organizações - name: API de Ledgers - name: API de Ativos - name: API de Segmentos - name: API de Portfolios - name: API de Tipos de Conta - name: API de Contas - name: API de Saldos - name: API de Transações - name: API de Operações - name: API de Rotas de Operação - name: API de Rotas de Transação - name: API de Índices de Metadata - name: API de Titulares - name: API de Instrumentos - name: API de Pacotes de Cobrança - name: API de Pacotes - name: API de Cálculo de Cobrança - name: API de Estimativa - name: API de Criptografia - name: API de Proteção - name: API de Taxas de Ativos paths: /v1/organizations: get: tags: - API de Organizações summary: Listar Organizações description: >- Use este endpoint para consultar os detalhes de todas as Organizações que você criou. **Nota:** o filtro `metadata` é mutuamente exclusivo com os filtros `legal_name` e `doing_business_as`. Combinar `metadata` com qualquer um deles retorna um erro `400`. parameters: - $ref: '#/components/parameters/ContentType' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Authorization' - name: limit in: query description: 'O número máximo de itens a incluir na resposta. Máx: 100' required: false example: 10 schema: type: integer default: 10 minimum: 1 maximum: 100 - name: start_date in: query description: >- O início do período que você deseja consultar. start_date e end_date são tudo-ou-nada: fornecer apenas um retorna 400. Se ambos forem omitidos, é usada uma janela padrão do último 1 mês. required: false example: '2021-01-01' schema: type: string - name: end_date in: query description: >- O fim do período que você deseja consultar. start_date e end_date são tudo-ou-nada: fornecer apenas um retorna 400. Se ambos forem omitidos, é usada uma janela padrão do último 1 mês. required: false example: '2025-01-01' schema: type: string - name: sort_order in: query description: A ordem utilizada para classificar os resultados. required: false example: asc schema: type: string default: asc enum: - asc - desc - name: page in: query description: O número da página que você deseja consultar. required: false example: 1 schema: type: integer default: 1 minimum: 1 - name: metadata.key in: query description: >- Filtra por metadata usando notação de ponto. Substitua `key` pelo nome do seu campo de metadata (ex.: `metadata.costCenter=BR_11101997`). required: false example: mymetadata schema: type: string - name: legal_name in: query description: >- Filtra organizações por razão social. Busca por prefixo (case-insensitive, máx. 256 caracteres). required: false example: Lerian schema: type: string maxLength: 256 - name: doing_business_as in: query description: >- Filtra organizações por nome fantasia. Busca por prefixo (case-insensitive, máx. 256 caracteres). required: false example: Midaz schema: type: string maxLength: 256 - name: status in: query description: >- Filtra organizações por status. Os valores aceitos são `ACTIVE` ou `INACTIVE` (em maiúsculas, correspondência exata). required: false schema: type: string enum: - ACTIVE - INACTIVE - name: legal_document in: query description: >- Filtra organizações por número do documento legal (correspondência exata). required: false schema: type: string responses: '200': description: >- Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados. content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/CreateOrganizationResponse' page: type: integer description: O número de páginas retornadas. limit: type: integer description: O número máximo de itens incluídos na resposta. 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: Não autorizado content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0041: $ref: '#/components/examples/Error0041' Error0042: $ref: '#/components/examples/Error0042' '403': description: Proibido content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0043: $ref: '#/components/examples/Error0043' '500': description: Erro Interno do Servidor content: application/json: schema: $ref: '#/components/schemas/ErrorFormat' examples: Error0046: $ref: '#/components/examples/Error0046' components: parameters: ContentType: name: Content-Type in: header description: O tipo de mídia do recurso. O valor recomendado é `application/json`. required: false example: application/json schema: type: string XRequestId: name: X-Request-Id in: header description: >- Um identificador único utilizado para rastrear e acompanhar cada requisição. 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 autenticação. Obrigatório quando `PLUGIN_AUTH_ENABLED=true` (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: `Bearer ` schemas: CreateOrganizationResponse: type: object properties: id: type: string format: uuid description: O identificador único da Organização. legalName: type: string description: A razão social da Organização. maxLength: 256 parentOrganizationId: type: - string - 'null' description: O identificador único da Organização pai. format: uuid doingBusinessAs: type: - string - 'null' maxLength: 256 description: O nome fantasia da Organização. legalDocument: type: string description: CPF, CNPJ ou outro documento de identificação legal da organização. 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: Data e hora de criação (UTC). updatedAt: type: string format: date-time description: Data e hora da última atualização (UTC). deletedAt: type: - string - 'null' format: date-time description: Data e hora da exclusão lógica, se aplicável (UTC). ErrorFormat: type: object description: A mensagem de erro da resposta. required: - code - title - message properties: code: type: string description: Um identificador único e estável para o erro. title: type: string description: Um breve resumo do problema. message: type: string description: Orientação detalhada para resolver o erro. entityType: type: string description: >- O tipo de entidade ao qual o erro se refere (por exemplo, organization, ledger, account, transaction). Opcional. fields: type: object additionalProperties: true description: Informações adicionais sobre os campos que causaram o erro. StatusOrganization: type: object description: Um objeto contendo informações sobre o status. properties: code: type: string maxLength: 100 description: O nome do status. description: type: - string - 'null' maxLength: 256 description: A descrição do status. AddressOrganization: type: object required: - line1 - zipCode - city - state - country description: Um objeto contendo informações sobre o endereço da Organização. properties: line1: type: string description: >- A primeira linha do endereço. Geralmente utilizada para informar o nome da rua e o número do edifício. line2: type: string description: >- A segunda linha do endereço. Geralmente utilizada para informar complementos como o número do apartamento. zipCode: type: string description: O código postal (apenas números). city: type: string description: O nome da cidade onde a Organização está estabelecida. state: type: string description: >- A abreviação de duas letras que representa o Estado onde a Organização está. country: description: >- O código de duas letras (ISO 3166-1 alpha2) que representa o país onde a Organização está. type: string description: type: string maxLength: 100 description: >- Um rótulo descritivo para o endereço (por exemplo, "Casa", "Escritório", "Cobrança"). Metadata: type: object additionalProperties: oneOf: - type: string maxLength: 2000 - type: number - type: boolean description: >- Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo `name` é a chave e o campo `value` é o valor. Por exemplo, para adicionar um Centro de Custo, use `'costCenter': 'BR_11101997'`. **Restrições:** as chaves devem ter no máximo 100 caracteres; valores de string no máximo 2000 caracteres. Objetos aninhados não são permitidos (os valores devem ser string, número ou booleano), a estrutura não pode exceder uma profundidade máxima de 10, e é permitido um máximo de 100 chaves. examples: Error0079: value: code: '0079' 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: '0080' 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: '0081' 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: '0083' 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. ````