---
title: "Busca avançada de clientes"
method: POST
path: "/api/management/customers/search"
tags: ["customers", "search"]
---

# Busca avançada de clientes

`POST /api/management/customers/search`

Buscar clientes com filtros e critérios específicos. Leia [aqui sobre busca avançada](https://docs.olie.ai/api-reference/general/advanced-search).

## Request body

- object
  - `filters` object[] — Array de filtros a serem aplicados na busca
    - `field` string, required — Campo a ser filtrado. Consulte os campos disponíveis de cada modelo [rota de listagem de parâmetros `/api/management/system/params/{model_name}`](https://docs.olie.ai/api-reference/system/listar-par%C3%A2metros-dispon%C3%ADveis-para-filtragem-de-um-modelo)
    - `operator` 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'greater_than' | 'greater_than_or_equals' | 'less_than' | 'less_than_or_equals' | 'is_null' | 'is_not_null', required — Operador relacional a ser usado no filtro
    - `value` union — Valor a ser filtrado (pode ser string, number, boolean, object com id, ou null)
      - string
      - number
      - boolean
      - object
        - `id` string, required
    - `logical_operator` 'and' | 'or' — Operador lógico para combinar com outros filtros (padrão: 'and')
    - `arguments` object[] — Argumentos adicionais para filtros especiais (ex: answer_pool requer edge_id)
      - `argument_key` string, required — Chave do argumento
      - `argument_value_id` string, required — ID do valor do argumento
      - `argument_value_type` string, required — Tipo do valor do argumento (classe do modelo)
  - `sorting` object[] — Array de ordenações a serem aplicadas
    - `field` 'name' | 'status' | 'email' | 'company_name' | 'document' | 'customer_type' | 'main_activity' | 'address' | 'description' | 'created_at', required — Campo para ordenação
    - `direction` 'asc' | 'desc', required — Direção da ordenação
    - `arguments` object[] — Argumentos adicionais para ordenações especiais
  - `page` integer — Número da página (paginação Laravel)
  - `per_page` integer — Quantidade de itens por página

## Response `200`

Sucesso: Filtro por telefone

- object
  - `customers` object[]
    - `id` string
    - `name` string
    - `headquarter` string
    - `company_name` string
    - `document_type` integer
    - `customer_type` integer
    - `document` string
    - `email` string, email
    - `phone` string
    - `address` string
    - `status` integer
    - `form_answers` unknown[]
      - unknown
    - `contacts` unknown[]
      - unknown
    - `frame_id` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `created_by_user` object
      - `id` string
      - `name` string
      - `avatar_url` string, uri
    - `created_by` string
    - `contacts_count` integer
    - `projects_count` integer
    - `tags` unknown[]
      - unknown
  - `meta` object
    - `current_page` integer
    - `from` integer
    - `last_page` integer
    - `per_page` integer
    - `to` integer
    - `total` integer
  - `response` boolean

---

[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/063de6e2e93c/schema)