GraphQL Get Patient(s)

Query: Users

Fetch a list of patients or details of a specific patient.

query Users(
  $id: ID, 
  $customerCode: String, 
  $patients_created_from: String, 
  $patients_created_to: String, 
  $data_from: String, 
  $data_to: String, 
  $first: Int!, 
  $page: Int
) {
  users(
    id: $id, 
    customerCode: $customerCode, 
    patients_created_from: $patients_created_from, 
    patients_created_to: $patients_created_to, 
    first: $first, 
    page: $page
  ) {
    data {
      patient_id
      user_type
      first_name
      middle_name
      last_name
      full_name
      gender
      addr1
      addr2
      state
      city
      country
      post_code
      email_id
      email_id_alt
      phone1
      phone2
      work_phone
      country_code_phone1
      country_code_phone2
      country_code_work_phone
      country_code
      birth_date
      timezone
      created_at
      updated_at
      last_call_date_time
      last_call_duration_seconds
      rpm_status
      sleep_data(data_from: $data_from, data_to: $data_to) {
        total_inbed_minutes
        total_sleep_minutes
        recorded_date
        source
      }
      steps_data(data_from: $data_from, data_to: $data_to) {
        steps
        recorded_date
        source
      }
      pulse_ox_data(data_from: $data_from, data_to: $data_to) {
        id
        pulse
        spo2
        recorded_date
        source
        device_type
      }
      temperature_data(data_from: $data_from, data_to: $data_to) {
        id
        temperature
        unit
        recorded_date
        source
        device_type
      }
      blood_pressure_data(data_from: $data_from, data_to: $data_to) {
        id
        systolic
        diastolic
        pulse_rate
        recorded_date
        source
        device_type
      }
      blood_sugar_data(data_from: $data_from, data_to: $data_to) {
        id
        blood_sugar
        unit
        recorded_date
        source
        device_type
      }
      weight_data(data_from: $data_from, data_to: $data_to) {
        id
        weight
        unit
        recorded_date
        source
        device_type
      }
      patient_devices {
        id
        device_shipped_date
        serial_number
        shipment
        physicalDevice {
          id
          device
        }
      }
      populations {
        id
        population_name
      }
      primary_provider {
        id
        full_name
      }
      other_assigned_provider {
        id
        full_name
      }
      billing_provider {
        id
        full_name
      }
    }
    paginatorInfo {
      currentPage
      lastPage
      total
    }
  }
}

Variables Example

{
  "id": 20240000867,
  "customerCode": "DEVMULTI",
  "patients_created_from": "2016-04-01",
  "patients_created_to": "2025-06-23",
  "data_from": "2025-01-01",
  "data_to": "2025-01-31",
  "first": 10,
  "page": 1
}

Parameters

Variable	Type	Required	Description
`id`	ID	❌	If provided, fetch details of a specific patient.
`customerCode`	String	✅	Practice code — mandatory to fetch patients for a specific practice.
`patients_created_from`	String	❌	Start date (YYYY-MM-DD) to filter patients created after this date.
`patients_created_to`	String	❌	End date (YYYY-MM-DD) to filter patients created before this date.
`data_from`	String	❌	Start date for fetching vital data.
`data_to`	String	❌	End date for fetching vital data.
`first`	Int	❌	Number of patients to fetch (for pagination).
`page`	Int	❌	Page number (for pagination).

Response Structure

{
  "data": {
    "users": {
      "data": [
        {
          "patient_id": 20240000867,
          "full_name": "John Doe",
          "gender": "Male",
          "email_id": "johndoe@example.com",
          "phone1": "+11234567890",
          "created_at": "2024-01-12T10:15:00Z",
          "sleep_data": [
            {
              "total_inbed_minutes": 420,
              "total_sleep_minutes": 390,
              "recorded_date": "2025-01-05",
              "source": "Wearable"
            }
          ],
          "blood_pressure_data": [
            {
              "systolic": 120,
              "diastolic": 80,
              "pulse_rate": 70,
              "recorded_date": "2025-01-05",
              "source": "Device"
            }
          ]
        }
      ],
      "paginatorInfo": {
        "currentPage": 1,
        "lastPage": 10,
        "total": 100
      }
    }
  }
}

Notes

customerCode is mandatory.

If id is provided, it returns only one patient.

Use patients_created_from and patients_created_to for filtering patients by creation date.

Use data_from and data_to to limit vital data records.

Pagination:

first = number of records per page

page = page number

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/service/v1/graphql' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{"query":"query Users($id:ID, $customerCode:String, $patients_created_from: String, $patients_created_to: String, $data_from: String, $data_to: String, $first: Int!, $page: Int){ \r\n    users (id:$id, customerCode: $customerCode, patients_created_from:$patients_created_from, patients_created_to:$patients_created_to, first:$first, page:$page){  \r\n        data{\r\n            patient_id\r\n            user_type\r\n            first_name\r\n            middle_name\r\n            last_name\r\n            full_name\r\n            gender\r\n            addr1\r\n            addr2\r\n            state\r\n            city\r\n            country\r\n            post_code\r\n            email_id\r\n            email_id_alt\r\n            phone1\r\n            phone2\r\n            work_phone\r\n            country_code_phone1\r\n            country_code_phone2\r\n            country_code_work_phone\r\n            country_code\r\n            birth_date\r\n            timezone\r\n            created_at\r\n            updated_at\r\n            last_call_date_time\r\n            last_call_duration_seconds\r\n            rpm_status\r\n            sleep_data(data_from: $data_from, data_to: $data_to){\r\n                total_inbed_minutes\r\n                total_sleep_minutes\r\n                recorded_date\r\n                source\r\n            }\r\n            steps_data(data_from: $data_from, data_to: $data_to){\r\n                steps\r\n                recorded_date\r\n                source\r\n            }\r\n            pulse_ox_data (data_from: $data_from, data_to: $data_to){\r\n                id\r\n                pulse\r\n                spo2\r\n                recorded_date\r\n                source\r\n                device_type\r\n            }\r\n            temperature_data (data_from: $data_from, data_to: $data_to){\r\n                id\r\n                temperature\r\n                unit\r\n                recorded_date\r\n                source\r\n                device_type\r\n            }\r\n            blood_pressure_data (data_from: $data_from, data_to: $data_to){\r\n                id\r\n                systolic\r\n                diastolic\r\n                pulse_rate\r\n                recorded_date\r\n                source\r\n                device_type\r\n            }\r\n            blood_sugar_data (data_from: $data_from, data_to: $data_to){\r\n                id\r\n                blood_sugar\r\n                unit\r\n                recorded_date\r\n                source\r\n                device_type\r\n            }\r\n            weight_data (data_from: $data_from, data_to: $data_to){\r\n                id\r\n                weight\r\n                unit\r\n                recorded_date\r\n                source\r\n                device_type\r\n            }\r\n            patient_devices{\r\n                id\r\n                device_shipped_date\r\n                serial_number\r\n                shipment\t\r\n                physicalDevice{\r\n                    id\r\n                    device\r\n                }\r\n            }\r\n            populations{\r\n                id\r\n                population_name\r\n            }\r\n            primary_provider{\r\n                id,\r\n                full_name\r\n            }\r\n            other_assigned_provider{\r\n                id,\r\n                full_name\r\n            }\r\n            billing_provider{\r\n                id,\r\n                full_name\r\n            }\r\n        }\r\n         paginatorInfo {\r\n            currentPage\r\n            lastPage\r\n            total\r\n        }\r\n    }\r\n}","variables":{"customerCode":"MDP","patients_created_from":"2016-04-01","patients_created_to":"2025-06-23","data_from":"2025-06-01","data_to":"2025-06-31","first":10,"page":1}}'

Query: Users#

Variables Example#

Parameters#

Response Structure#

Notes#