Parameters

Parameters defined for this API.

Path parameters

appIdstring✻

The app ID is a unique identifier for an app.

format: uuid

Documentation

Example
"9352258f-0263-47d1-b9c7-16cd93be7501"

appIdOrNamestring✻

The app ID or name is a unique identifier for an app.

Documentation

Any

App ID

App Name

collaboratorIdstring✻

The collaborator ID is a unique identifier for a collaborator.

format: uuid

Documentation

Example
"9352258f-0263-47d1-b9c7-16cd93be7501"

installationIdstring✻

The installation ID is a unique identifier for an installation.

format: uuid

Documentation

Example
"9352258f-0263-47d1-b9c7-16cd93be7501"

keyIdstring✻

The key ID is a unique identifier for a key.

format: uuid

Documentation

Example
"9352258f-0263-47d1-b9c7-16cd93be7501"

linkVerifierIdstring✻

The link verifier ID is a unique identifier for a link verifier.

format: uuid

Documentation

Example
"1c17b340-2b4b-4d88-8a38-5712d9f2feb8"

permissionIdstring✻

The permission ID is a unique identifier for a permission.

format: uuid

Documentation

Example
"9352258f-0263-47d1-b9c7-16cd93be7501"

sessionIdstring✻

The session ID is a unique identifier for a session.

format: uuid

Documentation

Example
"9352258f-0263-47d1-b9c7-16cd93be7501"

userIdstring✻

The user ID is a unique identifier for a user.

format: uuid

Documentation

Example
"9352258f-0263-47d1-b9c7-16cd93be7501"

Query parameters

actionstring

The action property grant access to different endpoints.

"read""write"

Documentation

approvedboolean

The approved property determines whether a permission has been granted or not.

Documentation

categoriesarray

List of app categories

unique items

Documentation

The category of the app

"cgm""forecasting""licensing""realtime""subscription"

Documentation

publicListboolean

The public list query parameter determines whether the response will include all apps or only apps the current user has access to.

Documentation

scopestring

The scope property grant access to a specific set of data.

"name""emails""phones""country""language""biologicalSex""bloodGlucose""bloodGlucoseTarget""bloodType""bolusCalculation""carbohydrates""carbohydratesRecommendation""dateOfBirth""diabetesType""insulinDelivery""insulinOnBoard""insulinRecommendation""insulinReduction""insulinSensitivity""insulinToCarbohydratesRatio""interstitialGlucose""licenses"

Documentation

sourceIdstring

The owner ID is a unique identifier for an owner (either a user or an app).

Documentation

Any

App ID

User ID

sourceTypestring

The source type property provides additional context to the source ID.

"app""user"

Documentation

targetIdstring

The owner ID is a unique identifier for an owner (either a user or an app).

Documentation

Any

App ID

User ID

targetTypestring

The target type property provides additional context to the target ID.

"app""system""user"

Documentation