List Onboarding Clinics¶

Clinics available for onboarding. emr_clinic_id correlates to /v2/clinics/{id} on this API once published; it is never accepted in place of id.

Endpoint¶

GET /v2/onboarding/clinics

Request¶

curl --location '{base_url}/v2/onboarding/clinics' \
  --header 'Authorization: Bearer JWT_TOKEN'

Response¶

Success Response¶

Code: 200 OK

{
  "data": [
    {
      "id": "b41f7c92-5e08-4a13-8d6f-2c9147ab3e5d",
      "emr_clinic_id": null,
      "name": "Example Therapy \u2014 Riverside",
      "npi": "1740398215",
      "address": {
        "line1": "482 Willow Creek Rd",
        "line2": null,
        "city": "Fairview",
        "state": "OR",
        "zip": "97024",
        "country": "US"
      },
      "phone": "+1-555-0143",
      "time_zone": "America/Los_Angeles",
      "published": false
    }
  ]
}

Response Fields¶

Field	Type	Description
`data`	array of object	See Data.

Data¶

Field	Type	Description
`id`	string	The onboarding record's UUID.
`emr_clinic_id`	integer or null	The operational clinic id once the record is published. `null` before publish, and never accepted in place of an id.
`name`	string or null
`npi`	string or null
`address`	object or null	See Address.
`phone`	string or null
`time_zone`	string or null	IANA timezone name.
`published`	boolean	Whether the onboarding record has been published to an operational record. Derived, so you don't need to infer it from a null `emr_clinic_id`.

Address¶

Field	Type	Description
`line1`	string or null
`line2`	string or null
`city`	string or null
`state`	string or null
`zip`	string or null	Postal code. Named `zip` here rather than the `postal_code` used everywhere else.
`country`	string or null

Error Response¶

Code: 400 Bad Request

{
  "code": "bad_request",
  "message": "Validation failed",
  "errors": [
    {
      "field": "patient_id",
      "message": "must be a string"
    }
  ]
}

Every error has the same shape — a machine-readable code, a message, and an errors[] array that's empty when there's nothing field-specific to report. The HTTP status is authoritative.

Status	`code`	Meaning
`400 Bad Request`	`bad_request`	The request body or parameters failed validation. `errors[]` names the offending fields.
`401 Unauthorized`	`unauthorized`	The access token is missing, malformed or expired.
`403 Forbidden`	`forbidden`	The request references a resource outside the token's organisation or clinic scope.
`404 Not Found`	`not_found`	No such resource, or it's outside your scope.
`429 Too Many Requests`	`rate_limited`	Rate limit exceeded. Back off and retry.
`500 Internal Server Error`	`internal_error`	Unexpected server error.
`502 Bad Gateway`	`upstream_error`	Upstream service failed or timed out.