App

Documentation

Properties

idstring✻

The app ID is a unique identifier for an app.

format: uuid

Documentation

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

namestring✻

The unique name of the app using only lowercase letters, numbers and hyphens.

1..256 characters/^[a-z0-9-]+$/i

Documentation

Example
"hda"

titlestring✻

The title is used to refer to the app in UI.

1..256 characters

Documentation

Example
"HDA"

descriptionnull | string

The description is a short description of what the app does.

1..512 characters

Documentation

Example
"This app will help you manage your diabetes"

iconnull | string

The icon is a URL to the app's icon. It should be a valid URL and should point to an image file.

format: uri1..131072 characters

Documentation

urlstring✻

The URL is the full URL to the app's homepage.

format: uri1..1024 characters

Documentation

Example
"https://www.sugarsense.com"

privacyNoticeUrlnull | string

The URL is the full URL to the app's privacy notice.

format: uri1..1024 characters

Documentation

Example
"https://example.com/privacy-notice"

setupUrlnull | string

The URL is the full URL to the app's setup page.

format: uri1..1024 characters

Documentation

Example
"https://example.com/setup"

categoriesarray✻

List of app categories

unique items

Documentation

The category of the app

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

Documentation

countriesarray✻

List of country codes

unique items

Documentation

The two-letter (A-2) ISO 3166-1 code for the user's country of residence. Only countries supported by Hedia are allowed.

"AT""CL""DE""DK""ES""FR""GB""IE""IT""LU""MT""PL""SE"

Documentation

Example
"DK"

privateboolean✻

The privacy level of the app.

Documentation

firstPartyboolean✻

The firstParty property determines whether or not an app is owned by Hedia.

Documentation

ownerIdstring✻

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

Documentation

createdAtstring✻

format: date-time

Documentation

createdBystring✻

format: uuid

Documentation

updatedAtstring

format: date-time

Documentation

updatedBystring

format: uuid

Documentation