Skip to main content
POST
/
dosespot
/
sso
Generate Sso Url
curl --request POST \
  --url https://api.decodahealth.com/dosespot/sso \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "locationId": "<string>",
  "patientId": "<string>",
  "userId": "<string>",
  "onBehalfOfUserId": "<string>",
  "encounterId": "<string>",
  "supervisorId": "<string>",
  "refillsErrors": false
}
'
{
  "url": "<string>"
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Request schema for generating DoseSpot SSO URL

locationId
string
required

Location ID - used to retrieve DoseSpot Clinic ID and Clinic Key

patientId
string | null

Optional internal patient ID. If provided, patient will be synced to DoseSpot first (if not already synced), then SSO URL will include DoseSpot Patient ID for deep linking

userId
string | null

Optional DoseSpot User ID. If not provided, will be looked up from the current provider's dosespot_user_id field

onBehalfOfUserId
string | null

Optional User ID when prescribing on behalf of another provider

encounterId
string | null

Optional Encounter ID to link prescription to specific encounter

supervisorId
string | null

Optional Supervisor User ID for supervision workflows

refillsErrors
boolean
default:false

If True, shows refill errors screen

Response

Successful Response

Response schema containing the generated DoseSpot SSO URL

url
string
required

The signed SSO URL to launch DoseSpot