---
title: "Listar clientes"
method: GET
path: "/api/management/customers"
tags: ["customers"]
---

# Listar clientes

`GET /api/management/customers`

Listar todos os clientes.

## Response `200`

Sucesso

- object
  - `response` true, required — Indicador de sucesso da requisição
  - `customers` object[], required — Array com os objetos de clientes
    - `id` string, uuid, required — Identificador único do cliente
    - `name` string, required — Nome do cliente
    - `headquarter` string — Nome da matriz (atributo computado)
    - `branch` string — Nome da filial (atributo computado)
    - `company_name` string — Razão social da empresa
    - `document_type` 1 | 2, required — Tipo de documento: 1 = CPF, 2 = CNPJ
    - `customer_type` 1 | 2, required — Tipo de cliente: 1 = Matriz, 2 = Filial
    - `parent` object — Dados da matriz (apenas quando há relacionamento)
      - `id` string, uuid — ID da matriz
      - `name` string — Nome da matriz
    - `document` string — Número do CPF ou CNPJ
    - `main_activity` string — Atividade principal da empresa
    - `email` string, email — E-mail do cliente
    - `phone` string — Telefone do cliente
    - `address` string — Endereço do cliente
    - `description` string — Descrição adicional do cliente
    - `custom_fields` object — Campos personalizados
    - `status` boolean — Status do cliente (true = ativo, false = inativo)
    - `form_answers` unknown[] — Respostas de formulários dinâmicos
      - unknown
    - `contacts` object[] — Contatos vinculados ao cliente (apenas se carregado)
    - `parent_id` string, uuid — ID do cliente matriz (se for filial)
    - `frame_id` string, uuid, required — ID do frame/organização
    - `created_at` string, date-time, required — Data de criação do registro
    - `updated_at` string, date-time, required — Data da última atualização
    - `deleted_at` string, date-time — Data de exclusão (soft delete)
    - `created_by` integer — ID do usuário que criou o registro
    - `created_by_user` object — Dados do usuário criador (apenas se carregado)
      - `id` integer — ID do usuário
      - `name` string — Nome do usuário
      - `avatar_url` string — URL do avatar do usuário
    - `contacts_count` integer — Quantidade de contatos vinculados (apenas se contado)
    - `projects_count` integer — Quantidade de projetos vinculados (apenas se contado)
    - `tags` object[] — Tags vinculadas ao cliente (apenas se carregadas)
      - `id` string, uuid — ID da tag
      - `name` string — Nome da tag
      - `color` string — Cor da tag em formato hexadecimal
  - `meta` object, required — Metadados da paginação
    - `current_page` integer, required — Página atual
    - `from` integer, required — Índice do primeiro item na página atual
    - `last_page` integer, required — Número da última página
    - `per_page` integer, required — Quantidade de itens por página
    - `to` integer, required — Índice do último item na página atual
    - `total` integer, required — Total de registros disponíveis

---

[API](https://skmtc.net/olie-ai/apis/olie-api.md) · [All operations](https://skmtc.net/olie-ai/apis/olie-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/olie-ai/olie-api/revisions/4859f7ec8b64/schema)