# Metadata API

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](../docs/quick-start.md) section.

Version: 1.0
License: BSD-2-Clause

## Servers

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
```

## Security

### sessionToken

Tidepool Session Token

Type: apiKey
In: header
Name: X-Tidepool-Session-Token

### serverToken

Tidepool Server Token

Type: apiKey
In: header
Name: X-Tidepool-Session-Token

## Download OpenAPI description

[Metadata API](https://tidepool.redocly.app/_spec/reference/metadata.v1.yaml)

## Metadata

Create and update user metadata.

### Get User's Private Metadata Item

 - [GET /metadata/{userId}/private/{fieldName}](https://tidepool.redocly.app/reference/metadata.v1/internal/getuserprivatemetadataitem.md): Returns the named item from the user's private metadata collection.

### Get Metadata Collections

 - [GET /metadata/collections](https://tidepool.redocly.app/reference/metadata.v1/metadata/getmetadatacollections.md): Returns list of valid metadata collections.

### Get User Metadata Collection

 - [GET /metadata/{userId}/{collectionName}](https://tidepool.redocly.app/reference/metadata.v1/metadata/getusermetadatacollection.md): Returns the user's metadata collection corresponding to . Each metadata collection is an unbounded JSON object with client-defined fields.

### Update User Metadata Collection

 - [POST /metadata/{userId}/{collectionName}](https://tidepool.redocly.app/reference/metadata.v1/metadata/updateusermetadatacollectionpost.md): Updates the user's metadata collection corresponding to . Each metadata collection is an unbounded JSON object with client-defined fields.

### Update User Metadata Collection

 - [PUT /metadata/{userId}/{collectionName}](https://tidepool.redocly.app/reference/metadata.v1/metadata/updateusermetadatacollectionput.md): Updates the user's metadata collection corresponding to . Each metadata collection is an unbounded JSON object with client-defined fields.

### Get User's Private Metadata Item

 - [GET /metadata/{userId}/private/{fieldName}](https://tidepool.redocly.app/reference/metadata.v1/metadata/getuserprivatemetadataitem.md): Returns the named item from the user's private metadata collection.

### List Users

 - [GET /metadata/users/{userId}/users](https://tidepool.redocly.app/reference/metadata.v1/metadata/listusers.md): List all users who have trustee or trustor access to the user account identified by .

## Internal

APIs intended for internal use by Tidepool.

### Get User's Private Metadata Item

 - [GET /metadata/{userId}/private/{fieldName}](https://tidepool.redocly.app/reference/metadata.v1/internal/getuserprivatemetadataitem.md): Returns the named item from the user's private metadata collection.

### Get User's Private Metadata Item

 - [GET /metadata/{userId}/private/{fieldName}](https://tidepool.redocly.app/reference/metadata.v1/metadata/getuserprivatemetadataitem.md): Returns the named item from the user's private metadata collection.