get Forms Requests

GET {{baseUrl}}/forms/requests?subdomain={{subdomain}}&location_id={{location_id}}&page=1&per_page=20&patient_id=<integer>&appointment_id=<integer>

Get a list of form requests

Request Params

KeyDatatypeRequiredDescription
subdomainstring(Required) Used to scope the request to the specified institution
location_idstring(Required) Used to scope the request to the specified institution
pagenumberPage number. Starts with page 1
per_pagenumberNumber of results to return per page. Defaults is 5 per page and Max 100 per page
patient_idstringFilter form requests by patient
appointment_idstringFilter form requests by appointment

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;code&quot;:&quot;\u003cboolean\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;error&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;data&quot;:[{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;url&quot;:&quot;\u003cstring\u003e&quot;,&quot;form_ids&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;request_status&quot;:&quot;\u003cstring\u003e&quot;,&quot;sync_status&quot;:&quot;\u003cstring\u003e&quot;,&quot;autosync&quot;:&quot;\u003cboolean\u003e&quot;,&quot;last_synced_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;patient&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;first_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_name&quot;:&quot;\u003cstring\u003e&quot;}},{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;url&quot;:&quot;\u003cstring\u003e&quot;,&quot;form_ids&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;request_status&quot;:&quot;\u003cstring\u003e&quot;,&quot;sync_status&quot;:&quot;\u003cstring\u003e&quot;,&quot;autosync&quot;:&quot;\u003cboolean\u003e&quot;,&quot;last_synced_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;patient&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;first_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;last_name&quot;:&quot;\u003cstring\u003e&quot;}}],&quot;count&quot;:&quot;\u003cinteger\u003e&quot;}