Skip to main content
API docs by Redocly

showboat API definition (1.0.0)

showboat API definition

/v1/action-example-models

/v1/action-example-models/

query Parameters
filter[category]
string <= 255 characters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[type]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/action-example-models/

Request Body schema: application/json
required
object
type
required
string
Value: "action-example-models"
required
object
category
required
string <= 255 characters
required
object (LocaleStrings)
en_US
required
string <= 512 characters
es_US
required
string <= 512 characters
organization-id
required
string <uuid>
type
required
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/action-example-models/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/action-example-models/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/action-example-models/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "action-example-models"
required
object
category
string <= 255 characters
object (LocaleStrings)
en_US
required
string <= 512 characters
es_US
required
string <= 512 characters
type
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/action-examples

/v1/action-examples/

query Parameters
categories
required
Array of strings[ items <= 60 characters ]
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/apps

/v1/apps/

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/apps/

Request Body schema: application/json
required
object
type
required
string
Value: "ui-apps"
required
object
app-name
required
string
Enum: "care" "carium"
latest-version
required
string <= 32 characters ^\d+\.\d+(\.\d+)?$
platform
required
string
Enum: "android" "ios"
minimum-version
string <= 32 characters ^\d+\.\d+(\.\d+)?$
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/apps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/apps/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/apps/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "ui-apps"
required
object
latest-version
string <= 32 characters ^\d+\.\d+(\.\d+)?$
minimum-version
string <= 32 characters ^\d+\.\d+(\.\d+)?$
id
required
string <= 32 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/banners

/v1/banners/

query Parameters
filter[name]
string <= 255 characters
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/banners/

Request Body schema: application/json
required
object
type
required
string
Value: "banners"
required
object
required
BannerGenericArgs (object) or BannerSurveyArgs (object) or BannerUpgradeArgs (object)
Any of
external-url
string
required
object (LocaleStrings)
en_US
required
string <= 512 characters
es_US
required
string <= 512 characters
name
required
string <= 128 characters
organization-id
required
string <uuid>
type
required
string
Enum: "generic" "survey" "upgrade"
description
string <= 255 characters
Default: ""
individual-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/banners/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/banners/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/banners/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "banners"
required
object
BannerGenericArgs (object) or BannerSurveyArgs (object) or BannerUpgradeArgs (object)
Any of
external-url
string
description
string <= 255 characters
object (LocaleStrings)
en_US
required
string <= 512 characters
es_US
required
string <= 512 characters
name
string <= 128 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/charts

DEPRECATED: Use /v2/charts/ Deprecated

query Parameters
fields
Array of strings
Items Enum: "has-readings" "icon-background-color" "icon-name" "max" "max-time" "min" "min-time" "precision" "read-only" "read-schema" "schema" "scopes" "source-options" "sources" "title" "unit"
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

DEPRECATED: Use /v2/charts/{id}/get-details/ Deprecated

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
scope
required
string
Enum: "30days" "3months" "day" "month" "week" "year"
tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

allow-summary
boolean
Default: false

Allow using summary graph-type where appropriate

context
string
Enum: "AFTER_MEAL" "BEDTIME" "BEFORE_MEAL" "FASTING" "FORMAL" "INFORMAL" "UNSPECIFIED"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
start
string <datetime>

UTC start time for readings within the scope

time
string <datetime>

Arbitrary UTC timestamp to compute a "start" and "end" from, it defaults to current time

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

DEPRECATED: Use /v2/charts/{id}/get-goal/ Deprecated

path Parameters
id
required
string

Resource identifier

query Parameters
tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

DEPRECATED: Use /v2/charts/{id}/get-readings/ Deprecated

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
scope
required
string
Enum: "30days" "3months" "day" "month" "week" "year"
context
string
Enum: "AFTER_MEAL" "BEDTIME" "BEFORE_MEAL" "FASTING" "FORMAL" "INFORMAL" "UNSPECIFIED"
reverse
boolean
start
string <datetime>

UTC start time for readings within the scope

time
string <datetime>

Arbitrary UTC timestamp to compute a "start" and "end" from, it defaults to current time

tz
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

tz-offset-mins
integer (TzOffset) [ -720 .. 840 ]

User's local timezone defined in minutes offset from UTC

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v1/companies

/v1/companies/

query Parameters
filter[fqdn]
string <= 127 characters
filter[name]
string <= 255 characters
filter[subdomain]
string <= 63 characters
Deprecated

Deprecated in favor of fqdn.

page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/company-models

/v1/company-models/

query Parameters
filter[fqdn]
string <= 127 characters
filter[name]
string <= 255 characters
filter[subdomain]
string <= 63 characters
Deprecated

Deprecated in favor of filter[fqdn].

page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/company-models/

Request Body schema: application/json
required
object
type
required
string
Value: "company-models"
required
object
app-display-name
required
string <= 255 characters
care-app-display-name
required
string <= 255 characters
display-name
required
string <= 255 characters
name
required
string <= 255 characters
app-url-android
string <= 255 characters
app-url-ios
string <= 255 characters
care-app-url-android
string <= 255 characters
care-app-url-ios
string <= 255 characters
default-organization-code
string <= 50 characters
default-organization-id
string <uuid>
fqdn
string <= 127 characters

Fully qualified domain name for private labels.

subdomain
string <= 63 characters
Deprecated

Deprecated in favor of fqdn.

support-email
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/company-models/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/company-models/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/company-models/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "company-models"
required
object
app-display-name
string <= 255 characters
app-url-android
string <= 255 characters
app-url-ios
string <= 255 characters
care-app-display-name
string <= 255 characters
care-app-url-android
string <= 255 characters
care-app-url-ios
string <= 255 characters
default-organization-code
string <= 50 characters
default-organization-id
string <uuid>
display-name
string <= 255 characters
fqdn
string <= 127 characters

Fully qualified domain name for private labels.

name
string <= 255 characters
subdomain
string <= 63 characters
Deprecated

Deprecated in favor of fqdn.

support-email
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/contexts

/v1/contexts/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
with-nav
boolean
Default: false
with-photo-link
boolean
Default: false
without-photo
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/debugger-entries

/v1/debugger-entries/

query Parameters
debugger-id
required
string <uuid>
Example: debugger-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/debugger-entries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/debuggers

/v1/debuggers/

query Parameters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/debuggers/

Request Body schema: application/json
required
object
type
required
string
Value: "debuggers"
required
object
individual-id
required
string <uuid>
scopes
required
Array of strings
Items Value: "bluetooth"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/debuggers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/debuggers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/debuggers/{id}/log/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
message
required
string <= 8192 characters
scope
required
string
Value: "bluetooth"
data
object

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "message": "string",
  • "scope": "bluetooth"
}

Response samples

Content type
application/vnd.api+json
null

/v1/disclaimer-models

/v1/disclaimer-models/

query Parameters
filter[page-name]
string <= 255 characters
filter[platform]
string (Platform)
Enum: "android" "ios" "web"
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/disclaimer-models/

Request Body schema: application/json
required
object
type
required
string
Value: "disclaimer-models"
required
object
page-name
required
string <= 255 characters
required
object (LocaleStrings)
en_US
required
string <= 512 characters
es_US
required
string <= 512 characters
organization-id
string <uuid>
platform
string (Platform)
Enum: "android" "ios" "web"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/disclaimer-models/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/disclaimer-models/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/disclaimer-models/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "disclaimer-models"
required
object
page-name
string <= 255 characters
platform
string (Platform)
Enum: "android" "ios" "web"
object (LocaleStrings)
en_US
required
string <= 512 characters
es_US
required
string <= 512 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/disclaimers

/v1/disclaimers/

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
page-name
required
string <= 255 characters
platform
required
string (Platform)
Enum: "android" "ios" "web"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/goals

/v1/goals/

query Parameters
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/v1/help-docs

/v1/help-docs/

query Parameters
filter[locale]
string
Enum: "all" "en_US" "es_US"
filter[type]
string
Default: "participant"
Enum: "all" "participant" "provider"
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/help-docs/

Request Body schema: application/json
required
object
type
required
string
Value: "help-docs"
required
object
locale
required
string (Locale)
Enum: "en_US" "es_US"
name
required
string <= 255 characters
url
required
string <= 200 characters
order
integer
organization-id
string <uuid>
type
string
Default: "participant"
Enum: "participant" "provider"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/help-docs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/help-docs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/help-docs/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "help-docs"
required
object
locale
string (Locale)
Enum: "en_US" "es_US"
name
string <= 255 characters
order
integer
organization-id
string <uuid>

This cannot be edited but lets you update a help doc for a specific organization

type
string
Default: "participant"
Enum: "participant" "provider"
url
string <= 200 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/homefeed-individual-logs

DEPRECATED: Use /v2/individuals/{id}/delete-homefeed-log/ Deprecated

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
entry-id
required
string <uuid>
entry-type
required
string <= 64 characters

Responses

Request samples

Content type
application/json
{
  • "entry-id": "11111111-1111-1111-1111-111111111111",
  • "entry-type": "string"
}

Response samples

Content type
application/vnd.api+json
null

/v1/homefeed-logs

/v1/homefeed-logs/

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
filter[entry-id]
string <uuid>
Example: filter[entry-id]=11111111-1111-1111-1111-111111111111
filter[entry-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against entry_time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.

filter[entry-type]
string <= 64 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/homefeed-logs/

Request Body schema: application/json
required
object
type
required
string
Value: "homefeed-logs"
required
object
entry-id
required
string <uuid>
entry-time
required
string <datetime>
entry-type
required
string <= 64 characters
individual-id
required
string <uuid>
entry-data
object
hide-at
string <datetime>
priority
integer
Default: 100
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/homefeed-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/homefeed-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/homefeed-logs/{id}/hide/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/homefeed-logs/{id}/respond/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
Any of
scheduler-id
required
string <uuid>
status
required
string
Enum: "SKIPPED" "TAKEN"
taken-at
required
string <datetime>
type
string
Value: "medication-scheduler"

Responses

Request samples

Content type
application/json
{
  • "type": "notification"
}

Response samples

Content type
application/vnd.api+json
null

/v1/individuals

DEPRECATED: Use /v2/individuals/{id}/add-reading-from-tile/ Deprecated

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
context
required
string
Enum: "AFTER_MEAL" "BEDTIME" "BEFORE_MEAL" "FASTING" "UNSPECIFIED"
input-unit
required
string

The unit that the value for this reading. It should be the one provided in /charts/ response.

type
required
string
Value: "BloodGlucose"
tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

value
required
number

The reading value

include-others
boolean
individual-id
string <uuid>
local-time
string <datetime>

Timestamp for reading in user's current timezone (tz) for series types with a single time

organization-id
string <uuid>
source
string <= 50 characters
time
string <datetime>

Timestamp for reading in UTC for series types with a single time

Responses

Request samples

Content type
application/json
{
  • "include-others": true,
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "input-unit": "string",
  • "local-time": "string",
  • "organization-id": "11111111-1111-1111-1111-111111111111",
  • "source": "string",
  • "time": "string",
  • "type": "ActiveEnergyBurned",
  • "tz": "string",
  • "value": 0
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

DEPRECATED: Use /v2/individuals/{id}/get-all-tiles/ Deprecated

path Parameters
id
required
string

Resource identifier

query Parameters
tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

include-others
boolean
Default: false
old-format
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/landing-page-models

/v1/landing-page-models/

query Parameters
filter[company-name]
string <= 255 characters
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/landing-page-models/

Request Body schema: application/json
required
object
type
required
string
Value: "landing-page-models"
required
object
required
object (LocaleDetails)
en_US
string <= 9999 characters
es_US
string <= 9999 characters
name
required
string <= 128 characters
order
required
integer
required
object (LocaleTitles)
en_US
string <= 255 characters
es_US
string <= 255 characters
company-name
string <= 255 characters
min-android-version
string <= 32 characters
min-ios-version
string <= 32 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/landing-page-models/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/landing-page-models/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/landing-page-models/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "landing-page-models"
required
object
company-name
string <= 255 characters
object (LocaleDetails)
en_US
string <= 9999 characters
es_US
string <= 9999 characters
min-android-version
string <= 32 characters
min-ios-version
string <= 32 characters
name
string <= 128 characters
order
integer
object (LocaleTitles)
en_US
string <= 255 characters
es_US
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/landing-page-models/{id}/upload-image/

path Parameters
id
required
string

Resource identifier

Request Body schema: multipart/form-data
content
required
string <binary>
content-type
string
Default: "image/png"
Value: "image/png"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/landing-pages

/v1/landing-pages/

query Parameters
platform
required
string
Enum: "android" "ios"
version
required
string <= 32 characters
company-name
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/linguist-labels

/v1/linguist-labels/

query Parameters
filter[en-us]
string <= 999 characters

Only labels whose en_US translation exactly matches query

filter[es-us]
string <= 999 characters

Only labels whose es_US translation exactly matches query

filter[name-prefix]
string <= 255 characters
filter[platform]
string
Enum: "android" "backend" "ios" "web"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/linguist-labels/

Request Body schema: application/json
required
object
type
required
string
Value: "linguist-labels"
required
object
en-us
required
string <= 999 characters
name
required
string <= 255 characters
comment
string <= 255 characters
Default: ""
es-us
string <= 999 characters
Default: ""
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/linguist-labels/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/linguist-labels/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/linguist-labels/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "linguist-labels"
required
object
comment
string <= 255 characters
en-us
string <= 999 characters
es-us
string <= 999 characters
name
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/linguist-platforms

/v1/linguist-platforms/{id}/add-collection/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
labels
required
object
timestamp
required
string <datetime>

Responses

Request samples

Content type
application/json
{
  • "labels": {
    },
  • "timestamp": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "count-added": 0
}

/v1/logo-models

/v1/logo-models/

query Parameters
filter[fqdn]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/logo-models/

Request Body schema: application/json
required
object
type
required
string
Value: "logo-models"
required
object
content-type
required
string <= 128 characters
fqdn
required
string <= 64 characters ^([a-z0-9-]+\.)+[a-z]+$

Fully qualified domain name

type
required
string
Enum: "EMAIL_LOGO" "FAVICON_16" "FAVICON_32" "LOGO" "LOGO_SIGN_IN" "LOGO_SMALL"

Type of logo being uploaded

tags
object

Tag map. Keys must be alphanumeric or dashes. Values must be non-zero-length strings

meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/logo-models/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/logo-models/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/manual-add-metrics

/v1/manual-add-metrics/

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
filter[exclude-type]
Array of strings[ items <= 255 characters ]
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/manual-add-metrics/

Request Body schema: application/json
required
object
type
required
string
Value: "manual-add-metrics"
required
object
individual-id
required
string <uuid>
required
Array of objects
Array
count
required
integer
subtype
required
string <= 64 characters
type
required
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/manual-add-metrics/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/manual-add-metrics/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/manual-add-metrics/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "manual-add-metrics"
required
object
individual-id
required
string <uuid>
required
Array of objects
Array
count
required
integer
subtype
required
string <= 64 characters
id
required
string <= 64 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/manual-add-metrics/{id}/increment/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-id
required
string <uuid>
subtype
required
string <= 64 characters

Responses

Request samples

Content type
application/json
{
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "subtype": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/options

/v1/options/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-preferences

/v1/organization-preferences/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-preferences/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "ui-organization-preferences"
required
object
exclude-charts
Array of strings (ChartType)
Deprecated
Items Enum: "ActiveEnergyBurned" "ActiveTime" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Distance" "FeelingRating" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"

Use only-charts instead

only-charts
Array of strings (ChartType)
Items Enum: "ActiveEnergyBurned" "ActiveTime" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Distance" "FeelingRating" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
only-participant-charts
Array of strings (ChartType)
Items Enum: "ActiveEnergyBurned" "ActiveTime" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Distance" "FeelingRating" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
participant-search-fields
Array of strings (ParticipantSearchField)
Items Enum: "allParticipants" "appInvite" "blank" "dateOfBirth" "email" "firstName" "group" "lastName" "phone"
pinned-charts
Array of strings (ChartType)
Items Enum: "ActiveEnergyBurned" "ActiveTime" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Distance" "FeelingRating" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
worklist-search
Array of strings (WorklistSearchField)
Deprecated
Items Enum: "blank" "careTeam" "careTeamMember" "completed" "concerning" "concerningGroup" "fullText" "includeAll" "notes" "search" "sortBy" "tags" "title" "titlePhrase"

Use worklist-search-fields

worklist-search-fields
Array of strings (WorklistSearchField)
Items Enum: "blank" "careTeam" "careTeamMember" "completed" "concerning" "concerningGroup" "fullText" "includeAll" "notes" "search" "sortBy" "tags" "title" "titlePhrase"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/organization-preferences/{id}/patient-preferences/

path Parameters
id
required
string

Resource identifier

query Parameters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v1/organization-preferences/{id}/pin-chart/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
chart-type
required
string (ChartType)
Enum: "ActiveEnergyBurned" "ActiveTime" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Distance" "FeelingRating" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
individual-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "chart-type": "ActiveEnergyBurned",
  • "individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/v1/organization-preferences/{id}/unpin-chart/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
chart-type
required
string (ChartType)
Enum: "ActiveEnergyBurned" "ActiveTime" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Distance" "FeelingRating" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
individual-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "chart-type": "ActiveEnergyBurned",
  • "individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/v1/organizations

/v1/organizations/{id}/get-enabled-chart-types/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/v1/participant-list-views

/v1/participant-list-views/

query Parameters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/participant-list-views/

Request Body schema: application/json
required
object
type
required
string
Value: "participant-list-views"
required
object
fields
required
Array of strings
Items Enum: "action-completion-pct" "birth-date" "created-time" "current-action-completion-pct" "email" "email-verified" "first-name" "last-appointment-time" "last-article-read-time" "last-blood-glucose" "last-blood-glucose-time" "last-body-mass" "last-body-mass-time" "last-bp-diastolic" "last-bp-diastolic-state" "last-bp-systolic" "last-bp-systolic-state" "last-bp-time" "last-feeling" "last-feeling-time" "last-heart-rate" "last-heart-rate-time" "last-journal-ack-time" "last-login-time" "last-message-read-time" "last-message-received-time" "last-message-sent-time" "last-name" "last-o2-saturation" "last-o2-saturation-time" "last-survey-assigned-time" "last-survey-completed-time" "phone-verified" "preferred-name" "registration-completed-time" "unack-journal-count"
name
required
string <= 64 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/participant-list-views/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/participant-list-views/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/participant-list-views/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "participant-list-views"
required
object
fields
Array of strings
Items Enum: "action-completion-pct" "birth-date" "created-time" "current-action-completion-pct" "email" "email-verified" "first-name" "last-appointment-time" "last-article-read-time" "last-blood-glucose" "last-blood-glucose-time" "last-body-mass" "last-body-mass-time" "last-bp-diastolic" "last-bp-diastolic-state" "last-bp-systolic" "last-bp-systolic-state" "last-bp-time" "last-feeling" "last-feeling-time" "last-heart-rate" "last-heart-rate-time" "last-journal-ack-time" "last-login-time" "last-message-read-time" "last-message-received-time" "last-message-sent-time" "last-name" "last-o2-saturation" "last-o2-saturation-time" "last-survey-assigned-time" "last-survey-completed-time" "phone-verified" "preferred-name" "registration-completed-time" "unack-journal-count"
name
string <= 64 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/patients

/v1/patients/

Request Body schema: application/json
required
object
type
required
string
Value: "ui-patients"
required
object
birth-date
required
string <date>
first-name
required
string [ 1 .. 255 ] characters
last-name
required
string [ 1 .. 255 ] characters
locale
required
string (Locale)
Enum: "en_US" "es_US"
auto-confirm
boolean
Deprecated
Default: false
auto-sign-up
boolean
Deprecated
Default: true
object (CommunicationPreferences)
email
object
mobile
object
sms
object
voice
object
web
object
email
string [ 1 .. 255 ] characters
email-user-now
boolean
Deprecated

Use 'notifications' instead

gender
string (Gender)
Enum: "female" "male" "other" "pnta" "unknown"
individual-group-id
string <uuid>
individual-group-ids
Array of strings <uuid> <= 20 items [ items <uuid > ]
mobile-phone
string <= 255 characters
notifications
Array of strings
Items Enum: "email" "sms"
organization-id
string <uuid>
password
string <= 255 characters
postal-code
string <= 32 characters
preferred-contact-method
string
Enum: "email" "phone" "sms"
preferred-name
string <= 255 characters
username
string [ 1 .. 255 ] characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/patients/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
include-photo
boolean

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/preferences

/v1/preferences/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/preferences/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "ui-preferences"
required
object
chart-ordering
object
locale
string (Locale)
Enum: "en_US" "es_US"
onboarding-email-notifications-shown
boolean
onboarding-metrics-shown
boolean
participant-details-tab-order
Array of strings (ParticipantDetailsTab)
Items Enum: "actions" "ai" "appointments" "attachments" "carePlans" "customData" "dashboards" "details" "devices" "forms" "healthFeed" "journal" "lcrs" "learning" "medications" "messages" "notes" "notifications" "nutrition" "pathways" "rpm" "surveys" "testResults" "timeTrack" "todo"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/preferences/{id}/collapse-chart-tile/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
chart-type
required
string (ChartType)
Enum: "ActiveEnergyBurned" "ActiveTime" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Distance" "FeelingRating" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
individual-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "chart-type": "ActiveEnergyBurned",
  • "individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/preferences/{id}/configure-tracking/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-id
required
string <uuid>
values
required
Array of strings[ items <= 255 characters ]

The "value" portion of the selected options

Responses

Request samples

Content type
application/json
{
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "values": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/preferences/{id}/expand-chart-tile/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
chart-type
required
string (ChartType)
Enum: "ActiveEnergyBurned" "ActiveTime" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Distance" "FeelingRating" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
individual-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "chart-type": "ActiveEnergyBurned",
  • "individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/preferences/{id}/get-tracking-options/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/v1/preferences/{id}/pin-chart/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
chart-type
required
string <= 255 characters
individual-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "chart-type": "string",
  • "individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

DEPRECATED

Use set-preferred-source instead

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
chart-type
required
string (ChartType)
Enum: "ActiveEnergyBurned" "ActiveTime" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Distance" "FeelingRating" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
individual-id
required
string <uuid>
source
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "chart-type": "ActiveEnergyBurned",
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "source": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/preferences/{id}/set-chart-orders/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-id
required
string <uuid>
other-charts
required
Array of strings[ items <= 255 characters ]
pinned-charts
required
Array of strings[ items <= 255 characters ]

Responses

Request samples

Content type
application/json
{
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "other-charts": [
    ],
  • "pinned-charts": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/preferences/{id}/set-mobile-nav-items/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-id
required
string <uuid>
mobile-nav-items
required
Array of strings <= 2 items [ items <= 255 characters ]

Responses

Request samples

Content type
application/json
{
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "mobile-nav-items": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/preferences/{id}/set-preferred-source/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
chart-type
required
string (ChartType)
Enum: "ActiveEnergyBurned" "ActiveTime" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Distance" "FeelingRating" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
individual-id
required
string <uuid>
source
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "chart-type": "ActiveEnergyBurned",
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "source": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/preferences/{id}/unpin-chart/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
chart-type
required
string <= 255 characters
individual-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "chart-type": "string",
  • "individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/programs

/v1/programs/

query Parameters
filter[exclude-ids]
Array of strings <uuid> [ items <uuid > ]
Example: filter[exclude-ids]=11111111-1111-1111-1111-111111111111
include-all
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/providers

/v1/providers/

Request Body schema: application/json
required
object
type
required
string
Value: "ui-providers"
required
object
email
required
string [ 1 .. 255 ] characters
first-name
required
string [ 1 .. 255 ] characters
last-name
required
string [ 1 .. 255 ] characters
locale
required
string (Locale)
Enum: "en_US" "es_US"
birth-date
string <date>
gender
string (Gender)
Enum: "female" "male" "other" "pnta" "unknown"
individual-group-ids
Array of strings <uuid> <= 20 items [ items <uuid > ]
mobile-phone
string <= 255 characters
organization-id
string <uuid>
postal-code
string <= 32 characters
preferred-contact-method
string
Enum: "email" "phone" "sms"
preferred-name
string <= 255 characters
roles
Array of strings <= 20 items [ items <= 255 characters ]
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/providers/{id}/add-org-role/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
role-name
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "role-name": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/v1/purge-data

/v1/purge-data/

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/purge-data/

Request Body schema: application/json
required
object
type
required
string
Value: "system-purges"
required
object
entity-id
required
string <= 255 characters
entity-type
required
string
Enum: "individual" "organization" "user"
reference-id
required
string <= 255 characters
request-id
required
string <= 255 characters
archive
boolean
Default: false
property name*
additional property
any
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/quick-add-interviews

/v1/quick-add-interviews/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/quick-add-interviews/

Request Body schema: application/json
required
object
type
required
string
Value: "quick-add-interviews"
required
object (QuickAddInterview)
icon-background-color
required
string <= 255 characters

Hex color

icon-name
required
string <= 255 characters
required
object (LocaleNames)
en_US
string <= 255 characters
es_US
string <= 255 characters
organization-id
required
string <uuid>
profile-name
required
string <= 255 characters
required
object (LocaleQuestions)
en_US
string <= 9999 characters
es_US
string <= 9999 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/quick-add-interviews/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/quick-add-interviews/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/quick-add-interviews/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "quick-add-interviews"
required
object
icon-background-color
string <= 255 characters

Hex color

icon-name
string <= 255 characters
object (LocaleNames)
en_US
string <= 255 characters
es_US
string <= 255 characters
profile-name
string <= 255 characters
object (LocaleQuestions)
en_US
string <= 9999 characters
es_US
string <= 9999 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/replicators

/v1/replicators/

query Parameters
filter[classpath]
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/replicators/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/reporter-csv-reports

/v1/reporter-csv-reports/

Request Body schema: application/json
required
object
type
required
string
Value: "reporter-csv-reports"
required
object
required
object
required
Array of objects
end
string <datetime>

UTC end time for readings (for custom) scope

start
string <datetime>

UTC start time for readings within the scope

time
string <datetime>

Arbitrary UTC timestamp to compute a 'start' and 'end' from, it defaults to current time

individual-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/reporter-csv-reports/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/reporter-csv-reports/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/reporter-csv-reports/{id}/get-content/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "url": "string"
}

/v1/reporter-reports

/v1/reporter-reports/

Request Body schema: application/json
required
object
type
required
string
Value: "reporter-reports"
required
object or object
Any of
full-path
required
string [ 1 .. 2000 ] characters

URL path, including leading '/', to generate report for.

individual-id
required
string <uuid>
local-storage
required
object
use-lambda
boolean
Deprecated
Default: true
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/reporter-reports/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/reporter-reports/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/reporter-reports/{id}/get-content/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "url": "string"
}

/v1/reporter-reports/{id}/update-result/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
returncode
required
integer
status
required
string
Enum: "failed" "success"
stderr
required
string <= 99999 characters
stdout
required
string <= 99999 characters

Responses

Request samples

Content type
application/json
{
  • "returncode": 0,
  • "status": "failed",
  • "stderr": "string",
  • "stdout": "string"
}

Response samples

Content type
application/vnd.api+json
{ }

/v1/sniffers

/v1/sniffers/

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/sniffers/

Request Body schema: application/json
required
object
type
required
string
Value: "sniffers"
required
object
user-id
required
string <uuid>
valid-until
required
string <datetime>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/sniffers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers/{id}/get-logs/

path Parameters
id
required
string

Resource identifier

query Parameters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/swagger-specs

/v1/swagger-specs/

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/teapots

/v1/teapots/

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/teapots/{id}/make-coffee/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/translations

/v1/translations/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
app-version
required
string <= 32 characters
linguist-version
required
string <= 32 characters
platform
required
string
Enum: "android" "ios" "web"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/users

/v1/users/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v2/charts

/v2/charts/

query Parameters
fields
Array of strings
Items Enum: "has-readings" "icon-background-color" "icon-name" "max" "max-time" "min" "min-time" "precision" "read-only" "read-schema" "schema" "scopes" "source-options" "sources" "title" "unit"
include-optional-scopes
Array of strings
Items Enum: "30days" "3months" "day" "month" "week" "year"
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v2/charts/{id}/add-reading/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
context
required
string
Enum: "AFTER_MEAL" "BEDTIME" "BEFORE_MEAL" "FASTING" "UNSPECIFIED"
input-unit
required
string

The unit that the value for this reading. It should be the one provided in /charts/ response.

type
required
string
Value: "BloodGlucose"
tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

value
required
number

The reading value

include-others
boolean
increment-metric
boolean
individual-id
string <uuid>
local-time
string <datetime>

Timestamp for reading in user's current timezone (tz) for series types with a single time

organization-id
string <uuid>
source
string <= 50 characters
time
string <datetime>

Timestamp for reading in UTC for series types with a single time

Responses

Request samples

Content type
application/json
{
  • "include-others": true,
  • "increment-metric": true,
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "input-unit": "string",
  • "local-time": "string",
  • "organization-id": "11111111-1111-1111-1111-111111111111",
  • "source": "string",
  • "time": "string",
  • "type": "ActiveEnergyBurned",
  • "tz": "string",
  • "value": 0
}

Response samples

Content type
application/vnd.api+json
{ }

/v2/charts/{id}/delete-reading/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
individual-id
required
string <uuid>
time
required
string <datetime>

Timestamp for reading in UTC for series types with a single time

organization-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "begin-time": "string",
  • "end-time": "string",
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "organization-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{ }

DEPRECATED: Use get-details instead Deprecated

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

all-sources
boolean
Default: false

When set and "source" is omitted, will show all sources instead of preferred source

allow-summary
boolean
Default: false

Allow using summary graph-type where appropriate

context
string
Enum: "AFTER_MEAL" "BEDTIME" "BEFORE_MEAL" "FASTING" "FORMAL" "INFORMAL" "UNSPECIFIED"
end
string <datetime>

UTC end time for readings within range

organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer [ 1 .. 1000 ]
Default: 500
scope
string
Enum: "30days" "3months" "day" "month" "week" "year"

When omitted, both 'start' and 'end' must be provided.

source
string <= 255 characters
start
string <datetime>

UTC start time for readings within the scope (or range)

time
string <datetime>

Arbitrary UTC timestamp to compute a "start" and "end" from, it defaults to current time

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v2/charts/{id}/edit-reading/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
context
required
string
Enum: "AFTER_MEAL" "BEDTIME" "BEFORE_MEAL" "FASTING" "UNSPECIFIED"
input-unit
required
string

The unit that the value for this reading. It should be the one provided in /charts/ response.

type
required
string
Value: "BloodGlucose"
tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

value
required
number

The reading value

include-others
boolean
individual-id
string <uuid>
local-time
string <datetime>

Timestamp for reading in user's current timezone (tz) for series types with a single time

organization-id
string <uuid>
previous-local-time
string <datetime>

Previous timestamp for reading in user's timezone (tz) when editing

previous-time
string <datetime>

Previous timestamp for reading in UTC when editing

source
string <= 50 characters
time
string <datetime>

Timestamp for reading in UTC for series types with a single time

Responses

Request samples

Content type
application/json
{
  • "include-others": true,
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "input-unit": "string",
  • "local-time": "string",
  • "organization-id": "11111111-1111-1111-1111-111111111111",
  • "previous-local-time": "string",
  • "previous-time": "string",
  • "source": "string",
  • "time": "string",
  • "type": "ActiveEnergyBurned",
  • "tz": "string",
  • "value": 0
}

Response samples

Content type
application/vnd.api+json
{ }

/v2/charts/{id}/get-details/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

all-sources
boolean
Default: false

When set and "source" is omitted, will show all sources instead of preferred source

allow-summary
boolean
Default: false

Allow using summary graph-type where appropriate

context
string
Enum: "AFTER_MEAL" "BEDTIME" "BEFORE_MEAL" "FASTING" "FORMAL" "INFORMAL" "UNSPECIFIED"
end
string <datetime>

UTC end time for readings within range

organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer [ 1 .. 1000 ]
Default: 500
scope
string
Enum: "30days" "3months" "day" "month" "week" "year"

When omitted, both 'start' and 'end' must be provided.

source
string <= 255 characters
start
string <datetime>

UTC start time for readings within the scope (or range)

time
string <datetime>

Arbitrary UTC timestamp to compute a "start" and "end" from, it defaults to current time

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v2/charts/{id}/get-goal/

path Parameters
id
required
string

Resource identifier

query Parameters
tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v2/charts/{id}/get-readings/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

all-sources
boolean
Default: false

When set and "source" is omitted, will show all sources instead of preferred source

context
string
Enum: "AFTER_MEAL" "BEDTIME" "BEFORE_MEAL" "FASTING" "FORMAL" "INFORMAL" "UNSPECIFIED"
end
string <datetime>

UTC end time for readings within range

organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
reverse
boolean
scope
string
Enum: "30days" "3months" "day" "month" "week" "year"

When omitted, both 'start' and 'end' must be provided.

source
string <= 255 characters
start
string <datetime>

UTC start time for readings within the scope (or range)

time
string <datetime>

Arbitrary UTC timestamp to compute a "start" and "end" from, it defaults to current time

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

DEPRECATED: Use get-goal instead Deprecated

path Parameters
id
required
string

Resource identifier

query Parameters
tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

DEPRECATED Deprecated

Use get-readings instead

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

all-sources
boolean
Default: false

When set and "source" is omitted, will show all sources instead of preferred source

context
string
Enum: "AFTER_MEAL" "BEDTIME" "BEFORE_MEAL" "FASTING" "FORMAL" "INFORMAL" "UNSPECIFIED"
end
string <datetime>

UTC end time for readings within range

organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
reverse
boolean
scope
string
Enum: "30days" "3months" "day" "month" "week" "year"

When omitted, both 'start' and 'end' must be provided.

source
string <= 255 characters
start
string <datetime>

UTC start time for readings within the scope (or range)

time
string <datetime>

Arbitrary UTC timestamp to compute a "start" and "end" from, it defaults to current time

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v2/individuals

/v2/individuals/{id}/add-reading-from-tile/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object or object or object or object or object or object (ChartReadingSchema)
One of
context
required
string
Enum: "AFTER_MEAL" "BEDTIME" "BEFORE_MEAL" "FASTING" "UNSPECIFIED"
input-unit
required
string

The unit that the value for this reading. It should be the one provided in /charts/ response.

time
required
string <datetime>

Timestamp for reading in UTC for series types with a single time

type
required
string
Value: "BloodGlucose"
value
required
number

The reading value

organization-id
string <uuid>
source
string <= 50 characters
tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

increment-metric
boolean
Default: false
organization-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "increment-metric": false,
  • "organization-id": "11111111-1111-1111-1111-111111111111",
  • "reading": {
    },
  • "tz": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v2/individuals/{id}/delete-homefeed-log/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
entry-id
required
string <uuid>
entry-type
required
string <= 64 characters

Responses

Request samples

Content type
application/json
{
  • "entry-id": "11111111-1111-1111-1111-111111111111",
  • "entry-type": "string"
}

Response samples

Content type
application/vnd.api+json
{ }

/v2/individuals/{id}/get-all-tiles/

path Parameters
id
required
string

Resource identifier

query Parameters
tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

count
integer [ 0 .. 10 ]
Default: 5

Number of tiles with actual data, the rest will be placeholders

include-new
boolean
Default: false

Include ActiveTime and all chart types added after Jan 28, 2020

include-others
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v2/individuals/{id}/get-chart-data/

path Parameters
id
required
string

Resource identifier

query Parameters
chart-types
required
Array of strings (ChartType)
Items Enum: "ActiveEnergyBurned" "ActiveTime" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Distance" "FeelingRating" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"

Explicit types being requested

date
required
string <date>

the day for which you want data

tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/v2/individuals/{id}/get-devices/

path Parameters
id
required
string

Resource identifier

query Parameters
filter[connected]
required
boolean
includes
Array of strings
Items Enum: "alio" "ble" "bodytrace" "carium" "dexcom" "fitbit" "garmin" "googlefit" "healthkit" "marsonik" "omron" "smartmeter" "tenovi" "transtek"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/v2/individuals/{id}/get-mobile-navigation/

path Parameters
id
required
string

Resource identifier

query Parameters
platform
string
Enum: "android" "ios"
version
string <= 32 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/v2/individuals/{id}/get-pinnable-features/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/v2/individuals/{id}/get-quick-add-types/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/v2/individuals/{id}/get-tiles/

path Parameters
id
required
string

Resource identifier

query Parameters
chart-types
required
Array of strings[ items <= 255 characters ]

Explicit tiles being requested

tz
required
string (Timezone) <= 64 characters

The tz database name of the current timezone of the user (e.g. "America/Los_Angeles")

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v2/individuals/{id}/pin-feature/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
name
required
string (PinnableFeature)
Enum: "actions" "appointments" "care-plans" "challenges" "journal" "learning" "medications" "nutrition" "test-results" "todos"

Responses

Request samples

Content type
application/json
{
  • "name": "actions"
}

Response samples

Content type
application/vnd.api+json
{ }

/v2/individuals/{id}/start-quick-add-interview/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/v2/individuals/{id}/unpin-feature/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
name
required
string (PinnableFeature)
Enum: "actions" "appointments" "care-plans" "challenges" "journal" "learning" "medications" "nutrition" "test-results" "todos"

Responses

Request samples

Content type
application/json
{
  • "name": "actions"
}

Response samples

Content type
application/vnd.api+json
{ }

/v2/translations

/v2/translations/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
app-version
required
string <= 32 characters
last-modified
required
string <datetime>
platform
required
string
Enum: "android" "ios" "web"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}