Skip to content
Tidepool API/Clinics API/
/
Send Upload Reminder

Clinics API (1.0)

Web service that stores information about clinics, clinicians and their patients

Download OpenAPI description
clinic.v1.json
clinic.v1.yaml
Overview
URL

https://www.tidepool.org

Tidepool

support@tidepool.org

License

BSD-2-Clause

Languages
Servers
Mock server

https://tidepool.redocly.app/_mock/reference/clinic.v1/

integration

https://external.integration.tidepool.org/

production

https://api.tidepool.org/

dev1

https://dev1.dev.tidepool.org/

qa1

https://qa1.development.tidepool.org/

qa2

https://qa2.development.tidepool.org/

Clinics

Manage clinics, clinians and patients.

Operations

Update Suppressed Notifications

Request

Endpoint to update clinic suppressed notifications

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Bodyapplication/json
suppressedNotificationsobject(Suppressed Notifications)required
suppressedNotifications.​patientClinicInvitationboolean
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/suppressed_notifications' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "suppressedNotifications": {
      "patientClinicInvitation": true
    }
  }'

Responses

OK

Send Upload Reminder

Request

Sends upload reminder to the patient

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
patientIdstring^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...required
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patients/{patientId}/upload_reminder' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Assign Patient Tag To Clinic Patients

Request

Assign a patient tag to a subset of clinic patients

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
patientTagIdstring^[a-f0-9]{24}$required
Bodyapplication/json

Array of clinic patient user IDs to target for tag assignment.

Array [
string(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

]
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '[
    "string"
  ]'

Responses

OK

Confirmations

Manage confirmations for account creation, sharing invites, etc.

Operations

Internal

APIs intended for internal use by Tidepool.

Operations

Redox

Public endpoints invoked by Redox.

Operations