View form requests

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

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 location
sortstringOptional comma-separated string of fields to sort on.
Include a leading dash for descending order.

Available fields: created_at, updated_at, completed_at | | page | number | | Page number. Starts with page 1 | | per_page | number | | Number of results to return per page. Defaults is 5 per page and Max 300 per page | | patient_id | string | | Filter form requests by patient | | appointment_id | string | | Filter 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;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;due_date&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;created_at&quot;:&quot;\u003cstring\u003e&quot;,&quot;due_date&quot;:&quot;\u003cstring\u003e&quot;}],&quot;count&quot;:&quot;\u003cinteger\u003e&quot;}