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

# Listar contatos

`GET /contacts`

## Request

- Base URL: `https://api.rd.services/crm/v2`
- URL: `https://api.rd.services/crm/v2/contacts`
- Auth: OAuth 2
  - Authorization code: `/oauth/authorize`
  - Token URL: `/oauth/token`

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: Identificador único.
    - `name` string: Nome do contato.
    - `job_title` string: Cargo do contato.
    - `emails` Email[]: Emails do contato.
      - `email` string: Endereço de email.
    - `phones` Phone[]: Telefones do contato.
      - `phone` string: Telefone.
      - `type` 'work' | 'fax' | 'home' | 'mobile': Tipo do telefone.
    - `whatsapp_username` string: Username do WhatsApp do contato.
    - `birthday` string, date: Data de aniversário do contato. Formato: `YYYY-MM-DD`. Caso só tenha o mês e o dia, use `0000-MM-DD`.
    - `social_profiles` SocialProfile[]: Perfis sociais do contato.
      - `type` 'facebook' | 'linkedin' | 'skype': Tipo de perfil social.
      - `username` string: Nome de usuário.
    - `organization_id` string: ID da organização.
    - `legal_bases` LegalBase[]: Bases legais para o contato. ([Saiba mais](crm-v2-introduction#bases-legais))
      - `category` 'communications': A categoria relativa à base legal.
      - `type` 'consent' | 'legitimate_interest' | 'pre_existent_contract' | 'judicial_process' | 'vital_interest' | 'public_interest': Qual base legal autoriza o tratamento dos dados pessoais.
      - `status` 'granted' | 'declined': Status da base legal.
    - `custom_fields` CustomFields
    - `created_at` string, date-time: Data de criação do contato.
    - `updated_at` string, date-time: Data de atualização do contato.
  - `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`: Erro interno ou inesperado no servidor.

---

[API](https://skmtc.dev/rdstation/apis/rd-station-crm-api-v2.md) - [All operations](https://skmtc.dev/rdstation/apis/rd-station-crm-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/rdstation/apis/rd-station-crm-api-v2/revisions/10d0a25b8c54?raw)