Pagination

Most list endpoints in the RxScale APIs are paginated through query parameters.

Not every list endpoint is paginated. Smaller, bounded collections — appointment types, appointment-type reminders, a doctor’s availability rules, notification subscriptions, webhook subscriptions, review links and wallet passes — return the full list in a single response.Do not send page or limit to an unpaginated endpoint. They are not part of its contract: depending on the endpoint they are either silently ignored or rejected with 400 and an Unknown field. message.A paginated response is recognisable by its envelope: it carries totalRegistries and totalPages. An unpaginated one does not. The rows sit under data, with one exception — GET /v1/management/doctors/{doctor_uid}/blacklisted-skus returns them under blacklisted_skus. Each endpoint’s reference page lists exactly which query parameters it accepts and shows the response it returns.

Query Parameters

Parameter	Type	Default	Description
`page`	integer	`0`	Page number (zero-indexed)
`limit`	integer	`50`	Number of items per page

Pages are zero-indexed. The first page is page=0, not page=1.

Response Format

Paginated endpoints return:

{
  "data": [...],
  "totalRegistries": 150,
  "totalPages": 3
}

data — Array of items for the current page
totalRegistries — Total number of items across all pages
totalPages — Total number of pages (calculated as ceil(totalRegistries / limit))

Limits

The maximum limit is not uniform across the External Pharmacy API — it depends on the endpoint family.

API	Endpoints	Default Limit	Maximum Limit
External Pharmacy API	`/pharmacy_orders`, `/payouts`	50	200
External Pharmacy API	`/pharmacy_skus`, `/pharmacy_products`	50	500
Management API	All list endpoints	50	200
Public API (Products)	Product listings	50	150

Requesting a limit above the maximum will be capped to the maximum — the request still succeeds, it simply returns fewer items than you asked for. Always read totalRegistries and totalPages from the response rather than assuming your requested limit was applied.

Requesting a Page Past the End

Requesting a page beyond the last one returns 200 with an empty data array. totalRegistries and totalPages still report the full collection, so you can tell how far it actually goes.

{
  "data": [],
  "totalRegistries": 75,
  "totalPages": 3
}

A negative page is treated as page=0.

An empty data array is a reliable stop condition for a sync loop: the API never silently serves the last page again in place of the page you asked for.

Example

Fetching the second page of 25 products:

curl -X GET "https://api.rxscale.com/v1/management/products?page=1&limit=25" \
  -H "X-API-Key: your-api-key"

Response:

{
  "data": [
    {"uid": "prod_abc", "name": "Product 26"},
    {"uid": "prod_def", "name": "Product 27"}
  ],
  "totalRegistries": 75,
  "totalPages": 3
}

Iterating Through All Pages

import requests

page = 0
all_items = []

while True:
    response = requests.get(
        "https://api.rxscale.com/v1/management/products",
        headers={"X-API-Key": "your-api-key"},
        params={"page": page, "limit": 50}
    )
    data = response.json()
    if not data["data"]:
        break
    all_items.extend(data["data"])
    page += 1

Use the smallest limit that makes sense for your use case. Smaller pages mean faster responses and less memory usage.

Getting Started

External Pharmacy API

Management API

Scheduling API

Public API

Patient API

Anamnesis API

Webhooks

Guides

Pagination

Query Parameters

Response Format

Limits

Requesting a Page Past the End

Example

Iterating Through All Pages

​Pagination

​Query Parameters

​Response Format

​Limits

​Requesting a Page Past the End

​Example

​Iterating Through All Pages

Pagination

Query Parameters

Response Format

Limits

Requesting a Page Past the End

Example

Iterating Through All Pages