List

GET /locations/:location_id/patients

This endpoint retrieves patients for a specific location.

Parameters

location_id (required): The ID of the location for which patients are to be retrieved.
after: A parameter to specify the cursor for pagination.
items: A parameter to specify the number of items to be returned.
The q[first_treatment_performed_at] field determines whether a record qualifies as a new patient. To retrieve a list of new patients, you can specify a date range for this field using the example format provided.
The q[fetch_modified_since] is used to capture the delta changes, pass the datetime in UTC as shown in example below

{
    "q": {
        "first_treatment_performed_at_gteq": "2001-01-01",
        "first_treatment_performed_at_lteq": "2024-01-31",
        "fetch_modified_since": "2025-12-02T01:58:00.164Z"
    }
}

Response

Content-Type: application/json

{
  "data": [
    {
      "id": "string",
      "type": "string",
      "attributes": {
        "first_name": "string",
        "last_name": "string",
        "middle_name": "string or null",
        "address_line1": "string",
        "address_line2": "string or null",
        "city": "string",
        "state": "string",
        "zip_code": "string",
        "latitude": "number or null",
        "longitude": "number or null",
        "status": "string",
        "gender": "string",
        "mobile_phone": "string",
        "home_phone": "string",
        "work_phone": "string",
        "other_phone": "string",
        "name": "string"
      }
    }
  ],
  "pagy": {
    "total": "number",
    "items": "number"
  }
}

Authentication

Organizations

Locations

GET /locations/:location_id/patients

Parameters

Response

​GET /locations/:location_id/patients

​Parameters

​Response

GET /locations/:location_id/patients

Parameters

Response