> ## Documentation Index > Fetch the complete documentation index at: https://docs.ararahq.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar contatos > Contatos da organização, no envelope `{ contacts, total, page, size, totalPages }` (não segue o padrão `{ data, pagination }`). Exige plano com contatos (`403 PLAN_FEATURE_LOCKED`). Permissão: `ADMIN`. ## OpenAPI ````yaml /openapi.yaml get /v1/contacts openapi: 3.0.3 info: title: API da Arara description: > API REST da Arara para WhatsApp Business: mensagens, templates, campanhas, contatos, conversas, formulários, automações, smart links e carteira. Esta especificação cobre só os endpoints que aceitam **chave de API** (`Authorization: Bearer ara_live_...`). Rotas usadas apenas pelo painel (gestão de chaves, configuração do webhook, pagamentos e perfil pessoal) ficam de fora. ## Autenticação Header `Authorization: Bearer ara_live_...`. Crie a chave em https://app.ararahq.com/dashboard/apikeys. As chaves são sempre LIVE: mensagens são entregues de verdade e o custo sai da carteira. ## Permissões da chave Chave criada sem permissões explícitas tem acesso total (`ADMIN`). Chave com permissões restritas só alcança: - `READ`: `GET` em `/v1/messages`, `/v1/campaigns`, `/v1/templates`, `/v1/flows`, `/v1/automations` e `/v1/organizations/me/numbers`. - `MESSAGES_SEND`: escrita em `/v1/messages/**`, `POST /v1/media/upload` e `POST /v1/flows/{id}/test`. - `TEMPLATES_WRITE`: escrita em `/v1/templates/**` e `/v1/flows/**`. - `CAMPAIGNS_SEND`: escrita em `/v1/campaigns/**`. - `CONTACTS_WRITE`: escrita em `/v1/contacts/**`. - `AUTOMATIONS_MANAGE`: escrita em `/v1/automations/**`. - `WEBHOOKS_MANAGE`: escrita em `/webhook/**`. Qualquer outra rota exige `ADMIN`. Fora do escopo, a resposta é `403`. ## Rate limit Por usuário da chave: 1.200 leituras (`GET`) por minuto e 3.000 escritas por minuto. Toda resposta traz `X-RateLimit-Remaining`. Acima do limite: `429` com `Retry-After` e `error.code = RATE_LIMIT_EXCEEDED`. O envio tem limites próprios (`SEND_RATE_LIMITED`, `BATCH_BUSY`, `MARKETING_FREQUENCY_EXCEEDED`). ## Formato de erro ```json { "error": { "code": "ERROR_CODE", "message": "Descrição", "details": {} } } ``` Exceções: falha de autenticação (`401`, `403` e `503` do filtro de chave) volta no formato padrão do Spring (`timestamp`, `status`, `error`, `path`, sem `code`), e alguns `404` e `403` voltam sem corpo. version: 2.1.0 contact: name: AraraHQ url: https://ararahq.com email: oi@ararahq.com servers: - url: https://api.ararahq.com description: Produção security: - bearerAuth: [] tags: - name: Mensagens description: Envio, consulta e histórico de mensagens de WhatsApp, e upload de mídia. - name: Conversas description: >- Conversas com cada telefone, resposta dentro da janela de 24h e situação da janela. - name: Templates description: Criação, listagem, status de aprovação e métricas de templates. - name: Campanhas description: >- Envio do mesmo template para muitos contatos, com estimativa, agendamento, cancelamento e teste A/B. - name: Contatos description: Base de contatos da organização e direitos do titular (LGPD). - name: Opt-out description: Registro e consulta de quem pediu para não receber mensagens. - name: Formulários description: >- Formulários nativos do WhatsApp (Flows) e as respostas recebidas. Disponíveis do plano Voo para cima. - name: Automações description: >- Sequências de passos que rodam sozinhas para cada contato que entra por um gatilho. Exigem plano com recuperação de receita. - name: Smart Links description: Links wa.me rastreáveis, com QR code. - name: Números description: >- Números de WhatsApp da organização e o perfil comercial exibido no WhatsApp. - name: Carteira description: Saldo, extrato, recarga automática e preços. - name: Consulta de telefone description: Consulta de tipo de linha e de WhatsApp de um número (cobrada). - name: Recuperação description: Endpoint de recuperação de receita (carrinho abandonado, Pix, boleto). - name: Conta description: Identidade da chave, plano da organização e status da API. paths: /v1/contacts: get: tags: - Contatos summary: Listar contatos description: > Contatos da organização, no envelope `{ contacts, total, page, size, totalPages }` (não segue o padrão `{ data, pagination }`). Exige plano com contatos (`403 PLAN_FEATURE_LOCKED`). Permissão: `ADMIN`. operationId: listContacts parameters: - in: query name: q required: false schema: type: string description: Busca por nome, telefone ou email. - in: query name: lifecycle required: false schema: type: string enum: - ALL - NEW - ENGAGED - SILENT - DORMANT - OPTED_OUT description: Estágio do contato. `ALL` (ou omitido) traz todos. - in: query name: page required: false schema: type: integer minimum: 0 default: 0 description: Página, começando em `0`. - in: query name: size required: false schema: type: integer minimum: 1 maximum: 200 default: 20 description: Itens por página. Máximo `200`. - $ref: '#/components/parameters/WabaIdHeader' responses: '200': description: Página de contatos content: application/json: schema: $ref: '#/components/schemas/ContactsListResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/RateLimited' components: parameters: WabaIdHeader: in: header name: X-Waba-Id required: false schema: type: string format: uuid description: >- Restringe o resultado a uma conta WhatsApp Business (WABA) da organização. schemas: ContactsListResponse: type: object required: - contacts - total - page - size - totalPages properties: contacts: type: array items: $ref: '#/components/schemas/ContactResponse' total: type: integer format: int64 page: type: integer size: type: integer totalPages: type: integer ContactResponse: type: object required: - id - name - phone - tags - createdAt - lifecycle - source - outboundCount - inboundCount properties: id: type: string format: uuid name: type: string phone: type: string email: type: string nullable: true attributes: type: object nullable: true additionalProperties: true tags: type: array items: type: string createdAt: type: string lifecycle: type: string description: >- Estágio do contato: `NEW`, `ENGAGED`, `SILENT`, `DORMANT` ou `OPTED_OUT`. source: type: string description: De onde o contato veio (ex. `API`). outboundCount: type: integer format: int64 inboundCount: type: integer format: int64 firstSeenAt: type: string nullable: true lastOutboundAt: type: string nullable: true lastInboundAt: type: string nullable: true lastMessageAt: type: string nullable: true optOutAt: type: string nullable: true description: Quando o contato pediu para não receber. lastTemplateName: type: string nullable: true description: Último template enviado ao contato. example: id: 1f2e3d4c-5b6a-7890-abcd-ef1234567890 name: João Silva phone: '+5511999999999' email: joao@exemplo.com attributes: plano: pro tags: - vip createdAt: '2026-09-01T14:30:00Z' lifecycle: ENGAGED source: API outboundCount: 12 inboundCount: 3 firstSeenAt: '2026-09-01T14:30:00Z' lastOutboundAt: '2026-09-14T10:00:00Z' lastInboundAt: '2026-09-14T10:05:00Z' lastMessageAt: '2026-09-14T10:05:00Z' optOutAt: null lastTemplateName: pedido_confirmado SpringError: type: object description: >- Corpo padrão do Spring nas falhas de autenticação (`401`, `403` e `503` do filtro de chave). Não tem `error.code`. properties: timestamp: type: string format: date-time status: type: integer example: 401 error: type: string example: Unauthorized path: type: string example: /v1/messages Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string example: INSUFFICIENT_FUNDS description: >- Código estável do erro. Use este campo no seu tratamento, não a mensagem. message: type: string nullable: true description: Descrição legível, em português. Pode mudar. details: type: object additionalProperties: true description: Dados extras do erro. Vazio na maioria dos casos. example: error: code: INSUFFICIENT_FUNDS message: Saldo insuficiente. details: {} responses: Unauthorized: description: > Chave inexistente, revogada, expirada, com prefixo errado (`ara_` sem `ara_live_`) ou vinda de IP fora da allowlist. O corpo é o JSON padrão do Spring, sem `error.code`. content: application/json: schema: $ref: '#/components/schemas/SpringError' example: timestamp: '2026-09-15T14:30:00.000+00:00' status: 401 error: Unauthorized path: /v1/messages Forbidden: description: > Dois casos, com corpos diferentes: - Autenticação: header `Authorization` ausente, Bearer que não começa com `ara_`, chave sem a permissão da rota ou rota que não aceita chave de API. Corpo no formato padrão do Spring, sem `error.code`. - Regra de negócio, no formato `{ "error": { ... } }`: `PLAN_FEATURE_LOCKED`, `PLAN_LIMIT_REACHED`, `ACCOUNT_NOT_ACTIVATED`, `NO_DEDICATED_NUMBER`, `ORGANIZATION_SUSPENDED`, `NUMBER_BLOCKED`, `FRAUD_SUSPECTED`, `RESOURCE_FORBIDDEN`, `VIEWER_READ_ONLY`. content: application/json: schema: anyOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/SpringError' examples: regraDeNegocio: summary: Regra de negócio value: error: code: PLAN_FEATURE_LOCKED message: Seu plano não inclui este recurso. details: {} autenticacao: summary: Sem header ou sem permissão value: timestamp: '2026-09-15T14:30:00.000+00:00' status: 403 error: Forbidden path: /v1/messages RateLimited: description: >- `RATE_LIMIT_EXCEEDED`: limite geral da API (1.200 leituras ou 3.000 escritas por minuto, por usuário da chave). headers: Retry-After: schema: type: integer description: Segundos a aguardar antes de repetir a chamada. X-RateLimit-Remaining: schema: type: integer description: Requisições restantes na janela atual. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: RATE_LIMIT_EXCEEDED message: Muitas requisições. Tente de novo em instantes. details: {} securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: ara_live_... description: >- Chave de API da Arara (`ara_live_...`), enviada no header `Authorization: Bearer ara_live_...`. Crie e gerencie as chaves no painel: https://app.ararahq.com/dashboard/apikeys. O valor completo aparece uma única vez, na criação. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.