---
title: "View a specific form schema (beta)"
method: GET
path: "/form_schemas/{uuid}"
tags: ["Form Schemas"]
---

# View a specific form schema (beta)

`GET /form_schemas/{uuid}`

## Request

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

> 🚧 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.

## Path parameters

- `uuid` string, required

## Query parameters

- `subdomain` string, required
- `location_id` integer, required

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV31EntitiesFormSchemaDetailResponse: API_V31_Entities_FormSchemaDetail_Response model
  - `code` boolean: Indicates the success or failure of the request
  - `description` string: Additional context on the request to help with debugging.
  - `error` string[]: Any errors that occur during the execution of the request.
  - `data` APIV31EntitiesFormSchemaDetail
    - `id` string: The form schema ID
    - `title` string: The title of the form
    - `form_slug` string: Stable identifier for this form across versions, derived from the filename
    - `deleted_at` string, date-time: Form schema deletion date in UTC; null for active forms
    - `foreign_id` string, nullable: Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.
    - `formio_schema` object: The full Form.io JSON schema for the form
    - `newest_version_id` string: UUID of the newest version of this form
  - `count` integer: Number of total objects, in case of collection.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta.md) - [All operations](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/llms.txt) - [OpenAPI document](https://skmtc.dev/nexhealth/apis/nexhealth-api-v3-1-0-beta/revisions/93cb4af790a5?raw)