APIs intended for internal use by Tidepool.
Messages API (1.0)
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.
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://tidepool.redocly.app/_mock/reference/message.v1/
integration
https://external.integration.tidepool.org/
production
https://api.tidepool.org/
dev1
https://dev1.dev.tidepool.org/
qa1
https://qa1.development.tidepool.org/
qa2
https://qa2.development.tidepool.org/
Messages
List, create and manage messages (also known as notes) in the user's account.
All APIs require a valid session token provided via the X-Tidepool-Session-Token header. There is currently no unauthenticated access to messages.
The common API input parameter userId is a Tidepool User ID that identifies the user whose account contains the messages. That user may have shared their account with (=given permission to) other users who can view and manage messages in their account. Therefore, in each API request the user ID identified with the session token must either a) match the userId parameter, or b) the corresponding user must have been granted the note permission to manage messages in the user account identified by userId.
Similarly, in the API responses the groupid field is a Tidepool User ID that identifies the user whose account contains the messages, corresponding to the userId parameter in requests. The userid field identifies the user who actually created the message, corresponding to the user ID encoded within the session token. The message was created by the owner of the account if these two fields match.
Each message has a unique message ID, and the messages can be threaded. A user can create either a new message, or create a reply to another message. Each message contains a parentmessage field that contains the message ID of previous message in the thread. Messages that have no parentmessage field value (i.e. it is null) are top-level messages, that is, the beginning of a message thread.
See the Authorization API for details on how permissions are managed.
Operations