Paginação e filtros

Paginação

Os endpoints de listagem podem utilizar paginação para controlar a quantidade de registros retornados em cada requisição.

Os parâmetros mais comuns são:

Parâmetro	Descrição	Valor comum
`PageNumber`	Número da página solicitada	`1`
`PageSize`	Quantidade de registros por página	`15`
`OrderBy`	Campo utilizado para ordenar os resultados	Depende do endpoint
`OrderDirection`	Direção da ordenação	`ASCENDING` ou `DESCENDING`

Exemplo de paginação

O exemplo abaixo solicita a primeira página, limitada a 15 registros:

GET /crm/v2/panel/card?PanelId=ID_DO_PAINEL&PageNumber=1&PageSize=15

Exemplo completo com cURL:

curl --request GET \
  --url 'https://api.chatbotv4.sincorp.com.br/crm/v2/panel/card?PanelId=ID_DO_PAINEL&PageNumber=1&PageSize=15' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer SEU_TOKEN_DE_INTEGRACAO'

O limite máximo de PageSize pode variar de acordo com o endpoint. Consulte sempre os parâmetros apresentados na Referência da API.

Ordenação

Quando disponível, utilize OrderBy para informar o campo de ordenação e OrderDirection para determinar a direção.

Valores aceitos para a direção:

ASCENDING: ordem crescente;
DESCENDING: ordem decrescente.

Filtros

Dependendo do endpoint, também podem estar disponíveis filtros por:

Texto;
Status;
Contato;
Responsável;
Canal;
Painel ou etapa;
Data de criação;
Data de atualização.

Consulte o endpoint desejado para verificar os filtros aceitos e quais campos são obrigatórios.

Datas e horários

Datas devem ser enviadas no padrão ISO 8601:

2026-07-11T12:30:00Z

O sufixo Z representa o horário UTC.

Boas práticas

Comece utilizando os valores padrão de paginação;
Evite solicitar o limite máximo sem necessidade;
Avance as páginas até não existirem mais registros;
Utilize filtros para reduzir o volume da resposta;
Defina uma ordenação consistente ao processar muitas páginas.