Skip to content
Tidepool API/Clinics API/Clinics

List Clinics

Request

Retrieve the list of clinics

Security
sessionToken
Query
limitinteger, >= 1
Default:10
offsetinteger, >= 0
shareCodestring
createdTimeStartstring, (date-time)

Return records created after the given date (inclusive)

createdTimeEndstring, (date-time)

Return records created before the given date (exclusive)

ehrEnabledboolean

Retrieve clinics with enabled EHR integration

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics?limit=10&offset=0&shareCode=string&createdTimeStart=2019-08-24T14%3A15%3A22Z&createdTimeEnd=2019-08-24T14%3A15%3A22Z&ehrEnabled=true' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
Array [
idstring, = 24 characters(Clinic ID)^[a-f0-9]{24}$read-onlyrequired

Clinic identifier.

Example:"2fe2488217ee43e1b2e83c2f"
addressstring, non-empty(Street Address)

Street address.

citystring, non-empty(City)

City name.

Example:"Palo Alto"
postalCodestring, non-empty(Postal Code)

Postal code. In the U.S., typically the zip code such as 94301 or 94301-1704.

Example:"94301"
statestring, non-empty(State)

State or province. In the U.S., typically something like CA or California.

Example:"CA"
countrystring, non-empty(Country)

Country name.

Example:"USA"
patientTagsArray of objects(Patient Tag)
sitesArray of objects(Site)
lastDeletedPatientTagobject(Patient Tag)
phoneNumbersArray of objects, non-empty, unique(Phone phoneNumbers)

An array of phone numbers.

Example:
[
  {
    "type": "main",
    "number": "+1 (555) 555-1212"
  }
]
clinicTypestring, non-empty
Enum:"provider_practice""healthcare_system""veterinary_clinic""other""researcher"
clinicSizestring
Enum:"0-249""250-499""500-999""1000+"
namestring, non-empty(Clinic Name)required

Name of the clinic.

shareCodestring(Clinic Share Code)^[ABCDEFGHJKLMNPQRSTUVWXYZ23456789]{4}-[ABCDE...read-onlyrequired

Globally unique share code for a clinic. The share code is 3 groups of 4 uppercase alphanumeric characters in each group. Ambiguous characters such as I and 1, or O and 0 are excluded.

canMigratebooleanread-onlyrequired
websitestring, (uri)
createdTimestring, (date-time)read-onlyrequired
updatedTimestring, (date-time)read-onlyrequired
tierDescriptionstring, non-emptyread-onlyrequired
Example:"Free"
tierstring, non-emptyread-onlyrequired
Example:"tier0100"
preferredBgUnitsstringrequired
Enum:"mg/dL""mmol/L"
suppressedNotificationsobject(Suppressed Notifications)
timezonestring(Clinic Timezone)
Enum:"Africa/Abidjan""Africa/Accra""Africa/Addis_Ababa""Africa/Algiers""Africa/Asmara""Africa/Asmera""Africa/Bamako""Africa/Bangui""Africa/Banjul""Africa/Bissau"
]
Response
[
  {
    "id": "2fe2488217ee43e1b2e83c2f",
    "address": "string",
    "city": "Palo Alto",
    "postalCode": "94301",
    "state": "CA",
    "country": "USA",
    "patientTags": [ … ],
    "sites": [ … ],
    "lastDeletedPatientTag": { … },
    "phoneNumbers": [ … ],
    "clinicType": "provider_practice",
    "clinicSize": "0-249",
    "name": "string",
    "shareCode": "string",
    "canMigrate": true,
    "website": "http://example.com",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "tierDescription": "Free",
    "tier": "tier0100",
    "preferredBgUnits": "mg/dL",
    "suppressedNotifications": { … },
    "timezone": "Africa/Abidjan"
  }
]