Skip to content
Tidepool API/Metadata API/Internal

Metadata 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
metadata.v1.json
metadata.v1.yaml
Overview
URL

https://support.tidepool.org/

API Support

support@tidepool.org

License

BSD-2-Clause

Languages
Servers
Mock server

https://tidepool.redocly.app/_mock/reference/metadata.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/

Internal

APIs intended for internal use by Tidepool.

Operations

Get User's Private Metadata Item

Request

Returns the named item from the user's private metadata collection.

Security
serverToken
Path
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID

fieldNamestringrequired

Metadata Field Name

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/metadata.v1/metadata/{userId}/private/{fieldName}' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

Metadata

Create and update user metadata.

Operations