API reference
Pagination
Collection endpoints return paginated results. Use query parameters to control page size and navigate through results.
Parameters
| Parameter | Type | Description |
|---|---|---|
| page | integer | Default 1. The page number to retrieve. |
| per_page | integer | Default 25, maximum 100. Number of records per page. |
Response headers
Every paginated response includes these headers:
| Header | Type | Description |
|---|---|---|
| X-Total | integer | Total number of records across all pages. |
| X-Per-Page | integer | Records per page (mirrors your per_page parameter). |
| X-Page | integer | Current page number. |
| X-Total-Pages | integer | Total number of pages. |
Example
Request
GET
/v1/products?page=2&per_page=10
curl -G https://beaconed.ai/api/v1/products \
-H "Authorization: Bearer YOUR_API_KEY" \
-d page=2 \
-d per_page=10
Response headers
X-Total: 87
X-Per-Page: 10
X-Page: 2
X-Total-Pages: 9