Skip to content

Form

List and retrieve forms (questionnaires) configured for a practice group.

List Forms

Request

Retrieves a list of all forms configured for the requesting practice group.

Security
apiKeyAuth and practiceGroupId
Query
searchstring
reply_formboolean
form_typestring
Enum:"questionnaire""response""appointment""care_navigation"
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/forms?search=string&reply_form=true&form_type=questionnaire' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
dataArray of objectsrequired
countnumberrequired
Response
{ "data": [ { … } ], "count": 0 }