Skip to content
API reference/
API Reference
/
/
Get Form

Get Form

Request

Get a form and its fields.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/forms/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstringrequired
form_typestringrequired
Enum:"questionnaire""response""appointment""care_navigation""intake_form""structured_consult"
titlestringrequired
descriptionstringrequired
patient_titlestring or nullrequired
patient_descriptionstring or nullrequired
confirmation_messagestring or nullrequired
snomed_codestring or nullrequired
fieldsArray of objectsrequired
Response
{
  "id": "string",
  "form_type": "questionnaire",
  "title": "string",
  "description": "string",
  "patient_title": "string",
  "patient_description": "string",
  "confirmation_message": "string",
  "snomed_code": "string",
  "fields": [
    { … }
  ]
}