# List Patients

Retrieve a list of patients of a clinic

Endpoint: GET /v1/clinics/{clinicId}/patients
Version: 1.0
Security: sessionToken

## Path parameters:

  - `clinicId` (string, required)

## Query parameters:

  - `search` (string)
    Full text search query

  - `offset` (integer)

  - `limit` (integer)

  - `sort` (string)
    Sort order and attribute (e.g. +name or -name)

  - `sortType` (string)
    Summary type to sort by
    Example: "cgm"

  - `period` (string)
    Time Period to display, filter, and sort
    Example: "7d"

  - `lastReviewed` (string)
    Inclusive

  - `cgm.max` (string)
    Max glucose value in mmol/L
    Example: ">=5.5"

  - `cgm.min` (string)
    Min glucose value in mmol/L
    Example: ">=5.5"

  - `cgm.averageGlucoseMmol` (string)
    Average glucose value of records in mmol/L
    Example: ">=5.5"

  - `cgm.glucoseManagementIndicator` (string)
    Glucose management Indicator of records
    Example: ">=5.5"

  - `cgm.timeCGMUsePercent` (string)
    Percentage of time [0.0-1.0]  of CGM use
    Example: ">=5.5"

  - `cgm.timeInVeryLowPercent` (string)
    Percentage of time [0.0-1.0]  below 54 mg/dL
    Example: ">=5.5"

  - `cgm.timeInAnyLowPercent` (string)
    Percentage of time [0.0-1.0]  below 70 mg/dL
    Example: ">=5.5"

  - `cgm.timeInLowPercent` (string)
    Percentage of time [0.0-1.0]  in range 54-70 mg/dL
    Example: ">=5.5"

  - `cgm.timeInTargetPercent` (string)
    Percentage of time [0.0-1.0]  in range 70-180 mg/dL
    Example: ">=5.5"

  - `cgm.timeInHighPercent` (string)
    Percentage of time [0.0-1.0]  in range 180-250 mg/dL
    Example: ">=5.5"

  - `cgm.timeInVeryHighPercent` (string)
    Percentage of time [0.0-1.0]  above 250 mg/dL
    Example: ">=5.5"

  - `cgm.timeInExtremeHighPercent` (string)
    Percentage of time [0.0-1.0]  above 350 mg/dL
    Example: ">=5.5"

  - `cgm.timeInAnyHighPercent` (string)
    Percentage of time [0.0-1.0]  above 180 mg/dL
    Example: ">=5.5"

  - `cgm.timeCGMUseMinutes` (string)
    Minutes of CGM use
    Example: ">=7"

  - `cgm.timeInVeryLowMinutes` (string)
    Minutes below 54 mg/dL
    Example: ">=7"

  - `cgm.timeInAnyLowMinutes` (string)
    Minutes below 70 mg/dL
    Example: ">=7"

  - `cgm.timeInLowMinutes` (string)
    Minutes in range 54-70 mg/dL
    Example: ">=7"

  - `cgm.timeInTargetMinutes` (string)
    Minutes in range 70-180 mg/dL
    Example: ">=7"

  - `cgm.timeInHighMinutes` (string)
    Minutes in range 180-250 mg/dL
    Example: ">=7"

  - `cgm.timeInVeryHighMinutes` (string)
    Minutes above 250 mg/dL
    Example: ">=7"

  - `cgm.timeInExtremeHighMinutes` (string)
    Minutes above 350 mg/dL
    Example: ">=7"

  - `cgm.timeInAnyHighMinutes` (string)
    Minutes above 180 mg/dL
    Example: ">=7"

  - `cgm.timeCGMUseRecords` (string)
    Records of CGM use
    Example: ">=7"

  - `cgm.timeInVeryLowRecords` (string)
    Records below 54 mg/dL
    Example: ">=7"

  - `cgm.timeInAnyLowRecords` (string)
    Records below 70 mg/dL
    Example: ">=7"

  - `cgm.timeInLowRecords` (string)
    Records in range 54-70 mg/dL
    Example: ">=7"

  - `cgm.timeInTargetRecords` (string)
    Records in range 70-180 mg/dL
    Example: ">=7"

  - `cgm.timeInHighRecords` (string)
    Records in range 180-250 mg/dL
    Example: ">=7"

  - `cgm.timeInVeryHighRecords` (string)
    Records above 250 mg/dL
    Example: ">=7"

  - `cgm.timeInAnyHighRecords` (string)
    Records above 180 mg/dL
    Example: ">=7"

  - `cgm.averageDailyRecords` (string)
    Average records per day
    Example: ">=5.5"

  - `cgm.totalRecords` (string)
    Total records in period
    Example: ">=7"

  - `cgm.hoursWithData` (string)
    Total hours with data in period
    Example: ">=7"

  - `cgm.daysWithData` (string)
    Total days with data in period
    Example: ">=7"

  - `cgm.standardDeviation` (string)
    Standard deviation of glucose values in mmol/L
    Example: ">=5.5"

  - `cgm.coefficientOfVariation` (string)
    Coefficient Of Variation of glucose values in mmol/L
    Example: ">=5.5"

  - `bgm.max` (string)
    Max glucose value in mmol/L
    Example: ">=5.5"

  - `bgm.min` (string)
    Min glucose value in mmol/L
    Example: ">=5.5"

  - `bgm.averageGlucoseMmol` (string)
    Average glucose value of records in mmol/L
    Example: ">=5.5"

  - `bgm.timeInVeryLowPercent` (string)
    Percentage of time [0.0-1.0]  below 54 mg/dL
    Example: ">=5.5"

  - `bgm.timeInAnyLowPercent` (string)
    Percentage of time [0.0-1.0]  below 70 mg/dL
    Example: ">=5.5"

  - `bgm.timeInLowPercent` (string)
    Percentage of time [0.0-1.0]  in range 54-70 mg/dL
    Example: ">=5.5"

  - `bgm.timeInTargetPercent` (string)
    Percentage of time [0.0-1.0]  in range 70-180 mg/dL
    Example: ">=5.5"

  - `bgm.timeInHighPercent` (string)
    Percentage of time [0.0-1.0]  in range 180-250 mg/dL
    Example: ">=5.5"

  - `bgm.timeInVeryHighPercent` (string)
    Percentage of time [0.0-1.0]  above 250 mg/dL
    Example: ">=5.5"

  - `bgm.timeInExtremeHighPercent` (string)
    Percentage of time [0.0-1.0]  above 350 mg/dL
    Example: ">=5.5"

  - `bgm.timeInAnyHighPercent` (string)
    Percentage of time [0.0-1.0]  above 180 mg/dL
    Example: ">=5.5"

  - `bgm.timeInVeryLowRecords` (string)
    Records below 54 mg/dL
    Example: ">=7"

  - `bgm.timeInAnyLowRecords` (string)
    Records below 70 mg/dL
    Example: ">=7"

  - `bgm.timeInLowRecords` (string)
    Records in range 54-70 mg/dL
    Example: ">=7"

  - `bgm.timeInTargetRecords` (string)
    Records in range 70-180 mg/dL
    Example: ">=7"

  - `bgm.timeInHighRecords` (string)
    Records in range 180-250 mg/dL
    Example: ">=7"

  - `bgm.timeInVeryHighRecords` (string)
    Records above 250 mg/dL
    Example: ">=7"

  - `bgm.timeInAnyHighRecords` (string)
    Records above 180 mg/dL
    Example: ">=7"

  - `bgm.averageDailyRecords` (string)
    Average records per day
    Example: ">=5.5"

  - `bgm.totalRecords` (string)
    Total records in period
    Example: ">=7"

  - `cgm.maxDelta` (string)
    Delta of Max glucose value in mmol/L
    Example: ">=5.5"

  - `cgm.minDelta` (string)
    Delta of Min glucose value in mmol/L
    Example: ">=5.5"

  - `cgm.averageGlucoseMmolDelta` (string)
    Delta of average glucose value in mmol/L
    Example: ">=5.5"

  - `cgm.glucoseManagementIndicatorDelta` (string)
    Glucose management Indicator of records
    Example: ">=5.5"

  - `cgm.timeCGMUsePercentDelta` (string)
    Delta of time of CGM use
    Example: ">=5.5"

  - `cgm.timeInVeryLowPercentDelta` (string)
    Delta of time below 54 mg/dL
    Example: ">=5.5"

  - `cgm.timeInAnyLowPercentDelta` (string)
    Delta of time below 70 mg/dL
    Example: ">=5.5"

  - `cgm.timeInLowPercentDelta` (string)
    Delta of time in range 54-70 mg/dL
    Example: ">=5.5"

  - `cgm.timeInTargetPercentDelta` (string)
    Delta of time in range 70-180 mg/dL
    Example: ">=5.5"

  - `cgm.timeInHighPercentDelta` (string)
    Delta of time in range 180-250 mg/dL
    Example: ">=5.5"

  - `cgm.timeInVeryHighPercentDelta` (string)
    Delta of time above 250 mg/dL
    Example: ">=5.5"

  - `cgm.timeInExtremeHighPercentDelta` (string)
    Delta of time above 350 mg/dL
    Example: ">=5.5"

  - `cgm.timeInAnyHighPercentDelta` (string)
    Delta of time above 180 mg/dL
    Example: ">=5.5"

  - `cgm.timeCGMUseMinutesDelta` (string)
    Delta of minutes of CGM use
    Example: ">=7"

  - `cgm.timeInVeryLowMinutesDelta` (string)
    Delta of minutes below 54 mg/dL
    Example: ">=7"

  - `cgm.timeInAnyLowMinutesDelta` (string)
    Delta of minutes below 70 mg/dL
    Example: ">=7"

  - `cgm.timeInLowMinutesDelta` (string)
    Delta of minutes in range 54-70 mg/dL
    Example: ">=7"

  - `cgm.timeInTargetMinutesDelta` (string)
    Delta of minutes in range 70-180 mg/dL
    Example: ">=7"

  - `cgm.timeInHighMinutesDelta` (string)
    Delta of minutes in range 180-250 mg/dL
    Example: ">=7"

  - `cgm.timeInVeryHighMinutesDelta` (string)
    Delta of minutes above 250 mg/dL
    Example: ">=7"

  - `cgm.timeInExtremeHighMinutesDelta` (string)
    Delta of minutes above 350 mg/dL
    Example: ">=7"

  - `cgm.timeInAnyHighMinutesDelta` (string)
    Delta of minutes above 180 mg/dL
    Example: ">=7"

  - `cgm.timeCGMUseRecordsDelta` (string)
    Delta of records count
    Example: ">=7"

  - `cgm.timeInVeryLowRecordsDelta` (string)
    Delta of records below 54 mg/dL
    Example: ">=7"

  - `cgm.timeInAnyLowRecordsDelta` (string)
    Delta of records below 70 mg/dL
    Example: ">=7"

  - `cgm.timeInLowRecordsDelta` (string)
    Delta of records in range 54-70 mg/dL
    Example: ">=7"

  - `cgm.timeInTargetRecordsDelta` (string)
    Delta of records in range 70-180 mg/dL
    Example: ">=7"

  - `cgm.timeInHighRecordsDelta` (string)
    Delta of records in range 180-250 mg/dL
    Example: ">=7"

  - `cgm.timeInVeryHighRecordsDelta` (string)
    Delta of records above 250 mg/dL
    Example: ">=7"

  - `cgm.timeInAnyHighRecordsDelta` (string)
    Delta of records above 180 mg/dL
    Example: ">=7"

  - `cgm.averageDailyRecordsDelta` (string)
    Delta of average records per day
    Example: ">=5.5"

  - `cgm.totalRecordsDelta` (string)
    Delta of total records
    Example: ">=7"

  - `cgm.hoursWithDataDelta` (string)
    Delta of total hours with data
    Example: ">=7"

  - `cgm.daysWithDataDelta` (string)
    Delta of total days with data
    Example: ">=7"

  - `cgm.standardDeviationDelta` (string)
    Delta of the standard deviation of glucose values in mmol/L
    Example: ">=5.5"

  - `cgm.coefficientOfVariationDelta` (string)
    Delta of the coefficient of glucose values in mmol/L
    Example: ">=5.5"

  - `cgm.lastDataFrom` (string)
    Inclusive

  - `cgm.lastDataTo` (string)
    Exclusive

  - `bgm.maxDelta` (string)
    Delta of Max glucose value in mmol/L
    Example: ">=5.5"

  - `bgm.minDelta` (string)
    Delta of Min glucose value in mmol/L
    Example: ">=5.5"

  - `bgm.averageGlucoseMmolDelta` (string)
    Delta of the average glucose values in mmol/L
    Example: ">=5.5"

  - `bgm.timeInVeryLowPercentDelta` (string)
    Delta of time below 54 mg/dL
    Example: ">=5.5"

  - `bgm.timeInAnyLowPercentDelta` (string)
    Delta of time below 70 mg/dL
    Example: ">=5.5"

  - `bgm.timeInLowPercentDelta` (string)
    Delta of time in range 54-70 mg/dL
    Example: ">=5.5"

  - `bgm.timeInTargetPercentDelta` (string)
    Delta of time in range 70-180 mg/dL
    Example: ">=5.5"

  - `bgm.timeInHighPercentDelta` (string)
    Delta of time in range 180-250 mg/dL
    Example: ">=5.5"

  - `bgm.timeInVeryHighPercentDelta` (string)
    Delta of time above 250 mg/dL
    Example: ">=5.5"

  - `bgm.timeInExtremeHighPercentDelta` (string)
    Delta of time above 350 mg/dL
    Example: ">=5.5"

  - `bgm.timeInAnyHighPercentDelta` (string)
    Delta of time above 180 mg/dL
    Example: ">=5.5"

  - `bgm.timeInVeryLowRecordsDelta` (string)
    Delta of records below 54 mg/dL
    Example: ">=7"

  - `bgm.timeInAnyLowRecordsDelta` (string)
    Delta of records below 70 mg/dL
    Example: ">=7"

  - `bgm.timeInLowRecordsDelta` (string)
    Delta of records in range 54-70 mg/dL
    Example: ">=7"

  - `bgm.timeInTargetRecordsDelta` (string)
    Delta of records in range 70-180 mg/dL
    Example: ">=7"

  - `bgm.timeInHighRecordsDelta` (string)
    Delta of records in range 180-250 mg/dL
    Example: ">=7"

  - `bgm.timeInVeryHighRecordsDelta` (string)
    Delta of records above 250 mg/dL
    Example: ">=7"

  - `bgm.timeInAnyHighRecordsDelta` (string)
    Delta of records above 180 mg/dL
    Example: ">=7"

  - `bgm.averageDailyRecordsDelta` (string)
    Delta of average records per day
    Example: ">=7"

  - `bgm.totalRecordsDelta` (string)
    Delta of total record count
    Example: ">=7"

  - `bgm.lastDataFrom` (string)
    Inclusive

  - `bgm.lastDataTo` (string)
    Exclusive

  - `tags` (array)
    Comma-separated list of patient tag IDs

  - `sites` (array)
    Comma-separated list of clinic site IDs

## Response 200 fields (application/json):

  - `data` (array)

  - `data.id` (string, required)
    String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit [UUID v4](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random))

  - `data.email` (string)

  - `data.fullName` (string, required)
    The full name of the patient

  - `data.birthDate` (string, required)
    Example: "2012-08-30"

  - `data.mrn` (string)
    The medical record number of the patient

  - `data.tags` (array,null)

  - `data.targetDevices` (array)

  - `data.permissions` (object)

  - `data.permissions.custodian` (object)

  - `data.permissions.view` (object)

  - `data.permissions.note` (object)

  - `data.permissions.upload` (object)

  - `data.createdTime` (string, required)

  - `data.updatedTime` (string, required)

  - `data.attestationSubmitted` (boolean)

  - `data.dataSources` (array,null)

  - `data.dataSources.state` (string, required)
    Enum: "pending", "pendingReconnect", "connected", "disconnected", "error"

  - `data.dataSources.providerName` (string, required)
    Example: "dexcom"

  - `data.dataSources.dataSourceId` (string)
    String representation of a resource id

  - `data.dataSources.modifiedTime` (string)
    [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) / [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp _with_ timezone information
    Example: "2017-02-06T02:37:46Z"

  - `data.dataSources.expirationTime` (string)
    [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) / [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp _with_ timezone information
    Example: "2017-02-06T02:37:46Z"

  - `data.lastUploadReminderTime` (string)

  - `data.summary` (object)
    A summary of a patients recent data

  - `data.summary.cgmStats` (object)
    A summary of a users recent CGM glucose values

  - `data.summary.cgmStats.id` (string)
    Summary Unique Identifier
    Example: "2fe2488217ee43e1b2e83c2f"

  - `data.summary.cgmStats.config` (object)
    Summary schema version and calculation configuration

  - `data.summary.cgmStats.config.schemaVersion` (number, required)
    Summary schema version

  - `data.summary.cgmStats.config.highGlucoseThreshold` (number, required)
    Threshold used for determining if a value is high

  - `data.summary.cgmStats.config.veryHighGlucoseThreshold` (number, required)
    Threshold used for determining if a value is very high

  - `data.summary.cgmStats.config.lowGlucoseThreshold` (number, required)
    Threshold used for determining if a value is low

  - `data.summary.cgmStats.config.veryLowGlucoseThreshold` (number, required)
    Threshold used for determining if a value is very low

  - `data.summary.cgmStats.dates` (object)
    dates tracked for summary calculation

  - `data.summary.cgmStats.dates.lastUpdatedDate` (string)
    Date of the last calculation

  - `data.summary.cgmStats.dates.lastUpdatedReason` (array)
    List of reasons the summary was updated for

  - `data.summary.cgmStats.dates.hasFirstData` (boolean, required)

  - `data.summary.cgmStats.dates.firstData` (string)
    Date of the first included value

  - `data.summary.cgmStats.dates.hasLastData` (boolean, required)

  - `data.summary.cgmStats.dates.lastData` (string)
    Date of the last calculated value

  - `data.summary.cgmStats.dates.hasLastUploadDate` (boolean, required)

  - `data.summary.cgmStats.dates.lastUploadDate` (string)
    Created date of the last calculated value

  - `data.summary.cgmStats.dates.hasOutdatedSince` (boolean, required)

  - `data.summary.cgmStats.dates.outdatedSince` (string)
    Date of the first user upload after lastData, removed when calculated

  - `data.summary.cgmStats.dates.outdatedSinceLimit` (string)
    Upper limit of the OutdatedSince value to prevent infinite queue duration

  - `data.summary.cgmStats.dates.outdatedReason` (array)
    List of reasons the summary was marked outdated for

  - `data.summary.cgmStats.periods` (object)
    A map to each supported CGM summary period

  - `data.summary.bgmStats` (object)
    A summary of a users recent BGM glucose values

  - `data.summary.bgmStats.periods` (object)
    A map to each supported BGM summary period

  - `data.reviews` (array,null)

  - `data.reviews.clinicianId` (string, required)

  - `data.reviews.time` (string, required)

  - `data.connectionRequests` (object, required)

  - `data.connectionRequests.twiist` (array, required)

  - `data.connectionRequests.dexcom` (array, required)

  - `data.connectionRequests.abbott` (array, required)

  - `data.sites` (array)

  - `data.sites.id` (string, required)
    String representation of a resource id

  - `data.sites.name` (string, required)
    The site's name.

  - `meta` (object)

  - `meta.count` (integer)
    The number of items matching the filter

  - `meta.totalCount` (integer)
    The total number of items