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
Key | Datatype | Required | Description |
---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
location_id | string | (Required) Used to scope the request to the specified institution | |
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 100 per page | |
patient_id | string | Filter form requests by patient | |
appointment_id | string | Filter form requests by appointment |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"code":"\u003cboolean\u003e","description":"\u003cstring\u003e","error":["\u003cstring\u003e","\u003cstring\u003e"],"data":[{"id":"\u003cstring\u003e","url":"\u003cstring\u003e","form_ids":["\u003cstring\u003e","\u003cstring\u003e"],"request_status":"\u003cstring\u003e","sync_status":"\u003cstring\u003e","autosync":"\u003cboolean\u003e","last_synced_at":"\u003cstring\u003e","patient":{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e"}},{"id":"\u003cstring\u003e","url":"\u003cstring\u003e","form_ids":["\u003cstring\u003e","\u003cstring\u003e"],"request_status":"\u003cstring\u003e","sync_status":"\u003cstring\u003e","autosync":"\u003cboolean\u003e","last_synced_at":"\u003cstring\u003e","patient":{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e"}}],"count":"\u003cinteger\u003e"}