Pagination

Collection endpoints return paginated results. Use query parameters to control page size and navigate through results.

Parameters

  • Name
    page
    Type
    integer
    Description
    Default 1. The page number to retrieve.
  • Name
    per_page
    Type
    integer
    Description
    Default 25, maximum 100. Number of records per page.

Response headers

Every paginated response includes these headers:

  • Name
    X-Total
    Type
    integer
    Description
    Total number of records across all pages.
  • Name
    X-Per-Page
    Type
    integer
    Description
    Records per page (mirrors your per_page parameter).
  • Name
    X-Page
    Type
    integer
    Description
    Current page number.
  • Name
    X-Total-Pages
    Type
    integer
    Description
    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