---
title: "Listar contatos"
method: GET
path: "/contacts"
tags: ["crm-v2-contacts"]
---

# Listar contatos

`GET /contacts`

Recupera uma lista paginada de todos os contatos na conta.

## Filtro

Propriedades disponíveis para filtro usando [RDQL](crm-v2-rdql-filtering).

| Propriedade | Tipo | Descrição |
| :--- | :--- | :--- |
| `name` | `String` | Filtra por nome do contato. Suporta busca exata e busca por correspondência de termo (usando operador match `~`). |
| `job_title` | `String` | Filtra por título de cargo do contato. Suporta busca exata e busca por correspondência de termo (match). |
| `email` | `String` | Filtra por endereço de e-mail do contato. |
| `phone` | `String` | Filtra por número de telefone do contato. |
| `whatsapp_username` | `String` | Filtra por username do WhatsApp do contato. Suporta busca exata e busca por correspondência de termo (match). |
| `organization_id` | `String` | Filtra por um ID de empresa. |
| `created_at` | `DateTime` | Filtra contatos pela data e hora de criação. |
| `updated_at` | `DateTime` | Filtra contatos pela data e hora da última atualização. |
| `@<custom_field_slug>` | `String` | Filtra por um campo personalizado. Exemplo: `cpf:111.111.111-11`, `erp_id:123`. |

## Ordenação

Propriedades disponíveis para [ordenação](crm-v2-introduction#ordenação).

* `name`
* `created_at`

## Query parameters

- `filter` string
- `sort` object
- `page` object
  - `number` integer — Número da página.
  - `size` integer — Tamanho da página.

## Response `200`

OK

- object
  - `data` object[] — Lista de recursos relacionados.
    - `_id` string, hash
    - `address` Address
      - `city` unknown
      - `complement` unknown
      - `country` unknown
      - `district` unknown
      - `number` unknown
      - `state` unknown
      - `street` unknown
      - `zip_code` unknown
    - `birth_date` string — Data de nascimento no formato brasileiro (DD/MM/YYYY).
    - `cel_phone` string — Número de telefone do contato.
    - `channel_metadata` object — Integração do WhatsApp a qual o contato está atribuído atualmente.
    - `cnpj` unknown
    - `code` string — Código do contato.
    - `cpf` unknown
    - `current_wallet` string — Nome da carteira ao qual o contato será inserido.
    - `customizable_field` object[] — Informações adicionais do contato.
      - `info` string
      - `label` string
    - `department_name` string — Nome do setor que o contato será direcionado.
    - `description` string — Descrição.
    - `email` string, email — Endereço de e-mail do contato.
    - `employee` string, hash
    - `full_name` string — Nome completo do contato.
    - `integration` string — Integração do WhatsApp a qual o contato está criado.
    - `job` JobInfo
      - `cnpj` unknown
      - `company` unknown
      - `department` unknown
      - `email` unknown
      - `occupation_area` unknown
      - `phone` unknown
      - `site` string, url — Website do negócio.
      - `title` unknown
    - `last_message_data` object — Última mensagem enviada pelo contato.
      - `channel` 'email' | 'instagram' | 'megasac' | 'messenger' | 'telegram' | 'whatsapp'
      - `content` string — Conteúdo da mensagem.
      - `created_at` string — Data e hora que o contato enviou a mensagem.
      - `type` string — Tipo da mensagem.
    - `rg` unknown
    - `tags` string[] — Tags.
    - `workflow_stage_title` string — Título do Estágio do Workflow ao qual o contato será atribuído.
    - `workflow_title` string — Título do Workflow ao qual o contato será atribuído.
  - `links` object — Links de navegação da paginação.
    - `first` string, uri — Link para a primeira página.
    - `prev` string, uri — Link para a página anterior.
    - `self` string, uri — Link para a página atual.
    - `next` string, uri — Link para a próxima página.
    - `last` string, uri — Link para a última página.

## Other responses

- `400` — A requisição está malformada e não consegue ser processada.
- `401` — O token da API está ausente ou inválido.
- `403` — O token não tem permissão para acessar o recurso solicitado.
- `429` — O limite de requisições foi excedido.
- `500` — Internal Server Error

---

[API](https://skmtc.net/rdstation/apis/webhook-service.md) · [All operations](https://skmtc.net/rdstation/apis/webhook-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rdstation/webhook-service/revisions/3867c21388e8/schema)