curl --request GET \
--url https://api.ziala.com.br/v1/contact_fields \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ziala.com.br/v1/contact_fields"
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/contact_fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"contact_id": "3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10",
"field_key": "segmento",
"value": "Varejo",
"updated_at": "2026-10-13T14:31:02.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 valores de campos
Lista os valores dos campos personalizados dos contatos em formato longo: uma linha por contato e campo. As definições dos campos estão em /v1/fields.
curl --request GET \
--url https://api.ziala.com.br/v1/contact_fields \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ziala.com.br/v1/contact_fields"
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/contact_fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"contact_id": "3f6c2a9e-8b1d-4c7e-9a52-1e0d6b7f4a10",
"field_key": "segmento",
"value": "Varejo",
"updated_at": "2026-10-13T14:31:02.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 (contact_id + field_key).
Valor de next_cursor da página anterior.
Itens por página.
1 <= x <= 200Resposta
Página de valores.
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"