Skip to content
Tidepool API/Clinics API/
/
Notification Webhook

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

Confirmations

Manage confirmations for account creation, sharing invites, etc.

Operations

Internal

APIs intended for internal use by Tidepool.

Operations

Get Program Url

Request

Security
sessionToken
curl -i -X PUT \
  https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/xealth/program \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Notification Webhook

Request

Security
sessionToken
curl -i -X POST \
  https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/xealth/notification \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

View PDF Report

Request

View PDF report for a given patient of a clinic

Security
sessionToken
Query
clinicIdstringrequired
patientIdstringrequired
restricted_tokenstringrequired
curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/xealth/report/web/viewer.html?clinicId=string&patientId=string&restricted_token=string' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Redox

Public endpoints invoked by Redox.

Operations