Get all Patients for Tenant
GET {{url}}/{{tenantName}}/admin/patients?size=1000&page=0&sort=createdAt,asc
This endpoint allows you to fetch patients by applying certain filters. However, this endpoint is restricted for API Clients, and a token must be obtained from the UI Admin portal.
HTTP URL: https://api.live.welkincloud.io/gh/sb-demo/by-filter/patients
HTTP Response Codes:
- 200: Successfully fetched patients based on the applied filter
- 400: Bad request - the request could not be understood or was missing required parameters
- 500: Internal server error - something went wrong on the server
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
size | number | Pagination: Specifies number of records to return by each page. | |
page | number | Pagination: Specifies what page to return | |
sort | string | Allows one to specify the sort order of the returned patients collection | |
query | null | When specified, will execute a search for a patient based of email address, first name, last name and phone | |
search | null |