Getting Started

API overview Authentication Access Control Partner onboarding Sourcing workflows Clinic boundaries AI agents

Platform

System

GETRead API health

Access

POSTCreate access request

Account

GETRead account destination

Admin

GETRead admin dashboard POSTCreate onboarding invite

Invites

POSTAccept partner invite GETPreview partner invite POSTAccept clinic staff invite GETPreview clinic staff invite

Clinic Operations

Clinics

POSTCreate clinic workspace POSTSelect clinic workspace

Clinic Settings

GETRead clinic settings data POSTInvite clinic staff

Workspace

GETRead clinic workspace bootstrap data

Sourcing

GETRead sourcing dashboard

Compounders

GETList compounders GETRead compounder GETList compounder catalog GETList compounder documents POSTSync compounder catalog

Catalog

GETList catalog items

Partner Workspace

Partner

PUTUpdate partner account settings GETList partner team members POSTAdd partner team member PATCHUpdate partner team member GETRead partner workspace

Partner Orders

GETList partner orders POSTCreate partner order draft GETList partner order events POSTValidate partner order locally

Partner API Orders

GETList partner API orders POSTCreate partner API order draft

Partner API Keys

GETList partner API keys POSTCreate partner API key POSTRevoke partner API key

Partner Audit

GETList partner audit logs

ERX & Prescribing

ERX

POSTCheck ERX eligibility GETRead ERX workspace overview POSTReset ERX sandbox demo data

ERX Prescribers

GETList ERX prescribers POSTCreate or update ERX prescriber

ERX Prescriptions

GETList ERX prescriptions awaiting prescriber action GETList ERX prescriptions POSTCreate ERX prescription GETRead ERX prescription PUTUpdate ERX prescription POSTApprove ERX prescription as prescriber POSTCancel ERX prescription GETList ERX prescription events POSTMark ERX prescription prepared for prescriber review POSTQuote ERX prescription POSTReject ERX prescription review POSTRequest prescriber review for ERX prescription POSTSign ERX prescription as prescriber POSTSubmit ERX prescription POSTTransmit signed ERX prescription to compounder POSTGenerate or clean up sandbox prescription SIG directions

ERX Documents

GETList ERX prescription documents POSTCreate ERX prescription document

ERX Audit

GETList ERX audit events

ERX Webhooks

POSTReceive ERX compounder webhook

Other

ERX Access

GETList ERX prescriber delegations POSTCreate ERX prescriber delegation DELETERevoke ERX prescriber delegation GETList ERX roles and permissions

Local sandbox

Demo prescription order endpoints stay local-only until a partner sandbox is confirmed.

Admin

Read admin dashboard

GET /admin/dashboard

Responses

application/json

200Successful response

CurrentDocs indexStart from the docs overview.

NextAppOpen the local app workspace.

Affinity docs

Support Terms Privacy Assets

curl --request GET \ \
  --url 'https://api.joinaffinityai.com/admin/dashboard' \
  --header 'Authorization: Bearer <token>'

"<string>"