Consultar contato

GET/contacts/{contact_id}

Gerada do contrato OpenAPI

Devolve um contato, com os dados do perfil, as etiquetas e os campos personalizados. Vêm o nome, o canal atual, o gênero, o idioma, o fuso, as datas da última mensagem e da última interação e a inscrição. Para achar o ID a partir do telefone ou do e-mail, use Buscar contato por campo personalizado.

Requisição

curl "https://app.nextagsai.com.br/api/contacts/123456789" \
  -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY"

const resposta = await fetch('https://app.nextagsai.com.br/api/contacts/123456789', {
  headers: {
    'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
  },
});
const dados = await resposta.json();
console.log(resposta.status, dados);

import os

import requests

resposta = requests.get(
    "https://app.nextagsai.com.br/api/contacts/123456789",
    headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
    timeout=30,
)
print(resposta.status_code, resposta.json())

<?php
$ch = curl_init('https://app.nextagsai.com.br/api/contacts/123456789');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
    ],
]);
$dados = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($dados);

Autenticação

Mande a chave de API da conta no cabeçalho X-ACCESS-TOKEN de cada chamada. Veja Autenticação com a chave de API.

Parâmetros de caminho

contact_idintegerobrigatório

O ID do contato.

Respostas

200Sucesso

O contato.

Ver os 23 campos

idinteger

O ID do contato: o contact_id das outras chamadas.

page_idinteger

O ID da conta.

first_namestring

O nome.

last_namestring

O sobrenome.

channelinteger

O canal atual do contato: 0 Messenger, 5 WhatsApp, 8 Telegram, 9 Webchat, 10 Instagram, 17 TikTok.

profile_picstring

O endereço da foto de perfil.

localestring

O idioma do contato, como pt_BR.

genderinteger

O gênero: 0 feminino, 1 masculino, 2 desconhecido.

timezoneinteger

O fuso horário do contato, em horas em relação ao UTC (-3 em Brasília).

last_sentinteger

Quando a última mensagem foi enviada ao contato, em Unix timestamp em milissegundos.

last_deliveredinteger

Quando a última mensagem foi entregue ao contato, em Unix timestamp em milissegundos.

last_seeninteger

Quando o contato foi visto pela última vez (Visto pela última vez, no app), em Unix timestamp em milissegundos.

last_interactioninteger

Quando o contato interagiu com a conta pela última vez, em Unix timestamp em milissegundos.

subscribed_datestring

Quando o contato entrou na conta, em UTC, no formato 2026-10-12 14:40:00.

subscribedinteger

1 inscrito; 2 inscrição cancelada (o contato saiu das transmissões e não recebe Broadcasts). Veja Contatos que pediram para sair das transmissões.

tagsarray de objeto Etiqueta

As etiquetas do contato.

tags[].idinteger

O ID da etiqueta.

tags[].namestring

O nome da etiqueta.

custom_fieldsarray de objeto Campo personalizado

Os campos personalizados do contato, com o valor de cada um.

custom_fields[].idinteger

O ID do campo.

custom_fields[].namestring

O nome do campo.

custom_fields[].typeinteger

O tipo: 0 texto, 1 número, 2 data, 3 data e hora, 4 sim/não, 5 texto longo, 6 seleção única, 7 seleção múltipla.

Valores: 0 1 2 3 4 5 6 7

custom_fields[].valuestring ou number

O valor do contato, no formato do tipo: texto nos campos de texto e de texto longo; número nos de número, de data e de data e hora (Unix timestamp, em segundos) e de sim/não (1 ou 0).

400Requisição inválida

O contact_id não é um ID válido.

404Não encontrado

Não existe contato com esse ID nesta conta.

401Chave inválida

A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja Autenticação.

Relacionados

Este conteúdo ajudou?

Obrigado! Sua resposta ajuda a melhorar a central.

const resposta = await fetch('https://app.nextagsai.com.br/api/contacts/123456789', { headers: { 'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY, }, }); const dados = await resposta.json(); console.log(resposta.status, dados);

import os import requests resposta = requests.get( "https://app.nextagsai.com.br/api/contacts/123456789", headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]}, timeout=30, ) print(resposta.status_code, resposta.json())

<?php $ch = curl_init('https://app.nextagsai.com.br/api/contacts/123456789'); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ 'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'), ], ]); $dados = json_decode(curl_exec($ch), true); echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL; print_r($dados);

{ "id": 123456789, "page_id": 123456, "first_name": "Ana", "last_name": "Souza", "channel": 5, "profile_pic": "https://exemplo.com.br/fotos/ana.jpg", "locale": "pt_BR", "gender": 0, "timezone": -3, "last_sent": 1792936930000, "last_delivered": 1792936932000, "last_seen": 1792937020000, "last_interaction": 1792936680000, "subscribed_date": "2026-10-12 14:40:00", "subscribed": 1, "tags": [ { "id": 2001, "name": "cliente-vip" } ], "custom_fields": [ { "id": 3001, "name": "cidade", "type": 0, "value": "São Paulo" } ] }

Autenticação

Parâmetros de caminho

Respostas

Relacionados

Limites, erros e boas práticas

Campos personalizados, campos do bot e variáveis

Criar ou atualizar um contato

Encontrar um contato pelo e-mail ou telefone

Criar contato

Buscar contato por campo personalizado