Contatos

Consultar contato

Changed on Oct 12, 2026

Telefone E.164 com +. Contato inexistente responde hoje 422 UNPROCESSABLE_ENTITY, não 404. Permissão: ADMIN.

get/v1/contacts/{phone}

Request

Base URL
https://api.ararahq.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ararahq/apis/ararahq-api/docs/v1/contacts/:phone/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

phonestring required

Telefone E.164 com + (ex. +5511999999999).

Response

Contato

idstring uuid required

namestring required

phonestring required

emailstring nullable

attributesobject nullable

tagsstring[] required

createdAtstring required

lifecyclestring required

Estágio do contato: NEW, ENGAGED, SILENT, DORMANT ou OPTED_OUT.

sourcestring required

De onde o contato veio (ex. API).

outboundCountinteger required

inboundCountinteger required

firstSeenAtstring nullable

lastOutboundAtstring nullable

lastInboundAtstring nullable

lastMessageAtstring nullable

optOutAtstring nullable

Quando o contato pediu para não receber.

lastTemplateNamestring nullable

Último template enviado ao contato.

Example response

{
  "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"
}

Changes

Oct 12, 2026d576cd28afc0 Revision changes
- info
  api tag Contatos added
- info
  api tag contacts removed
- info
  added the non-success response with the status
Sep 15, 2026372d8c2e735d Revision changes
- breaking
  the response property became optional for the status
- breaking
  the response's property type changed from object to string for status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  removed the non-success response with the status
- info
  removed the non-success response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history (3 revisions)