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

# Paginação

> Como percorrer a lista de protocolos página por página.

`GET /protocols` usa paginação por cursor. Os protocolos vêm do mais novo para o mais antigo. O cursor é o `protocol_id` de um item.

| Parâmetro | O que faz |
| - | - |
| `limit` | Define quantos itens vêm por página, de 1 a 100. O padrão é 20. |
| `after` | Traz a página seguinte. Envie o `protocol_id` do último item recebido. |
| `before` | Traz a página anterior. Envie o `protocol_id` do primeiro item recebido. |

Use `after` ou `before`, nunca os dois na mesma chamada.

## Percorrer as páginas

A resposta traz os protocolos em `data`. Cada item é um resumo. Use `GET /protocols/{protocol_id}` para consultar o protocolo completo.

1. Faça a primeira chamada, sem `after`.

```bash theme={"system"}
curl "https://certificados.zapsign.com.br/api/v2/partners/protocols\
?limit=2" \
  -H "Authorization: Bearer czk_live_SUA_CHAVE"
```

Resposta (resumo):

```json theme={"system"}
{
  "data": [
    {
      "status": "creating",
      "protocol_id": "CPR_01K7Q3XWVTR3397NXS3140MKR8",
      "certificate": { "name": "e-CPF A1 (1 ano)", "type": "e_cpf", "model": "a1", "validity_months": 12 },
      "customer": { "type": "pf", "name": "Ana Souza", "cpf": "52998224725" },
      "created_at": "2026-10-21T13:01:00.000Z",
      "updated_at": "2026-10-21T13:01:30.000Z"
    },
    {
      "status": "creating",
      "protocol_id": "CPR_01K7Q3XN4BEZN33DCZF0AK48K0",
      ...
    }
  ],
  "has_more": true,
  "object": "list"
}
```

2. Como `has_more` é `true`, envie o último `protocol_id` em `after`. Repita até `has_more` ser `false`.

```bash theme={"system"}
curl "https://certificados.zapsign.com.br/api/v2/partners/protocols\
?limit=2&after=CPR_01K7Q3XN4BEZN33DCZF0AK48K0" \
  -H "Authorization: Bearer czk_live_SUA_CHAVE"
```

## Filtros

`GET /protocols` aceita estes filtros, que você pode combinar com a paginação.

| Filtro | O que filtra |
| - | - |
| `status` | Protocolos em um status. Envie uma única vez. |
| `certificate_type` | Protocolos de um tipo de certificado. |
| `document` | CPF ou CNPJ do titular, sem pontuação. Use apenas números para CPF. Para CNPJ alfanumérico, use números e letras. Não busca o CPF do representante legal. |
| `created_after` | Protocolos criados nesta data e hora ou depois, em UTC. O valor termina em `Z`, como `2026-10-01T00:00:00Z`. Não aceita deslocamento, como `-03:00`. |
| `created_before` | Protocolos criados antes desta data e hora, sem incluir o instante informado. Use o mesmo formato de `created_after`, terminado em `Z`. |


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