Skip to content
Tidepool API/Clinics API/
/
Get Patient Count Setting...

Get Patient Count Settings

Request

Get Patient Count settings

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

Responses

OK

Bodyapplication/json
hardLimitobject(Patient Count Limit)

The hard limit for the clinic patient count where new patients cannot be created

softLimitobject(Patient Count Limit)

The soft limit for the clinic patient count where new patients may still be created

Response
{
  "hardLimit": {
    "plan": 0,
    "startDate": "2017-02-06T02:37:46Z",
    "endDate": "2017-02-06T02:37:46Z"
  },
  "softLimit": {
    "plan": 0,
    "startDate": "2017-02-06T02:37:46Z",
    "endDate": "2017-02-06T02:37:46Z"
  }
}