API reference

Start with the shared request conventions, then choose the reference for your practice, platform, or pharmacy.

Base URLhttps://api.affinityrx.com2026-09-28

General

Use an API key and pin the API version in your request headers.

Build with synthetic data in Test mode. Your API key determines the mode.

Manage your practice's patients, team, and orders.

Connect practices to Affinity from your software.

Understand pharmacy connections and the available integration contracts.

Send Affinity-Version: 2026-09-28 to pin your contract. Endpoint paths remain under /v1.

Send Idempotency-Key on writes. Reuse the same key and body when retrying the same operation.

Paginated collections return data and hasMore. Use startingAfter or endingBefore with the returned record ID.

The default page size is 25, with a maximum of 100. Bounded collections such as shipping options return an array.

Errors include a stable code, HTTP status, detail, and requestId. Include the request ID when contacting support.