Skip to main content
GET
Obter contato

Autorizações

Authorization
string
header
obrigatório

Chave da API da conta, no formato zk_live_….

Parâmetros de caminho

id
string
obrigatório

Identificador do contato.

Resposta

O contato.

id
string
obrigatório

Identificador único do registro.

Exemplo:

"3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10"

created_at
string<date-time>
obrigatório

Data de criação.

Exemplo:

"2026-10-13T14:02:11.000Z"

updated_at
string<date-time>
obrigatório

Data da última alteração.

Exemplo:

"2026-10-13T14:31:02.000Z"

name
string | null
obrigatório

Nome completo.

Exemplo:

"Maria Souza"

first_name
string | null
obrigatório

Primeiro nome.

Exemplo:

"Maria"

last_name
string | null
obrigatório

Sobrenome.

Exemplo:

"Souza"

email
string | null
obrigatório

E-mail.

Exemplo:

"maria@exemplo.com.br"

phone
string | null
obrigatório

Telefone no formato E.164, por exemplo +5548999990000.

Exemplo:

"+5548999990000"

job_title
string | null
obrigatório

Cargo.

Exemplo:

"Gerente comercial"

company_name
string | null
obrigatório

Empresa.

Exemplo:

"Exemplo Ltda"

icp_id
string | null
obrigatório

Perfil de cliente ideal em que o contato foi enquadrado.

Exemplo:

"c4d8e2f1-3a6b-4c9d-8e7f-1a2b3c4d5e6f"

qualification_score
integer | null
obrigatório

Pontuação de qualificação calculada pelas regras do perfil.

Exemplo:

72

temperature
string | null
obrigatório

Propensão de compra estimada. Valores: hot, warm ou cold.

Exemplo:

"warm"

source
string | null
obrigatório

Como o contato entrou. Valores: manual, inbound_whatsapp, webhook_form, api ou hubspot.

Exemplo:

"inbound_whatsapp"

source_detail
string | null
obrigatório

Complemento da origem, como o material, a página ou a campanha.

Exemplo:

"Campanha de outubro"

Data em que o contato deu consentimento.

Exemplo:

"2026-10-13T14:02:11.000Z"

do_not_contact
boolean
obrigatório

true quando o contato pediu para não receber mensagens.

Exemplo:

false

do_not_contact_at
string<date-time> | null
obrigatório

Data do pedido para não receber mensagens.

Exemplo:

null

won_at
string<date-time> | null
obrigatório

Data em que o contato chegou a uma etapa de ganho.

Exemplo:

null

lost_at
string<date-time> | null
obrigatório

Data em que o contato chegou a uma etapa de perda.

Exemplo:

null

current_stage_id
string | null
obrigatório

Etapa atual do contato. Detalhes em /v1/pipeline_stages.

Exemplo:

"9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d"

current_stage_entered_at
string<date-time> | null
obrigatório

Data de entrada na etapa atual.

Exemplo:

"2026-10-13T14:02:11.000Z"

current_agent_id
string | null
obrigatório

Agente responsável pelo contato hoje.

Exemplo:

"b7e1c0d2-5a4f-4e3b-8c9d-2f1a0e6d3c55"

last_activity_at
string<date-time> | null
obrigatório

Data da última mensagem trocada com o contato, em qualquer conversa.

Exemplo:

"2026-10-13T14:30:48.000Z"

first_origin_kind
string | null
obrigatório

Origem da primeira conversa com origem conhecida. Valores: ad (anúncio Click-to-WhatsApp da Meta) ou link (texto de um link de campanha).

Exemplo:

"ad"

first_origin_ad_id
string | null
obrigatório

Identificador do anúncio na Meta, na primeira origem.

Exemplo:

"120211234567890123"

first_origin_ctwa_clid
string | null
obrigatório

Identificador de clique da Meta (ctwa_clid), na primeira origem.

Exemplo:

"ARAkLkA8rmlFeiCktEJQ-QTwRiyYHAFDLMNDBH0CD3qpjd0HR4irJ6LEkR7JwFF4XvnO"

first_origin_headline
string | null
obrigatório

Título do anúncio, na primeira origem.

Exemplo:

"Fale com um especialista"

first_origin_at
string<date-time> | null
obrigatório

Data em que a primeira origem foi registrada.

Exemplo:

"2026-10-13T14:02:11.000Z"

first_campaign_id
string | null
obrigatório

Campanha cadastrada na Ziala que corresponde à primeira origem.

Exemplo:

"d5e6f7a8-9b0c-4d1e-8f2a-3b4c5d6e7f80"