# API de dados da Ziala

- [API de dados](https://docs.ziala.com.br/index.md): API REST somente leitura para sincronizar os dados de uma conta Ziala.
- [Autenticação](https://docs.ziala.com.br/autenticacao.md): Chave de API por conta, enviada como token Bearer.
- [Modelo de dados](https://docs.ziala.com.br/conceitos/modelo-de-dados.md): Objetos, chaves primárias, relacionamentos e convenções.
- [Paginação](https://docs.ziala.com.br/conceitos/paginacao.md): Paginação por cursor em todos os endpoints de lista.
- [Sincronização incremental](https://docs.ziala.com.br/conceitos/sincronizacao-incremental.md): Leitura do que mudou desde a última execução.
- [Exclusões](https://docs.ziala.com.br/conceitos/exclusoes.md): Registros apagados, para replicar a exclusão.
- [Limites de uso](https://docs.ziala.com.br/conceitos/limites.md): Limites de requisições por plano.
- [Erros](https://docs.ziala.com.br/conceitos/erros.md): Formato RFC 9457 e códigos de status.
- [Versionamento](https://docs.ziala.com.br/conceitos/versionamento.md): Política de compatibilidade da v1.
- [Histórico de mudanças](https://docs.ziala.com.br/changelog.md): Mudanças na API de dados, da mais recente para a mais antiga.
- [Referência da API](https://docs.ziala.com.br/api-reference/introducao.md): Endpoints, parâmetros e atributos da v1.
- [Obter conta](https://docs.ziala.com.br/api-reference/conta/obter-conta.md): Retorna a conta dona da chave, as permissões da chave e os limites de uso. Útil para testar a chave.
- [Listar contatos](https://docs.ziala.com.br/api-reference/contatos/listar-contatos.md): Lista os contatos da conta com a etapa atual e a primeira origem (anúncio ou link). Contatos do ambiente de teste não aparecem.
- [Obter contato](https://docs.ziala.com.br/api-reference/contatos/obter-contato.md): Retorna um contato pelo `id`.
- [Listar valores de campos](https://docs.ziala.com.br/api-reference/contatos/listar-valores-de-campos.md): 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`.
- [Listar conversas](https://docs.ziala.com.br/api-reference/conversas/listar-conversas.md): Lista as conversas com origem, resultado, contagem de mensagens e horário da primeira resposta. O conteúdo das mensagens não é exposto.
- [Listar mudanças de etapa](https://docs.ziala.com.br/api-reference/funis/listar-mudanças-de-etapa.md): Lista o histórico de mudanças de etapa dos contatos. Os registros são imutáveis e filtrados pela data de criação.
- [Listar etapas](https://docs.ziala.com.br/api-reference/funis/listar-etapas.md): Lista todas as etapas de todos os funis da conta, numa página só. `next_cursor`, `has_more` e `sync_watermark` existem só para manter o formato comum das listas.
- [Listar campos](https://docs.ziala.com.br/api-reference/campos/listar-campos.md): 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.
- [Listar exclusões](https://docs.ziala.com.br/api-reference/exclusões/listar-exclusões.md): Lista contatos e conversas apagados nos últimos 90 dias, para replicar a exclusão na sua cópia.

## OpenAPI Specs

- [openapi](https://api.ziala.com.br/v1/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.