Pular para o conteúdo principal

Paginação

Endpoints de listagem retornam os resultados em páginas, controladas pelos parâmetros de query limit e offset.

ParâmetroDescriçãoPadrãoMínimoMáximo
limitQuantidade de itens por página101100
offsetQuantidade de itens a pular00200000
curl "https://carchost.fieldcontrol.com.br/customers?limit=20&offset=40" \
-H "X-Api-Key: SUA_CHAVE" \
-H "User-Agent: MinhaIntegracao/1.0"

Para percorrer uma lista inteira, repita a requisição somando o valor de limit ao offset até que offset seja maior ou igual a totalCount. Exemplo com 345 registros e limit=100: offset=0, 100, 200 e 300.

Valores inválidos (não numéricos, negativos ou fora dos limites) retornam 422 com o código parametersValidationErr.