curl --request GET \
--url https://api.ziala.com.br/v1/conversations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ziala.com.br/v1/conversations"
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/conversations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "7c2d9e41-0a3b-4f5c-8d6e-1f2a3b4c5d6e",
"contact_id": "3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10",
"created_at": "2026-10-13T14:02:11.000Z",
"updated_at": "2026-10-13T14:31:02.000Z",
"closed_at": null,
"active": true,
"channel_id": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4a5b",
"agent_id": "b7e1c0d2-5a4f-4e3b-8c9d-2f1a0e6d3c55",
"origin_kind": "ad",
"origin_ad_id": "120211234567890123",
"origin_ctwa_clid": "ARAkLkA8rmlFeiCktEJQ-QTwRiyYHAFDLMNDBH0CD3qpjd0HR4irJ6LEkR7JwFF4XvnO",
"origin_headline": "Fale com um especialista",
"origin_at": "2026-10-13T14:02:11.000Z",
"campaign_id": "d5e6f7a8-9b0c-4d1e-8f2a-3b4c5d6e7f80",
"outcome_category": null,
"outcome_stage_id": null,
"outcome_set_at": null,
"contact_message_count": 6,
"agent_message_count": 7,
"first_response_at": "2026-10-13T14:02:19.000Z"
}
],
"next_cursor": "eyJ0IjoiM2Y2YzJhOWUiLCJ0cyI6IjIwMjYtMTEtMDNUMTQ6MzE6MDIuMDAwWiJ9",
"has_more": true,
"sync_watermark": "2026-10-13T14:29:00.000Z"
}{
"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"
}Listar conversas
Lista as conversas com origem, resultado, contagem de mensagens e horário da primeira resposta. O conteúdo das mensagens não é exposto.
curl --request GET \
--url https://api.ziala.com.br/v1/conversations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ziala.com.br/v1/conversations"
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/conversations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "7c2d9e41-0a3b-4f5c-8d6e-1f2a3b4c5d6e",
"contact_id": "3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10",
"created_at": "2026-10-13T14:02:11.000Z",
"updated_at": "2026-10-13T14:31:02.000Z",
"closed_at": null,
"active": true,
"channel_id": "f1e2d3c4-b5a6-4978-8a9b-0c1d2e3f4a5b",
"agent_id": "b7e1c0d2-5a4f-4e3b-8c9d-2f1a0e6d3c55",
"origin_kind": "ad",
"origin_ad_id": "120211234567890123",
"origin_ctwa_clid": "ARAkLkA8rmlFeiCktEJQ-QTwRiyYHAFDLMNDBH0CD3qpjd0HR4irJ6LEkR7JwFF4XvnO",
"origin_headline": "Fale com um especialista",
"origin_at": "2026-10-13T14:02:11.000Z",
"campaign_id": "d5e6f7a8-9b0c-4d1e-8f2a-3b4c5d6e7f80",
"outcome_category": null,
"outcome_stage_id": null,
"outcome_set_at": null,
"contact_message_count": 6,
"agent_message_count": 7,
"first_response_at": "2026-10-13T14:02:19.000Z"
}
],
"next_cursor": "eyJ0IjoiM2Y2YzJhOWUiLCJ0cyI6IjIwMjYtMTEtMDNUMTQ6MzE6MDIuMDAwWiJ9",
"has_more": true,
"sync_watermark": "2026-10-13T14:29:00.000Z"
}{
"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 consulta
Retorna só registros criados ou alterados a partir deste instante: data e hora ISO 8601 com fuso, ou só a data (AAAA-MM-DD, meia-noite UTC). A busca recua 5 minutos para cobrir diferenças de relógio, então grave pela chave primária (id).
Valor de next_cursor da página anterior.
Itens por página.
1 <= x <= 200Resposta
Página de conversas.
Show child attributes
Show child attributes
Cursor da próxima página, para enviar em cursor. null na última página.
"eyJ0IjoiM2Y2YzJhOWUiLCJ0cyI6IjIwMjYtMTEtMDNUMTQ6MzE6MDIuMDAwWiJ9"
true se há mais páginas.
true
Instante até o qual esta leitura está completa, igual em todas as páginas. Envie como updated_since na próxima sincronização.
"2026-10-13T14:29:00.000Z"