> ## Documentation Index > Fetch the complete documentation index at: https://docs.connectadesk.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar contatos > Os filtros se combinam: o contato precisa atender a todos os que forem enviados. Todos valem só para os contatos da empresa do token. Os filtros de texto buscam por parte do valor, sem diferenciar maiúsculas. Filtro vazio é ignorado; filtro repetido (`?email=a&email=b`) responde `422` (`ERR_API_VALIDATION`). ## OpenAPI ````yaml /api-reference/openapi.yaml get /contacts openapi: 3.0.3 info: title: Connecta DESK API pública version: 1.0.0 description: > API pública do Connecta DESK, disponível em `/api/v1`. O acesso é feito com um token gerado no módulo de tokens. Cada token tem permissões por **módulo × método**, e toda leitura de lista é paginada. ## Autenticação ``` Authorization: Bearer sk_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 ``` O token pertence a uma **empresa**, e não a um usuário. A empresa usada é sempre a do token, então enviar `companyId` no corpo não tem efeito. Token ausente, inválido, revogado ou expirado recebe a mesma resposta `401`. ## Ordem de verificação 1. **token** → `401` 2. **empresa ativa** → `403` 3. **API habilitada no plano** → `403 ERR_API_NOT_ENABLED` (não se aplica a on-premise) 4. **rate limit da empresa** → `429` 5. **permissão do token** → `403 ERR_API_FORBIDDEN_SCOPE` ## Ids de usuário Todo id de usuário na API é o id do usuário **nesta empresa**, o mesmo que `GET /users` devolve. Vale para o que a API responde (`user.id`, `assignedTo.id`, `userCreated.id`) e para o que ela aceita (`userId`, `userIds`, `assignedToUserId` e o `{id}` das rotas de usuário). A mesma pessoa pode trabalhar em várias empresas, com nome e perfil diferentes em cada uma, e tem um id diferente em cada empresa. Um id que não pertence a esta empresa responde `404`, com a mesma mensagem de um id inexistente. ## Paginação Todo `GET` de lista é paginado. O `meta` traz apenas `page`, `perPage` e `hasMore`, sem o total de registros. Para percorrer tudo, avance `page` enquanto `hasMore` for `true`. ## Idempotência Opcional em `POST`/`PUT`, pelo header `Idempotency-Key`. Se você repetir a chamada com a mesma chave e o mesmo corpo, recebe a resposta já gravada (com `Idempotent-Replay: true`). Com a mesma chave e um corpo diferente, a resposta é `409`. servers: - url: https://api.connectadesk.com/api/v1 description: Produção security: - apiToken: [] tags: - name: contacts description: Cadastro de contatos, campos extras e origem de marketing. - name: tickets x-displayName: Conversas description: Abertura, transferência, encerramento e qualificação de conversas. - name: messages description: Envio assíncrono e leitura de mensagens. - name: tags description: Tags e vínculo com atendimentos. - name: queues description: Filas de atendimento e seus atendentes. - name: wrapups description: Tipos de qualificação. - name: users description: Atendentes e administradores. - name: schedules description: Mensagens programadas. - name: quick-messages description: Respostas rápidas. - name: campaigns description: Disparos em massa. - name: crm description: Painéis, etapas, cards e indicadores. - name: channels description: Canais (somente leitura). - name: reports description: Relatórios e dashboards. - name: products description: Catálogo de produtos, categorias e desempenho nas vendas. - name: custom-fields description: >- Campos personalizados de contato e de card, e variáveis globais da empresa. - name: profiles description: Perfis de permissões da empresa (somente leitura). - name: webchat description: >- Webchat nativo pelo seu sistema: abrir sessão de um visitante, enviar e ler mensagens. O token precisa do escopo `webchat` (GET e POST). paths: /contacts: get: tags: - contacts summary: Listar contatos description: > Os filtros se combinam: o contato precisa atender a todos os que forem enviados. Todos valem só para os contatos da empresa do token. Os filtros de texto buscam por parte do valor, sem diferenciar maiúsculas. Filtro vazio é ignorado; filtro repetido (`?email=a&email=b`) responde `422` (`ERR_API_VALIDATION`). parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/perPage' - name: search in: query description: >- Busca livre por nome, número, código ou LID. Um termo só com dígitos também encontra o contato pelo id. schema: type: string example: marina - name: tagsIds in: query description: >- Ids de tags, separados por vírgula. Traz os contatos que têm atendimento com alguma dessas tags. Tag que não é da sua empresa responde `422` (`ERR_API_INVALID_REFERENCE`). schema: type: string example: 3,7 - name: channelsIds in: query description: >- Ids de canais, separados por vírgula. Traz os contatos cujo último canal de conversa é um desses. Canal que não é da sua empresa responde `422` (`ERR_API_INVALID_REFERENCE`). schema: type: string example: '4' - name: name in: query description: Filtra pelo nome. schema: type: string example: Marina - name: number in: query description: >- Filtra pelo telefone. Só os dígitos são comparados: `+55 (11) 99999` vale o mesmo que `5511999999`. Sem nenhum dígito, responde `422`. schema: type: string example: '5511999999999' - name: email in: query description: Filtra pelo e-mail. schema: type: string example: marina@exemplo.com.br - name: code in: query description: Filtra pelo código do contato no seu sistema. schema: type: string example: CLI-8842 - name: origin in: query description: Filtra pela origem. schema: type: string example: Site - name: cpfCnpj in: query description: Filtra pelo CPF ou CNPJ. schema: type: string example: '12345678909' - name: lid in: query description: Filtra pelo LID do WhatsApp. schema: type: string example: '178452961234567' - name: instagramUsername in: query description: Filtra pelo usuário do Instagram. O `@` é opcional. schema: type: string example: marina.alves - name: sourceUrl in: query description: Marketing — filtra pela página de origem. schema: type: string example: https://exemplo.com.br/promo - name: sourceId in: query description: 'Marketing — filtra pelo id da origem (ex.: id do anúncio).' schema: type: string example: '120210000000000' - name: headline in: query description: Marketing — filtra pelo título do anúncio. schema: type: string example: Matrículas abertas - name: mediaType in: query description: Marketing — filtra pelo tipo da mídia de origem. schema: type: string example: image - name: mediaUrl in: query description: Marketing — filtra pela URL da mídia de origem. schema: type: string example: https://exemplo.com.br/banner.jpg - name: utmSource in: query description: Marketing — filtra pelo `utm_source`. schema: type: string example: google - name: utmMedium in: query description: Marketing — filtra pelo `utm_medium`. schema: type: string example: cpc - name: utmCampaign in: query description: Marketing — filtra pelo `utm_campaign`. schema: type: string example: setembro - name: utmId in: query description: Marketing — filtra pelo `utm_id`. schema: type: string example: abc123 - name: fbclid in: query description: Marketing — filtra pelo `fbclid` (clique em anúncio da Meta). schema: type: string example: IwAR0abc - name: gclid in: query description: Marketing — filtra pelo `gclid` (clique em anúncio do Google). schema: type: string example: Cj0KCQjw - name: ctwaClid in: query description: >- Marketing — filtra pelo `ctwa_clid` (clique em anúncio Click to WhatsApp). schema: type: string example: ARAkLk - name: customFields in: query style: deepObject explode: true description: > Filtra por campo personalizado de contato, no formato `customFields[]=` — a `key` é a mesma de `GET /custom-fields?application=contact` e da lista `customFields` de cada contato. Dá para enviar vários campos; o contato precisa atender a todos. Campos de texto, texto longo, e-mail, telefone e link buscam por parte do valor. Os demais (número, moeda, data, seleção e sim/não) exigem o valor exato — data no formato `DD/MM/AAAA`. Uma `key` que não é de um campo de contato da sua empresa responde `422` (`ERR_API_INVALID_REFERENCE`); um valor que não combina com o tipo do campo, `422` (`ERR_API_VALIDATION`). schema: type: object additionalProperties: type: string example: cargo_do_contato: diretor data_de_aniversario: 15/03/1994 - name: from in: query description: >- Traz contatos criados a partir desta data, no fuso horário da empresa. schema: type: string format: date example: '2026-09-01' - name: to in: query description: Traz contatos criados até esta data, no fuso horário da empresa. schema: type: string format: date example: '2026-09-30' responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Contact' meta: $ref: '#/components/schemas/PageMeta' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/UnprocessableEntity' '429': $ref: '#/components/responses/TooManyRequests' components: parameters: page: name: page in: query description: Número da página, começando em 1. Um valor inválido é tratado como 1. schema: type: integer minimum: 1 default: 1 example: 1 perPage: name: perPage in: query description: >- Quantidade de itens por página. O máximo depende do ambiente (padrão 100). schema: type: integer minimum: 1 maximum: 100 default: 20 example: 50 schemas: Contact: type: object properties: id: type: integer name: type: string description: Nome exibido. number: type: string numberCountry: type: string nullable: true description: >- País do número, no padrão ISO 3166-1 alfa-2. Deduzido do DDI quando o número é gravado pela API. example: BR email: type: string nullable: true example: marina@exemplo.com.br code: type: string nullable: true cpfCnpj: type: string nullable: true example: '12345678909' origin: type: string nullable: true profilePicUrl: type: string nullable: true example: https://cdn.exemplo.com.br/avatar/1042.jpg isGroup: type: boolean description: O contato é um grupo, e não uma pessoa. instagramUsername: type: string nullable: true example: marina.alves lid: type: string nullable: true example: '178452961234567' sourceUrl: type: string nullable: true example: https://loja.exemplo.com.br/promo sourceId: type: string nullable: true example: '23851234567890123' headline: type: string nullable: true example: Coleção de inverno mediaType: type: string nullable: true example: image mediaUrl: type: string nullable: true example: https://cdn.exemplo.com.br/anuncios/inverno.jpg utmSource: type: string nullable: true example: instagram utmMedium: type: string nullable: true example: cpc utmCampaign: type: string nullable: true example: inverno-2026 utmId: type: string nullable: true example: '6543210987' fbclid: type: string nullable: true example: IwAR0xYzAbC123 gclid: type: string nullable: true ctwaClid: type: string nullable: true tags: type: array items: type: object properties: id: type: integer name: type: string description: Nome exibido. color: type: string description: Cor em hexadecimal, com `#`. example: '#6941C6' customFields: type: array description: >- Campos personalizados de contato preenchidos. Sempre vem na resposta, como lista vazia quando o contato não tem nenhum. items: $ref: '#/components/schemas/CustomFieldValue' lastChannel: type: object nullable: true properties: id: type: integer name: type: string description: Nome exibido. type: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time example: id: 842 name: Maria Silva number: '5511987654321' numberCountry: BR email: maria.silva@exemplo.com.br code: CLI-00842 cpfCnpj: '12345678909' origin: site profilePicUrl: https://cdn.exemplo.com/avatars/842.jpg isGroup: false instagramUsername: maria.silva lid: null sourceUrl: https://loja.exemplo.com.br/promo sourceId: '23851234567890123' headline: Coleção de inverno mediaType: image mediaUrl: https://cdn.exemplo.com/anuncios/inverno.jpg utmSource: instagram utmMedium: cpc utmCampaign: inverno-2026 utmId: '6543210987' fbclid: IwAR0xYzAbC123 gclid: null ctwaClid: null tags: - id: 3 name: Cliente VIP color: '#6941C6' customFields: - key: plano value: Ouro customFieldId: 91 name: Plano type: select lastChannel: id: 11 name: Instagram Loja type: instagram createdAt: '2026-07-14T13:22:05.412Z' updatedAt: '2026-08-18T09:41:17.883Z' PageMeta: type: object required: - page - perPage - hasMore properties: page: type: integer example: 1 perPage: type: integer example: 20 hasMore: type: boolean description: Indica se há mais registros além desta página. example: true example: page: 1 perPage: 20 hasMore: true CustomFieldValue: type: object description: >- Valor de um campo personalizado, junto com a definição do campo. Assim você não precisa chamar `GET /custom-fields` para saber qual é o campo 91. properties: key: type: string nullable: true description: >- Identificador fixo do campo. Use-o para indicar o campo ao gravar valores, porque o `name` pode ser renomeado no painel e a integração deixaria de funcionar sem aviso. value: type: string description: Valor preenchido no campo, no formato definido pelo tipo. customFieldId: type: integer description: Id da definição do campo personalizado. example: 91 name: type: string nullable: true description: Nome exibido. type: type: string nullable: true description: Tipo do campo, que define o formato aceito no valor. example: key: plano value: Ouro customFieldId: 91 name: Plano type: select Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string description: Código fixo do erro, para você tratar cada caso no seu sistema. example: ERR_API_FORBIDDEN_SCOPE message: type: string details: {} responses: Unauthorized: description: Token ausente, inválido, revogado ou expirado. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: ERR_API_UNAUTHORIZED message: Token de API ausente ou inválido. Forbidden: description: Empresa inativa, API não habilitada no plano ou permissão insuficiente. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: ERR_API_FORBIDDEN_SCOPE message: >- O token não tem permissão para este método neste módulo. A mensagem real nomeia os dois. UnprocessableEntity: description: >- O corpo está bem formado, mas falta um campo obrigatório ou algum valor não é aceito. Por exemplo, `application` diferente de `contact`/`card`, `orderedIds` vazio ou `name` em branco. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: ERR_API_VALIDATION message: >- O parâmetro `application` é obrigatório e aceita "contact" ou "card". TooManyRequests: description: A empresa ultrapassou o limite de requisições por minuto. headers: RateLimit-Limit: schema: type: integer description: Limite de requisições por minuto. RateLimit-Remaining: schema: type: integer description: Quantas requisições ainda restam na janela atual. RateLimit-Reset: schema: type: integer description: Segundos até a janela reiniciar. Retry-After: schema: type: integer description: Tempo de espera antes de tentar de novo. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: ERR_API_RATE_LIMIT message: Limite de requisições por minuto excedido para esta empresa. securitySchemes: apiToken: type: http scheme: bearer description: Token da API no formato `sk_live_…`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.