Paginação
Como funcionam os parâmetros de paginação e o envelope das listagens.
As rotas de listagem são paginadas:
GET /v1/servicosGET /v1/clientesGET /v1/profissionaisGET /v1/agendamentos
Parâmetros
| Param | Tipo | Padrão | Descrição |
|---|---|---|---|
page | int32 | 1 | Página desejada (mínimo 1). |
pageSize | int32 | 20 | Itens 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 depageSize.- Para percorrer todos os resultados, incremente
pageaté atingirtotalPages.
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"Updated 5 months ago
Did this page help you?
