Listar campos
curl --request GET \
--url https://api.ziala.com.br/v1/fields \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ziala.com.br/v1/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/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "6e4f2a1b-9c8d-4e7f-b0a1-2b3c4d5e6f70",
"object_type": "contact",
"key": "segmento",
"label": "Segmento",
"type": "enum",
"options": "[\"varejo\",\"industria\",\"servicos\"]",
"group": "Qualificação",
"archived_at": null,
"created_at": "2026-10-13T14:02:11.000Z",
"updated_at": "2026-10-13T14:31:02.000Z"
}
],
"next_cursor": "eyJ0IjoiM2Y2YzJhOWUiLCJ0cyI6IjIwMjYtMTEtMDNUMTQ6MzE6MDIuMDAwWiJ9",
"has_more": false,
"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"
}Campos
Listar campos
Lista as definições dos campos personalizados da conta, numa página só. next_cursor, has_more e sync_watermark existem só para manter o formato comum das listas.
GET
/
v1
/
fields
Listar campos
curl --request GET \
--url https://api.ziala.com.br/v1/fields \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.ziala.com.br/v1/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/fields', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "6e4f2a1b-9c8d-4e7f-b0a1-2b3c4d5e6f70",
"object_type": "contact",
"key": "segmento",
"label": "Segmento",
"type": "enum",
"options": "[\"varejo\",\"industria\",\"servicos\"]",
"group": "Qualificação",
"archived_at": null,
"created_at": "2026-10-13T14:02:11.000Z",
"updated_at": "2026-10-13T14:31:02.000Z"
}
],
"next_cursor": "eyJ0IjoiM2Y2YzJhOWUiLCJ0cyI6IjIwMjYtMTEtMDNUMTQ6MzE6MDIuMDAwWiJ9",
"has_more": false,
"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"
}Autorizações
Chave da API da conta, no formato zk_live_….
Resposta
Todas as definições.
Show child attributes
Show child attributes
Cursor da próxima página. Sempre null: o endpoint devolve tudo numa página.
Exemplo:
"eyJ0IjoiM2Y2YzJhOWUiLCJ0cyI6IjIwMjYtMTEtMDNUMTQ6MzE6MDIuMDAwWiJ9"
true se há mais páginas. Sempre false: o endpoint devolve tudo numa página.
Exemplo:
false
Instante até o qual esta leitura está completa, igual em todas as páginas. Envie como updated_since na próxima sincronização.
Exemplo:
"2026-10-13T14:29:00.000Z"