Skip to content

Clinics API (1.0)

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

Download OpenAPI description
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

Confirmations

Manage confirmations for account creation, sharing invites, etc.

Operations

Internal

APIs intended for internal use by Tidepool.

Operations

Merge Clinic

Request

Merges tags, patients, clinicians, invites and share codes of the source clinic

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Bodyapplication/json
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/merge' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{}'

Responses

OK

Connect Provider

Request

Send a new request to the patient to connect a data provider

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
providerIdstring(Third-Party Data Providers)required

Provider ID

Enum"dexcom""twiist""abbott"
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

No Content

Redox

Public endpoints invoked by Redox.

Operations