Todos os endpoints de listagem na Vendaze API retornam resultados paginados. Nenhum endpoint retorna uma lista ilimitada de registros.Documentation Index
Fetch the complete documentation index at: https://developers.vendaze.com/llms.txt
Use this file to discover all available pages before exploring further.
Como funciona
Use os parâmetrospage e per_page para navegar pelos resultados:
Metadados de paginação
Toda resposta de listagem inclui um objetometa:
| Campo | Descrição |
|---|---|
total | Total de registros que correspondem aos filtros atuais. |
page | Número da página atual. |
per_page | Número de registros por página. |
has_more | true se existem mais páginas após esta. |
Parâmetros disponíveis
| Parâmetro | Tipo | Padrão | Máximo | Descrição |
|---|---|---|---|---|
page | integer | 1 | - | Número da página a buscar. |
per_page | integer | 50 | 100 | Registros por página. Retorna 422 se acima de 100. |
order_by | string | created_at | - | Campo de ordenação. |
order | string | desc | - | asc ou desc. |
Buscar todos os registros
Para recuperar todos os registros, itere pelas páginas atéhas_more ser false:
Fique atento aos limites de taxa ao iterar sobre grandes datasets. Use filtros para estreitar o
conjunto de resultados quando possível.
Ordenação disponível por recurso
| Recurso | Campos de ordenação |
|---|---|
| People | created_at, updated_at, full_name |
| Companies | created_at, updated_at, full_name |
| Deals | created_at, updated_at, name, price_cts |
| Tasks | created_at, updated_at, due_date |
| Activities | created_at |
| Products | created_at, name |