Luna Health API / API Reference / Get a completed patient form Get a completed patient form GET /patient-form
Retrieves one completed form's fields in display order, as structured data: each field's label and answer, plus the options and checked state of choice fields, and the measurements recorded on vitals fields. Signature fields report only whether they were signed; the signature image is never returned. Drawing fields (body and facial charts, sketches, spine) are listed without a value. Scoped to your organization.
Code samples Node.js const fetch = require('node-fetch');
async function callApi() {
const apiKey = 'YOUR_API_KEY';
const id = 'your-id';
const queryString = new URLSearchParams({
id: id
}).toString();
const url = `https://account.lunahealth.app/api/patient-form` + (queryString ? `?${queryString}` : '');
try {
const response = await fetch(url, {
method: 'GET',
headers: {
'Authorization': `Bearer ${apiKey}`,
'Content-Type': 'application/json'
}
});
if (!response.ok) {
throw new Error(`API error: ${response.status}`);
}
const data = await response.json();
console.log(data);
return data;
} catch (error) {
console.error('Error calling API:', error);
throw error;
}
}
callApi();Python import requests
def call_api():
api_key = 'YOUR_API_KEY'
url = 'https://account.lunahealth.app/api/patient-form'
headers = {
'Authorization': f'Bearer {api_key}',
'Content-Type': 'application/json'
}
params = {
'id': 'your-id'
}
try:
response = requests.get(
url,
headers=headers,
params=params
)
response.raise_for_status()
data = response.json()
print(data)
return data
except requests.exceptions.RequestException as e:
print(f'Error calling API: {e}')
raise
call_api()Parameters Name In Type Required Description idquery string Yes —
Responses Status Description 200Successful response 400Invalid input data 401Authorization not provided 403Insufficient access 404Not found 500Internal server error
200 — Successful responseResponse fields Name Type Required Description idstring Yes — namestring Yes — descriptionstringnull Yes — completed_atstringnull Yes — updated_atstring Yes — patient_idstring Yes — fieldsarray<object> Yes —
Example response {
"id": "string",
"name": "string",
"description": null,
"completed_at": null,
"updated_at": "string",
"patient_id": "string",
"fields": [
{
"id": "string",
"order": 0,
"type": "CHIEF_COMPLAINT",
"label": null,
"value": null,
"options": [
"string"
],
"checked": [
{
"option": "string",
"checked": true,
"notes": null
}
],
"signed": null,
"vitals": [
{
"name": "string",
"value": 0,
"unit": null,
"custom": true
}
]
}
]
}400 — Invalid input dataResponse fields Name Type Required Description messagestring Yes The error message codestring Yes The error code issuesarray<object> No An array of issues that were responsible for the error
Example response {
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}401 — Authorization not providedResponse fields Name Type Required Description messagestring Yes The error message codestring Yes The error code issuesarray<object> No An array of issues that were responsible for the error
Example response {
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}403 — Insufficient accessResponse fields Name Type Required Description messagestring Yes The error message codestring Yes The error code issuesarray<object> No An array of issues that were responsible for the error
Example response {
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}404 — Not foundResponse fields Name Type Required Description messagestring Yes The error message codestring Yes The error code issuesarray<object> No An array of issues that were responsible for the error
Example response {
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}500 — Internal server errorResponse fields Name Type Required Description messagestring Yes The error message codestring Yes The error code issuesarray<object> No An array of issues that were responsible for the error
Example response {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Open in interactive reference →
