Listagem e paginação

Os parâmetros de página e os formatos de resposta das listas.

A maioria das listas é paginada por número de página:

ParâmetroDescrição
pageNúmero da página, a partir de 1. O padrão é 1.
pageSizeItens por página. O padrão é 20 e o máximo, na maioria das rotas, é 100.
curl "https://api.vozkoia.com/leads?page=1&pageSize=20" \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN" \
  -H "X-Workspace-ID: SEU_WORKSPACE_ID"

A resposta traz os itens e a paginação em um destes formatos, conforme a rota:

{
  "data": [],
  "meta": { "page": 1, "pageSize": 20, "totalPages": 4, "totalItems": 72 }
}
{
  "items": [],
  "page": 1,
  "page_size": 20,
  "total_items": 72,
  "total_pages": 4
}

Algumas listas usam cursor (limit e cursor, com next_cursor na resposta), e algumas listas curtas não são paginadas. A descrição de cada rota diz qual forma ela usa. Os detalhes estão no guia Paginação.