List team members

GET/v1/practices/{practiceId}/team/members

Requires team:read. Search the roster by name or email, and filter by role or membership status. Includes members invited in Clinic, location access, and account-specific prescriber connections. Memberships are shared between Test and Live.

Practices API key authenticationVersion 2026-09-28

Request example

curl -X GET 'https://api.affinityrx.com/v1/practices/{practiceId}/team/members' \
  -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": [
    {
      "id": "mbr_01j2y8m6jcc9tt24af5pw9x1bc",
      "externalId": "<string>",
      "name": "<string>",
      "email": "<string>",
      "locationIds": [
        "loc_01j2y8m6jcc9tt24af5pw9x1bc"
      ],
      "account": {
        "accountId": "<string>",
        "emailVerified": false,
        "membershipId": "mbr_01j2y8m6jcc9tt24af5pw9x1bc",
        "membershipStatus": "<string>",
        "roles": [
          {
            "id": "role_01j2y8m6jcc9tt24af5pw9x1bc",
            "name": "<string>",
            "key": "<string>"
          }
        ],
        "prescriberConnection": {
          "status": "<string>",
          "provider": {
            "id": "prov_01j2y8m6jcc9tt24af5pw9x1bc",
            "name": "<string>",
            "legalName": "<string>",
            "credentials": "<string>",
            "phone": "<string>",
            "address": {
              "line1": null,
              "line2": null,
              "city": null,
              "state": null,
              "postalCode": null,
              "country": null
            },
            "npi": "<string>",
            "practiceStatus": "<string>",
            "licenses": [
              {
                "id": null,
                "state": null,
                "licenseNumber": null,
                "expiresAt": null
              }
            ]
          }
        }
      },
      "nextActions": [
        "<string>"
      ]
    }
  ],
  "hasMore": false,
  "object": "list",
  "url": "<string>"
}

{
  "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": 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.

Path parameters

practiceIdstringrequired

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

Query parameters

limitinteger

Default: 25

Minimum: 1

Maximum: 100

startingAfterstring | null

Show schema

Any of · 1: string

string

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

Any of · 2: null

null

endingBeforestring | null

Show schema

Any of · 1: string

string

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

Any of · 2: null

null

searchstring | null

Show schema

Any of · 1: string

string

Any of · 2: null

null

rolestring | null

Show schema

Any of · 1: string

string

Allowed: "owner", "administrator", "prescriber", "clinical_staff", "billing", "developer"

Any of · 2: null

null

statusstring | null

Show schema

Any of · 1: string

string

Allowed: "active", "disabled"

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

idstringrequired

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

externalIdstring | nullrequired

This integration's external ID for the accepted invitee in the API key's mode. Null for members invited outside this integration.

Show externalId fields

Any of · 1: string

string

Any of · 2: null

null

namestringrequired

emailstring | nullrequired

Show email fields

Any of · 1: string

string

Any of · 2: null

null

locationIdsany[]required

Show locationIds fields

Array items · any

All of · 1: any

any

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

accountobjectrequired

No additional properties

Show account fields

accountIdstringrequired

emailVerifiedbooleanrequired

membershipIdanyrequired

Show membershipId fields

All of · 1: any

any

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

membershipStatusstringrequired

rolesobject[]required

Show roles fields

Array items · object

idanyrequired

Show id fields

All of · 1: any

any

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

namestringrequired

keystring | nullrequired

Show key fields

Any of · 1: string

string

Any of · 2: null

null

prescriberConnectionobject | nullrequired

Show prescriberConnection fields

Any of · 1: object

statusstringrequired

providerobjectrequired

No additional properties

Show provider fields

idanyrequired

Show id fields

All of · 1: any

any

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

namestringrequired

legalNamestringrequired

credentialsstring | nullrequired

Show credentials fields

Any of · 1: string

string

Any of · 2: null

null

phonestring | nullrequired

Show phone fields

Any of · 1: string

string

Any of · 2: null

null

addressobject | nullrequired

Show address fields

Any of · 1: object

line1stringrequired

line2string | null

Show line2 fields

Any of · 1: string

string

Any of · 2: null

null

citystringrequired

statestringrequired

postalCodestringrequired

countrystringrequired

Any of · 2: null

null

npistringrequired

practiceStatusstringrequired

licensesobject[]required

Show licenses fields

Array items · object

idanyrequired

Show id fields

All of · 1: any

any

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

statestringrequired

licenseNumberstringrequired

expiresAtstring | nullrequired

Show expiresAt fields

Any of · 1: string

string

Any of · 2: null

null

Any of · 2: null

null

nextActionsstring[]required

Show nextActions fields

Array items · string

string

hasMorebooleanrequired

objectstringrequired

Allowed: "list"

urlstringrequired

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

429Too many requests

application/json

codestringrequired

dataobject

detailstringrequired

instancestringrequired

requestIdstringrequired

statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired

traceIdstring

typestringrequired

Format: uri