v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Onboardings

Create onboarding

Creates an onboarding link to set up NexHealth at a practice. Include institution_name to onboard a new institution, or subdomain to add locations to an existing institution. Send the returned url to practice staff; it expires 3 months after creation. Only production applications can create onboardings.

post/onboardings

Headers

Nex-Api-Versionstring required

The NexHealth API version

Request body

Example request

{
  "onboarding": {
    "institution_name": "Smile Dental Group",
    "institution_zip_code": "94105",
    "institution_website": "https://www.smiledentalgroup.example.com",
    "institution_email": "office@smiledentalgroup.example.com",
    "subdomain": "smile-dental",
    "emr_name": "opendental"
  }
}

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": {
    "id": "y2wxl82zldm4",
    "created_at": "2026-01-01T00:00:00Z",
    "subdomain": "test-subdomain",
    "url": "https://app.nexhealth.com/onboardings/y2wxl82zldm4",
    "url_expires_at": "2026-02-01T00:00:00Z",
    "status": "in_progress",
    "booking_params": {
      "location_id": 105,
      "appointment_type_ids": [
        19,
        20
      ]
    },
    "availability_ready_at": "2026-01-01T00:00:00Z"
  },
  "count": 2
}