API Reference

/rest/patients

get
{Protocol}://{Host}:{Port}/{Path}/rest/patients

Returns a summary of all patient records

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

For large result set paging, the index of the first patient to display in the returned page; defaults to 0

integer

For large result set paging, how many patients to display in the returned page; defaults to 30

string

Query parameter used for ordering the patients. Can be id (default) or eid

string

The sorting order, can be asc (default) or desc

string

If studyId is specified, the results will only return patients that are part of the study with the provided id

Responses

401

User not authenticated

403

User not authorized

Updated 8 months ago

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago