NEnexhealth
Form Schemas

View a specific form schema (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.

get/form_schemas/{uuid}

Request

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

Path parameters

uuidstring required

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

Used to scope the request to the specified location

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": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "title": "Patient Health History",
    "form_slug": "patient-health-history",
    "deleted_at": "2026-05-12T20:16:57.007Z",
    "foreign_id": "1",
    "formio_schema": {
      "display": "form",
      "components": []
    },
    "newest_version_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "count": 2
}

Changes

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