curl --request GET \
--url https://api.ziala.com.br/v1/contacts/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ziala.com.br/v1/contacts/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ziala.com.br/v1/contacts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10",
"created_at": "2026-10-13T14:02:11.000Z",
"updated_at": "2026-10-13T14:31:02.000Z",
"name": "Maria Souza",
"first_name": "Maria",
"last_name": "Souza",
"email": "maria@exemplo.com.br",
"phone": "+5548999990000",
"job_title": "Gerente comercial",
"company_name": "Exemplo Ltda",
"icp_id": "c4d8e2f1-3a6b-4c9d-8e7f-1a2b3c4d5e6f",
"qualification_score": 72,
"temperature": "warm",
"source": "inbound_whatsapp",
"source_detail": "Campanha de outubro",
"consent_given_at": "2026-10-13T14:02:11.000Z",
"do_not_contact": false,
"do_not_contact_at": null,
"won_at": null,
"lost_at": null,
"current_stage_id": "9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d",
"current_stage_entered_at": "2026-10-13T14:02:11.000Z",
"current_agent_id": "b7e1c0d2-5a4f-4e3b-8c9d-2f1a0e6d3c55",
"last_activity_at": "2026-10-13T14:30:48.000Z",
"first_origin_kind": "ad",
"first_origin_ad_id": "120211234567890123",
"first_origin_ctwa_clid": "ARAkLkA8rmlFeiCktEJQ-QTwRiyYHAFDLMNDBH0CD3qpjd0HR4irJ6LEkR7JwFF4XvnO",
"first_origin_headline": "Fale com um especialista",
"first_origin_at": "2026-10-13T14:02:11.000Z",
"first_campaign_id": "d5e6f7a8-9b0c-4d1e-8f2a-3b4c5d6e7f80"
}{
"type": "about:blank",
"title": "Requisição inválida",
"status": 400,
"detail": "limit deve ser um número inteiro de 1 a 200.",
"request_id": "req-3f2a"
}{
"type": "about:blank",
"title": "Requisição inválida",
"status": 400,
"detail": "limit deve ser um número inteiro de 1 a 200.",
"request_id": "req-3f2a"
}{
"type": "about:blank",
"title": "Requisição inválida",
"status": 400,
"detail": "limit deve ser um número inteiro de 1 a 200.",
"request_id": "req-3f2a"
}{
"type": "about:blank",
"title": "Requisição inválida",
"status": 400,
"detail": "limit deve ser um número inteiro de 1 a 200.",
"request_id": "req-3f2a"
}{
"type": "about:blank",
"title": "Requisição inválida",
"status": 400,
"detail": "limit deve ser um número inteiro de 1 a 200.",
"request_id": "req-3f2a"
}{
"type": "about:blank",
"title": "Requisição inválida",
"status": 400,
"detail": "limit deve ser um número inteiro de 1 a 200.",
"request_id": "req-3f2a"
}Obter contato
Retorna um contato pelo id.
curl --request GET \
--url https://api.ziala.com.br/v1/contacts/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ziala.com.br/v1/contacts/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.ziala.com.br/v1/contacts/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": "3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10",
"created_at": "2026-10-13T14:02:11.000Z",
"updated_at": "2026-10-13T14:31:02.000Z",
"name": "Maria Souza",
"first_name": "Maria",
"last_name": "Souza",
"email": "maria@exemplo.com.br",
"phone": "+5548999990000",
"job_title": "Gerente comercial",
"company_name": "Exemplo Ltda",
"icp_id": "c4d8e2f1-3a6b-4c9d-8e7f-1a2b3c4d5e6f",
"qualification_score": 72,
"temperature": "warm",
"source": "inbound_whatsapp",
"source_detail": "Campanha de outubro",
"consent_given_at": "2026-10-13T14:02:11.000Z",
"do_not_contact": false,
"do_not_contact_at": null,
"won_at": null,
"lost_at": null,
"current_stage_id": "9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d",
"current_stage_entered_at": "2026-10-13T14:02:11.000Z",
"current_agent_id": "b7e1c0d2-5a4f-4e3b-8c9d-2f1a0e6d3c55",
"last_activity_at": "2026-10-13T14:30:48.000Z",
"first_origin_kind": "ad",
"first_origin_ad_id": "120211234567890123",
"first_origin_ctwa_clid": "ARAkLkA8rmlFeiCktEJQ-QTwRiyYHAFDLMNDBH0CD3qpjd0HR4irJ6LEkR7JwFF4XvnO",
"first_origin_headline": "Fale com um especialista",
"first_origin_at": "2026-10-13T14:02:11.000Z",
"first_campaign_id": "d5e6f7a8-9b0c-4d1e-8f2a-3b4c5d6e7f80"
}{
"type": "about:blank",
"title": "Requisição inválida",
"status": 400,
"detail": "limit deve ser um número inteiro de 1 a 200.",
"request_id": "req-3f2a"
}{
"type": "about:blank",
"title": "Requisição inválida",
"status": 400,
"detail": "limit deve ser um número inteiro de 1 a 200.",
"request_id": "req-3f2a"
}{
"type": "about:blank",
"title": "Requisição inválida",
"status": 400,
"detail": "limit deve ser um número inteiro de 1 a 200.",
"request_id": "req-3f2a"
}{
"type": "about:blank",
"title": "Requisição inválida",
"status": 400,
"detail": "limit deve ser um número inteiro de 1 a 200.",
"request_id": "req-3f2a"
}{
"type": "about:blank",
"title": "Requisição inválida",
"status": 400,
"detail": "limit deve ser um número inteiro de 1 a 200.",
"request_id": "req-3f2a"
}{
"type": "about:blank",
"title": "Requisição inválida",
"status": 400,
"detail": "limit deve ser um número inteiro de 1 a 200.",
"request_id": "req-3f2a"
}Autorizações
Chave da API da conta, no formato zk_live_….
Parâmetros de caminho
Identificador do contato.
Resposta
O contato.
Identificador único do registro.
"3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10"
Data de criação.
"2026-10-13T14:02:11.000Z"
Data da última alteração.
"2026-10-13T14:31:02.000Z"
Nome completo.
"Maria Souza"
Primeiro nome.
"Maria"
Sobrenome.
"Souza"
E-mail.
"maria@exemplo.com.br"
Telefone no formato E.164, por exemplo +5548999990000.
"+5548999990000"
Cargo.
"Gerente comercial"
Empresa.
"Exemplo Ltda"
Perfil de cliente ideal em que o contato foi enquadrado.
"c4d8e2f1-3a6b-4c9d-8e7f-1a2b3c4d5e6f"
Pontuação de qualificação calculada pelas regras do perfil.
72
Propensão de compra estimada. Valores: hot, warm ou cold.
"warm"
Como o contato entrou. Valores: manual, inbound_whatsapp, webhook_form, api ou hubspot.
"inbound_whatsapp"
Complemento da origem, como o material, a página ou a campanha.
"Campanha de outubro"
Data em que o contato deu consentimento.
"2026-10-13T14:02:11.000Z"
true quando o contato pediu para não receber mensagens.
false
Data do pedido para não receber mensagens.
null
Data em que o contato chegou a uma etapa de ganho.
null
Data em que o contato chegou a uma etapa de perda.
null
Etapa atual do contato. Detalhes em /v1/pipeline_stages.
"9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d"
Data de entrada na etapa atual.
"2026-10-13T14:02:11.000Z"
Agente responsável pelo contato hoje.
"b7e1c0d2-5a4f-4e3b-8c9d-2f1a0e6d3c55"
Data da última mensagem trocada com o contato, em qualquer conversa.
"2026-10-13T14:30:48.000Z"
Origem da primeira conversa com origem conhecida. Valores: ad (anúncio Click-to-WhatsApp da Meta) ou link (texto de um link de campanha).
"ad"
Identificador do anúncio na Meta, na primeira origem.
"120211234567890123"
Identificador de clique da Meta (ctwa_clid), na primeira origem.
"ARAkLkA8rmlFeiCktEJQ-QTwRiyYHAFDLMNDBH0CD3qpjd0HR4irJ6LEkR7JwFF4XvnO"
Título do anúncio, na primeira origem.
"Fale com um especialista"
Data em que a primeira origem foi registrada.
"2026-10-13T14:02:11.000Z"
Campanha cadastrada na Ziala que corresponde à primeira origem.
"d5e6f7a8-9b0c-4d1e-8f2a-3b4c5d6e7f80"