Skip to content
/
List Patients

List Patients

Request

Security
x-api-key and a-api-key
Query
pageinteger, >= 1
Example:page=1
page_sizeinteger, [ 1 .. 200 ]
Example:page_size=50
sort_byArray of strings

Comma separated search fields. See Sorting

Example:sort_by=["client_id","first_name","surname","file_created"]
q[]Array of strings

Filter result by one or more fields.

See Query Filtering

Available filters:

ValueFormat
first_namestring
surnamestring
file_createdtimestamp
date_of_birthdate
preferred_namestring
emailstring
archivedtimestamp
updatedtimestamp
home_phonestring
work_phonestring
mobilestring
phonestring
statusinteger
= only.
Active = 1, Inactive = 2, All = 3, Inactive (excl deceased) = 4, All (excl deceased) = 5, Deceased = 6
email_marketing_typeinteger
= only.
Soft Opt-In = 1, Opt-In = 2, Soft Opt-Out = 3, Opt-Out = 4
sms_marketing_typeinteger
= only.
Soft Opt-In = 1, Opt-In = 2, Soft Opt-Out = 3, Opt-Out = 4
tag_any_idsinteger array
Matches patients who have any of the supplied tag IDs.
tag_all_idsinteger array
Matches patients who have all of the supplied tag IDs.
tag_exc_idsinteger array
Excludes patients who have any of the supplied tag IDs.
curl -i -X GET \
  'https://api.pracsuite.com/v1/patient?page=1&page_size=50&sort_by=%5B%22field_name%22%2C%22field_name%22%5D&q%5B%5D=string' \
  -H 'a-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful

Bodyapplication/json
clientsArray of objects(Patient)
total_entriesinteger
Response
{
  "clients": [
    { … }
  ],
  "total_entries": 0,
  "links": {
    "self": "https://api.pracsuite.com/v1/patient?page=2",
    "previous": "https://api.pracsuite.com/v1/patient?page=1",
    "next": "https://api.pracsuite.com/v1/patient?page=3"
  }
}