[{"type":"group","fsPath":"reference/access.v1.yaml","metadata":{"type":"openapi","title":"Authorization API","version":"1.0","description":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform. For more information, see the Getting Started section."},"link":"/reference/access.v1","routeSlug":"/reference/access.v1","label":"Authorization API","items":[{"type":"link","label":"Authorization API","link":"/reference/access.v1","routeSlug":"/reference/access.v1"},{"type":"group","label":"Internal","link":"/reference/access.v1/internal","routeSlug":"/reference/access.v1/internal","items":[]},{"type":"group","label":"Authorization","link":"/reference/access.v1/authorization","routeSlug":"/reference/access.v1/authorization","items":[{"label":"Get Groups for User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/access.v1/authorization/getgroupsforuser","routeSlug":"/reference/access.v1/authorization/getgroupsforuser","metadata":{"seo":{"title":"Get Groups for User","description":"Retrieve all groups accessible to the user userId."}},"httpPath":"/access/groups/{userId}"},{"label":"Get Users in Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/access.v1/authorization/getusersingroup","routeSlug":"/reference/access.v1/authorization/getusersingroup","metadata":{"seo":{"title":"Get Users in Group","description":"Retrieve all users that have access to group sharerId."}},"httpPath":"/access/{sharerId}"},{"label":"Get User Permissions in Group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/access.v1/authorization/getpermissionsforuser","routeSlug":"/reference/access.v1/authorization/getpermissionsforuser","metadata":{"seo":{"title":"Get User Permissions in Group","description":"Retrieve permissions of individual user userId in group sharerId."}},"httpPath":"/access/{sharerId}/{userId}"},{"label":"Update Permissions for User in Group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/access.v1/authorization/grantpermissionsingroup","routeSlug":"/reference/access.v1/authorization/grantpermissionsingroup","metadata":{"seo":{"title":"Update Permissions for User in Group","description":"Update permissions of individual user userId in group sharerId. The permissions provided in the request body replace all existing permissions for that user. Therefore to delete a permission, submit the request body without that permission."}},"httpPath":"/access/{sharerId}/{userId}"}]}],"sidebar":[{"type":"link","label":"Authorization API","link":"/reference/access.v1","routeSlug":"/reference/access.v1"}]},{"type":"group","fsPath":"reference/alerts.v1.yaml","metadata":{"type":"openapi","title":"Alerts API","version":"1.0","description":"The Tidepool API is an HTTP REST API used by Tidepool clients to communicate with the Tidepool Platform. For more information, see the Getting Started section."},"link":"/reference/alerts.v1","routeSlug":"/reference/alerts.v1","label":"Alerts API","items":[{"type":"link","label":"Alerts API","link":"/reference/alerts.v1","routeSlug":"/reference/alerts.v1"},{"type":"group","label":"Alerts","link":"/reference/alerts.v1/alerts","routeSlug":"/reference/alerts.v1/alerts","items":[{"label":"Delete an alerts configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/alerts.v1/alerts/deletealertsconfiguration","routeSlug":"/reference/alerts.v1/alerts/deletealertsconfiguration","metadata":{"seo":{"title":"Delete an alerts configuration","description":"Delete an existing alerts configuration."}},"httpPath":"/v1/users/{userId}/followers/{followerUserId}/alerts"},{"label":"Get an alerts configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/alerts.v1/alerts/getalertsconfiguration","routeSlug":"/reference/alerts.v1/alerts/getalertsconfiguration","metadata":{"seo":{"title":"Get an alerts configuration","description":"Retrieve an existing alerts configuration."}},"httpPath":"/v1/users/{userId}/followers/{followerUserId}/alerts"},{"label":"Create or update an alerts configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/alerts.v1/alerts/upsertalertsconfiguration","routeSlug":"/reference/alerts.v1/alerts/upsertalertsconfiguration","metadata":{"seo":{"title":"Create or update an alerts configuration","description":"Create or update an alerts configuration. If no alerts configuration exists, it will be created."}},"httpPath":"/v1/users/{userId}/followers/{followerUserId}/alerts"}]}],"sidebar":[{"type":"link","label":"Alerts API","link":"/reference/alerts.v1","routeSlug":"/reference/alerts.v1"}]},{"type":"group","fsPath":"reference/auth.v2.yaml","metadata":{"type":"openapi","title":"Authentication API","version":"2.0","description":"See the 'Authentication' for description of this API"},"link":"/reference/auth.v2","routeSlug":"/reference/auth.v2","label":"Authentication API","items":[{"type":"link","label":"Authentication API","link":"/reference/auth.v2","routeSlug":"/reference/auth.v2"},{"type":"group","label":"Authentication","link":"/reference/auth.v2/authentication","routeSlug":"/reference/auth.v2/authentication","items":[{"label":"Obtain Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/auth.v2/authentication/obtaintoken","routeSlug":"/reference/auth.v2/authentication/obtaintoken","metadata":{"seo":{"title":"Obtain Token","description":"Obtain an access, id and refresh token(s) by using an authorization code, client credentials or a valid refresh token ."}},"httpPath":"/realms/{realm}/protocol/openid-connect/token"},{"label":"Authorize","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/auth.v2/authentication/authorize","routeSlug":"/reference/auth.v2/authentication/authorize","metadata":{"seo":{"title":"Authorize","description":"The starting point for browser-based OpenID Connect flows. This endpoint authenticates the user and returns an authorization grant or an access token to callback endpoint at the specified redirect_uri."}},"httpPath":"/realms/{realm}/protocol/openid-connect/auth"}]}],"sidebar":[{"type":"link","label":"Authentication API","link":"/reference/auth.v2","routeSlug":"/reference/auth.v2"}]},{"type":"group","fsPath":"reference/blob.v1.yaml","metadata":{"type":"openapi","title":"Blob API","version":"1.0","description":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform. For more information, see the Getting Started section."},"link":"/reference/blob.v1","routeSlug":"/reference/blob.v1","label":"Blob API","items":[{"type":"link","label":"Blob API","link":"/reference/blob.v1","routeSlug":"/reference/blob.v1"},{"type":"group","label":"Internal","link":"/reference/blob.v1/internal","routeSlug":"/reference/blob.v1/internal","items":[]},{"type":"group","label":"Blobs","link":"/reference/blob.v1/blobs","routeSlug":"/reference/blob.v1/blobs","items":[{"label":"List Binary Blobs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/blob.v1/blobs/listblobs","routeSlug":"/reference/blob.v1/blobs/listblobs","metadata":{"seo":{"title":"List Binary Blobs","description":"List previously uploaded binary blobs in the user's account. The list can be filtered with mediaType and status query parameters."}},"httpPath":"/v1/users/{userId}/blobs"},{"label":"Create New Binary Blob","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/blob.v1/blobs/createblob","routeSlug":"/reference/blob.v1/blobs/createblob","metadata":{"seo":{"title":"Create New Binary Blob","description":"Creates a new binary blob in the user's account. The Content-Type and the Digest headers must represent the media type and MD5 hash of the binary blob content, respectively."}},"httpPath":"/v1/users/{userId}/blobs"},{"label":"Delete All Binary Blobs","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/blob.v1/blobs/deleteallblobs","routeSlug":"/reference/blob.v1/blobs/deleteallblobs","metadata":{"seo":{"title":"Delete All Binary Blobs","description":"Deletes all previously uploaded binary blobs in the user's account."}},"httpPath":"/v1/users/{userId}/blobs"},{"label":"Get Binary Blob Metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/blob.v1/blobs/getblobmetadata","routeSlug":"/reference/blob.v1/blobs/getblobmetadata","metadata":{"seo":{"title":"Get Binary Blob Metadata","description":"Get a previously uploaded binary blob in the user's account."}},"httpPath":"/v1/blobs/{blobId}"},{"label":"Delete Binary Blob","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/blob.v1/blobs/deleteblob","routeSlug":"/reference/blob.v1/blobs/deleteblob","metadata":{"seo":{"title":"Delete Binary Blob","description":"Deletes a previously uploaded binary blob in the user's account. This operation fails if the blobId does not match the ID of an existing blob."}},"httpPath":"/v1/blobs/{blobId}"},{"label":"Get Binary Blob Content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/blob.v1/blobs/getblobcontent","routeSlug":"/reference/blob.v1/blobs/getblobcontent","metadata":{"seo":{"title":"Get Binary Blob Content","description":"Retrieves the content of a binary blob in the user's account."}},"httpPath":"/v1/blobs/{blobId}/content"}]},{"type":"group","label":"Device Logs","link":"/reference/blob.v1/device-logs","routeSlug":"/reference/blob.v1/device-logs","items":[{"label":"Upload new device logs as json","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/blob.v1/device-logs/uploaddevicelogs","routeSlug":"/reference/blob.v1/device-logs/uploaddevicelogs","metadata":{"seo":{"title":"Upload new device logs as json","description":"Uploads a new device logs json to the user's account. The Digest header must represent the MD5 hash of the json data content."}},"httpPath":"/v1/users/{userId}/device_logs"},{"label":"List device logs metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/blob.v1/device-logs/listdevicelogs","routeSlug":"/reference/blob.v1/device-logs/listdevicelogs","metadata":{"seo":{"title":"List device logs metadata","description":"List previously uploaded device logs json data in the user's account. The list must be filtered with startAt and endAt parameters"}},"httpPath":"/v1/users/{userId}/device_logs"}]}],"sidebar":[{"type":"link","label":"Blob API","link":"/reference/blob.v1","routeSlug":"/reference/blob.v1"}]},{"type":"group","fsPath":"reference/clinic.v1.yaml","metadata":{"type":"openapi","title":"Clinics API","version":"1.0","description":"Web service that stores information about clinics, clinicians and their patients"},"link":"/reference/clinic.v1","routeSlug":"/reference/clinic.v1","label":"Clinics API","items":[{"type":"link","label":"Clinics API","link":"/reference/clinic.v1","routeSlug":"/reference/clinic.v1"},{"type":"group","label":"Clinics","link":"/reference/clinic.v1/clinics","routeSlug":"/reference/clinic.v1/clinics","items":[{"label":"List Clinics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listclinics","routeSlug":"/reference/clinic.v1/clinics/listclinics","metadata":{"seo":{"title":"List Clinics","description":"Retrieve the list of clinics"}},"httpPath":"/v1/clinics"},{"label":"Create Clinic","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/createclinic","routeSlug":"/reference/clinic.v1/clinics/createclinic","metadata":{"seo":{"title":"Create Clinic","description":"Create a new clinic"}},"httpPath":"/v1/clinics"},{"label":"Get Clinic by Share Code","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getclinicbysharecode","routeSlug":"/reference/clinic.v1/clinics/getclinicbysharecode","metadata":{"seo":{"title":"Get Clinic by Share Code","description":"Retrieve a clinic object with a share code"}},"httpPath":"/v1/clinics/share_code/{shareCode}"},{"label":"Get Clinic","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getclinic","routeSlug":"/reference/clinic.v1/clinics/getclinic","metadata":{"seo":{"title":"Get Clinic","description":"Retrieve a clinic by id"}},"httpPath":"/v1/clinics/{clinicId}"},{"label":"Update Clinic","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updateclinic","routeSlug":"/reference/clinic.v1/clinics/updateclinic","metadata":{"seo":{"title":"Update Clinic","description":"Update an existing clinic"}},"httpPath":"/v1/clinics/{clinicId}"},{"label":"Delete Clinic","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deleteclinic","routeSlug":"/reference/clinic.v1/clinics/deleteclinic","metadata":{"seo":{"title":"Delete Clinic","description":"Deletes a clinic if there are no connected patient accounts (besides demo accounts)."}},"httpPath":"/v1/clinics/{clinicId}"},{"label":"List Clinicians","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listclinicians","routeSlug":"/reference/clinic.v1/clinics/listclinicians","metadata":{"seo":{"title":"List Clinicians","description":"Retrieve the list of clinic members."}},"httpPath":"/v1/clinics/{clinicId}/clinicians"},{"label":"Create Clinician","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/createclinician","routeSlug":"/reference/clinic.v1/clinics/createclinician","metadata":{"seo":{"title":"Create Clinician","description":"Internal endpoint to create a new clinician"}},"httpPath":"/v1/clinics/{clinicId}/clinicians"},{"label":"View TIDE Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/tidereport","routeSlug":"/reference/clinic.v1/clinics/tidereport","metadata":{"seo":{"title":"View TIDE Report","description":"Retrieve a report of patients with tags by TIDE categories"}},"httpPath":"/v1/clinics/{clinicId}/tide_report"},{"label":"List Patients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listpatients","routeSlug":"/reference/clinic.v1/clinics/listpatients","metadata":{"seo":{"title":"List Patients","description":"Retrieve a list of patients of a clinic"}},"httpPath":"/v1/clinics/{clinicId}/patients"},{"label":"Create Patient Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/createpatientaccount","routeSlug":"/reference/clinic.v1/clinics/createpatientaccount","metadata":{"seo":{"title":"Create Patient Account","description":"Create a custodial account for a patient"}},"httpPath":"/v1/clinics/{clinicId}/patients"},{"label":"Create Patient Tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/createpatienttag","routeSlug":"/reference/clinic.v1/clinics/createpatienttag","metadata":{"seo":{"title":"Create Patient Tag","description":"Create a new patient tag"}},"httpPath":"/v1/clinics/{clinicId}/patient_tags"},{"label":"Create a Site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/createsite","routeSlug":"/reference/clinic.v1/clinics/createsite","metadata":{"seo":{"title":"Create a Site","description":"Create a Site"}},"httpPath":"/v1/clinics/{clinicId}/sites"},{"label":"Update a Site","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatesite","routeSlug":"/reference/clinic.v1/clinics/updatesite","metadata":{"seo":{"title":"Update a Site","description":"Update a Site"}},"httpPath":"/v1/clinics/{clinicId}/sites/{siteId}"},{"label":"Delete a Site","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deletesite","routeSlug":"/reference/clinic.v1/clinics/deletesite","metadata":{"seo":{"title":"Delete a Site","description":"Delete a Site"}},"httpPath":"/v1/clinics/{clinicId}/sites/{siteId}"},{"label":"Merge two sites","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/mergesite","routeSlug":"/reference/clinic.v1/clinics/mergesite","metadata":{"seo":{"title":"Merge two sites","description":"Merge a site, identified in the request body, into the site identified in the URL."}},"httpPath":"/v1/clinics/{clinicId}/sites/{siteId}/merge"},{"label":"Get Clinician","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getclinician","routeSlug":"/reference/clinic.v1/clinics/getclinician","metadata":{"seo":{"title":"Get Clinician","description":"Retrieve a member of clinic given their user id"}},"httpPath":"/v1/clinics/{clinicId}/clinicians/{clinicianId}"},{"label":"Update Clinician","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updateclinician","routeSlug":"/reference/clinic.v1/clinics/updateclinician","metadata":{"seo":{"title":"Update Clinician","description":"Update existing clinician"}},"httpPath":"/v1/clinics/{clinicId}/clinicians/{clinicianId}"},{"label":"Delete Clinician","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deleteclinician","routeSlug":"/reference/clinic.v1/clinics/deleteclinician","metadata":{"seo":{"title":"Delete Clinician","description":"Removes a clinician from a clinic"}},"httpPath":"/v1/clinics/{clinicId}/clinicians/{clinicianId}"},{"label":"Get Patient","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getpatient","routeSlug":"/reference/clinic.v1/clinics/getpatient","metadata":{"seo":{"title":"Get Patient","description":"Retrieve a patient of clinic given their user id"}},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}"},{"label":"Create Patient from Existing User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/createpatientfromuser","routeSlug":"/reference/clinic.v1/clinics/createpatientfromuser","metadata":{"seo":{"title":"Create Patient from Existing User","description":"Internal endpoint for creating a patient from an existing user"}},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}"},{"label":"Update Patient","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatepatient","routeSlug":"/reference/clinic.v1/clinics/updatepatient","metadata":{"seo":{"title":"Update Patient","description":"Update existing patient of a clinic"}},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}"},{"label":"Delete Patient","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deletepatient","routeSlug":"/reference/clinic.v1/clinics/deletepatient","metadata":{"seo":{"title":"Delete Patient","description":"Deletes patient from a clinic. Requires the request to be made by a clinic admin or the currently authenticated user id to match the patient id."}},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}"},{"label":"Update Patient Tag","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatepatienttag","routeSlug":"/reference/clinic.v1/clinics/updatepatienttag","metadata":{"seo":{"title":"Update Patient Tag","description":"Update existing patient tag"}},"httpPath":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}"},{"label":"Delete Patient Tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deletepatienttag","routeSlug":"/reference/clinic.v1/clinics/deletepatienttag","metadata":{"seo":{"title":"Delete Patient Tag","description":"Removes a patient tag from a clinic and tagged patients"}},"httpPath":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}"},{"label":"Convert Patient Tag to Site","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/convertpatienttagtosite","routeSlug":"/reference/clinic.v1/clinics/convertpatienttagtosite","metadata":{"seo":{"title":"Convert Patient Tag to Site","description":"Convert a patient tag to a site."}},"httpPath":"/v1/clinics/{clinicId}/patient_tags/{patientTagId}/site"},{"label":"Invite Clinician","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/inviteclinician","routeSlug":"/reference/clinic.v1/clinics/inviteclinician","metadata":{"seo":{"title":"Invite Clinician","description":"Send an invite to clinician's email address to join a clinic."}},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians"},{"label":"Resend Clinician Invite","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/resendinvite","routeSlug":"/reference/clinic.v1/clinics/resendinvite","metadata":{"seo":{"title":"Resend Clinician Invite","description":"Resend invite to the email address of the clinician."}},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}"},{"label":"Delete Invite","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deleteinvite","routeSlug":"/reference/clinic.v1/clinics/deleteinvite","metadata":{"seo":{"title":"Delete Invite","description":"Deletes unaccepted invite"}},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}"},{"label":"Associate Clinician to User","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/associatecliniciantouser","routeSlug":"/reference/clinic.v1/clinics/associatecliniciantouser","metadata":{"seo":{"title":"Associate Clinician to User","description":"Internal endpoint to associate a clinician to a user."}},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician"},{"label":"Delete Invited Clinician","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deleteinvitedclinician","routeSlug":"/reference/clinic.v1/clinics/deleteinvitedclinician","metadata":{"seo":{"title":"Delete Invited Clinician","description":"Internal endpoint to delete an invited clinician object"}},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician"},{"label":"Get Invited Clinician","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getinvitedclinician","routeSlug":"/reference/clinic.v1/clinics/getinvitedclinician","metadata":{"seo":{"title":"Get Invited Clinician","description":"Internal endpoint to retrieve invited clinician."}},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}/clinician"},{"label":"Get Patient Invites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getpatientinvites","routeSlug":"/reference/clinic.v1/clinics/getpatientinvites","metadata":{"seo":{"title":"Get Patient Invites","description":"Retrieve the list of all pending invites from users who would like to share their accounts with the clinic and become patients."}},"httpPath":"/v1/clinics/{clinicId}/invites/patients"},{"label":"Accept Patient Invitation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/acceptpatientinvitation","routeSlug":"/reference/clinic.v1/clinics/acceptpatientinvitation","metadata":{"seo":{"title":"Accept Patient Invitation","description":"Accept a pending invite from a user who would like to share their account with the clinic and become a patient."}},"httpPath":"/v1/clinics/{clinicId}/invites/patients/{inviteId}"},{"label":"Update Patient Reviews","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatepatientreviews","routeSlug":"/reference/clinic.v1/clinics/updatepatientreviews","metadata":{"seo":{"title":"Update Patient Reviews","description":"Update the patient's last reviewed date and clinician ID"}},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}/reviews"},{"label":"Delete Patient Reviews","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deletepatientreviews","routeSlug":"/reference/clinic.v1/clinics/deletepatientreviews","metadata":{"seo":{"title":"Delete Patient Reviews","description":"Revert the patient's last reviewed date to the previous set"}},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}/reviews"},{"label":"Update Patient Permissions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatepatientpermissions","routeSlug":"/reference/clinic.v1/clinics/updatepatientpermissions","metadata":{"seo":{"title":"Update Patient Permissions","description":"Update permissions that a clinic has over a patient account. If all permissions are revoked as a result of the update, the patient profile will be removed from the clinic."}},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}/permissions"},{"label":"Delete Patient Permission","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deletepatientpermission","routeSlug":"/reference/clinic.v1/clinics/deletepatientpermission","metadata":{"seo":{"title":"Delete Patient Permission","description":"Remove a single permission that a clinic has over a patient account. If all permissions are revoked as a result of the update, the patient profile will be removed from the clinic."}},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}/permissions/{permission}"},{"label":"List Clinics for Patient","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listclinicsforpatient","routeSlug":"/reference/clinic.v1/clinics/listclinicsforpatient","metadata":{"seo":{"title":"List Clinics for Patient","description":"Get all clinics a user is a patient of"}},"httpPath":"/v1/patients/{userId}/clinics"},{"label":"List Clinician Invites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listclinicianinvites","routeSlug":"/reference/clinic.v1/clinics/listclinicianinvites","metadata":{"seo":{"title":"List Clinician Invites","description":"Retrieve a list of the outstanding invites to join a clinic"}},"httpPath":"/v1/clinicians/{userId}/invites"},{"label":"Dismiss Clinician Invite","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/dismissclinicianinvite","routeSlug":"/reference/clinic.v1/clinics/dismissclinicianinvite","metadata":{"seo":{"title":"Dismiss Clinician Invite","description":"Dismisses an invite sent from a clinic to clinician"}},"httpPath":"/v1/clinicians/{userId}/invites/{inviteId}"},{"label":"Accept Clinician Invite","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/acceptclinicianinvite","routeSlug":"/reference/clinic.v1/clinics/acceptclinicianinvite","metadata":{"seo":{"title":"Accept Clinician Invite","description":"Accept an invite to join a clinic as clinician. The clinician will be associated to the currently authenticated user if the email in their profile matches the email of the invite."}},"httpPath":"/v1/clinicians/{userId}/invites/{inviteId}"},{"label":"List Clinics for Clinician","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listclinicsforclinician","routeSlug":"/reference/clinic.v1/clinics/listclinicsforclinician","metadata":{"seo":{"title":"List Clinics for Clinician","description":"Returns a list of all clinics a clinician is a member of"}},"httpPath":"/v1/clinicians/{userId}/clinics"},{"label":"Migrate Legacy Clinician Patients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/migratelegacyclinicianpatients","routeSlug":"/reference/clinic.v1/clinics/migratelegacyclinicianpatients","metadata":{"seo":{"title":"Migrate Legacy Clinician Patients","description":"Migrate the patients of a legacy clinic account."}},"httpPath":"/v1/clinics/{clinicId}/migrations"},{"label":"Retrieve Migration Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listmigrations","routeSlug":"/reference/clinic.v1/clinics/listmigrations","metadata":{"seo":{"title":"Retrieve Migration Status","description":"ListMigrations"}},"httpPath":"/v1/clinics/{clinicId}/migrations"},{"label":"Enable Clinics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/enablenewclinicexperience","routeSlug":"/reference/clinic.v1/clinics/enablenewclinicexperience","metadata":{"seo":{"title":"Enable Clinics","description":"Internal only endpoint to enable new clinic experience for a legacy clinician account. Patients won't be migrated until the clinic details are populated and migration is explicitly kicked-off by blip."}},"httpPath":"/v1/clinicians/{userId}/migrate"},{"label":"Trigger initial migration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/triggerinitialmigration","routeSlug":"/reference/clinic.v1/clinics/triggerinitialmigration","metadata":{"seo":{"title":"Trigger initial migration","description":"Trigger the initial migration"}},"httpPath":"/v1/clinics/{clinicId}/migrate"},{"label":"Get Migration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getmigration","routeSlug":"/reference/clinic.v1/clinics/getmigration","metadata":{"seo":{"title":"Get Migration","description":"Get a migration by user id"}},"httpPath":"/v1/clinics/{clinicId}/migrations/{userId}"},{"label":"Update Migration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatemigration","routeSlug":"/reference/clinic.v1/clinics/updatemigration","metadata":{"seo":{"title":"Update Migration","description":"Internal endpoint to update the status of a migration"}},"httpPath":"/v1/clinics/{clinicId}/migrations/{userId}"},{"label":"Remove User from Clinics","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deleteuserfromclinics","routeSlug":"/reference/clinic.v1/clinics/deleteuserfromclinics","metadata":{"seo":{"title":"Remove User from Clinics","description":"Internal endpoint that deletes any user associations with clinics they are a patient or a member of."}},"httpPath":"/v1/users/{userId}/clinics"},{"label":"Update User Details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updateclinicuserdetails","routeSlug":"/reference/clinic.v1/clinics/updateclinicuserdetails","metadata":{"seo":{"title":"Update User Details","description":"Internal endpoint to update clinician details. In the future it may be extended to support patient updates."}},"httpPath":"/v1/users/{userId}/clinics"},{"label":"List All Clinicians","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listallclinicians","routeSlug":"/reference/clinic.v1/clinics/listallclinicians","metadata":{"seo":{"title":"List All Clinicians","description":"Returns list of all clinician/clinic relationships in the system. Internal endpoint used for reporting purposes."}},"httpPath":"/v1/clinicians"},{"label":"UpdatePatientSummary","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatepatientsummary","routeSlug":"/reference/clinic.v1/clinics/updatepatientsummary","metadata":{"seo":{"title":"UpdatePatientSummary","description":"Internal endpoint which updates the summary in all patient records which match the user id."}},"httpPath":"/v1/patients/{patientId}/summary"},{"label":"DeletePatientSummary","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deletepatientsummary","routeSlug":"/reference/clinic.v1/clinics/deletepatientsummary","metadata":{"seo":{"title":"DeletePatientSummary","description":"Internal endpoint which deletes the summary in all patient records which match the summary id."}},"httpPath":"/v1/summaries/{summaryId}/clinics"},{"label":"Create or update a data source for a patient","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatepatientdatasources","routeSlug":"/reference/clinic.v1/clinics/updatepatientdatasources","metadata":{"seo":{"title":"Create or update a data source for a patient","description":"Internal endpoint to upsert patient data source provider details in all their associated clinic records."}},"httpPath":"/v1/patients/{userId}/data_sources"},{"label":"Update Tier","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatetier","routeSlug":"/reference/clinic.v1/clinics/updatetier","metadata":{"seo":{"title":"Update Tier","description":"Internal endpoint to update clinic service tier"}},"httpPath":"/v1/clinics/{clinicId}/tier"},{"label":"Update Suppressed Notifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatesuppressednotifications","routeSlug":"/reference/clinic.v1/clinics/updatesuppressednotifications","metadata":{"seo":{"title":"Update Suppressed Notifications","description":"Endpoint to update clinic suppressed notifications"}},"httpPath":"/v1/clinics/{clinicId}/suppressed_notifications"},{"label":"Send Upload Reminder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/senduploadreminder","routeSlug":"/reference/clinic.v1/clinics/senduploadreminder","metadata":{"seo":{"title":"Send Upload Reminder","description":"Sends upload reminder to the patient"}},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}/upload_reminder"},{"label":"Assign Patient Tag To Clinic Patients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/assignpatienttagtoclinicpatients","routeSlug":"/reference/clinic.v1/clinics/assignpatienttagtoclinicpatients","metadata":{"seo":{"title":"Assign Patient Tag To Clinic Patients","description":"Assign a patient tag to a subset of clinic patients"}},"httpPath":"/v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}"},{"label":"Delete Patient Tag From Clinic Patients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/deletepatienttagfromclinicpatients","routeSlug":"/reference/clinic.v1/clinics/deletepatienttagfromclinicpatients","metadata":{"seo":{"title":"Delete Patient Tag From Clinic Patients","description":"Delete a patient tag from all or a subset of clinic patients"}},"httpPath":"/v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}"},{"label":"List Membership Restrictions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/listmembershiprestrictions","routeSlug":"/reference/clinic.v1/clinics/listmembershiprestrictions","metadata":{"seo":{"title":"List Membership Restrictions","description":"Returns a list of the membership restrictions that will be evaluated when a user joins a clinic."}},"httpPath":"/v1/clinics/{clinicId}/membership_restrictions"},{"label":"Update Membership Restrictions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatemembershiprestrictions","routeSlug":"/reference/clinic.v1/clinics/updatemembershiprestrictions","metadata":{"seo":{"title":"Update Membership Restrictions","description":"An internal endpoint to update clinic membership restrictions"}},"httpPath":"/v1/clinics/{clinicId}/membership_restrictions"},{"label":"Redox EHR Endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/processehrmessage","routeSlug":"/reference/clinic.v1/clinics/processehrmessage","metadata":{"seo":{"title":"Redox EHR Endpoint","description":"An endpoint for incoming Redox messages"}},"httpPath":"/v1/redox"},{"label":"Redox Verify Endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/verifyendpoint","routeSlug":"/reference/clinic.v1/clinics/verifyendpoint","metadata":{"seo":{"title":"Redox Verify Endpoint","description":"Internal endpoint for Redox challenge verification"}},"httpPath":"/v1/redox/verify"},{"label":"Get EHR Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getehrsettings","routeSlug":"/reference/clinic.v1/clinics/getehrsettings","metadata":{"seo":{"title":"Get EHR Settings","description":"Returns EHR related settings"}},"httpPath":"/v1/clinics/{clinicId}/settings/ehr"},{"label":"Update EHR Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updateehrsettings","routeSlug":"/reference/clinic.v1/clinics/updateehrsettings","metadata":{"seo":{"title":"Update EHR Settings","description":"Update EHR related settings for a clinic"}},"httpPath":"/v1/clinics/{clinicId}/settings/ehr"},{"label":"Match Clinic and Patient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/matchclinicandpatient","routeSlug":"/reference/clinic.v1/clinics/matchclinicandpatient","metadata":{"seo":{"title":"Match Clinic and Patient","description":"An internal endpoint used for matching an EHR request (e.g. NewOrder) to a clinic and patient."}},"httpPath":"/v1/redox/match"},{"label":"Get MRN Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getmrnsettings","routeSlug":"/reference/clinic.v1/clinics/getmrnsettings","metadata":{"seo":{"title":"Get MRN Settings","description":"Retrieve MRN settings"}},"httpPath":"/v1/clinics/{clinicId}/settings/mrn"},{"label":"Update MRN Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatemrnsettings","routeSlug":"/reference/clinic.v1/clinics/updatemrnsettings","metadata":{"seo":{"title":"Update MRN Settings","description":"Update MRN Settings"}},"httpPath":"/v1/clinics/{clinicId}/settings/mrn"},{"label":"Get Patient Count Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getpatientcountsettings","routeSlug":"/reference/clinic.v1/clinics/getpatientcountsettings","metadata":{"seo":{"title":"Get Patient Count Settings","description":"Get Patient Count settings"}},"httpPath":"/v1/clinics/{clinicId}/settings/patient_count"},{"label":"Update Patient Count Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/updatepatientcountsettings","routeSlug":"/reference/clinic.v1/clinics/updatepatientcountsettings","metadata":{"seo":{"title":"Update Patient Count Settings","description":"Update Patient Count Settings"}},"httpPath":"/v1/clinics/{clinicId}/settings/patient_count"},{"label":"Get Patient Count","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/getpatientcount","routeSlug":"/reference/clinic.v1/clinics/getpatientcount","metadata":{"seo":{"title":"Get Patient Count","description":"Get Patient Count"}},"httpPath":"/v1/clinics/{clinicId}/patient_count"},{"label":"Refresh Patient Count","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/refreshpatientcount","routeSlug":"/reference/clinic.v1/clinics/refreshpatientcount","metadata":{"seo":{"title":"Refresh Patient Count","description":"An internal endpoint to refresh the patient count for the specified clinic."}},"httpPath":"/v1/clinics/{clinicId}/patient_count/refresh"},{"label":"Sync EHR Data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/syncehrdata","routeSlug":"/reference/clinic.v1/clinics/syncehrdata","metadata":{"seo":{"title":"Sync EHR Data","description":"An internal endpoint which will push the latest patient summary statistics and PDF reports for all patients who have an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled for each patient of the clinic with an active subscription."}},"httpPath":"/v1/clinics/{clinicId}/ehr/sync"},{"label":"Find Patients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/findpatients","routeSlug":"/reference/clinic.v1/clinics/findpatients","metadata":{"seo":{"title":"Find Patients","description":"Returns all patients to which the clinician has access to"}},"httpPath":"/v1/patients"},{"label":"Preorder Form Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/xealthpreorder","routeSlug":"/reference/clinic.v1/clinics/xealthpreorder","metadata":{"seo":{"title":"Preorder Form Webhook","description":"The Preorder endpoint can be invoked when a care provider attempts to place an order manually within the EHR. Subscribers can use Preorder Forms to present additional information to, or receive input from, a care provider before an order can be placed. Preorder Forms can also be implemented so as to prevent an order from being placed entirely."}},"httpPath":"/v1/xealth/preorder"},{"label":"Get Programs","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/xealthgetprograms","routeSlug":"/reference/clinic.v1/clinics/xealthgetprograms","metadata":{"seo":{"title":"Get Programs","description":"Get programs"}},"httpPath":"/v1/xealth/programs"},{"label":"Get Program Url","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/xealthgetprogramurl","routeSlug":"/reference/clinic.v1/clinics/xealthgetprogramurl","metadata":{"seo":{"title":"Get Program Url","description":"Get program URL"}},"httpPath":"/v1/xealth/program"},{"label":"Notification Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/xealthnotification","routeSlug":"/reference/clinic.v1/clinics/xealthnotification","metadata":{"seo":{"title":"Notification Webhook","description":"Notification webhook"}},"httpPath":"/v1/xealth/notification"},{"label":"View PDF Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/viewpdfreport","routeSlug":"/reference/clinic.v1/clinics/viewpdfreport","metadata":{"seo":{"title":"View PDF Report","description":"View PDF report for a given patient of a clinic"}},"httpPath":"/v1/xealth/report/web/viewer.html"},{"label":"Add Service Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/addserviceaccount","routeSlug":"/reference/clinic.v1/clinics/addserviceaccount","metadata":{"seo":{"title":"Add Service Account","description":"Adds authentication client's service account as a new clinician member."}},"httpPath":"/v1/clinics/{clinicId}/service_accounts"},{"label":"Sync EHR Data for Patient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/syncehrdataforpatient","routeSlug":"/reference/clinic.v1/clinics/syncehrdataforpatient","metadata":{"seo":{"title":"Sync EHR Data for Patient","description":"An internal endpoint which will push the latest patient summary statistics and PDF reports to all EHR enabled clinics for which the patient has an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled."}},"httpPath":"/v1/patients/{patientId}/ehr/sync"},{"label":"Generate Clinic Merge Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/generatemergereport","routeSlug":"/reference/clinic.v1/clinics/generatemergereport","metadata":{"seo":{"title":"Generate Clinic Merge Report","description":"Generates a spreadsheet report for merging two clinics"}},"httpPath":"/v1/clinics/{clinicId}/reports/merge"},{"label":"Merge Clinic","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/mergeclinic","routeSlug":"/reference/clinic.v1/clinics/mergeclinic","metadata":{"seo":{"title":"Merge Clinic","description":"Merges tags, patients, clinicians, invites and share codes of the source clinic"}},"httpPath":"/v1/clinics/{clinicId}/merge"},{"label":"Connect Provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/clinics/connectprovider","routeSlug":"/reference/clinic.v1/clinics/connectprovider","metadata":{"seo":{"title":"Connect Provider","description":"Send a new request to the patient to connect a data provider"}},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}"}]},{"type":"group","label":"Confirmations","link":"/reference/clinic.v1/confirmations","routeSlug":"/reference/clinic.v1/confirmations","items":[{"label":"Invite Clinician","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/inviteclinician","routeSlug":"/reference/clinic.v1/confirmations/inviteclinician","metadata":{"seo":{"title":"Invite Clinician","description":"Send an invite to clinician's email address to join a clinic."}},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians"},{"label":"Resend Clinician Invite","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/resendinvite","routeSlug":"/reference/clinic.v1/confirmations/resendinvite","metadata":{"seo":{"title":"Resend Clinician Invite","description":"Resend invite to the email address of the clinician."}},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}"},{"label":"Delete Invite","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/deleteinvite","routeSlug":"/reference/clinic.v1/confirmations/deleteinvite","metadata":{"seo":{"title":"Delete Invite","description":"Deletes unaccepted invite"}},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}"},{"label":"Get Clinician Invite","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/getclinicianinvite","routeSlug":"/reference/clinic.v1/confirmations/getclinicianinvite","metadata":{"seo":{"title":"Get Clinician Invite","description":"Retrieve an invitation sent to clinician to join the clinic"}},"httpPath":"/v1/clinics/{clinicId}/invites/clinicians/{inviteId}"},{"label":"Get Patient Invites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/getpatientinvites","routeSlug":"/reference/clinic.v1/confirmations/getpatientinvites","metadata":{"seo":{"title":"Get Patient Invites","description":"Retrieve the list of all pending invites from users who would like to share their accounts with the clinic and become patients."}},"httpPath":"/v1/clinics/{clinicId}/invites/patients"},{"label":"Accept Patient Invitation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/acceptpatientinvitation","routeSlug":"/reference/clinic.v1/confirmations/acceptpatientinvitation","metadata":{"seo":{"title":"Accept Patient Invitation","description":"Accept a pending invite from a user who would like to share their account with the clinic and become a patient."}},"httpPath":"/v1/clinics/{clinicId}/invites/patients/{inviteId}"},{"label":"List Clinician Invites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/listclinicianinvites","routeSlug":"/reference/clinic.v1/confirmations/listclinicianinvites","metadata":{"seo":{"title":"List Clinician Invites","description":"Retrieve a list of the outstanding invites to join a clinic"}},"httpPath":"/v1/clinicians/{userId}/invites"},{"label":"Dismiss Clinician Invite","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/dismissclinicianinvite","routeSlug":"/reference/clinic.v1/confirmations/dismissclinicianinvite","metadata":{"seo":{"title":"Dismiss Clinician Invite","description":"Dismisses an invite sent from a clinic to clinician"}},"httpPath":"/v1/clinicians/{userId}/invites/{inviteId}"},{"label":"Accept Clinician Invite","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/confirmations/acceptclinicianinvite","routeSlug":"/reference/clinic.v1/confirmations/acceptclinicianinvite","metadata":{"seo":{"title":"Accept Clinician Invite","description":"Accept an invite to join a clinic as clinician. The clinician will be associated to the currently authenticated user if the email in their profile matches the email of the invite."}},"httpPath":"/v1/clinicians/{userId}/invites/{inviteId}"}]},{"type":"group","label":"Internal","link":"/reference/clinic.v1/internal","routeSlug":"/reference/clinic.v1/internal","items":[{"label":"Migrate Legacy Clinician Patients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/migratelegacyclinicianpatients","routeSlug":"/reference/clinic.v1/internal/migratelegacyclinicianpatients","metadata":{"seo":{"title":"Migrate Legacy Clinician Patients","description":"Migrate the patients of a legacy clinic account."}},"httpPath":"/v1/clinics/{clinicId}/migrations"},{"label":"Retrieve Migration Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/listmigrations","routeSlug":"/reference/clinic.v1/internal/listmigrations","metadata":{"seo":{"title":"Retrieve Migration Status","description":"ListMigrations"}},"httpPath":"/v1/clinics/{clinicId}/migrations"},{"label":"Enable Clinics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/enablenewclinicexperience","routeSlug":"/reference/clinic.v1/internal/enablenewclinicexperience","metadata":{"seo":{"title":"Enable Clinics","description":"Internal only endpoint to enable new clinic experience for a legacy clinician account. Patients won't be migrated until the clinic details are populated and migration is explicitly kicked-off by blip."}},"httpPath":"/v1/clinicians/{userId}/migrate"},{"label":"Trigger initial migration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/triggerinitialmigration","routeSlug":"/reference/clinic.v1/internal/triggerinitialmigration","metadata":{"seo":{"title":"Trigger initial migration","description":"Trigger the initial migration"}},"httpPath":"/v1/clinics/{clinicId}/migrate"},{"label":"Get Migration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/getmigration","routeSlug":"/reference/clinic.v1/internal/getmigration","metadata":{"seo":{"title":"Get Migration","description":"Get a migration by user id"}},"httpPath":"/v1/clinics/{clinicId}/migrations/{userId}"},{"label":"Update Migration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updatemigration","routeSlug":"/reference/clinic.v1/internal/updatemigration","metadata":{"seo":{"title":"Update Migration","description":"Internal endpoint to update the status of a migration"}},"httpPath":"/v1/clinics/{clinicId}/migrations/{userId}"},{"label":"Remove User from Clinics","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/deleteuserfromclinics","routeSlug":"/reference/clinic.v1/internal/deleteuserfromclinics","metadata":{"seo":{"title":"Remove User from Clinics","description":"Internal endpoint that deletes any user associations with clinics they are a patient or a member of."}},"httpPath":"/v1/users/{userId}/clinics"},{"label":"Update User Details","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updateclinicuserdetails","routeSlug":"/reference/clinic.v1/internal/updateclinicuserdetails","metadata":{"seo":{"title":"Update User Details","description":"Internal endpoint to update clinician details. In the future it may be extended to support patient updates."}},"httpPath":"/v1/users/{userId}/clinics"},{"label":"List All Clinicians","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/listallclinicians","routeSlug":"/reference/clinic.v1/internal/listallclinicians","metadata":{"seo":{"title":"List All Clinicians","description":"Returns list of all clinician/clinic relationships in the system. Internal endpoint used for reporting purposes."}},"httpPath":"/v1/clinicians"},{"label":"UpdatePatientSummary","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updatepatientsummary","routeSlug":"/reference/clinic.v1/internal/updatepatientsummary","metadata":{"seo":{"title":"UpdatePatientSummary","description":"Internal endpoint which updates the summary in all patient records which match the user id."}},"httpPath":"/v1/patients/{patientId}/summary"},{"label":"DeletePatientSummary","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/deletepatientsummary","routeSlug":"/reference/clinic.v1/internal/deletepatientsummary","metadata":{"seo":{"title":"DeletePatientSummary","description":"Internal endpoint which deletes the summary in all patient records which match the summary id."}},"httpPath":"/v1/summaries/{summaryId}/clinics"},{"label":"Create or update a data source for a patient","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updatepatientdatasources","routeSlug":"/reference/clinic.v1/internal/updatepatientdatasources","metadata":{"seo":{"title":"Create or update a data source for a patient","description":"Internal endpoint to upsert patient data source provider details in all their associated clinic records."}},"httpPath":"/v1/patients/{userId}/data_sources"},{"label":"Update Tier","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updatetier","routeSlug":"/reference/clinic.v1/internal/updatetier","metadata":{"seo":{"title":"Update Tier","description":"Internal endpoint to update clinic service tier"}},"httpPath":"/v1/clinics/{clinicId}/tier"},{"label":"Assign Patient Tag To Clinic Patients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/assignpatienttagtoclinicpatients","routeSlug":"/reference/clinic.v1/internal/assignpatienttagtoclinicpatients","metadata":{"seo":{"title":"Assign Patient Tag To Clinic Patients","description":"Assign a patient tag to a subset of clinic patients"}},"httpPath":"/v1/clinics/{clinicId}/patients/assign_tag/{patientTagId}"},{"label":"Delete Patient Tag From Clinic Patients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/deletepatienttagfromclinicpatients","routeSlug":"/reference/clinic.v1/internal/deletepatienttagfromclinicpatients","metadata":{"seo":{"title":"Delete Patient Tag From Clinic Patients","description":"Delete a patient tag from all or a subset of clinic patients"}},"httpPath":"/v1/clinics/{clinicId}/patients/delete_tag/{patientTagId}"},{"label":"Update Membership Restrictions","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updatemembershiprestrictions","routeSlug":"/reference/clinic.v1/internal/updatemembershiprestrictions","metadata":{"seo":{"title":"Update Membership Restrictions","description":"An internal endpoint to update clinic membership restrictions"}},"httpPath":"/v1/clinics/{clinicId}/membership_restrictions"},{"label":"Redox EHR Endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/processehrmessage","routeSlug":"/reference/clinic.v1/internal/processehrmessage","metadata":{"seo":{"title":"Redox EHR Endpoint","description":"An endpoint for incoming Redox messages"}},"httpPath":"/v1/redox"},{"label":"Redox Verify Endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/verifyendpoint","routeSlug":"/reference/clinic.v1/internal/verifyendpoint","metadata":{"seo":{"title":"Redox Verify Endpoint","description":"Internal endpoint for Redox challenge verification"}},"httpPath":"/v1/redox/verify"},{"label":"Get EHR Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/getehrsettings","routeSlug":"/reference/clinic.v1/internal/getehrsettings","metadata":{"seo":{"title":"Get EHR Settings","description":"Returns EHR related settings"}},"httpPath":"/v1/clinics/{clinicId}/settings/ehr"},{"label":"Update EHR Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updateehrsettings","routeSlug":"/reference/clinic.v1/internal/updateehrsettings","metadata":{"seo":{"title":"Update EHR Settings","description":"Update EHR related settings for a clinic"}},"httpPath":"/v1/clinics/{clinicId}/settings/ehr"},{"label":"Match Clinic and Patient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/matchclinicandpatient","routeSlug":"/reference/clinic.v1/internal/matchclinicandpatient","metadata":{"seo":{"title":"Match Clinic and Patient","description":"An internal endpoint used for matching an EHR request (e.g. NewOrder) to a clinic and patient."}},"httpPath":"/v1/redox/match"},{"label":"Get MRN Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/getmrnsettings","routeSlug":"/reference/clinic.v1/internal/getmrnsettings","metadata":{"seo":{"title":"Get MRN Settings","description":"Retrieve MRN settings"}},"httpPath":"/v1/clinics/{clinicId}/settings/mrn"},{"label":"Update MRN Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updatemrnsettings","routeSlug":"/reference/clinic.v1/internal/updatemrnsettings","metadata":{"seo":{"title":"Update MRN Settings","description":"Update MRN Settings"}},"httpPath":"/v1/clinics/{clinicId}/settings/mrn"},{"label":"Update Patient Count Settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/updatepatientcountsettings","routeSlug":"/reference/clinic.v1/internal/updatepatientcountsettings","metadata":{"seo":{"title":"Update Patient Count Settings","description":"Update Patient Count Settings"}},"httpPath":"/v1/clinics/{clinicId}/settings/patient_count"},{"label":"Refresh Patient Count","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/refreshpatientcount","routeSlug":"/reference/clinic.v1/internal/refreshpatientcount","metadata":{"seo":{"title":"Refresh Patient Count","description":"An internal endpoint to refresh the patient count for the specified clinic."}},"httpPath":"/v1/clinics/{clinicId}/patient_count/refresh"},{"label":"Sync EHR Data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/syncehrdata","routeSlug":"/reference/clinic.v1/internal/syncehrdata","metadata":{"seo":{"title":"Sync EHR Data","description":"An internal endpoint which will push the latest patient summary statistics and PDF reports for all patients who have an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled for each patient of the clinic with an active subscription."}},"httpPath":"/v1/clinics/{clinicId}/ehr/sync"},{"label":"Preorder Form Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/xealthpreorder","routeSlug":"/reference/clinic.v1/internal/xealthpreorder","metadata":{"seo":{"title":"Preorder Form Webhook","description":"The Preorder endpoint can be invoked when a care provider attempts to place an order manually within the EHR. Subscribers can use Preorder Forms to present additional information to, or receive input from, a care provider before an order can be placed. Preorder Forms can also be implemented so as to prevent an order from being placed entirely."}},"httpPath":"/v1/xealth/preorder"},{"label":"Get Programs","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/xealthgetprograms","routeSlug":"/reference/clinic.v1/internal/xealthgetprograms","metadata":{"seo":{"title":"Get Programs","description":"Get programs"}},"httpPath":"/v1/xealth/programs"},{"label":"Get Program Url","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/xealthgetprogramurl","routeSlug":"/reference/clinic.v1/internal/xealthgetprogramurl","metadata":{"seo":{"title":"Get Program Url","description":"Get program URL"}},"httpPath":"/v1/xealth/program"},{"label":"Notification Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/xealthnotification","routeSlug":"/reference/clinic.v1/internal/xealthnotification","metadata":{"seo":{"title":"Notification Webhook","description":"Notification webhook"}},"httpPath":"/v1/xealth/notification"},{"label":"View PDF Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/viewpdfreport","routeSlug":"/reference/clinic.v1/internal/viewpdfreport","metadata":{"seo":{"title":"View PDF Report","description":"View PDF report for a given patient of a clinic"}},"httpPath":"/v1/xealth/report/web/viewer.html"},{"label":"Add Service Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/addserviceaccount","routeSlug":"/reference/clinic.v1/internal/addserviceaccount","metadata":{"seo":{"title":"Add Service Account","description":"Adds authentication client's service account as a new clinician member."}},"httpPath":"/v1/clinics/{clinicId}/service_accounts"},{"label":"Sync EHR Data for Patient","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/syncehrdataforpatient","routeSlug":"/reference/clinic.v1/internal/syncehrdataforpatient","metadata":{"seo":{"title":"Sync EHR Data for Patient","description":"An internal endpoint which will push the latest patient summary statistics and PDF reports to all EHR enabled clinics for which the patient has an active subscription. The actual data is pushed asynchronously. A successful response means that an asynchronous task has been scheduled."}},"httpPath":"/v1/patients/{patientId}/ehr/sync"},{"label":"Merge Clinic","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/mergeclinic","routeSlug":"/reference/clinic.v1/internal/mergeclinic","metadata":{"seo":{"title":"Merge Clinic","description":"Merges tags, patients, clinicians, invites and share codes of the source clinic"}},"httpPath":"/v1/clinics/{clinicId}/merge"},{"label":"Connect Provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/internal/connectprovider","routeSlug":"/reference/clinic.v1/internal/connectprovider","metadata":{"seo":{"title":"Connect Provider","description":"Send a new request to the patient to connect a data provider"}},"httpPath":"/v1/clinics/{clinicId}/patients/{patientId}/connect/{providerId}"}]},{"type":"group","label":"Redox","link":"/reference/clinic.v1/redox","routeSlug":"/reference/clinic.v1/redox","items":[{"label":"Redox EHR Endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/redox/processehrmessage","routeSlug":"/reference/clinic.v1/redox/processehrmessage","metadata":{"seo":{"title":"Redox EHR Endpoint","description":"An endpoint for incoming Redox messages"}},"httpPath":"/v1/redox"},{"label":"Redox Verify Endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/clinic.v1/redox/verifyendpoint","routeSlug":"/reference/clinic.v1/redox/verifyendpoint","metadata":{"seo":{"title":"Redox Verify Endpoint","description":"Internal endpoint for Redox challenge verification"}},"httpPath":"/v1/redox/verify"}]}],"sidebar":[{"type":"link","label":"Clinics API","link":"/reference/clinic.v1","routeSlug":"/reference/clinic.v1"}]},{"type":"group","fsPath":"reference/confirm.v1.yaml","metadata":{"type":"openapi","title":"Confirmation API","version":"1.0","description":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform. For more information, see the Getting Started section."},"link":"/reference/confirm.v1","routeSlug":"/reference/confirm.v1","label":"Confirmation API","items":[{"type":"link","label":"Confirmation API","link":"/reference/confirm.v1","routeSlug":"/reference/confirm.v1"},{"type":"group","label":"Internal","link":"/reference/confirm.v1/internal","routeSlug":"/reference/confirm.v1/internal","items":[]},{"type":"group","label":"Confirmations","link":"/reference/confirm.v1/confirmations","routeSlug":"/reference/confirm.v1/confirmations","items":[{"label":"Send Account Signup Confirmation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/sendaccountsignupconfirmation","routeSlug":"/reference/confirm.v1/confirmations/sendaccountsignupconfirmation","metadata":{"seo":{"title":"Send Account Signup Confirmation","description":"Sends account signup confirmation email."}},"httpPath":"/confirm/send/signup/{userId}"},{"label":"Resend account signup confirmation email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/resendaccountsignup","routeSlug":"/reference/confirm.v1/confirmations/resendaccountsignup","metadata":{"seo":{"title":"Resend account signup confirmation email","description":"If a user didn't receive the confirmation email and logs in, they're directed to the confirmation-required page which can offer to resend the confirmation email."}},"httpPath":"/confirm/resend/signup/{email}"},{"label":"Accept Account Signup","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/confirmaccountsignup","routeSlug":"/reference/confirm.v1/confirmations/confirmaccountsignup","metadata":{"seo":{"title":"Accept Account Signup","description":"Marks the account as having been verified. This would be PUT by the web page at the link in the signup email."}},"httpPath":"/confirm/accept/signup/{key}"},{"label":"Dismiss Account Signup","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/dismissaccountsignup","routeSlug":"/reference/confirm.v1/confirmations/dismissaccountsignup","metadata":{"seo":{"title":"Dismiss Account Signup","description":"In the event that someone uses the wrong email address, the receiver could explicitly dismiss a signup"}},"httpPath":"/confirm/dismiss/signup/{userId}"},{"label":"Get Account Signup Confirmation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/getaccountsignupconfirmation","routeSlug":"/reference/confirm.v1/confirmations/getaccountsignupconfirmation","metadata":{"seo":{"title":"Get Account Signup Confirmation","description":"Fetch latest account signup confirmation for the provided userId"}},"httpPath":"/confirm/signup/{userId}"},{"label":"Upsert Account Signup Confirmation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/upsertaccountsignupconfirmation","routeSlug":"/reference/confirm.v1/confirmations/upsertaccountsignupconfirmation","metadata":{"seo":{"title":"Upsert Account Signup Confirmation","description":"Add or refresh an account signup confirmation for the provided userId"}},"httpPath":"/confirm/signup/{userId}"},{"label":"Cancel Account Signup","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/cancelaccountsignupconfirmation","routeSlug":"/reference/confirm.v1/confirmations/cancelaccountsignupconfirmation","metadata":{"seo":{"title":"Cancel Account Signup","description":"Cancels the account signup."}},"httpPath":"/confirm/signup/{userId}"},{"label":"Send Password Reset Email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/sendpasswordreset","routeSlug":"/reference/confirm.v1/confirmations/sendpasswordreset","metadata":{"seo":{"title":"Send Password Reset Email","description":"If the request is correctly formed, always returns a 200, even if the email address was not found (this way it can't be used to validate email addresses). If the email address is found in the Tidepool system, this will: - Create a confirm record and a random key - Send an email with a link containing the key"}},"httpPath":"/confirm/forgot/{email}"},{"label":"Accept password change","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/acceptpasswordchange","routeSlug":"/reference/confirm.v1/confirmations/acceptpasswordchange","metadata":{"seo":{"title":"Accept password change","description":"Accept the password change This endpoint will be invoked by the lost password screen with the key that was included in the URL of the lost password screen."}},"httpPath":"/confirm/accept/forgot"},{"label":"Send Invitation to Join Care Team","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/sendcareteaminvite","routeSlug":"/reference/confirm.v1/confirmations/sendcareteaminvite","metadata":{"seo":{"title":"Send Invitation to Join Care Team","description":"Sends an invitation to join the care team of the user identified by userId."}},"httpPath":"/confirm/send/invite/{userId}"},{"label":"Accept Invitation to Join Care Team","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/acceptcareteaminvite","routeSlug":"/reference/confirm.v1/confirmations/acceptcareteaminvite","metadata":{"seo":{"title":"Accept Invitation to Join Care Team","description":"Accepts the invitation to join a care team."}},"httpPath":"/confirm/accept/invite/{userId}/{invitedBy}"},{"label":"Get Pending Care Team Invitations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/getsentinvitations","routeSlug":"/reference/confirm.v1/confirmations/getsentinvitations","metadata":{"seo":{"title":"Get Pending Care Team Invitations","description":"Returns the still-pending invitations for an account you own or are an admin of. These are the invitations you have sent that have not been accepted. There is no way to tell if an invitation has been ignored."}},"httpPath":"/confirm/invite/{userId}"},{"label":"Get Received Care Team Invitations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/getreceivedinvitations","routeSlug":"/reference/confirm.v1/confirmations/getreceivedinvitations","metadata":{"seo":{"title":"Get Received Care Team Invitations","description":"Get list of received invitations for logged in user. These are invitations that have been sent to this user but not yet acted upon."}},"httpPath":"/confirm/invitations/{userId}"},{"label":"Dismiss Care Team Invitation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/dismissinvite","routeSlug":"/reference/confirm.v1/confirmations/dismissinvite","metadata":{"seo":{"title":"Dismiss Care Team Invitation","description":"Declines the invitation to join a care team."}},"httpPath":"/confirm/dismiss/invite/{userId}/{invitedBy}"},{"label":"Cancel Care Team Invitation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/confirm.v1/confirmations/cancelinvite","routeSlug":"/reference/confirm.v1/confirmations/cancelinvite","metadata":{"seo":{"title":"Cancel Care Team Invitation","description":"Cancels an invitation that has been sent to an email address."}},"httpPath":"/confirm/{userId}/invited/{invitedBy}"}]}],"sidebar":[{"type":"link","label":"Confirmation API","link":"/reference/confirm.v1","routeSlug":"/reference/confirm.v1"}]},{"type":"group","fsPath":"reference/data.v1.yaml","metadata":{"type":"openapi","title":"Data API","version":"1.0","description":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform. For more information, see the Getting Started section."},"link":"/reference/data.v1","routeSlug":"/reference/data.v1","label":"Data API","items":[{"type":"link","label":"Data API","link":"/reference/data.v1","routeSlug":"/reference/data.v1"},{"type":"group","label":"Internal","link":"/reference/data.v1/internal","routeSlug":"/reference/data.v1/internal","items":[{"label":"Create New Data Source for User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/internal/createdatasource","routeSlug":"/reference/data.v1/internal/createdatasource","metadata":{"seo":{"title":"Create New Data Source for User","description":"Creates a new data source for the user specified by the userId. Before creating a new data source, you must first create the data provider session. See the Authentication APIs for the details on how to create data provider sessions."}},"httpPath":"/v1/users/{userId}/data_sources"},{"label":"Delete All Data Sources for User","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/internal/deletealldatasources","routeSlug":"/reference/data.v1/internal/deletealldatasources","metadata":{"seo":{"title":"Delete All Data Sources for User","description":"Deletes all data sources for the user specified by the userId. This does not delete the corresponding data provider sessions. See the Authentication APIs for the details on how to delete data provider sessions."}},"httpPath":"/v1/users/{userId}/data_sources"},{"label":"Update Data Source","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/internal/updatedatasource","routeSlug":"/reference/data.v1/internal/updatedatasource","metadata":{"seo":{"title":"Update Data Source","description":"Updates the data source specified by the dataSourceId. If you want to change the data provider session, you must first create the data provider session. See the Authentication APIs for the details on how to create data provider sessions."}},"httpPath":"/v1/data_sources/{dataSourceId}"},{"label":"Delete Data Source","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/internal/deletedatasource","routeSlug":"/reference/data.v1/internal/deletedatasource","metadata":{"seo":{"title":"Delete Data Source","description":"Deletes data source specified by the dataSourceId. This does not delete the corresponding data provider session. See the Authentication APIs for the details on how to delete data provider sessions."}},"httpPath":"/v1/data_sources/{dataSourceId}"},{"label":"Upload Data (LEGACY)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/internal/uploaddata","routeSlug":"/reference/data.v1/internal/uploaddata","metadata":{"seo":{"title":"Upload Data (LEGACY)","description":"This is a legacy API for uploading diabetes data to user's account. It is deprecated and should not be used."}},"httpPath":"/data/{userId}"}]},{"type":"group","label":"Data","link":"/reference/data.v1/data","routeSlug":"/reference/data.v1/data","items":[{"label":"Delete All Data for User","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/deletealluserdata","routeSlug":"/reference/data.v1/data/deletealluserdata","metadata":{"seo":{"title":"Delete All Data for User","description":"Delete all data for user specified by the userId."}},"httpPath":"/v1/users/{userId}/data"},{"label":"Get Data Sets for User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/getuserdatasets","routeSlug":"/reference/data.v1/data/getuserdatasets","metadata":{"seo":{"title":"Get Data Sets for User","description":"Gets data sets for the user account specified by the userId."}},"httpPath":"/v1/users/{userId}/datasets"},{"label":"Create New Data Set for User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/createdataset","routeSlug":"/reference/data.v1/data/createdataset","metadata":{"seo":{"title":"Create New Data Set for User","description":"Creates a new data set of type upload and data set type dataSetType for the user specified by the userId."}},"httpPath":"/v1/users/{userId}/datasets"},{"label":"List Data Sets for User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/listdatasets","routeSlug":"/reference/data.v1/data/listdatasets","metadata":{"seo":{"title":"List Data Sets for User","description":"Returns a list of data sets for the user specified by the userId."}},"httpPath":"/v1/users/{userId}/data_sets"},{"label":"Create New Data Set for User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/createdataset2","routeSlug":"/reference/data.v1/data/createdataset2","metadata":{"seo":{"title":"Create New Data Set for User","description":"Creates a new data set of type upload and data set type dataSetType for the user specified by the userId."}},"httpPath":"/v1/users/{userId}/data_sets"},{"label":"Update Data Set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/updatedataset","routeSlug":"/reference/data.v1/data/updatedataset","metadata":{"seo":{"title":"Update Data Set","description":"Updates the data set specified by the dataSetId."}},"httpPath":"/v1/datasets/{dataSetId}"},{"label":"Delete Data Set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/deletedataset","routeSlug":"/reference/data.v1/data/deletedataset","metadata":{"seo":{"title":"Delete Data Set","description":"Deletes the data set specified by the dataSetId."}},"httpPath":"/v1/datasets/{dataSetId}"},{"label":"Get Data Set","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/getdataset","routeSlug":"/reference/data.v1/data/getdataset","metadata":{"seo":{"title":"Get Data Set","description":"Returns the data set specified by the dataSetId."}},"httpPath":"/v1/data_sets/{dataSetId}"},{"label":"Update Data Set","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/updatedataset2","routeSlug":"/reference/data.v1/data/updatedataset2","metadata":{"seo":{"title":"Update Data Set","description":"Updates the data set specified by the dataSetId."}},"httpPath":"/v1/data_sets/{dataSetId}"},{"label":"Delete Data Set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/deletedataset2","routeSlug":"/reference/data.v1/data/deletedataset2","metadata":{"seo":{"title":"Delete Data Set","description":"Deletes an entire dataset specified by the dataSetId."}},"httpPath":"/v1/data_sets/{dataSetId}"},{"label":"Upload Data to Data Set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/uploaddatatodataset","routeSlug":"/reference/data.v1/data/uploaddatatodataset","metadata":{"seo":{"title":"Upload Data to Data Set","description":"Uploads data to a user's data set identified by the dataSetId."}},"httpPath":"/v1/datasets/{dataSetId}/data"},{"label":"Upload Data to Data Set","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/uploaddatatodataset2","routeSlug":"/reference/data.v1/data/uploaddatatodataset2","metadata":{"seo":{"title":"Upload Data to Data Set","description":"Uploads data to a user's data set identified by the dataSetId."}},"httpPath":"/v1/data_sets/{dataSetId}/data"},{"label":"Delete Data from Data Set","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/deletedatasetdata","routeSlug":"/reference/data.v1/data/deletedatasetdata","metadata":{"seo":{"title":"Delete Data from Data Set","description":"Deletes data from data set specified by the dataSetId."}},"httpPath":"/v1/data_sets/{dataSetId}/data"},{"label":"Upload twiist Data","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/uploadtwiistdata","routeSlug":"/reference/data.v1/data/uploadtwiistdata","metadata":{"seo":{"title":"Upload twiist Data","description":"Uploads data to a user's data set for twiist."}},"httpPath":"/v1/partners/twiist/data/{dataSetId}"},{"label":"Get Data for User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/getdata","routeSlug":"/reference/data.v1/data/getdata","metadata":{"seo":{"title":"Get Data for User","description":"Get data for the specified userId. You can filter the data to pull with several query parameters."}},"httpPath":"/data/{userId}"},{"label":"List Data Sources for User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/listdatasources","routeSlug":"/reference/data.v1/data/listdatasources","metadata":{"seo":{"title":"List Data Sources for User","description":"Returns a list of data sources for the user specified by the userId."}},"httpPath":"/v1/users/{userId}/data_sources"},{"label":"Create New Data Source for User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/createdatasource","routeSlug":"/reference/data.v1/data/createdatasource","metadata":{"seo":{"title":"Create New Data Source for User","description":"Creates a new data source for the user specified by the userId. Before creating a new data source, you must first create the data provider session. See the Authentication APIs for the details on how to create data provider sessions."}},"httpPath":"/v1/users/{userId}/data_sources"},{"label":"Delete All Data Sources for User","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/deletealldatasources","routeSlug":"/reference/data.v1/data/deletealldatasources","metadata":{"seo":{"title":"Delete All Data Sources for User","description":"Deletes all data sources for the user specified by the userId. This does not delete the corresponding data provider sessions. See the Authentication APIs for the details on how to delete data provider sessions."}},"httpPath":"/v1/users/{userId}/data_sources"},{"label":"Get Data Source","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/getdatasource","routeSlug":"/reference/data.v1/data/getdatasource","metadata":{"seo":{"title":"Get Data Source","description":"Returns the data source specified by the dataSourceId."}},"httpPath":"/v1/data_sources/{dataSourceId}"},{"label":"Update Data Source","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/updatedatasource","routeSlug":"/reference/data.v1/data/updatedatasource","metadata":{"seo":{"title":"Update Data Source","description":"Updates the data source specified by the dataSourceId. If you want to change the data provider session, you must first create the data provider session. See the Authentication APIs for the details on how to create data provider sessions."}},"httpPath":"/v1/data_sources/{dataSourceId}"},{"label":"Delete Data Source","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/deletedatasource","routeSlug":"/reference/data.v1/data/deletedatasource","metadata":{"seo":{"title":"Delete Data Source","description":"Deletes data source specified by the dataSourceId. This does not delete the corresponding data provider session. See the Authentication APIs for the details on how to delete data provider sessions."}},"httpPath":"/v1/data_sources/{dataSourceId}"},{"label":"Upload Data (LEGACY)","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/data.v1/data/uploaddata","routeSlug":"/reference/data.v1/data/uploaddata","metadata":{"seo":{"title":"Upload Data (LEGACY)","description":"This is a legacy API for uploading diabetes data to user's account. It is deprecated and should not be used."}},"httpPath":"/data/{userId}"},{"type":"link","label":"Device Alarm","link":"/reference/data.v1/data/alarm.v1","routeSlug":"/reference/data.v1/data/alarm.v1","httpVerb":"schema"},{"type":"link","label":"Alert","link":"/reference/data.v1/data/alert.v1","routeSlug":"/reference/data.v1/data/alert.v1","httpVerb":"schema"},{"type":"link","label":"Amount","link":"/reference/data.v1/data/amount.v1","routeSlug":"/reference/data.v1/data/amount.v1","httpVerb":"schema"},{"type":"link","label":"Glucose Backfilled","link":"/reference/data.v1/data/backfilled.v1","routeSlug":"/reference/data.v1/data/backfilled.v1","httpVerb":"schema"},{"type":"link","label":"Basal Automated","link":"/reference/data.v1/data/basal-automated.v1","routeSlug":"/reference/data.v1/data/basal-automated.v1","httpVerb":"schema"},{"type":"link","label":"Basal Scheduled","link":"/reference/data.v1/data/basal-scheduled.v1","routeSlug":"/reference/data.v1/data/basal-scheduled.v1","httpVerb":"schema"},{"type":"link","label":"Basal Suspend","link":"/reference/data.v1/data/basal-suspend.v1","routeSlug":"/reference/data.v1/data/basal-suspend.v1","httpVerb":"schema"},{"type":"link","label":"Basal Temporary","link":"/reference/data.v1/data/basal-temporary.v1","routeSlug":"/reference/data.v1/data/basal-temporary.v1","httpVerb":"schema"},{"type":"link","label":"Base","link":"/reference/data.v1/data/base.v1","routeSlug":"/reference/data.v1/data/base.v1","httpVerb":"schema"},{"type":"link","label":"Blood Glucose for Dosing Decision","link":"/reference/data.v1/data/bloodglucose.v1","routeSlug":"/reference/data.v1/data/bloodglucose.v1","httpVerb":"schema"},{"type":"link","label":"Bolus Automated","link":"/reference/data.v1/data/bolus-automated.v1","routeSlug":"/reference/data.v1/data/bolus-automated.v1","httpVerb":"schema"},{"type":"link","label":"Bolus Combination","link":"/reference/data.v1/data/bolus-combination.v1","routeSlug":"/reference/data.v1/data/bolus-combination.v1","httpVerb":"schema"},{"type":"link","label":"Bolus Extended","link":"/reference/data.v1/data/bolus-extended.v1","routeSlug":"/reference/data.v1/data/bolus-extended.v1","httpVerb":"schema"},{"type":"link","label":"Bolus Normal","link":"/reference/data.v1/data/bolus-normal.v1","routeSlug":"/reference/data.v1/data/bolus-normal.v1","httpVerb":"schema"},{"type":"link","label":"Bolus","link":"/reference/data.v1/data/bolus.v1","routeSlug":"/reference/data.v1/data/bolus.v1","httpVerb":"schema"},{"type":"link","label":"Bolus Calculator","link":"/reference/data.v1/data/calculator.v1","routeSlug":"/reference/data.v1/data/calculator.v1","httpVerb":"schema"},{"type":"link","label":"Device Calibration","link":"/reference/data.v1/data/calibration.v1","routeSlug":"/reference/data.v1/data/calibration.v1","httpVerb":"schema"},{"type":"link","label":"CGM Settings","link":"/reference/data.v1/data/cgmsettings.v1","routeSlug":"/reference/data.v1/data/cgmsettings.v1","httpVerb":"schema"},{"type":"link","label":"Client Software","link":"/reference/data.v1/data/clientsoftware.v1","routeSlug":"/reference/data.v1/data/clientsoftware.v1","httpVerb":"schema"},{"type":"link","label":"Clock Drift Offset","link":"/reference/data.v1/data/clockdriftoffset.v1","routeSlug":"/reference/data.v1/data/clockdriftoffset.v1","httpVerb":"schema"},{"type":"link","label":"Insulin Compound","link":"/reference/data.v1/data/compound.v1","routeSlug":"/reference/data.v1/data/compound.v1","httpVerb":"schema"},{"type":"link","label":"Insulin Compound Array","link":"/reference/data.v1/data/compoundarray.v1","routeSlug":"/reference/data.v1/data/compoundarray.v1","httpVerb":"schema"},{"type":"link","label":"Computer Time","link":"/reference/data.v1/data/computertime.v1","routeSlug":"/reference/data.v1/data/computertime.v1","httpVerb":"schema"},{"type":"link","label":"Insulin Concentration","link":"/reference/data.v1/data/concentration.v1","routeSlug":"/reference/data.v1/data/concentration.v1","httpVerb":"schema"},{"type":"link","label":"Continuous Glucose","link":"/reference/data.v1/data/continuousglucose.v1","routeSlug":"/reference/data.v1/data/continuousglucose.v1","httpVerb":"schema"},{"type":"link","label":"Controller Settings","link":"/reference/data.v1/data/controllersettings.v1","routeSlug":"/reference/data.v1/data/controllersettings.v1","httpVerb":"schema"},{"type":"link","label":"Conversion Offset","link":"/reference/data.v1/data/conversionoffset.v1","routeSlug":"/reference/data.v1/data/conversionoffset.v1","httpVerb":"schema"},{"type":"link","label":"Data Source ID","link":"/reference/data.v1/data/data-source-id.v1","routeSlug":"/reference/data.v1/data/data-source-id.v1","httpVerb":"schema"},{"type":"link","label":"Tidepool Diabetes Data","link":"/reference/data.v1/data/data.v1","routeSlug":"/reference/data.v1/data/data.v1","httpVerb":"schema"},{"type":"link","label":"Tidepool Diabetes Data Array","link":"/reference/data.v1/data/dataarray.v1","routeSlug":"/reference/data.v1/data/dataarray.v1","httpVerb":"schema"},{"type":"link","label":"Tidepool Data Set","link":"/reference/data.v1/data/dataset.v1","routeSlug":"/reference/data.v1/data/dataset.v1","httpVerb":"schema"},{"type":"link","label":"Tidepool Data Set Array","link":"/reference/data.v1/data/datasetarray.v1","routeSlug":"/reference/data.v1/data/datasetarray.v1","httpVerb":"schema"},{"type":"link","label":"Data Set ID","link":"/reference/data.v1/data/datasetid.v1","routeSlug":"/reference/data.v1/data/datasetid.v1","httpVerb":"schema"},{"type":"link","label":"Data Set State","link":"/reference/data.v1/data/datasetstate.v1","routeSlug":"/reference/data.v1/data/datasetstate.v1","httpVerb":"schema"},{"type":"link","label":"Data Set Type","link":"/reference/data.v1/data/datasettype.v1","routeSlug":"/reference/data.v1/data/datasettype.v1","httpVerb":"schema"},{"type":"link","label":"Data Source","link":"/reference/data.v1/data/datasource.v1","routeSlug":"/reference/data.v1/data/datasource.v1","httpVerb":"schema"},{"type":"link","label":"Tidepool Data Type","link":"/reference/data.v1/data/datatype.v1","routeSlug":"/reference/data.v1/data/datatype.v1","httpVerb":"schema"},{"type":"link","label":"Deduplicator Descriptor","link":"/reference/data.v1/data/deduplicatordescriptor.v1","routeSlug":"/reference/data.v1/data/deduplicatordescriptor.v1","httpVerb":"schema"},{"type":"link","label":"Device Delivery Status","link":"/reference/data.v1/data/deliverystatus.v1","routeSlug":"/reference/data.v1/data/deliverystatus.v1","httpVerb":"schema"},{"type":"link","label":"Delivery Type","link":"/reference/data.v1/data/deliverytype.v1","routeSlug":"/reference/data.v1/data/deliverytype.v1","httpVerb":"schema"},{"type":"link","label":"Controller Settings Device","link":"/reference/data.v1/data/device.v1","routeSlug":"/reference/data.v1/data/device.v1","httpVerb":"schema"},{"type":"link","label":"Device ID","link":"/reference/data.v1/data/deviceid.v1","routeSlug":"/reference/data.v1/data/deviceid.v1","httpVerb":"schema"},{"type":"link","label":"Device Manufacturers","link":"/reference/data.v1/data/devicemanufacturers.v1","routeSlug":"/reference/data.v1/data/devicemanufacturers.v1","httpVerb":"schema"},{"type":"link","label":"Device Model Name","link":"/reference/data.v1/data/devicemodelname.v1","routeSlug":"/reference/data.v1/data/devicemodelname.v1","httpVerb":"schema"},{"type":"link","label":"Device Serial Number","link":"/reference/data.v1/data/deviceserialnumber.v1","routeSlug":"/reference/data.v1/data/deviceserialnumber.v1","httpVerb":"schema"},{"type":"link","label":"Device Tag","link":"/reference/data.v1/data/devicetag.v1","routeSlug":"/reference/data.v1/data/devicetag.v1","httpVerb":"schema"},{"type":"link","label":"Device Tags","link":"/reference/data.v1/data/devicetags.v1","routeSlug":"/reference/data.v1/data/devicetags.v1","httpVerb":"schema"},{"type":"link","label":"Insulin Dose","link":"/reference/data.v1/data/dose.v1","routeSlug":"/reference/data.v1/data/dose.v1","httpVerb":"schema"},{"type":"link","label":"Dosing Decision","link":"/reference/data.v1/data/dosingdecision.v1","routeSlug":"/reference/data.v1/data/dosingdecision.v1","httpVerb":"schema"},{"type":"link","label":"Device Event","link":"/reference/data.v1/data/event.v1","routeSlug":"/reference/data.v1/data/event.v1","httpVerb":"schema"},{"type":"link","label":"Event History [Proposed]","link":"/reference/data.v1/data/eventhistory.v1","routeSlug":"/reference/data.v1/data/eventhistory.v1","httpVerb":"schema"},{"type":"link","label":"Food","link":"/reference/data.v1/data/food.v1","routeSlug":"/reference/data.v1/data/food.v1","httpVerb":"schema"},{"type":"link","label":"Insulin Formulation","link":"/reference/data.v1/data/formulation.v1","routeSlug":"/reference/data.v1/data/formulation.v1","httpVerb":"schema"},{"type":"link","label":"Water Amount, in Gallons","link":"/reference/data.v1/data/gallons.v1","routeSlug":"/reference/data.v1/data/gallons.v1","httpVerb":"schema"},{"type":"link","label":"Blood Glucose","link":"/reference/data.v1/data/glucose.v1","routeSlug":"/reference/data.v1/data/glucose.v1","httpVerb":"schema"},{"type":"link","label":"Blood Glucose (mg/dL)","link":"/reference/data.v1/data/glucosemgdl.v1","routeSlug":"/reference/data.v1/data/glucosemgdl.v1","httpVerb":"schema"},{"type":"link","label":"Blood Glucose (mmol/L)","link":"/reference/data.v1/data/glucosemmol.v1","routeSlug":"/reference/data.v1/data/glucosemmol.v1","httpVerb":"schema"},{"type":"link","label":"Ingredient","link":"/reference/data.v1/data/ingredient.v1","routeSlug":"/reference/data.v1/data/ingredient.v1","httpVerb":"schema"},{"type":"link","label":"Ingredient Array","link":"/reference/data.v1/data/ingredientarray.v1","routeSlug":"/reference/data.v1/data/ingredientarray.v1","httpVerb":"schema"},{"type":"link","label":"Insulin","link":"/reference/data.v1/data/insulin.v1","routeSlug":"/reference/data.v1/data/insulin.v1","httpVerb":"schema"},{"type":"link","label":"Issue for Dosing Decision","link":"/reference/data.v1/data/issue.v1","routeSlug":"/reference/data.v1/data/issue.v1","httpVerb":"schema"},{"type":"link","label":"Blood Ketone","link":"/reference/data.v1/data/ketone.v1","routeSlug":"/reference/data.v1/data/ketone.v1","httpVerb":"schema"},{"type":"link","label":"Water Amount, in Liters","link":"/reference/data.v1/data/liters.v1","routeSlug":"/reference/data.v1/data/liters.v1","httpVerb":"schema"},{"type":"link","label":"Metadata","link":"/reference/data.v1/data/metadata.v1","routeSlug":"/reference/data.v1/data/metadata.v1","httpVerb":"schema"},{"type":"link","label":"Water Amount, in Milliliters","link":"/reference/data.v1/data/milliliters.v1","routeSlug":"/reference/data.v1/data/milliliters.v1","httpVerb":"schema"},{"type":"link","label":"New Tidepool Diabetes Data Set","link":"/reference/data.v1/data/newdataset.v1","routeSlug":"/reference/data.v1/data/newdataset.v1","httpVerb":"schema"},{"type":"link","label":"New Data Source","link":"/reference/data.v1/data/newdatasource.v1","routeSlug":"/reference/data.v1/data/newdatasource.v1","httpVerb":"schema"},{"type":"link","label":"Controller Settings Notifications","link":"/reference/data.v1/data/notifications.v1","routeSlug":"/reference/data.v1/data/notifications.v1","httpVerb":"schema"},{"type":"link","label":"Other State","link":"/reference/data.v1/data/otherstate.v1","routeSlug":"/reference/data.v1/data/otherstate.v1","httpVerb":"schema"},{"type":"link","label":"Water Amount, in Ounces","link":"/reference/data.v1/data/ounces.v1","routeSlug":"/reference/data.v1/data/ounces.v1","httpVerb":"schema"},{"type":"link","label":"Pump Settings Override Preset","link":"/reference/data.v1/data/overridepreset.v1","routeSlug":"/reference/data.v1/data/overridepreset.v1","httpVerb":"schema"},{"type":"link","label":"Physical Activity","link":"/reference/data.v1/data/physical.v1","routeSlug":"/reference/data.v1/data/physical.v1","httpVerb":"schema"},{"type":"link","label":"Client Software Platform","link":"/reference/data.v1/data/platform.v1","routeSlug":"/reference/data.v1/data/platform.v1","httpVerb":"schema"},{"type":"link","label":"Device Prime Event","link":"/reference/data.v1/data/prime.v1","routeSlug":"/reference/data.v1/data/prime.v1","httpVerb":"schema"},{"type":"link","label":"Cannula Prime Event","link":"/reference/data.v1/data/primecannula.v1","routeSlug":"/reference/data.v1/data/primecannula.v1","httpVerb":"schema"},{"type":"link","label":"Tubing Prime Event","link":"/reference/data.v1/data/primetubing.v1","routeSlug":"/reference/data.v1/data/primetubing.v1","httpVerb":"schema"},{"type":"link","label":"Pump Settings","link":"/reference/data.v1/data/pumpsettings.v1","routeSlug":"/reference/data.v1/data/pumpsettings.v1","httpVerb":"schema"},{"type":"link","label":"Device Pump Settings Override Event","link":"/reference/data.v1/data/pumpsettingsoverride.v1","routeSlug":"/reference/data.v1/data/pumpsettingsoverride.v1","httpVerb":"schema"},{"type":"link","label":"Pump Status","link":"/reference/data.v1/data/pumpstatus.v1","routeSlug":"/reference/data.v1/data/pumpstatus.v1","httpVerb":"schema"},{"type":"link","label":"Glucose Rate Units (mg/dL/minute)","link":"/reference/data.v1/data/rateunits.v1","routeSlug":"/reference/data.v1/data/rateunits.v1","httpVerb":"schema"},{"type":"link","label":"Insulin Recommended","link":"/reference/data.v1/data/recommended.v1","routeSlug":"/reference/data.v1/data/recommended.v1","httpVerb":"schema"},{"type":"link","label":"Reported State","link":"/reference/data.v1/data/reportedstate.v1","routeSlug":"/reference/data.v1/data/reportedstate.v1","httpVerb":"schema"},{"type":"link","label":"Device Reservoir Change","link":"/reference/data.v1/data/reservoirchange.v1","routeSlug":"/reference/data.v1/data/reservoirchange.v1","httpVerb":"schema"},{"type":"link","label":"Glucose Sample Interval","link":"/reference/data.v1/data/sampleinterval.v1","routeSlug":"/reference/data.v1/data/sampleinterval.v1","httpVerb":"schema"},{"type":"link","label":"Self Monitored Glucose","link":"/reference/data.v1/data/selfmonitoredglucose.v1","routeSlug":"/reference/data.v1/data/selfmonitoredglucose.v1","httpVerb":"schema"},{"type":"link","label":"DeviceSensorEvent [Proposed]","link":"/reference/data.v1/data/sensor.v1","routeSlug":"/reference/data.v1/data/sensor.v1","httpVerb":"schema"},{"type":"link","label":"Settings","link":"/reference/data.v1/data/settings.v1","routeSlug":"/reference/data.v1/data/settings.v1","httpVerb":"schema"},{"type":"link","label":"Device Settings Change [Proposed]","link":"/reference/data.v1/data/settingschange.v1","routeSlug":"/reference/data.v1/data/settingschange.v1","httpVerb":"schema"},{"type":"link","label":"Severity","link":"/reference/data.v1/data/severity.v1","routeSlug":"/reference/data.v1/data/severity.v1","httpVerb":"schema"},{"type":"link","label":"Insulin Simple","link":"/reference/data.v1/data/simple.v1","routeSlug":"/reference/data.v1/data/simple.v1","httpVerb":"schema"},{"type":"link","label":"Data Source State","link":"/reference/data.v1/data/sources-state.v1","routeSlug":"/reference/data.v1/data/sources-state.v1","httpVerb":"schema"},{"type":"link","label":"Start Time","link":"/reference/data.v1/data/start.v1","routeSlug":"/reference/data.v1/data/start.v1","httpVerb":"schema"},{"type":"link","label":"State","link":"/reference/data.v1/data/state.v1","routeSlug":"/reference/data.v1/data/state.v1","httpVerb":"schema"},{"type":"link","label":"States","link":"/reference/data.v1/data/states.v1","routeSlug":"/reference/data.v1/data/states.v1","httpVerb":"schema"},{"type":"link","label":"Basal Suppressed Automated","link":"/reference/data.v1/data/suppressed-automated.v1","routeSlug":"/reference/data.v1/data/suppressed-automated.v1","httpVerb":"schema"},{"type":"link","label":"Basal Suppressed Scheduled","link":"/reference/data.v1/data/suppressed-scheduled.v1","routeSlug":"/reference/data.v1/data/suppressed-scheduled.v1","httpVerb":"schema"},{"type":"link","label":"Basal Suppressed Temporary","link":"/reference/data.v1/data/suppressed-temporary.v1","routeSlug":"/reference/data.v1/data/suppressed-temporary.v1","httpVerb":"schema"},{"type":"link","label":"Blood Glucose Target","link":"/reference/data.v1/data/target.v1","routeSlug":"/reference/data.v1/data/target.v1","httpVerb":"schema"},{"type":"link","label":"Blood Glucose Target Value (mg/dL)","link":"/reference/data.v1/data/targetmgdl.v1","routeSlug":"/reference/data.v1/data/targetmgdl.v1","httpVerb":"schema"},{"type":"link","label":"Blood Glucose Target Value (mmol/L)","link":"/reference/data.v1/data/targetmmol.v1","routeSlug":"/reference/data.v1/data/targetmmol.v1","httpVerb":"schema"},{"type":"link","label":"Blood Glucose Target Start","link":"/reference/data.v1/data/targetstart.v1","routeSlug":"/reference/data.v1/data/targetstart.v1","httpVerb":"schema"},{"type":"link","label":"Device Time Change","link":"/reference/data.v1/data/timechange.v1","routeSlug":"/reference/data.v1/data/timechange.v1","httpVerb":"schema"},{"type":"link","label":"Time Change Info","link":"/reference/data.v1/data/timechangeinfo.v1","routeSlug":"/reference/data.v1/data/timechangeinfo.v1","httpVerb":"schema"},{"type":"link","label":"Time Processing","link":"/reference/data.v1/data/timeprocessing.v1","routeSlug":"/reference/data.v1/data/timeprocessing.v1","httpVerb":"schema"},{"type":"link","label":"Time Zone","link":"/reference/data.v1/data/timezonename.v1","routeSlug":"/reference/data.v1/data/timezonename.v1","httpVerb":"schema"},{"type":"link","label":"Time Zone offset","link":"/reference/data.v1/data/timezoneoffset.v1","routeSlug":"/reference/data.v1/data/timezoneoffset.v1","httpVerb":"schema"},{"type":"link","label":"DeviceTransmitterEvent [Proposed]","link":"/reference/data.v1/data/transmitter.v1","routeSlug":"/reference/data.v1/data/transmitter.v1","httpVerb":"schema"},{"type":"link","label":"Glucose Trend","link":"/reference/data.v1/data/trend.v1","routeSlug":"/reference/data.v1/data/trend.v1","httpVerb":"schema"},{"type":"link","label":"Glucose Trend Rate","link":"/reference/data.v1/data/trendrate.v1","routeSlug":"/reference/data.v1/data/trendrate.v1","httpVerb":"schema"},{"type":"link","label":"Blood Unit (mg/dL or mmol/L)","link":"/reference/data.v1/data/units.v1","routeSlug":"/reference/data.v1/data/units.v1","httpVerb":"schema"},{"type":"link","label":"Blood Unit (mg/dL)","link":"/reference/data.v1/data/unitsmgdl.v1","routeSlug":"/reference/data.v1/data/unitsmgdl.v1","httpVerb":"schema"},{"type":"link","label":"Blood Unit (mmol/L)","link":"/reference/data.v1/data/unitsmmol.v1","routeSlug":"/reference/data.v1/data/unitsmmol.v1","httpVerb":"schema"},{"type":"link","label":"Tidepool Data Array","link":"/reference/data.v1/data/updatedataset.v1","routeSlug":"/reference/data.v1/data/updatedataset.v1","httpVerb":"schema"},{"type":"link","label":"Update Data Source","link":"/reference/data.v1/data/updatedatasource.v1","routeSlug":"/reference/data.v1/data/updatedatasource.v1","httpVerb":"schema"},{"type":"link","label":"Upload","link":"/reference/data.v1/data/upload.v1","routeSlug":"/reference/data.v1/data/upload.v1","httpVerb":"schema"},{"type":"link","label":"Upload Device","link":"/reference/data.v1/data/uploaddevice.v1","routeSlug":"/reference/data.v1/data/uploaddevice.v1","httpVerb":"schema"},{"type":"link","label":"Upload ID","link":"/reference/data.v1/data/uploadid.v1","routeSlug":"/reference/data.v1/data/uploadid.v1","httpVerb":"schema"},{"type":"link","label":"Blood Value (in mg/dL or mmol/L units)","link":"/reference/data.v1/data/value.v1","routeSlug":"/reference/data.v1/data/value.v1","httpVerb":"schema"},{"type":"link","label":"Blood Value (mg/dL)","link":"/reference/data.v1/data/valuemgdl.v1","routeSlug":"/reference/data.v1/data/valuemgdl.v1","httpVerb":"schema"},{"type":"link","label":"Blood Value (mmol/L)","link":"/reference/data.v1/data/valuemmol.v1","routeSlug":"/reference/data.v1/data/valuemmol.v1","httpVerb":"schema"},{"type":"link","label":"Water Consumption","link":"/reference/data.v1/data/water.v1","routeSlug":"/reference/data.v1/data/water.v1","httpVerb":"schema"}]}],"sidebar":[{"type":"link","label":"Data API","link":"/reference/data.v1","routeSlug":"/reference/data.v1"}]},{"type":"group","fsPath":"reference/devices.v1.yaml","metadata":{"type":"openapi","title":"Devices API","version":"1.0","description":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform. For more information, see the Getting Started section."},"link":"/reference/devices.v1","routeSlug":"/reference/devices.v1","label":"Devices API","items":[{"type":"link","label":"Devices API","link":"/reference/devices.v1","routeSlug":"/reference/devices.v1"},{"type":"group","label":"Devices","link":"/reference/devices.v1/devices","routeSlug":"/reference/devices.v1/devices","items":[{"label":"List Pumps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/devices.v1/devices/listpumps","routeSlug":"/reference/devices.v1/devices/listpumps","metadata":{"seo":{"title":"List Pumps","description":"List all Tidepool supported insulin pumps."}},"httpPath":"/v1/devices/pumps"},{"label":"Get Pump by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/devices.v1/devices/getpumpbyid","routeSlug":"/reference/devices.v1/devices/getpumpbyid","metadata":{"seo":{"title":"Get Pump by ID","description":"Get a Tidepool supported insulin pump by its unique device identifier."}},"httpPath":"/v1/devices/pumps/{id}"},{"label":"List CGMs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/devices.v1/devices/listcgms","routeSlug":"/reference/devices.v1/devices/listcgms","metadata":{"seo":{"title":"List CGMs","description":"List all Tidepool supported continuous glucose monitors (CGMs)."}},"httpPath":"/v1/devices/cgms"},{"label":"Get CGM by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/devices.v1/devices/getcgmbyid","routeSlug":"/reference/devices.v1/devices/getcgmbyid","metadata":{"seo":{"title":"Get CGM by ID","description":"Get a Tidepool supported continuous glucose monitor (CGM) by its unique device identifier."}},"httpPath":"/v1/devices/cgms/{id}"}]}],"sidebar":[{"type":"link","label":"Devices API","link":"/reference/devices.v1","routeSlug":"/reference/devices.v1"}]},{"type":"group","fsPath":"reference/export.v1.yaml","metadata":{"type":"openapi","title":"Export API","version":"1.0","description":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform. For more information, see the Getting Started section."},"link":"/reference/export.v1","routeSlug":"/reference/export.v1","label":"Export API","items":[{"type":"link","label":"Export API","link":"/reference/export.v1","routeSlug":"/reference/export.v1"},{"type":"group","label":"Internal","link":"/reference/export.v1/internal","routeSlug":"/reference/export.v1/internal","items":[{"label":"Export user data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/export.v1/internal/exportuserdata","routeSlug":"/reference/export.v1/internal/exportuserdata","metadata":{"seo":{"title":"Export user data","description":"Exports the diabetes data from user identified by userId, from startDate to endDate, in the requested format. Either a Tidepool session token, or a restricted token must be supplied."}},"httpPath":"/export/{userId}"}]},{"type":"group","label":"Export","link":"/reference/export.v1/export","routeSlug":"/reference/export.v1/export","items":[{"label":"Export user data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/export.v1/export/exportuserdata","routeSlug":"/reference/export.v1/export/exportuserdata","metadata":{"seo":{"title":"Export user data","description":"Exports the diabetes data from user identified by userId, from startDate to endDate, in the requested format. Either a Tidepool session token, or a restricted token must be supplied."}},"httpPath":"/export/{userId}"}]}],"sidebar":[{"type":"link","label":"Export API","link":"/reference/export.v1","routeSlug":"/reference/export.v1"}]},{"type":"group","fsPath":"reference/general.v1.yaml","metadata":{"type":"openapi","title":"General API","version":"1.0","description":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform. For more information, see the Getting Started section."},"link":"/reference/general.v1","routeSlug":"/reference/general.v1","label":"General API","items":[{"type":"link","label":"General API","link":"/reference/general.v1","routeSlug":"/reference/general.v1"},{"type":"group","label":"Internal","link":"/reference/general.v1/internal","routeSlug":"/reference/general.v1/internal","items":[{"label":"Get Minimum Client Versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/general.v1/internal/getminimumclientversions","routeSlug":"/reference/general.v1/internal/getminimumclientversions","metadata":{"seo":{"title":"Get Minimum Client Versions","description":"Returns minimum Tidepool client application versions. If a client application detects that it is older than the minimum version returned by this API, it should notify the user and terminate promptly. This API requires no authentication or authorization."}},"httpPath":"/info"}]},{"type":"group","label":"General","link":"/reference/general.v1/general","routeSlug":"/reference/general.v1/general","items":[{"label":"Get Minimum Client Versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/general.v1/general/getminimumclientversions","routeSlug":"/reference/general.v1/general/getminimumclientversions","metadata":{"seo":{"title":"Get Minimum Client Versions","description":"Returns minimum Tidepool client application versions. If a client application detects that it is older than the minimum version returned by this API, it should notify the user and terminate promptly. This API requires no authentication or authorization."}},"httpPath":"/info"}]}],"sidebar":[{"type":"link","label":"General API","link":"/reference/general.v1","routeSlug":"/reference/general.v1"}]},{"type":"group","fsPath":"reference/message.v1.yaml","metadata":{"type":"openapi","title":"Messages API","version":"1.0","description":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform. For more information, see the Getting Started section."},"link":"/reference/message.v1","routeSlug":"/reference/message.v1","label":"Messages API","items":[{"type":"link","label":"Messages API","link":"/reference/message.v1","routeSlug":"/reference/message.v1"},{"type":"group","label":"Internal","link":"/reference/message.v1/internal","routeSlug":"/reference/message.v1/internal","items":[]},{"type":"group","label":"Messages","link":"/reference/message.v1/messages","routeSlug":"/reference/message.v1/messages","items":[{"label":"List All Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/message.v1/messages/listallmessages","routeSlug":"/reference/message.v1/messages/listallmessages","metadata":{"seo":{"title":"List All Messages","description":"List all messages in the user account identified by userId, optionally within the time range bounded by starttime and/or endtime."}},"httpPath":"/message/all/{userId}"},{"label":"List Top-Level Messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/message.v1/messages/listtoplevelmessages","routeSlug":"/reference/message.v1/messages/listtoplevelmessages","metadata":{"seo":{"title":"List Top-Level Messages","description":"List only the top-level message threads in the user account identified by userId, optionally within the time range bounded by starttime and/or endtime. Top-level messages are the starting point of each message thread (i.e. parentmessage == null), that is, messages that are not responses to other messages."}},"httpPath":"/message/notes/{userId}"},{"label":"Create New Top-Level Message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/message.v1/messages/createmessage","routeSlug":"/reference/message.v1/messages/createmessage","metadata":{"seo":{"title":"Create New Top-Level Message","description":"Creates a new top-level message (thread) in the account identified by userId. Top-level messages are the starting point of a message thread (i.e. parentmessage == null), that is, not a response to any other message."}},"httpPath":"/message/send/{userId}"},{"label":"Reply to Message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/message.v1/messages/replytomessage","routeSlug":"/reference/message.v1/messages/replytomessage","metadata":{"seo":{"title":"Reply to Message","description":"Adds a reply to an existing message identified by messageId."}},"httpPath":"/message/reply/{messageId}"},{"label":"Get Message by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/message.v1/messages/findmessagebyid","routeSlug":"/reference/message.v1/messages/findmessagebyid","metadata":{"seo":{"title":"Get Message by ID","description":"Returns message identified by messageId"}},"httpPath":"/message/read/{messageId}"},{"label":"Get Message Thread by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/message.v1/messages/getmessagethread","routeSlug":"/reference/message.v1/messages/getmessagethread","metadata":{"seo":{"title":"Get Message Thread by ID","description":"Returns message thread identified by messageId"}},"httpPath":"/message/thread/{messageId}"},{"label":"Update Message","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/message.v1/messages/updatemessage","routeSlug":"/reference/message.v1/messages/updatemessage","metadata":{"seo":{"title":"Update Message","description":"Updates the message identified by messageId. Either the timestamp or the messagetext field or both must be supplied in the request body. No other fields of the message may be updated. The modifiedtime field of the message will indicate when the message was last modified."}},"httpPath":"/message/edit/{messageId}"},{"label":"Delete Message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/message.v1/messages/deletemessage","routeSlug":"/reference/message.v1/messages/deletemessage","metadata":{"seo":{"title":"Delete Message","description":"Deletes the message identified by messageId."}},"httpPath":"/message/remove/{messageId}"}]}],"sidebar":[{"type":"link","label":"Messages API","link":"/reference/message.v1","routeSlug":"/reference/message.v1"}]},{"type":"group","fsPath":"reference/metadata.v1.yaml","metadata":{"type":"openapi","title":"Metadata API","version":"1.0","description":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform. For more information, see the Getting Started section."},"link":"/reference/metadata.v1","routeSlug":"/reference/metadata.v1","label":"Metadata API","items":[{"type":"link","label":"Metadata API","link":"/reference/metadata.v1","routeSlug":"/reference/metadata.v1"},{"type":"group","label":"Internal","link":"/reference/metadata.v1/internal","routeSlug":"/reference/metadata.v1/internal","items":[{"label":"Get User's Private Metadata Item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metadata.v1/internal/getuserprivatemetadataitem","routeSlug":"/reference/metadata.v1/internal/getuserprivatemetadataitem","metadata":{"seo":{"title":"Get User's Private Metadata Item","description":"Returns the named item from the user's private metadata collection."}},"httpPath":"/metadata/{userId}/private/{fieldName}"}]},{"type":"group","label":"Metadata","link":"/reference/metadata.v1/metadata","routeSlug":"/reference/metadata.v1/metadata","items":[{"label":"Get Metadata Collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metadata.v1/metadata/getmetadatacollections","routeSlug":"/reference/metadata.v1/metadata/getmetadatacollections","metadata":{"seo":{"title":"Get Metadata Collections","description":"Returns list of valid metadata collections."}},"httpPath":"/metadata/collections"},{"label":"Get User Metadata Collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metadata.v1/metadata/getusermetadatacollection","routeSlug":"/reference/metadata.v1/metadata/getusermetadatacollection","metadata":{"seo":{"title":"Get User Metadata Collection","description":"Returns the user's metadata collection corresponding to collectionName. Each metadata collection is an unbounded JSON object with client-defined fields."}},"httpPath":"/metadata/{userId}/{collectionName}"},{"label":"Update User Metadata Collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metadata.v1/metadata/updateusermetadatacollectionpost","routeSlug":"/reference/metadata.v1/metadata/updateusermetadatacollectionpost","metadata":{"seo":{"title":"Update User Metadata Collection","description":"Updates the user's metadata collection corresponding to collectionName. Each metadata collection is an unbounded JSON object with client-defined fields."}},"httpPath":"/metadata/{userId}/{collectionName}"},{"label":"Update User Metadata Collection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metadata.v1/metadata/updateusermetadatacollectionput","routeSlug":"/reference/metadata.v1/metadata/updateusermetadatacollectionput","metadata":{"seo":{"title":"Update User Metadata Collection","description":"Updates the user's metadata collection corresponding to collectionName. Each metadata collection is an unbounded JSON object with client-defined fields."}},"httpPath":"/metadata/{userId}/{collectionName}"},{"label":"Get User's Private Metadata Item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metadata.v1/metadata/getuserprivatemetadataitem","routeSlug":"/reference/metadata.v1/metadata/getuserprivatemetadataitem","metadata":{"seo":{"title":"Get User's Private Metadata Item","description":"Returns the named item from the user's private metadata collection."}},"httpPath":"/metadata/{userId}/private/{fieldName}"},{"label":"List Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metadata.v1/metadata/listusers","routeSlug":"/reference/metadata.v1/metadata/listusers","metadata":{"seo":{"title":"List Users","description":"List all users who have trustee or trustor access to the user account identified by userId."}},"httpPath":"/metadata/users/{userId}/users"}]}],"sidebar":[{"type":"link","label":"Metadata API","link":"/reference/metadata.v1","routeSlug":"/reference/metadata.v1"}]},{"type":"group","fsPath":"reference/metrics.v1.yaml","metadata":{"type":"openapi","title":"Metrics API","version":"1.0","description":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform. For more information, see the Getting Started section."},"link":"/reference/metrics.v1","routeSlug":"/reference/metrics.v1","label":"Metrics API","items":[{"type":"link","label":"Metrics API","link":"/reference/metrics.v1","routeSlug":"/reference/metrics.v1"},{"type":"group","label":"Internal","link":"/reference/metrics.v1/internal","routeSlug":"/reference/metrics.v1/internal","items":[{"label":"Record Metrics Event for Server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metrics.v1/internal/recordmetricseventforserver","routeSlug":"/reference/metrics.v1/internal/recordmetricseventforserver","metadata":{"seo":{"title":"Record Metrics Event for Server","description":"Records a new metrics event on behalf of a server. This API requires a session token, and it must be a valid server token. Any query parameters supplied with the request will be recorded as part of the event."}},"httpPath":"/metrics/server/{serverName}/{eventName}"}]},{"type":"group","label":"Metrics","link":"/reference/metrics.v1/metrics","routeSlug":"/reference/metrics.v1/metrics","items":[{"label":"Record Metrics Event for User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metrics.v1/metrics/recordmetricseventfornameduser","routeSlug":"/reference/metrics.v1/metrics/recordmetricseventfornameduser","metadata":{"seo":{"title":"Record Metrics Event for User","description":"Records a new metrics event for the user identified by the userId parameter. This API does not require a session token, but if one is provided it must be a valid token. The userId parameter is not validated. Any query parameters supplied with the request will be recorded as part of the event."}},"httpPath":"/metrics/user/{userId}/{eventName}"},{"label":"Record Metrics Event for Logged-In User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metrics.v1/metrics/recordmetricseventforloggedinuser","routeSlug":"/reference/metrics.v1/metrics/recordmetricseventforloggedinuser","metadata":{"seo":{"title":"Record Metrics Event for Logged-In User","description":"Records a new metrics event for the user identified by the session token. This API requires a session token, and it must be a valid user token. The userId parameter is extracted from the session token. Any query parameters supplied with the request will be recorded as part of the event."}},"httpPath":"/metrics/thisuser/{eventName}"},{"label":"Record Metrics Event for Server","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/metrics.v1/metrics/recordmetricseventforserver","routeSlug":"/reference/metrics.v1/metrics/recordmetricseventforserver","metadata":{"seo":{"title":"Record Metrics Event for Server","description":"Records a new metrics event on behalf of a server. This API requires a session token, and it must be a valid server token. Any query parameters supplied with the request will be recorded as part of the event."}},"httpPath":"/metrics/server/{serverName}/{eventName}"}]}],"sidebar":[{"type":"link","label":"Metrics API","link":"/reference/metrics.v1","routeSlug":"/reference/metrics.v1"}]},{"type":"group","fsPath":"reference/prescription.v1.yaml","metadata":{"type":"openapi","title":"Prescriptions API","version":"1.0","description":"Prescription service for Tidepool Loop"},"link":"/reference/prescription.v1","routeSlug":"/reference/prescription.v1","label":"Prescriptions API","items":[{"type":"link","label":"Prescriptions API","link":"/reference/prescription.v1","routeSlug":"/reference/prescription.v1"},{"type":"group","label":"Internal","link":"/reference/prescription.v1/internal","routeSlug":"/reference/prescription.v1/internal","items":[]},{"type":"group","label":"Prescriptions","link":"/reference/prescription.v1/prescriptions","routeSlug":"/reference/prescription.v1/prescriptions","items":[{"label":"List Prescriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/prescription.v1/prescriptions/listclinicprescriptions","routeSlug":"/reference/prescription.v1/prescriptions/listclinicprescriptions","metadata":{"seo":{"title":"List Prescriptions","description":"Retrieve the list of prescriptions created by clinic members"}},"httpPath":"/v1/clinics/{clinicId}/prescriptions"},{"label":"Create a Prescription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/prescription.v1/prescriptions/createprescription","routeSlug":"/reference/prescription.v1/prescriptions/createprescription","metadata":{"seo":{"title":"Create a Prescription","description":"Create a new prescription"}},"httpPath":"/v1/clinics/{clinicId}/prescriptions"},{"label":"Get Prescription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/prescription.v1/prescriptions/getprescriptionbyid","routeSlug":"/reference/prescription.v1/prescriptions/getprescriptionbyid","metadata":{"seo":{"title":"Get Prescription","description":"Retrieve a prescription by id"}},"httpPath":"/v1/clinics/{clinicId}/prescriptions/{prescriptionId}"},{"label":"Delete Prescription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/prescription.v1/prescriptions/deleteprescription","routeSlug":"/reference/prescription.v1/prescriptions/deleteprescription","metadata":{"seo":{"title":"Delete Prescription","description":"Clinician only endpoint to delete a prescription. Works only when the prescription has status draft."}},"httpPath":"/v1/clinics/{clinicId}/prescriptions/{prescriptionId}"},{"label":"Create new revision","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/prescription.v1/prescriptions/createprescriptionrevision","routeSlug":"/reference/prescription.v1/prescriptions/createprescriptionrevision","metadata":{"seo":{"title":"Create new revision","description":"Add a new revision to a prescription which is still a draft."}},"httpPath":"/v1/clinics/{clinicId}/prescriptions/{prescriptionId}/revisions"},{"label":"Claim Prescription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/prescription.v1/prescriptions/claimprescription","routeSlug":"/reference/prescription.v1/prescriptions/claimprescription","metadata":{"seo":{"title":"Claim Prescription","description":"Claim a submitted prescription using an access code and date of birth."}},"httpPath":"/v1/patients/{userId}/prescriptions"},{"label":"List Prescriptions for Patient","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/prescription.v1/prescriptions/listpatientprescriptions","routeSlug":"/reference/prescription.v1/prescriptions/listpatientprescriptions","metadata":{"seo":{"title":"List Prescriptions for Patient","description":"Retrieve a list of prescription that the user has claimed"}},"httpPath":"/v1/patients/{userId}/prescriptions"},{"label":"Get Prescription for User","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/prescription.v1/prescriptions/getprescriptionforuser","routeSlug":"/reference/prescription.v1/prescriptions/getprescriptionforuser","metadata":{"seo":{"title":"Get Prescription for User","description":"Retrieve a prescription by id"}},"httpPath":"/v1/patients/{userId}/prescriptions/{prescriptionId}"},{"label":"Update Prescription State","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/prescription.v1/prescriptions/updateprescriptionstate","routeSlug":"/reference/prescription.v1/prescriptions/updateprescriptionstate","metadata":{"seo":{"title":"Update Prescription State","description":"Update prescription state"}},"httpPath":"/v1/patients/{userId}/prescriptions/{prescriptionId}"}]}],"sidebar":[{"type":"link","label":"Prescriptions API","link":"/reference/prescription.v1","routeSlug":"/reference/prescription.v1"}]},{"type":"group","fsPath":"reference/summary.v1.yaml","metadata":{"type":"openapi","title":"Data Summary API","version":"1.0","description":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform. For more information, see the Getting Started section."},"link":"/reference/summary.v1","routeSlug":"/reference/summary.v1","label":"Data Summary API","items":[{"type":"link","label":"Data Summary API","link":"/reference/summary.v1","routeSlug":"/reference/summary.v1"},{"type":"group","label":"Internal","link":"/reference/summary.v1/internal","routeSlug":"/reference/summary.v1/internal","items":[{"label":"Get User Summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/summary.v1/internal/getsummary","routeSlug":"/reference/summary.v1/internal/getsummary","metadata":{"seo":{"title":"Get User Summary","description":"Retrieve a summary by user id"}},"httpPath":"/v1/summaries/{summaryType}/{userId}"}]},{"type":"group","label":"Summary","link":"/reference/summary.v1/summary","routeSlug":"/reference/summary.v1/summary","items":[{"label":"Get User Summary","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/summary.v1/summary/getsummary","routeSlug":"/reference/summary.v1/summary/getsummary","metadata":{"seo":{"title":"Get User Summary","description":"Retrieve a summary by user id"}},"httpPath":"/v1/summaries/{summaryType}/{userId}"}]}],"sidebar":[{"type":"link","label":"Data Summary API","link":"/reference/summary.v1","routeSlug":"/reference/summary.v1"}]},{"type":"group","fsPath":"reference/task.v1.yaml","metadata":{"type":"openapi","title":"Task API","version":"1.0","description":"The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform. For more information, see the Getting Started section."},"link":"/reference/task.v1","routeSlug":"/reference/task.v1","label":"Task API","items":[{"type":"link","label":"Task API","link":"/reference/task.v1","routeSlug":"/reference/task.v1"},{"type":"group","label":"Internal","link":"/reference/task.v1/internal","routeSlug":"/reference/task.v1/internal","items":[{"label":"List Tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/task.v1/internal/listtasks","routeSlug":"/reference/task.v1/internal/listtasks","metadata":{"seo":{"title":"List Tasks","description":"Returns list of tasks. The list can be filtered with the name, type, or state query parameters. It can also be paginated with the page and size query parameters."}},"httpPath":"/v1/tasks"},{"label":"Create New Task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/task.v1/internal/createtask","routeSlug":"/reference/task.v1/internal/createtask","metadata":{"seo":{"title":"Create New Task","description":"Creates a new task."}},"httpPath":"/v1/tasks"},{"label":"Get Task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/task.v1/internal/gettask","routeSlug":"/reference/task.v1/internal/gettask","metadata":{"seo":{"title":"Get Task","description":"Returns the task identified by taskId."}},"httpPath":"/v1/tasks/{taskId}"},{"label":"Update Task","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/task.v1/internal/updatetask","routeSlug":"/reference/task.v1/internal/updatetask","metadata":{"seo":{"title":"Update Task","description":"Updates the task identified by taskId."}},"httpPath":"/v1/tasks/{taskId}"},{"label":"Delete Task","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/task.v1/internal/deletetask","routeSlug":"/reference/task.v1/internal/deletetask","metadata":{"seo":{"title":"Delete Task","description":"Deletes the task identified by taskId."}},"httpPath":"/v1/tasks/{taskId}"}]},{"type":"group","label":"Tasks","link":"/reference/task.v1/tasks","routeSlug":"/reference/task.v1/tasks","items":[{"label":"List Tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/task.v1/tasks/listtasks","routeSlug":"/reference/task.v1/tasks/listtasks","metadata":{"seo":{"title":"List Tasks","description":"Returns list of tasks. The list can be filtered with the name, type, or state query parameters. It can also be paginated with the page and size query parameters."}},"httpPath":"/v1/tasks"},{"label":"Create New Task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/task.v1/tasks/createtask","routeSlug":"/reference/task.v1/tasks/createtask","metadata":{"seo":{"title":"Create New Task","description":"Creates a new task."}},"httpPath":"/v1/tasks"},{"label":"Get Task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/task.v1/tasks/gettask","routeSlug":"/reference/task.v1/tasks/gettask","metadata":{"seo":{"title":"Get Task","description":"Returns the task identified by taskId."}},"httpPath":"/v1/tasks/{taskId}"},{"label":"Update Task","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/task.v1/tasks/updatetask","routeSlug":"/reference/task.v1/tasks/updatetask","metadata":{"seo":{"title":"Update Task","description":"Updates the task identified by taskId."}},"httpPath":"/v1/tasks/{taskId}"},{"label":"Delete Task","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/reference/task.v1/tasks/deletetask","routeSlug":"/reference/task.v1/tasks/deletetask","metadata":{"seo":{"title":"Delete Task","description":"Deletes the task identified by taskId."}},"httpPath":"/v1/tasks/{taskId}"}]}],"sidebar":[{"type":"link","label":"Task API","link":"/reference/task.v1","routeSlug":"/reference/task.v1"}]}]