Skip to content
Tidepool API/Clinics API/
/
List Membership Restricti...

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

Delete Patient Tag From Clinic Patients

Request

Delete a patient tag from all or a subset of clinic patients

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

Pass an array of patient IDs to target a subset of the clinic patients. Omit request body to target all clinic patients.

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/delete_tag/{patientTagId}' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '[
    "string"
  ]'

Responses

OK

List Membership Restrictions

Request

Returns a list of the membership restrictions that will be evaluated when a user joins a clinic.

Only clinic admins can access this endpoint.

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/membership_restrictions' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
restrictionsArray of objects(Membership Restriction)
Response
application/json
{
  "restrictions": [
    { … }
  ]
}

Update Membership Restrictions

Request

An internal endpoint to update clinic membership restrictions

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Bodyapplication/json
restrictionsArray of objects(Membership Restriction)
curl -i -X PUT \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/membership_restrictions' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "restrictions": [
      {
        "emailDomain": "example.com",
        "requiredIdp": "string"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
restrictionsArray of objects(Membership Restriction)
Response
application/json
{
  "restrictions": [
    { … }
  ]
}

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