Providers & Locations

30 endpoints

Providers

20 endpoints

get/api/v1/{org_id}/providers

List providers

List providers with optional filters. Staff callers receive the full ``ProviderListOut`` shape.

Parameters

Path Parameters

org_idstringrequired

Query Parameters

pageinteger

Default: 1

page_sizeinteger

Default: 50

statusstring

searchstring

provider_type_uuidstring

is_hiddenboolean

Responses

200Successful Response

itemsobject[]required

pageintegerrequired

page_sizeintegerrequired

totalintegerrequired

422Validation Error

detailobject[]

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/providers" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/providers" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

get/api/v1/{org_id}/providers/{provider_uuid}

Get Provider

Retrieve a single provider by UUID. Staff callers receive the full ``ProviderOut`` shape.

Parameters

Path Parameters

provider_uuidstringrequired

org_idstringrequired

Responses

200Successful Response

abbreviationstringrequired

billing_override_providerobject

Lightweight reference to a related entity — exposes UUID and optional name.

birthdatestring (date)

created_atstring (date-time)required

custom_idstring

date_termstring (date)

deleted_atstring (date-time)

erx_enabledstring

first_namestringrequired

hourly_production_goalstring

idstring (uuid)required

is_hiddenboolean

is_hidden_reportboolean

is_instructorboolean

is_not_personboolean

is_secondaryboolean

item_orderinteger

last_namestringrequired

medicaid_idstring

middle_namestring

national_provider_idstring

outline_colorinteger

preferred_namestring

provider_colorinteger

provider_typeobject

Lightweight reference to a related entity — exposes UUID and optional name.

provider_type_namestring

schedule_notestring

sig_on_fileboolean

specialtyobject

Lightweight reference to a related entity — exposes UUID and optional name.

specialty_namestring

ssn_tinstring

statusstring

suffixstring

taxonomy_code_overridestring

updated_atstring (date-time)required

using_tinboolean

versionintegerrequired

422Validation Error

detailobject[]

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

get/api/v1/{org_id}/providers/{provider_uuid}/identities

List Provider Identities

Parameters

Path Parameters

provider_uuidstringrequired

org_idstringrequired

Query Parameters

pageinteger

Default: 1

page_sizeinteger

Default: 50

Responses

200Successful Response

itemsobject[]required

pageintegerrequired

page_sizeintegerrequired

totalintegerrequired

422Validation Error

detailobject[]

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/identities" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/identities" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

get/api/v1/{org_id}/providers/{provider_uuid}/location-links

List Location Links

Parameters

Path Parameters

provider_uuidstringrequired

org_idstringrequired

Responses

200Successful Response

422Validation Error

detailobject[]

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/location-links" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/location-links" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

get/api/v1/{org_id}/providers/{provider_uuid}/location-overrides

List Provider Location Overrides

Parameters

Path Parameters

provider_uuidstringrequired

org_idstringrequired

Query Parameters

pageinteger

Default: 1

page_sizeinteger

Default: 50

Responses

200Successful Response

itemsobject[]required

pageintegerrequired

page_sizeintegerrequired

totalintegerrequired

422Validation Error

detailobject[]

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/location-overrides" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/location-overrides" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

get/api/v1/{org_id}/providers/{provider_uuid}/prescription-access

List Provider Prescription Access

Parameters

Path Parameters

provider_uuidstringrequired

org_idstringrequired

Query Parameters

pageinteger

Default: 1

page_sizeinteger

Default: 50

Responses

200Successful Response

itemsobject[]required

pageintegerrequired

page_sizeintegerrequired

totalintegerrequired

422Validation Error

detailobject[]

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/prescription-access" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/prescription-access" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

get/api/v1/{org_id}/providers/summary

Summarize providers

Return provider aggregate counts without exposing credential-bearing provider rows.

Parameters

Path Parameters

org_idstringrequired

Query Parameters

status_setstring[]

Provider statuses to include. Repeat the query param for multiple values. Defaults to active.

include_hiddenboolean

Include hidden providers in the aggregate count.

Default: false

Responses

200Successful Response

include_hiddenboolean

status_setstring[]required

totalintegerrequired

422Validation Error

detailobject[]

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/providers/summary" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/providers/summary" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

post/api/v1/{org_id}/providers

Create Provider

Parameters

Path Parameters

org_idstringrequired

Request Body

abbreviationstringrequired

billing_override_provider_uuidstring (uuid)

birthdatestring (date)

custom_idstring

date_termstring (date)

erx_enabledstring

first_namestringrequired

hourly_production_goalnumber

is_hiddenboolean

is_hidden_reportboolean

is_instructorboolean

is_not_personboolean

is_secondaryboolean

item_orderinteger

last_namestringrequired

medicaid_idstring

middle_namestring

national_provider_idstring

outline_colorinteger

preferred_namestring

provider_colorinteger

provider_type_uuidstring (uuid)

schedule_notestring

sig_on_fileboolean

specialty_uuidstring (uuid)

ssn_tinstring

statusstring

suffixstring

taxonomy_code_overridestring

using_tinboolean

Responses

201Successful Response

abbreviationstringrequired

billing_override_providerobject

Lightweight reference to a related entity — exposes UUID and optional name.

birthdatestring (date)

created_atstring (date-time)required

custom_idstring

date_termstring (date)

deleted_atstring (date-time)

erx_enabledstring

first_namestringrequired

hourly_production_goalstring

idstring (uuid)required

is_hiddenboolean

is_hidden_reportboolean

is_instructorboolean

is_not_personboolean

is_secondaryboolean

item_orderinteger

last_namestringrequired

medicaid_idstring

middle_namestring

national_provider_idstring

outline_colorinteger

preferred_namestring

provider_colorinteger

provider_typeobject

Lightweight reference to a related entity — exposes UUID and optional name.

provider_type_namestring

schedule_notestring

sig_on_fileboolean

specialtyobject

Lightweight reference to a related entity — exposes UUID and optional name.

specialty_namestring

ssn_tinstring

statusstring

suffixstring

taxonomy_code_overridestring

updated_atstring (date-time)required

using_tinboolean

versionintegerrequired

422Validation Error

detailobject[]

curl

curl -X POST "https://api.example.com/api/v1/{org_id}/providers" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "abbreviation": "string",
    "billing_override_provider_uuid": "string",
    "birthdate": "string",
    "custom_id": "string",
    "date_term": "string",
    "first_name": "string",
    "last_name": "string"
  }'

curl

curl -X POST "https://api.example.com/api/v1/{org_id}/providers" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "abbreviation": "string",
    "billing_override_provider_uuid": "string",
    "birthdate": "string",
    "custom_id": "string",
    "date_term": "string",
    "first_name": "string",
    "last_name": "string"
  }'

post/api/v1/{org_id}/providers/{provider_uuid}/archive

Archive Provider

Parameters

Path Parameters

provider_uuidstringrequired

org_idstringrequired

Responses

200Successful Response

abbreviationstringrequired

billing_override_providerobject

Lightweight reference to a related entity — exposes UUID and optional name.

birthdatestring (date)

created_atstring (date-time)required

custom_idstring

date_termstring (date)

deleted_atstring (date-time)

erx_enabledstring

first_namestringrequired

hourly_production_goalstring

idstring (uuid)required

is_hiddenboolean

is_hidden_reportboolean

is_instructorboolean

is_not_personboolean

is_secondaryboolean

item_orderinteger

last_namestringrequired

medicaid_idstring

middle_namestring

national_provider_idstring

outline_colorinteger

preferred_namestring

provider_colorinteger

provider_typeobject

Lightweight reference to a related entity — exposes UUID and optional name.

provider_type_namestring

schedule_notestring

sig_on_fileboolean

specialtyobject

Lightweight reference to a related entity — exposes UUID and optional name.

specialty_namestring

ssn_tinstring

statusstring

suffixstring

taxonomy_code_overridestring

updated_atstring (date-time)required

using_tinboolean

versionintegerrequired

422Validation Error

detailobject[]

curl

curl -X POST "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/archive" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X POST "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/archive" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

post/api/v1/{org_id}/providers/{provider_uuid}/identities

Create Provider Identity

Parameters

Path Parameters

provider_uuidstringrequired

org_idstringrequired

Request Body

id_numberstringrequired

payor_idstringrequired

supplemental_id_typestringrequired

Responses

201Successful Response

created_atstring (date-time)required

idstring (uuid)required

id_numberstringrequired

payor_idstringrequired

supplemental_id_typestringrequired

updated_atstring (date-time)required

versionintegerrequired

422Validation Error

detailobject[]

curl

curl -X POST "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/identities" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id_number": "string",
    "payor_id": "string",
    "supplemental_id_type": "string"
  }'

curl

curl -X POST "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/identities" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id_number": "string",
    "payor_id": "string",
    "supplemental_id_type": "string"
  }'

post/api/v1/{org_id}/providers/{provider_uuid}/location-overrides

Create Provider Location Override

Parameters

Path Parameters

provider_uuidstringrequired

org_idstringrequired

Request Body

dea_numberstring

location_uuidstring (uuid)required

state_licensestring

state_rx_idstring

state_where_licensedstring

Responses

201Successful Response

created_atstring (date-time)required

dea_numberstring

idstring (uuid)required

locationobject

Lightweight reference to a related entity — exposes UUID and optional name.

location_namestring

state_licensestring

state_rx_idstring

state_where_licensedstring

updated_atstring (date-time)required

versionintegerrequired

422Validation Error

detailobject[]

curl

curl -X POST "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/location-overrides" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "dea_number": "string",
    "location_uuid": "00000000-0000-0000-0000-000000000000",
    "state_license": "string",
    "state_rx_id": "string",
    "state_where_licensed": "string"
  }'

curl

curl -X POST "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/location-overrides" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "dea_number": "string",
    "location_uuid": "00000000-0000-0000-0000-000000000000",
    "state_license": "string",
    "state_rx_id": "string",
    "state_where_licensed": "string"
  }'

post/api/v1/{org_id}/providers/{provider_uuid}/prescription-access

Create Provider Prescription Access

Parameters

Path Parameters

provider_uuidstringrequired

org_idstringrequired

Request Body

erx_statusstring

erx_typestring

is_epcsboolean

is_identity_proofedboolean

national_provider_idstringrequired

user_uuidstring (uuid)

Responses

201Successful Response

created_atstring (date-time)required

erx_statusstring

erx_typestring

idstring (uuid)required

is_epcsboolean

is_identity_proofedboolean

national_provider_idstringrequired

updated_atstring (date-time)required

user_uuidstring (uuid)

versionintegerrequired

422Validation Error

detailobject[]

curl

curl -X POST "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/prescription-access" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "erx_status": "string",
    "erx_type": "string",
    "is_epcs": null,
    "is_identity_proofed": null,
    "national_provider_id": "string"
  }'

curl

curl -X POST "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/prescription-access" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "erx_status": "string",
    "erx_type": "string",
    "is_epcs": null,
    "is_identity_proofed": null,
    "national_provider_id": "string"
  }'

put/api/v1/{org_id}/providers/{provider_uuid}/location-links

Replace Location Links

Parameters

Path Parameters

provider_uuidstringrequired

org_idstringrequired

Request Body

location_uuidsstring (uuid)[]required

Responses

200Successful Response

422Validation Error

detailobject[]

curl

curl -X PUT "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/location-links" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "location_uuids": []
  }'

curl

curl -X PUT "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/location-links" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "location_uuids": []
  }'

patch/api/v1/{org_id}/providers/{provider_uuid}

Update Provider

Parameters

Path Parameters

provider_uuidstringrequired

org_idstringrequired

Request Body

abbreviationstring

base_versionintegerrequired

billing_override_provider_uuidstring (uuid)

birthdatestring (date)

custom_idstring

date_termstring (date)

erx_enabledstring

first_namestring

hourly_production_goalnumber

is_hiddenboolean

is_hidden_reportboolean

is_instructorboolean

is_not_personboolean

is_secondaryboolean

item_orderinteger

last_namestring

medicaid_idstring

middle_namestring

national_provider_idstring

outline_colorinteger

preferred_namestring

provider_colorinteger

provider_type_uuidstring (uuid)

schedule_notestring

sig_on_fileboolean

specialty_uuidstring (uuid)

ssn_tinstring

statusstring

suffixstring

taxonomy_code_overridestring

using_tinboolean

Responses

200Successful Response

abbreviationstringrequired

billing_override_providerobject

Lightweight reference to a related entity — exposes UUID and optional name.

birthdatestring (date)

created_atstring (date-time)required

custom_idstring

date_termstring (date)

deleted_atstring (date-time)

erx_enabledstring

first_namestringrequired

hourly_production_goalstring

idstring (uuid)required

is_hiddenboolean

is_hidden_reportboolean

is_instructorboolean

is_not_personboolean

is_secondaryboolean

item_orderinteger

last_namestringrequired

medicaid_idstring

middle_namestring

national_provider_idstring

outline_colorinteger

preferred_namestring

provider_colorinteger

provider_typeobject

Lightweight reference to a related entity — exposes UUID and optional name.

provider_type_namestring

schedule_notestring

sig_on_fileboolean

specialtyobject

Lightweight reference to a related entity — exposes UUID and optional name.

specialty_namestring

ssn_tinstring

statusstring

suffixstring

taxonomy_code_overridestring

updated_atstring (date-time)required

using_tinboolean

versionintegerrequired

422Validation Error

detailobject[]

curl

curl -X PATCH "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "abbreviation": "string",
    "base_version": 1,
    "billing_override_provider_uuid": "string",
    "birthdate": "string",
    "custom_id": "string"
  }'

curl

curl -X PATCH "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "abbreviation": "string",
    "base_version": 1,
    "billing_override_provider_uuid": "string",
    "birthdate": "string",
    "custom_id": "string"
  }'

patch/api/v1/{org_id}/providers/{provider_uuid}/identities/{identity_uuid}

Update Provider Identity

Parameters

Path Parameters

provider_uuidstringrequired

identity_uuidstringrequired

org_idstringrequired

Request Body

base_versionintegerrequired

id_numberstring

payor_idstring

supplemental_id_typestring

Responses

200Successful Response

created_atstring (date-time)required

idstring (uuid)required

id_numberstringrequired

payor_idstringrequired

supplemental_id_typestringrequired

updated_atstring (date-time)required

versionintegerrequired

422Validation Error

detailobject[]

curl

curl -X PATCH "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/identities/{identity_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1,
    "id_number": "string",
    "payor_id": "string",
    "supplemental_id_type": "string"
  }'

curl

curl -X PATCH "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/identities/{identity_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1,
    "id_number": "string",
    "payor_id": "string",
    "supplemental_id_type": "string"
  }'

patch/api/v1/{org_id}/providers/{provider_uuid}/location-overrides/{override_uuid}

Update Provider Location Override

Parameters

Path Parameters

provider_uuidstringrequired

override_uuidstringrequired

org_idstringrequired

Request Body

base_versionintegerrequired

dea_numberstring

location_uuidstring (uuid)

state_licensestring

state_rx_idstring

state_where_licensedstring

Responses

200Successful Response

created_atstring (date-time)required

dea_numberstring

idstring (uuid)required

locationobject

Lightweight reference to a related entity — exposes UUID and optional name.

location_namestring

state_licensestring

state_rx_idstring

state_where_licensedstring

updated_atstring (date-time)required

versionintegerrequired

422Validation Error

detailobject[]

curl

curl -X PATCH "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/location-overrides/{override_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1,
    "dea_number": "string",
    "location_uuid": "string",
    "state_license": "string",
    "state_rx_id": "string"
  }'

curl

curl -X PATCH "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/location-overrides/{override_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1,
    "dea_number": "string",
    "location_uuid": "string",
    "state_license": "string",
    "state_rx_id": "string"
  }'

patch/api/v1/{org_id}/providers/{provider_uuid}/prescription-access/{access_uuid}

Update Provider Prescription Access

Parameters

Path Parameters

provider_uuidstringrequired

access_uuidstringrequired

org_idstringrequired

Request Body

base_versionintegerrequired

erx_statusstring

erx_typestring

is_epcsboolean

is_identity_proofedboolean

national_provider_idstring

user_uuidstring (uuid)

Responses

200Successful Response

created_atstring (date-time)required

erx_statusstring

erx_typestring

idstring (uuid)required

is_epcsboolean

is_identity_proofedboolean

national_provider_idstringrequired

updated_atstring (date-time)required

user_uuidstring (uuid)

versionintegerrequired

422Validation Error

detailobject[]

curl

curl -X PATCH "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/prescription-access/{access_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1,
    "erx_status": "string",
    "erx_type": "string",
    "is_epcs": null,
    "is_identity_proofed": null
  }'

curl

curl -X PATCH "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/prescription-access/{access_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "base_version": 1,
    "erx_status": "string",
    "erx_type": "string",
    "is_epcs": null,
    "is_identity_proofed": null
  }'

delete/api/v1/{org_id}/providers/{provider_uuid}/identities/{identity_uuid}

Delete Provider Identity

Parameters

Path Parameters

provider_uuidstringrequired

identity_uuidstringrequired

org_idstringrequired

Responses

204Successful Response

422Validation Error

detailobject[]

curl

curl -X DELETE "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/identities/{identity_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X DELETE "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/identities/{identity_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

delete/api/v1/{org_id}/providers/{provider_uuid}/location-overrides/{override_uuid}

Delete Provider Location Override

Parameters

Path Parameters

provider_uuidstringrequired

override_uuidstringrequired

org_idstringrequired

Responses

204Successful Response

422Validation Error

detailobject[]

curl

curl -X DELETE "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/location-overrides/{override_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X DELETE "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/location-overrides/{override_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

delete/api/v1/{org_id}/providers/{provider_uuid}/prescription-access/{access_uuid}

Delete Provider Prescription Access

Parameters

Path Parameters

provider_uuidstringrequired

access_uuidstringrequired

org_idstringrequired

Responses

204Successful Response

422Validation Error

detailobject[]

curl

curl -X DELETE "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/prescription-access/{access_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X DELETE "https://api.example.com/api/v1/{org_id}/providers/{provider_uuid}/prescription-access/{access_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Locations

5 endpoints

get/api/v1/{org_id}/locations

List locations

List practice locations with optional filters. Staff callers receive the full ``LocationListOut`` shape.

Parameters

Path Parameters

org_idstringrequired

Query Parameters

pageinteger

Page number to return.

Default: 1

page_sizeinteger

Number of locations per page.

Default: 50

statusstring

Filter by location status.

searchstring

Search name, short name, or city.

entity_idstring

Filter to locations assigned to this entity.

Responses

200Successful Response

itemsobject[]required

pageintegerrequired

page_sizeintegerrequired

totalintegerrequired

422Validation Error

detailobject[]

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/locations" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/locations" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

get/api/v1/{org_id}/locations/{location_uuid}

Get Location

Retrieve a single location by UUID. Staff callers receive the full ``LocationOut`` shape.

Parameters

Path Parameters

location_uuidstringrequired

org_idstringrequired

Responses

200Successful Response

address_line1string

address_line2string

bank_numberstring

billing_address_line1string

billing_address_line2string

billing_citystring

billing_entity_namestring

billing_entity_typestring

billing_npistring

billing_phonestring

billing_specialtystring

billing_statestring

billing_tax_idstring

billing_zipstring

citystring

created_atstring (date-time)required

default_imaging_softwarestring

default_place_of_servicestring

deleted_atstring (date-time)

display_referral_in_schedulerboolean

emailstring

entityobject

Lightweight Entity reference.

external_idstring

faxstring

generate_sales_tax_codeboolean

idstring (uuid)required

ins_billing_provobject

Lightweight reference to a related entity — exposes UUID and optional name.

is_medical_onlyboolean

item_orderinteger

location_typestringrequired

logo_urlstring

med_lab_account_numstring

namestringrequired

npistring

operatoriesobject[]

pay_to_address_line1string

pay_to_address_line2string

pay_to_citystring

pay_to_statestring

pay_to_zipstring

phonestring

sales_tax_ratestring

settingsobject

short_namestringrequired

skipped_daysstring[]

social_linksobject[]

statestring

statusstringrequired

tax_idstring

time_zonestring

updated_atstring (date-time)required

use_billing_addr_on_claimsboolean

versionintegerrequired

websitestring

zipstring

422Validation Error

detailobject[]

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/locations/{location_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/locations/{location_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

post/api/v1/{org_id}/locations

Create Location

Parameters

Path Parameters

org_idstringrequired

Request Body

address_line1string

address_line2string

bank_numberstring

billing_address_line1string

billing_address_line2string

billing_citystring

billing_entity_namestring

billing_entity_typestring

billing_npistring

billing_phonestring

billing_specialtystring

billing_statestring

billing_tax_idstring

billing_zipstring

citystring

default_imaging_softwarestring

default_place_of_servicestring

display_referral_in_schedulerboolean

emailstring

entity_uuidstring (uuid)required

external_idstring

faxstring

generate_sales_tax_codeboolean

ins_billing_prov_uuidstring (uuid)

is_medical_onlyboolean

item_orderinteger

location_typestring

logo_urlstring

med_lab_account_numstring

namestringrequired

npistring

pay_to_address_line1string

pay_to_address_line2string

pay_to_citystring

pay_to_statestring

pay_to_zipstring

phonestring

sales_tax_ratenumber

settingsobject

short_namestringrequired

skipped_daysstring[]

social_linksobject[]

statestring

statusstring

tax_idstring

time_zonestring

use_billing_addr_on_claimsboolean

websitestring

zipstring

Responses

201Successful Response

address_line1string

address_line2string

bank_numberstring

billing_address_line1string

billing_address_line2string

billing_citystring

billing_entity_namestring

billing_entity_typestring

billing_npistring

billing_phonestring

billing_specialtystring

billing_statestring

billing_tax_idstring

billing_zipstring

citystring

created_atstring (date-time)required

default_imaging_softwarestring

default_place_of_servicestring

deleted_atstring (date-time)

display_referral_in_schedulerboolean

emailstring

entityobject

Lightweight Entity reference.

external_idstring

faxstring

generate_sales_tax_codeboolean

idstring (uuid)required

ins_billing_provobject

Lightweight reference to a related entity — exposes UUID and optional name.

is_medical_onlyboolean

item_orderinteger

location_typestringrequired

logo_urlstring

med_lab_account_numstring

namestringrequired

npistring

operatoriesobject[]

pay_to_address_line1string

pay_to_address_line2string

pay_to_citystring

pay_to_statestring

pay_to_zipstring

phonestring

sales_tax_ratestring

settingsobject

short_namestringrequired

skipped_daysstring[]

social_linksobject[]

statestring

statusstringrequired

tax_idstring

time_zonestring

updated_atstring (date-time)required

use_billing_addr_on_claimsboolean

versionintegerrequired

websitestring

zipstring

422Validation Error

detailobject[]

curl

curl -X POST "https://api.example.com/api/v1/{org_id}/locations" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "address_line1": "string",
    "address_line2": "string",
    "bank_number": "string",
    "billing_address_line1": "string",
    "billing_address_line2": "string",
    "entity_uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "short_name": "string"
  }'

curl

curl -X POST "https://api.example.com/api/v1/{org_id}/locations" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "address_line1": "string",
    "address_line2": "string",
    "bank_number": "string",
    "billing_address_line1": "string",
    "billing_address_line2": "string",
    "entity_uuid": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "short_name": "string"
  }'

post/api/v1/{org_id}/locations/{location_uuid}/archive

Archive Location

Parameters

Path Parameters

location_uuidstringrequired

org_idstringrequired

Responses

200Successful Response

address_line1string

address_line2string

bank_numberstring

billing_address_line1string

billing_address_line2string

billing_citystring

billing_entity_namestring

billing_entity_typestring

billing_npistring

billing_phonestring

billing_specialtystring

billing_statestring

billing_tax_idstring

billing_zipstring

citystring

created_atstring (date-time)required

default_imaging_softwarestring

default_place_of_servicestring

deleted_atstring (date-time)

display_referral_in_schedulerboolean

emailstring

entityobject

Lightweight Entity reference.

external_idstring

faxstring

generate_sales_tax_codeboolean

idstring (uuid)required

ins_billing_provobject

Lightweight reference to a related entity — exposes UUID and optional name.

is_medical_onlyboolean

item_orderinteger

location_typestringrequired

logo_urlstring

med_lab_account_numstring

namestringrequired

npistring

operatoriesobject[]

pay_to_address_line1string

pay_to_address_line2string

pay_to_citystring

pay_to_statestring

pay_to_zipstring

phonestring

sales_tax_ratestring

settingsobject

short_namestringrequired

skipped_daysstring[]

social_linksobject[]

statestring

statusstringrequired

tax_idstring

time_zonestring

updated_atstring (date-time)required

use_billing_addr_on_claimsboolean

versionintegerrequired

websitestring

zipstring

422Validation Error

detailobject[]

curl

curl -X POST "https://api.example.com/api/v1/{org_id}/locations/{location_uuid}/archive" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X POST "https://api.example.com/api/v1/{org_id}/locations/{location_uuid}/archive" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

patch/api/v1/{org_id}/locations/{location_uuid}

Update Location

Parameters

Path Parameters

location_uuidstringrequired

org_idstringrequired

Request Body

address_line1string

address_line2string

bank_numberstring

base_versionintegerrequired

billing_address_line1string

billing_address_line2string

billing_citystring

billing_entity_namestring

billing_entity_typestring

billing_npistring

billing_phonestring

billing_specialtystring

billing_statestring

billing_tax_idstring

billing_zipstring

citystring

default_imaging_softwarestring

default_place_of_servicestring

display_referral_in_schedulerboolean

emailstring

entity_uuidstring (uuid)

external_idstring

faxstring

generate_sales_tax_codeboolean

ins_billing_prov_uuidstring (uuid)

is_medical_onlyboolean

item_orderinteger

location_typestring

logo_urlstring

med_lab_account_numstring

namestring

npistring

pay_to_address_line1string

pay_to_address_line2string

pay_to_citystring

pay_to_statestring

pay_to_zipstring

phonestring

sales_tax_ratenumber

settingsobject

short_namestring

skipped_daysstring[]

social_linksobject[]

statestring

statusstring

tax_idstring

time_zonestring

use_billing_addr_on_claimsboolean

websitestring

zipstring

Responses

200Successful Response

address_line1string

address_line2string

bank_numberstring

billing_address_line1string

billing_address_line2string

billing_citystring

billing_entity_namestring

billing_entity_typestring

billing_npistring

billing_phonestring

billing_specialtystring

billing_statestring

billing_tax_idstring

billing_zipstring

citystring

created_atstring (date-time)required

default_imaging_softwarestring

default_place_of_servicestring

deleted_atstring (date-time)

display_referral_in_schedulerboolean

emailstring

entityobject

Lightweight Entity reference.

external_idstring

faxstring

generate_sales_tax_codeboolean

idstring (uuid)required

ins_billing_provobject

Lightweight reference to a related entity — exposes UUID and optional name.

is_medical_onlyboolean

item_orderinteger

location_typestringrequired

logo_urlstring

med_lab_account_numstring

namestringrequired

npistring

operatoriesobject[]

pay_to_address_line1string

pay_to_address_line2string

pay_to_citystring

pay_to_statestring

pay_to_zipstring

phonestring

sales_tax_ratestring

settingsobject

short_namestringrequired

skipped_daysstring[]

social_linksobject[]

statestring

statusstringrequired

tax_idstring

time_zonestring

updated_atstring (date-time)required

use_billing_addr_on_claimsboolean

versionintegerrequired

websitestring

zipstring

422Validation Error

detailobject[]

curl

curl -X PATCH "https://api.example.com/api/v1/{org_id}/locations/{location_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "address_line1": "string",
    "address_line2": "string",
    "bank_number": "string",
    "base_version": 1,
    "billing_address_line1": "string"
  }'

curl

curl -X PATCH "https://api.example.com/api/v1/{org_id}/locations/{location_uuid}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "address_line1": "string",
    "address_line2": "string",
    "bank_number": "string",
    "base_version": 1,
    "billing_address_line1": "string"
  }'

Users

5 endpoints

get/api/v1/{org_id}/me

Get Current User Profile

Get current user profile and memberships.

Parameters

Path Parameters

org_idstringrequired

Responses

200Successful Response

avatar_urlstring

created_atstring (date-time)required

Timestamp when user was created.

display_namestringrequired

Display name.

emailstringrequired

User email address.

email_verifiedboolean

Whether email is verified.

idstring (uuid)required

User UUID.

is_platform_adminboolean

Whether the user has platform admin access.

last_login_atstring (date-time)

orgsobject[]required

List of org memberships visible to the current actor.

phonestring

422Validation Error

detailobject[]

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/me" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/me" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

get/api/v1/{org_id}/me/orgs

List Current User Orgs

Get lightweight org membership list.

Parameters

Path Parameters

org_idstringrequired

Responses

200Successful Response

is_platform_adminboolean

Whether the current user has a platform admin role.

orgsobject[]required

Organization memberships for the current user.

422Validation Error

detailobject[]

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/me/orgs" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/me/orgs" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

get/api/v1/{org_id}/me/preferences

Get Current User Preferences

Get current user's preferences for current org.

Parameters

Path Parameters

org_idstringrequired

Responses

200Successful Response

compact_sidebarboolean

Whether compact sidebar mode is enabled.

default_location_uuidstring (uuid)

default_viewstring

Default landing view.

localestring

Preferred locale code.

notifications_enabledboolean

Whether UI notifications are enabled.

themestring

UI theme preference.

timezonestring

422Validation Error

detailobject[]

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/me/preferences" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

curl

curl -X GET "https://api.example.com/api/v1/{org_id}/me/preferences" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

patch/api/v1/{org_id}/me

Update Current User Profile

Update own profile fields.

Parameters

Path Parameters

org_idstringrequired

Request Body

avatar_urlstring

display_namestring

phonestring

Responses

200Successful Response

avatar_urlstring

created_atstring (date-time)required

Timestamp when user was created.

display_namestringrequired

Display name.

emailstringrequired

User email address.

email_verifiedboolean

Whether email is verified.

idstring (uuid)required

User UUID.

is_platform_adminboolean

Whether the user has platform admin access.

last_login_atstring (date-time)

orgsobject[]required

List of org memberships visible to the current actor.

phonestring

422Validation Error

detailobject[]

curl

curl -X PATCH "https://api.example.com/api/v1/{org_id}/me" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "avatar_url": "string",
    "display_name": "string",
    "phone": "string"
  }'

curl

curl -X PATCH "https://api.example.com/api/v1/{org_id}/me" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "avatar_url": "string",
    "display_name": "string",
    "phone": "string"
  }'

patch/api/v1/{org_id}/me/preferences

Update Current User Preferences

Partially update preferences for current org.

Parameters

Path Parameters

org_idstringrequired

Request Body

compact_sidebarboolean

default_location_uuidstring (uuid)

default_viewstring

localestring

notifications_enabledboolean

themestring

timezonestring

Responses

200Successful Response

compact_sidebarboolean

Whether compact sidebar mode is enabled.

default_location_uuidstring (uuid)

default_viewstring

Default landing view.

localestring

Preferred locale code.

notifications_enabledboolean

Whether UI notifications are enabled.

themestring

UI theme preference.

timezonestring

422Validation Error

detailobject[]

curl

curl -X PATCH "https://api.example.com/api/v1/{org_id}/me/preferences" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "compact_sidebar": null,
    "default_location_uuid": "string",
    "default_view": "string",
    "locale": "string",
    "notifications_enabled": null
  }'

curl

curl -X PATCH "https://api.example.com/api/v1/{org_id}/me/preferences" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "compact_sidebar": null,
    "default_location_uuid": "string",
    "default_view": "string",
    "locale": "string",
    "notifications_enabled": null
  }'