Paginação

Como funcionam os parâmetros de paginação e o envelope das listagens.

As rotas de listagem são paginadas:

  • GET /v1/servicos
  • GET /v1/clientes
  • GET /v1/profissionais
  • GET /v1/agendamentos

Parâmetros

ParamTipoPadrãoDescrição
pageint321Página desejada (mínimo 1).
pageSizeint3220Itens por página (de 1 a 100).

Envelope da resposta

A resposta sempre vem com um envelope de paginação, em que os registros ficam no array data:

{
  "page": 1,
  "pageSize": 20,
  "totalPages": 3,
  "totalRecords": 42,
  "data": [ ... ]
}
  • totalRecords é o total de registros que atendem aos filtros.
  • totalPages é o número total de páginas, calculado a partir de pageSize.
  • Para percorrer todos os resultados, incremente page até atingir totalPages.

Recursos individuais

As rotas que retornam um único recurso (ex.: GET /v1/clientes/{id}) não usam envelope — retornam o objeto diretamente.

Exemplo

curl -H "X-Api-Key: SUA_CHAVE_AQUI" \
  "https://app.saikoobtech.com.br/api/v1/clientes?page=2&pageSize=50"

Did this page help you?