NEnexhealth
Onboardings

View onboarding (beta)

🚧 Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds response fields data.locations, data.locations[].city, data.locations[].data_ready_at, data.locations[].external_id (+13 more).

get/onboardings/{hashid}

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/onboardings/{hashid}
  • Auth
    API key in header Authorization

Path parameters

hashidstring required

Headers

Nex-Api-Versionstring required

The NexHealth API version

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://setup.nexhealth.com/test-app?hashid=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",
    "locations": [
      {
        "location_id": 105,
        "external_id": "loc_8f3a1c",
        "name": "Smile Dental Downtown",
        "zip_code": "94105",
        "street_address": "123 Market St",
        "city": "San Francisco",
        "state": "CA",
        "progress": {
          "status": "failed",
          "path": "cloud",
          "error": {
            "key": "invalid_credentials",
            "responsible_party": "practice",
            "message": "The Cloud 9 username or password the practice entered was rejected.",
            "remediation": "The practice sees this in the setup flow and can re-enter their Cloud 9 credentials there. Follow up with them if the status does not move."
          }
        },
        "data_ready_at": "2026-01-01T00:00:00Z"
      }
    ]
  },
  "count": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.