> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ziala.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# API de dados

> API REST somente leitura para sincronizar os dados de uma conta Ziala.

Expõe contatos, valores de campos personalizados, conversas, histórico de etapas e
exclusões, com paginação por cursor e leitura incremental. Disponível nos planos Pro e
Enterprise.

## URL base

```
https://api.ziala.com.br/v1
```

## Primeira requisição

A chave é criada no painel da Ziala, em **Integrações > API de dados**, por um
administrador da conta.

```bash theme={null}
curl https://api.ziala.com.br/v1/me \
  -H "Authorization: Bearer $ZIALA_API_KEY"
```

```json theme={null}
{
  "account_name": "Exemplo Ltda",
  "scopes": ["data:read"],
  "limits": { "per_minute": 60, "per_day": 10000 }
}
```

## Especificação OpenAPI

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


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