List practices

GET/v1/practices

Returns the practices that belong to the platform. The default Affinity-Version is 2026-09-28.

Platforms API key authenticationVersion 2026-09-28

Request example

curl -X GET 'https://api.affinityrx.com/v1/practices' \
  -H "Authorization: Bearer $AFFINITY_API_KEY" \
  -H 'Affinity-Version: 2026-09-28'

Response example

These examples show the body structure. Values can differ. Select a status code to see its response.

{
  "data": [
    {
      "address": {
        "city": "<string>",
        "country": "<string>",
        "line1": "<string>",
        "line2": "<string>",
        "postalCode": "<string>",
        "state": "<string>"
      },
      "contacts": {
        "compliance": {
          "email": "<string>",
          "name": "<string>",
          "phone": "<string>"
        },
        "primary": {
          "email": "<string>",
          "name": "<string>",
          "phone": "<string>"
        }
      },
      "createdAt": "<string>",
      "externalId": "<string>",
      "id": "prac_01j2y8m6jcc9tt24af5pw9x1bc",
      "legalName": "<string>",
      "livemode": false,
      "metadata": "<string>",
      "name": "<string>",
      "object": "practice",
      "prescribers": [
        {
          "credentials": "<string>",
          "licenseStates": [
            "<string>"
          ],
          "name": "<string>",
          "npi": "<string>"
        }
      ],
      "liveEnabled": false,
      "supportEmail": "<string>",
      "supportPhone": "<string>",
      "timezone": "<string>"
    }
  ],
  "hasMore": false,
  "object": "list",
  "url": "/v1/practices"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 400,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 401,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 403,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 404,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 409,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 422,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 429,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

Implementation specification

Use these field types and limits to build your integration. Download the OpenAPI document for the complete contract.

Query parameters

searchstring | null

Show schema

Any of · 1: string

string

Maximum length: 200

Any of · 2: null

null

endingBeforestring | null

Show schema

Any of · 1: string

string

Pattern: ^prac_[0-7][0-9a-hjkmnp-tv-z]{25}$

Any of · 2: null

null

limitinteger

Default: 25

Minimum: 1

Maximum: 100

startingAfterstring | null

Show schema

Any of · 1: string

string

Pattern: ^prac_[0-7][0-9a-hjkmnp-tv-z]{25}$

Any of · 2: null

null

Headers

Affinity-Versionstring

Selects the HTTP API contract for this request only. When omitted, API-key requests use their service account’s stored version. Does not change the stored default.

Pin requests to 2026-09-28.

Response specifications

200Successful response

application/json

dataobject[]required

Show data fields

Array items · object

addressobject | nullrequired

Show address fields

Any of · 1: object

cityany & anyrequired

Show city fields

All of · 1: any

any

Pattern: ^[^\u0000\p{Cs}]*$

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

countryany & any | null

Show country fields

Any of · 1: any & any

All of · 1: any

any

Pattern: ^[^\u0000\p{Cs}]*$

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

Any of · 2: null

null

line1any & anyrequired

Show line1 fields

All of · 1: any

any

Pattern: ^[^\u0000\p{Cs}]*$

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

line2any & any | null | null

Show line2 fields

Any of · 1: any & any | null

Any of · 1: any & any

All of · 1: any

any

Pattern: ^[^\u0000\p{Cs}]*$

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

Any of · 2: null

null

Any of · 2: null

null

postalCodeany & anyrequired

Show postalCode fields

All of · 1: any

any

Pattern: ^[^\u0000\p{Cs}]*$

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

stateany & anyrequired

Show state fields

All of · 1: any

any

Pattern: ^[^\u0000\p{Cs}]*$

All of · 2: any

any

Pattern: ^[^\p{Cc}\u200B\u2028-\u202E\u2066-\u2069]*$

Any of · 2: null

null

contactsobjectrequired

No additional properties

Show contacts fields

complianceobject | nullrequired

Show compliance fields

Any of · 1: object

emailstringrequired

namestringrequired

phonestring | null | null

Show phone fields

Any of · 1: string | null

Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

Any of · 2: null

null

primaryobject | nullrequired

Show primary fields

Any of · 1: object

emailstringrequired

namestringrequired

phonestring | null | null

Show phone fields

Any of · 1: string | null

Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

Any of · 2: null

null

createdAtstringrequired

externalIdstring | nullrequired

Show externalId fields

Any of · 1: string

string

Any of · 2: null

null

idstringrequired

Pattern: ^prac_[0-7][0-9a-hjkmnp-tv-z]{25}$

legalNamestring | nullrequired

Show legalName fields

Any of · 1: string

string

Any of · 2: null

null

livemodebooleanrequired

metadataobjectrequired

namestringrequired

objectstringrequired

Allowed: "practice"

prescribersobject[]required

Show prescribers fields

Array items · object

credentialsstring | null | null

Show credentials fields

Any of · 1: string | null

Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

licenseStatesstring[]required

Show licenseStates fields

Array items · string

string

namestringrequired

npistringrequired

liveEnabledbooleanrequired

Whether this practice currently has Live access. False for Test practices.

supportEmailstring | nullrequired

Show supportEmail fields

Any of · 1: string

string

Any of · 2: null

null

supportPhonestring | nullrequired

Show supportPhone fields

Any of · 1: string

string

Any of · 2: null

null

timezonestring | nullrequired

Show timezone fields

Any of · 1: string

string

Any of · 2: null

null

hasMorebooleanrequired

objectstringrequired

Allowed: "list"

urlstringrequired

Allowed: "/v1/practices"

400HTTP 400

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

401Unauthorized

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

403Forbidden

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

404Not found

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

409Conflict

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

422Validation error

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri

429Too many requests

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri