All listing endpoints in the Vendaze API return paginated results. No endpoint returns an unbounded list of records.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.
How it works
Use thepage and per_page query parameters to navigate through results:
Pagination metadata
Every listing response includes ameta object:
| Field | Description |
|---|---|
total | Total number of records matching the current filters. |
page | Current page number. |
per_page | Records per page. |
has_more | true if there are more pages after this one. |
Available parameters
| Parameter | Type | Default | Max | Description |
|---|---|---|---|---|
page | integer | 1 | - | Page number to retrieve. |
per_page | integer | 50 | 100 | Records per page. Returns 422 if above 100. |
order_by | string | created_at | - | Field to sort by. |
order | string | desc | - | asc or desc. |
Fetching all records
To retrieve all records, iterate through pages untilhas_more is false:
Be mindful of rate limits when iterating over large datasets. Use filters to narrow the result set
when possible.
Sortable fields by resource
| Resource | Sortable fields |
|---|---|
| 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 |