> ## Documentation Index > Fetch the complete documentation index at: https://docs.olie.ai/llms.txt > Use this file to discover all available pages before exploring further. # Listar clientes > Listar todos os clientes. ## OpenAPI ````yaml /api-reference/openapi.json get /api/management/customers openapi: 3.0.0 info: title: Olie API version: 1.0.0 description: > # Introdução 👋 Olá! Esta é a documentação oficial da API da [olie.ai](https://olie.ai/). Aqui você encontra as referências e exemplos de uso dos nossos endpoints. Para uma visão completa, recomendamos fortemente que você leia a [documentação oficial](https://docs.olie.ai/api-reference/introduction). Lá estão detalhados tópicos essenciais como [autenticação](https://docs.olie.ai/api-reference/introduction/authentication), [estrutura de respostas](https://docs.olie.ai/api-reference/general/response-structure), [paginação](https://docs.olie.ai/api-reference/general/pagination) e outros guias de integração. No Postman, esta coleção foca nas informações específicas de cada requisição (endpoints, parâmetros e exemplos), servindo como apoio rápido para testes e desenvolvimento. servers: - url: https://api.olie.ai security: - BearerAuth: [] paths: /api/management/customers: get: tags: - customers summary: Listar clientes description: Listar todos os clientes. operationId: listarClientes responses: '200': description: Sucesso headers: Access-Control-Allow-Origin: schema: type: string example: '*' Access-Control-Expose-Headers: schema: type: string example: '*' Cache-Control: schema: type: string example: no-cache, private Date: schema: type: string example: Fri, 16 Jan 2026 18:06:16 GMT X-Ratelimit-Limit: schema: type: integer example: 160 X-Ratelimit-Remaining: schema: type: integer example: 159 Transfer-Encoding: schema: type: string example: chunked content: application/json: schema: type: object properties: response: type: boolean enum: - true description: Indicador de sucesso da requisição customers: type: array description: Array com os objetos de clientes items: type: object properties: id: type: string description: Identificador único do cliente format: uuid name: type: string description: Nome do cliente headquarter: type: string description: Nome da matriz (atributo computado) branch: type: string description: Nome da filial (atributo computado) company_name: type: string description: Razão social da empresa document_type: type: integer enum: - 1 - 2 description: 'Tipo de documento: 1 = CPF, 2 = CNPJ' customer_type: type: integer enum: - 1 - 2 description: 'Tipo de cliente: 1 = Matriz, 2 = Filial' parent: type: object description: Dados da matriz (apenas quando há relacionamento) properties: id: type: string description: ID da matriz format: uuid name: type: string description: Nome da matriz document: type: string description: Número do CPF ou CNPJ main_activity: type: string description: Atividade principal da empresa email: type: string description: E-mail do cliente format: email phone: type: string description: Telefone do cliente address: type: string description: Endereço do cliente description: type: string description: Descrição adicional do cliente custom_fields: type: object description: Campos personalizados status: type: boolean description: Status do cliente (true = ativo, false = inativo) form_answers: type: array description: Respostas de formulários dinâmicos items: {} default: [] contacts: type: array description: Contatos vinculados ao cliente (apenas se carregado) items: type: object parent_id: type: string description: ID do cliente matriz (se for filial) format: uuid frame_id: type: string description: ID do frame/organização format: uuid created_at: type: string description: Data de criação do registro format: date-time updated_at: type: string description: Data da última atualização format: date-time deleted_at: type: string description: Data de exclusão (soft delete) format: date-time created_by: type: integer description: ID do usuário que criou o registro created_by_user: type: object description: Dados do usuário criador (apenas se carregado) properties: id: type: integer description: ID do usuário name: type: string description: Nome do usuário avatar_url: type: string description: URL do avatar do usuário contacts_count: type: integer description: >- Quantidade de contatos vinculados (apenas se contado) projects_count: type: integer description: >- Quantidade de projetos vinculados (apenas se contado) tags: type: array description: Tags vinculadas ao cliente (apenas se carregadas) items: type: object properties: id: type: string description: ID da tag format: uuid name: type: string description: Nome da tag color: type: string description: Cor da tag em formato hexadecimal required: - id - name - document_type - customer_type - frame_id - created_at - updated_at meta: type: object description: Metadados da paginação properties: current_page: type: integer minimum: 1 description: Página atual from: type: integer description: Índice do primeiro item na página atual last_page: type: integer minimum: 1 description: Número da última página per_page: type: integer minimum: 1 description: Quantidade de itens por página to: type: integer description: Índice do último item na página atual total: type: integer minimum: 0 description: Total de registros disponíveis required: - current_page - from - last_page - per_page - to - total required: - response - customers - meta example: response: true customers: - id: 9d4e5f6a-7b8c-9d0e-1f2a-3b4c5d6e7f8a name: Cliente Exemplo LTDA headquarter: Cliente Exemplo LTDA branch: null company_name: Cliente Exemplo Comércio LTDA document_type: 2 customer_type: 1 document: 12.345.678/0001-90 main_activity: Comércio de produtos alimentícios email: contato@clienteexemplo.com.br phone: (91) 99999-0000 address: Rua Exemplo, 123 - Centro - São Paulo/SP description: Cliente do segmento de alimentação custom_fields: null status: true form_answers: [] parent_id: null frame_id: 8c3d4e5f-6a7b-8c9d-0e1f-2a3b4c5d6e7f created_at: '2026-01-15T10:30:00.000000Z' updated_at: '2026-01-15T10:30:00.000000Z' deleted_at: null created_by: 123 contacts_count: 2 projects_count: 5 meta: current_page: 1 from: 1 last_page: 10 per_page: 15 to: 15 total: 150 components: securitySchemes: BearerAuth: type: http scheme: bearer ````