Skip to main content
API docs by Redocly

integrator API definition (1.0.0)

integrator API definition

/v1/alio-account-organizations

/v1/alio-account-organizations/

query Parameters
filter[organization-id]
string <uuid>
Example: filter[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/alio-account-organizations/

Request Body schema: application/json
required
object
type
required
string
Value: "alio-account-organizations"
required
object
account-id
required
string <uuid>
organization-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/alio-account-organizations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/alio-accounts

/v1/alio-accounts/

query Parameters
filter[name]
string <= 32 characters
filter[organization-id]
string <uuid>
Example: filter[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/alio-accounts/

Request Body schema: application/json
required
object
type
required
string
Value: "alio-accounts"
required
object
name
required
string <= 32 characters
system
required
string
Enum: "dev" "prod"
organization-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/alio-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/alio-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/alio-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "alio-accounts"
required
object
system
required
string
Default: "prod"
Enum: "dev" "prod"
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/alio-attachments

/v1/alio-attachments/

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
filter[end-time]
string <datetime>
filter[filename]
string <= 255 characters
filter[start-time]
string <datetime>
filter[with-url]
boolean
Default: false
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": { }
}

Deletes an attachment

Deletes an attachment

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/alio-maps

/v1/alio-maps/

query Parameters
filter[device-id]
string <= 17 characters
filter[device-types]
Array of strings
Items Enum: "gateway" "kit" "patchbox" "smartpatch"
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[status]
Array of strings
Items Enum: "active" "deleted" "expired" "registered" "running"
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/alio-maps/

Request Body schema: application/json
required
object
type
required
string
Value: "alio-maps"
required
object
device-id
required
string <= 32 characters
individual-id
required
string <uuid>
device-type
string
Enum: "gateway" "kit" "patchbox" "smartpatch"
organization-id
string <uuid>
start-time
string <datetime>
ticket-duplicates
boolean
Default: true
meta
object

Responses

Request samples

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

Response samples

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

/v1/alio-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/alio-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/alio-notification

/v1/alio-notification/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v1/alio-users

/v1/alio-users/

query Parameters
filter[external-id]
string <= 12 characters
filter[first-name]
string <= 255 characters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[last-name]
string <= 255 characters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[username]
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/alio-users/

Request Body schema: application/json
required
object
type
required
string
Value: "alio-users"
required
object
individual-id
required
string <uuid>
organization-id
required
string <uuid>
enable-simulator
boolean
meta
object

Responses

Request samples

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

Response samples

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

/v1/alio-users/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/alio-users/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/alio-users/{id}/start-sim/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
mode
string
Value: "STANDARD"
scenario
string
Enum: "HIGH POTASSIUM" "HIGH POTASSIUM (With Data Gap)" "LOW POTASSIUM" "LOW POTASSIUM (With Data Gap)" "NORMAL" "NORMAL (With Data Gap)"

Responses

Request samples

Content type
application/json
{
  • "mode": "STANDARD",
  • "scenario": "HIGH POTASSIUM"
}

Response samples

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

/v1/alio-users/{id}/stop-monitor/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
reason
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

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

/v1/alio-users/{id}/stop-sim/

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/alio-users/{id}/sync/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
start-time
string <datetime>

Responses

Request samples

Content type
application/json
{
  • "start-time": "string"
}

Response samples

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

/v1/bodytrace-collectors

/v1/bodytrace-collectors/

Request Body schema: application/json
imei
required
string <= 32 characters
ts
required
integer
values
required
object
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "imei": "string",
  • "ts": 0,
  • "values": { }
}

Response samples

Content type
application/vnd.api+json
{ }

/v1/bodytrace-maps

/v1/bodytrace-maps/

query Parameters
filter[device-type]
string
Enum: "" "scale" "sphygmomanometer"
filter[imei]
string <= 15 characters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[shared-with-org-id]
string <uuid>
Example: filter[shared-with-org-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": { }
}

Use the `integrator:bodytrace-map:v2:post` Deprecated

Use the integrator:bodytrace-map:v2:post

Request Body schema: application/json
required
object
type
required
string
Value: "bodytrace-maps"
required
object
individual-id
required
string <uuid>
barcode
string <= 255 characters
imei
string <= 15 characters
organization-id
string <uuid>
start-time
string <datetime>
ticket-duplicates
boolean
Default: true
meta
object

Responses

Request samples

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

Response samples

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

/v1/bodytrace-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/bodytrace-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/bodytrace-maps/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "bodytrace-maps"
required
object
anchor-value
number
device-type
string
Enum: "" "scale" "sphygmomanometer"
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/bodytrace-maps/{id}/sync/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
start-time
string <datetime>

Responses

Request samples

Content type
application/json
{
  • "start-time": "string"
}

Response samples

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

/v1/device-bledata

/v1/device-bledata/

Request Body schema: application/json
required
object
type
required
string
Value: "device-bledata"
required
object
characteristic-id
required
string <= 32 characters
required
Array of integers or object
Any of
Array
integer
device-name
required
string <= 255 characters
individual-id
required
string <uuid>
tz-offset-mins
required
integer
device-id
string <= 48 characters
meta
object

Responses

Request samples

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

Response samples

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

/v1/device-debuggers

/v1/device-debuggers/

Request Body schema: application/json
required
object
type
required
string
Value: "device-debuggers"
required
object
debugger-type
required
string
Enum: "bodytrace" "smartmeter" "tenovi"
method
required
string <= 32 characters
args
object
meta
object

Responses

Request samples

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

Response samples

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

/v1/device-debuggers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/device-debuggers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/device-manufacturers

/v1/device-manufacturers/

query Parameters
filter[manufacturer]
string <= 32 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/device-orders

/v1/device-orders/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[external-order-id]
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/device-orders/

Request Body schema: application/json
required
object
type
required
string
Value: "device-orders"
required
object
external-order-id
required
string <= 64 characters
organization-id
required
string <uuid>
destination-address
string <= 255 characters
destination-city
string <= 255 characters
destination-state
string <= 16 characters
destination-to
string <= 255 characters
destination-zipcode
string <= 16 characters
individual-id
string <uuid>
notes
string <= 99999 characters
order-email
string <email>
payer-company
string <= 255 characters
payer-name
string <= 255 characters
recipient-email
string <email>
meta
object

Responses

Request samples

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

Response samples

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

/v1/device-orders/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/device-orders/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/device-orders/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "device-orders"
required
object
destination-address
string <= 255 characters
destination-city
string <= 255 characters
destination-state
string <= 16 characters
destination-to
string <= 255 characters
destination-zipcode
string <= 16 characters
external-order-id
string <= 64 characters
individual-id
string <uuid>
notes
string <= 99999 characters
order-email
string <email>
payer-company
string <= 255 characters
payer-name
string <= 255 characters
recipient-email
string <email>
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/device-shipments

/v1/device-shipments/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[order-id]
string <uuid>
Example: filter[order-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/device-shipments/

Request Body schema: application/json
required
object
type
required
string
Value: "device-shipments"
required
object
order-id
required
string <uuid>
shipper
required
string
Enum: "fedex" "ups" "usps"
tracked
boolean
tracking-id
string <= 64 characters
tracking-status
string
Enum: "created" "delivered" "error" "transit"
meta
object

Responses

Request samples

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

Response samples

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

/v1/device-shipments/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/device-shipments/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/device-shipments/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "device-shipments"
required
object
shipper
string
Enum: "fedex" "ups" "usps"
tracked
boolean
tracking-id
string <= 64 characters
tracking-status
string
Enum: "created" "delivered" "error" "transit"
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/devices

/v1/devices/

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

Responses

Response samples

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

/v1/devices/

Request Body schema: application/json
required
object
type
required
string
Value: "devices"
required
object
device-id
required
string <= 48 characters
device-model
required
string <= 255 characters
individual-id
required
string <uuid>
platform-model
required
string <= 255 characters
platform-os
required
string <= 255 characters
firmware-revision
string <= 32 characters
hardware-revision
string <= 32 characters
manufacturer-name
string <= 128 characters
model-number
string <= 64 characters
serial-number
string <= 64 characters
software-revision
string <= 32 characters
system-id
string <= 64 characters
user-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/devices/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
device-id
string <= 48 characters

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/devices/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/display-devices

/v1/display-devices/

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/display-devices/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/exposomes

/v1/exposomes/{id}/update-location/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
latitude
required
string <decimal>
longitude
required
string <decimal>

Responses

Request samples

Content type
application/json
{
  • "latitude": "string",
  • "longitude": "string"
}

Response samples

Content type
application/vnd.api+json
null

/v1/health-kit-files

/v1/health-kit-files/

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

Responses

Request samples

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

Response samples

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

/v1/health-kit-files/{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
{
  • "task-id": "string"
}

/v1/health-kits

/v1/health-kits/{id}/upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/marsonik-account-organizations

/v1/marsonik-account-organizations/

query Parameters
filter[organization-id]
string <uuid>
Example: filter[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/marsonik-account-organizations/

Request Body schema: application/json
required
object
type
required
string
Value: "marsonik-account-organizations"
required
object
account-id
required
string <uuid>
organization-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/marsonik-account-organizations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/marsonik-accounts

/v1/marsonik-accounts/

query Parameters
filter[name]
string <= 32 characters
filter[organization-id]
string <uuid>
Example: filter[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/marsonik-accounts/

Request Body schema: application/json
required
object
type
required
string
Value: "marsonik-accounts"
required
object
name
required
string <= 32 characters
organization-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/marsonik-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/marsonik-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/marsonik-maps

/v1/marsonik-maps/

query Parameters
filter[device-id]
string [ 5 .. 15 ] characters
filter[device-type]
string
Enum: "gateway" "pulsox" "scale" "smart-watch" "sphygmomanometer"
filter[hwi-device-id]
string <uuid>
Example: filter[hwi-device-id]=11111111-1111-1111-1111-111111111111
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[manufacturer-model]
string <= 64 characters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[shared-with-org-id]
string <uuid>
Example: filter[shared-with-org-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/marsonik-maps/

Request Body schema: application/json
required
object
type
required
string
Value: "marsonik-maps"
required
object
device-id
required
string <= 32 characters
individual-id
required
string <uuid>
organization-id
string <uuid>
start-time
string <datetime>
ticket-duplicates
boolean
Default: true
meta
object

Responses

Request samples

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

Response samples

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

/v1/marsonik-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/marsonik-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/marsonik-notification

Endpoint to process data notification events from

Endpoint to process data notification events from Marsonik

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v1/notification-bis

/v1/notification-bis/

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{ }

/v1/notification-fitbit

/v1/notification-fitbit/

query Parameters
verify
required
string <= 255 characters

Responses

/v1/notification-fitbit/

Request Body schema: application/json
__body__
Array of objects

Responses

Request samples

Content type
application/json
{
  • "__body__": [
    ]
}

/v1/notification-garmin

/v1/notification-garmin/

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{ }

/v1/notification-omron

/v1/notification-omron/

Request Body schema: application/json
id
required
string <= 64 characters
timestamp
required
string <= 255 characters

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
null

/v1/nutrition-favorite-items

/v1/nutrition-favorite-items/

query Parameters
individual-id
required
string <uuid>
Example: 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/nutrition-favorite-items/

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-favorite-items"
required
object
individual-id
required
string <uuid>
item-id
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/nutrition-favorite-items/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/nutrition-favorite-items/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/nutrition-historic-nutrients-goals

/v1/nutrition-historic-nutrients-goals/

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[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/nutrition-historic-nutrients-goals/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/nutrition-individual-summaries

/v1/nutrition-individual-summaries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/nutrition-item-lookups

/v1/nutrition-item-lookups/

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-item-lookups"
required
object or object
Any of
item-id
required
string <= 100 characters
upc
string <= 255 characters ^[0-9]+$
meta
object

Responses

Request samples

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

Response samples

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

/v1/nutrition-log-occasions

/v1/nutrition-log-occasions/

query Parameters
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/nutrition-log-occasions/

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-log-occasions"
required
object
display-name
required
object

keyed by locale

icon-name
required
string <= 255 characters
name
required
string <= 255 characters
sort-order
required
integer >= 0
default-time
string <time>
meta
object

Responses

Request samples

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

Response samples

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

/v1/nutrition-log-occasions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/nutrition-log-occasions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/nutrition-log-occasions/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-log-occasions"
required
object
default-time
string <time>
display-name
object

keyed by locale

icon-name
string <= 255 characters
name
string <= 255 characters
sort-order
integer >= 0
meta
object

Responses

Request samples

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

Response samples

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

/v1/nutrition-log-summaries

/v1/nutrition-log-summaries/

query Parameters
days
required
integer [ 1 .. 14 ]
Default: 1
entry-date
required
string <date>
include-averages
required
boolean
Default: false
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/nutrition-logged-items

/v1/nutrition-logged-items/

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
filter[include-hidden]
boolean
Default: false
occasion-name
string <= 255 characters
page[limit]
integer [ 1 .. 100 ]
Default: 100

Responses

Response samples

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

/v1/nutrition-logged-items/{id}/hide/

path Parameters
id
required
string

Resource identifier

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

Responses

Request samples

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

Response samples

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

/v1/nutrition-logs

/v1/nutrition-logs/

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
filter[entry-date]
string <date>
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/nutrition-logs/

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-logs"
required
object
entry-date
required
string <date>
individual-id
required
string <uuid>
item-id
required
string <= 255 characters
occasion-name
required
string <= 255 characters
serving-qty
required
number >= 0
serving-unit
required
string <= 255 characters
consumed-at
string <datetime>
meta
object

Responses

Request samples

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

Response samples

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

/v1/nutrition-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/nutrition-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/nutrition-logs/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-logs"
required
object
consumed-at
string <datetime>
serving-qty
number >= 0
serving-unit
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/nutrition-meal-plans

/v1/nutrition-meal-plans/

query Parameters
individual-id
required
string <uuid>
Example: 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/nutrition-meal-plans/

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-meal-plans"
required
object
individual-id
required
string <uuid>
name
required
string <= 255 characters
required
Array of objects
Array
required
Array of objects
occasion-name
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/nutrition-meal-plans/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/nutrition-meal-plans/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/nutrition-meal-plans/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-meal-plans"
required
object
name
string <= 255 characters
Array of objects
Array
required
Array of objects
occasion-name
required
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/nutrition-meal-plans/{id}/log-plan/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
entry-date
required
string <date>
required
Array of objects
Array
consumed-at
required
string <datetime>
occasion-name
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "entry-date": "2019-08-24",
  • "occasion-items": [
    ]
}

Response samples

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

/v1/nutrition-meals

/v1/nutrition-meals/

query Parameters
individual-id
required
string <uuid>
Example: 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/nutrition-meals/

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-meals"
required
object
individual-id
required
string <uuid>
required
Array of objects
Array
item-id
required
string <= 255 characters
serving-qty
required
number >= 0
serving-unit
required
string <= 255 characters
name
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/nutrition-meals/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/nutrition-meals/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/nutrition-meals/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-meals"
required
object
Array of objects
Array
item-id
required
string <= 255 characters
serving-qty
required
number >= 0
serving-unit
required
string <= 255 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/nutrition-meals/{id}/log-meal/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
entry-date
required
string <date>
occasion-name
required
string <= 255 characters
consumed-at
string <datetime>

Responses

Request samples

Content type
application/json
{
  • "consumed-at": "string",
  • "entry-date": "2019-08-24",
  • "occasion-name": "string"
}

Response samples

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

/v1/nutrition-nutrients-goals

/v1/nutrition-nutrients-goals/ Deprecated

query Parameters
individual-id
required
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/nutrition-nutrients-goals/ Deprecated

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-nutrients-goals"
required
NutrientsGoalPostJS (object) or NutrientsGoalPostJS (object) (NutrientsGoalPostJS)
Any of
individual-id
required
string <uuid>
nutrient-calories
required
integer >= 0
nutrient-protein-pct
required
integer [ 0 .. 100 ]
nutrient-total-carbohydrate-pct
required
integer [ 0 .. 100 ]
nutrient-total-fat-pct
required
integer [ 0 .. 100 ]
organization-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/nutrition-nutrients-goals/{id}/ Deprecated

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/nutrition-nutrients-goals/{id}/ Deprecated

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/nutrition-nutrients-goals/{id}/ Deprecated

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-nutrients-goals"
required
NutrientsGoalPatchJS (object) or NutrientsGoalPatchJS (object) (NutrientsGoalPatchJS)
Any of
nutrient-calories
integer >= 0
nutrient-protein-pct
integer [ 0 .. 100 ]
nutrient-total-carbohydrate-pct
integer [ 0 .. 100 ]
nutrient-total-fat-pct
integer [ 0 .. 100 ]
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/nutrition-queries

/v1/nutrition-queries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/nutrition-searches

/v1/nutrition-searches/

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-searches"
required
object
input
required
string <= 100 characters
meta
object

Responses

Request samples

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

Response samples

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

/v1/nutrition-user-items

/v1/nutrition-user-items/

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
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/nutrition-user-items/

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-user-items"
required
object
individual-id
required
string <uuid>
name
required
string <= 255 characters
nutrient-calories
number <= 9999.99
nutrient-cholesterol
number <= 9999.99
nutrient-dietary-fiber
number <= 9999.99
nutrient-potassium
number <= 9999.99
nutrient-protein
number <= 9999.99
nutrient-saturated-fat
number <= 9999.99
nutrient-sodium
number <= 9999.99
nutrient-sugars
number <= 9999.99
nutrient-total-carbohydrate
number <= 9999.99
nutrient-total-fat
number <= 9999.99
serving-qty
number [ 0.000001 .. 9999.99 ]
Default: 1
serving-unit
string <= 255 characters
Default: ""
serving-weight
number [ 0 .. 9999.99 ]
Default: 0
meta
object

Responses

Request samples

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

Response samples

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

/v1/nutrition-user-items/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/nutrition-user-items/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/nutrition-users

/v1/nutrition-users/

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

Responses

Response samples

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

/v1/oauth

/v1/oauth/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
type
required
string <= 32 characters

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/oauth/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
type
required
string
Enum: "alio" "bodytrace" "dexcom" "fitbit" "garmin" "googlefit" "healthkit" "marsonik" "omron" "smartmeter" "tellihealth" "tenovi" "transtek"

Responses

Response samples

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

/v1/oauth/{id}/request/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
extra
required
object
method
required
string <= 32 characters
oauth-url
required
string <= 255 characters
type
required
string <= 32 characters

Responses

Request samples

Content type
application/json
{
  • "extra": { },
  • "method": "string",
  • "oauth-url": "string",
  • "type": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "js": { },
  • "status-code": 0
}

/v1/oauth/{id}/start/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
type
required
string
Enum: "alio" "bodytrace" "dexcom" "fitbit" "garmin" "googlefit" "healthkit" "marsonik" "omron" "smartmeter" "tellihealth" "tenovi" "transtek"
final-url
string <= 255 characters
scopes
string <= 9999 characters

Responses

Request samples

Content type
application/json
{
  • "final-url": "string",
  • "scopes": "string",
  • "type": "alio"
}

Response samples

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

/v1/oauth/{id}/types/

path Parameters
id
required
string

Resource identifier

query Parameters
filter[include-beta]
boolean

[deprecated] new optional type needs to be explicitly specified in includes

filter[type]
string
Enum: "alio" "bodytrace" "dexcom" "fitbit" "garmin" "googlefit" "healthkit" "marsonik" "omron" "smartmeter" "tellihealth" "tenovi" "transtek"
includes
Array of strings[ items <= 32 characters ]

Responses

Response samples

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

/v1/oauth-config

/v1/oauth-config/

query Parameters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[type]
string
Enum: "alio" "bodytrace" "dexcom" "fitbit" "garmin" "googlefit" "healthkit" "marsonik" "omron" "smartmeter" "tellihealth" "tenovi" "transtek"
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/oauth-config/

Request Body schema: application/json
required
object
type
required
string
Value: "oauth-config"
required
object
individual-id
required
string <uuid>
type
required
string
Enum: "alio" "bodytrace" "dexcom" "fitbit" "garmin" "googlefit" "healthkit" "marsonik" "omron" "smartmeter" "tellihealth" "tenovi" "transtek"
collector-fetch-history-days
integer [ 0 .. 365 ]
Default: 7
collector-fetch-history-months
integer [ 0 .. 24 ]
Default: 12
meta
object

Responses

Request samples

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

Response samples

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

/v1/oauth-config/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/oauth-config/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/oauth-config/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "oauth-config"
required
object
collector-fetch-history-days
integer [ 0 .. 365 ]
collector-fetch-history-months
integer [ 0 .. 24 ]
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/oauth-config-feature

/v1/oauth-config-feature/

query Parameters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[type]
string
Enum: "alio" "bodytrace" "dexcom" "fitbit" "garmin" "googlefit" "healthkit" "marsonik" "omron" "smartmeter" "tellihealth" "tenovi" "transtek"
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/oauth-config-feature/

Request Body schema: application/json
required
object
type
required
string
Value: "oauth-config-feature"
required
object
feature
string
Enum: "dexcom-legacy" "dexcom-sandbox" "dexcom-v3-api" "omron-legacy" "omron-prd" "omron-stg"
individual-id
string <uuid>
type
string
Enum: "alio" "bodytrace" "dexcom" "fitbit" "garmin" "googlefit" "healthkit" "marsonik" "omron" "smartmeter" "tellihealth" "tenovi" "transtek"
meta
object

Responses

Request samples

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

Response samples

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

/v1/oauth-config-feature/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/oauth-config-feature/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/oauth-dexcom

/v1/oauth-dexcom/

query Parameters
state
required
string <= 255 characters
code
string <= 255 characters
error
string <= 255 characters
session_state
string <= 255 characters

Responses

Response samples

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

/v1/oauth-dexcom/{id}/collect/

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
{
  • "task-id": "string"
}

/v1/oauth-dexcom/{id}/refresh-token/

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
{
  • "task-id": "string"
}

/v1/oauth-fitbit

/v1/oauth-fitbit/

query Parameters
state
required
string <= 255 characters
code
string <= 255 characters
error
string <= 255 characters
session_state
string <= 255 characters

Responses

Response samples

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

/v1/oauth-fitbit/{id}/collect/

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
{
  • "task-id": "string"
}

/v1/oauth-fitbit/{id}/refresh-token/

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
{
  • "task-id": "string"
}

/v1/oauth-fitbit/{id}/subscribe/

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
{
  • "task-id": "string"
}

/v1/oauth-fitbit/{id}/unsubscribe/

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
{
  • "task-id": "string"
}

/v1/oauth-garmin

/v1/oauth-garmin/

query Parameters
state
required
string <= 255 characters
oauth_token
string <= 64 characters
oauth_verifier
string <= 64 characters

Responses

/v1/oauth-garmin/{id}/collect/

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
{
  • "task-id": "string"
}

/v1/oauth-garmin/{id}/refresh-token/

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
{
  • "task-id": "string"
}

/v1/oauth-googlefit

/v1/oauth-googlefit/

query Parameters
state
required
string <= 255 characters
code
string <= 255 characters
error
string <= 255 characters
session_state
string <= 255 characters

Responses

Response samples

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

/v1/oauth-googlefit/{id}/collect/

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
{
  • "task-id": "string"
}

/v1/oauth-googlefit/{id}/refresh-token/

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
{
  • "task-id": "string"
}

/v1/oauth-omron

/v1/oauth-omron/

query Parameters
state
required
string <= 255 characters
code
string <= 255 characters
error
string <= 255 characters
session_state
string <= 255 characters

Responses

Response samples

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

/v1/oauth-omron/{id}/collect/

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
{
  • "task-id": "string"
}

/v1/oauth-omron/{id}/refresh-token/

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
{
  • "task-id": "string"
}

/v1/opsis-collectors

/v1/opsis-collectors/

Request Body schema: application/json
data
required
object
time
required
string <datetime>
user-email
string <email>
user-id
string <uuid>
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "time": "string",
  • "user-email": "user@example.com",
  • "user-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "log-id": "11111111-1111-1111-1111-111111111111"
}

/v1/opsis-maps

/v1/opsis-maps/

query Parameters
filter[external-id]
string <= 64 characters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[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/opsis-maps/

Request Body schema: application/json
required
object
type
required
string
Value: "opsis-maps"
required
object
external-id
required
string <= 64 characters
individual-id
required
string <uuid>
organization-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/opsis-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/opsis-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/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/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/smartmeter-collectors

/v1/smartmeter-collectors/

Request Body schema: application/json
date_recorded
required
string <= 19 characters
device_id
required
string <= 32 characters
reading_type
required
string <= 32 characters
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "date_recorded": "string",
  • "device_id": "string",
  • "reading_type": "string"
}

Response samples

Content type
application/vnd.api+json
{ }

/v1/smartmeter-maps

/v1/smartmeter-maps/

query Parameters
filter[device-id]
string [ 5 .. 15 ] characters
filter[device-type]
string
Enum: "" "glucometer" "pulsox" "scale" "sphygmomanometer"
filter[imei]
string = 15 characters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[shared-with-org-id]
string <uuid>
Example: filter[shared-with-org-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/smartmeter-maps/

Request Body schema: application/json
required
object
type
required
string
Value: "smartmeter-maps"
required
object
device-id
required
string <= 32 characters
individual-id
required
string <uuid>
device-type
string
Default: ""
Enum: "" "glucometer" "pulsox" "scale" "sphygmomanometer"
organization-id
string <uuid>
start-time
string <datetime>
ticket-duplicates
boolean
Default: true
meta
object

Responses

Request samples

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

Response samples

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

/v1/smartmeter-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/smartmeter-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/smartmeter-maps/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "smartmeter-maps"
required
object
device-type
string
Enum: "" "glucometer" "pulsox" "scale" "sphygmomanometer"
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/smartmeter-maps/{id}/sync/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
start-time
string <datetime>

Responses

Request samples

Content type
application/json
{
  • "start-time": "string"
}

Response samples

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

/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/tasks

/v1/tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/tellihealth-collectors

/v1/tellihealth-collectors/

Request Body schema: application/json
deviceId
required
string <= 64 characters
readingType
required
string <= 64 characters
time
required
string <= 32 characters
data
object
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "deviceId": "string",
  • "readingType": "string",
  • "time": "string"
}

Response samples

Content type
application/vnd.api+json
{ }

/v1/tellihealth-maps

/v1/tellihealth-maps/

query Parameters
filter[device-id]
string <= 64 characters
filter[device-type]
string
Enum: "pulsox" "scale" "sphygmomanometer" "thermometer"
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[shared-with-org-id]
string <uuid>
Example: filter[shared-with-org-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/tellihealth-maps/

Request Body schema: application/json
required
object
type
required
string
Value: "tellihealth-maps"
required
object
device-id
required
string <= 64 characters
device-type
required
string
Enum: "pulsox" "scale" "sphygmomanometer" "thermometer"
individual-id
required
string <uuid>
organization-id
required
string <uuid>
ticket-duplicates
boolean
Default: true
meta
object

Responses

Request samples

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

Response samples

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

/v1/tellihealth-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/tellihealth-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/tellihealth-maps/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "tellihealth-maps"
required
object
device-type
string
Enum: "pulsox" "scale" "sphygmomanometer" "thermometer"
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/tenovi-accounts

/v1/tenovi-accounts/

query Parameters
filter[name]
string <= 32 characters
filter[organization-id]
string <uuid>
Example: filter[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/tenovi-accounts/

Request Body schema: application/json
required
object
type
required
string
Value: "tenovi-accounts"
required
object
api-key
required
string <= 255 characters
name
required
string <= 32 characters
organization-id
required
string <uuid>
base-url
string <= 50 characters
Default: "https://api2.tenovi.com/clients"
meta
object

Responses

Request samples

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

Response samples

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

/v1/tenovi-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/tenovi-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/tenovi-accounts/{id}/rotate/

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
null

/v1/tenovi-maps

/v1/tenovi-maps/

query Parameters
filter[device-id]
string [ 5 .. 15 ] characters
filter[device-type]
string
Enum: "gateway" "glucometer" "peakflow" "pulsox" "scale" "sphygmomanometer" "thermometer"
filter[hwi-device-id]
string <uuid>
Example: filter[hwi-device-id]=11111111-1111-1111-1111-111111111111
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[shared-with-org-id]
string <uuid>
Example: filter[shared-with-org-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/tenovi-maps/

Request Body schema: application/json
required
object
type
required
string
Value: "tenovi-maps"
required
object
device-id
required
string <= 32 characters
individual-id
required
string <uuid>
organization-id
string <uuid>
start-time
string <datetime>
ticket-duplicates
boolean
Default: true
meta
object

Responses

Request samples

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

Response samples

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

/v1/tenovi-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/tenovi-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/tenovi-maps/{id}/sync/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
start-time
string <datetime>

Responses

Request samples

Content type
application/json
{
  • "start-time": "string"
}

Response samples

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

/v1/tenovi-notification

/v1/tenovi-notification/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v1/transtek-cert

/v1/transtek-cert/

Responses

/v1/transtek-device-setup

/v1/transtek-device-setup/

query Parameters
imei
string [ 5 .. 15 ] characters

Responses

/v1/transtek-maps

/v1/transtek-maps/

query Parameters
filter[device-id]
string [ 5 .. 15 ] characters
filter[device-type]
string
Enum: "" "pulsox" "scale" "sphygmomanometer"
filter[imei]
string [ 5 .. 15 ] characters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[shared-with-org-id]
string <uuid>
Example: filter[shared-with-org-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/transtek-maps/

Request Body schema: application/json
required
object
type
required
string
Value: "transtek-maps"
required
object
device-id
required
string <= 32 characters
individual-id
required
string <uuid>
device-type
string
Default: ""
Enum: "" "pulsox" "scale" "sphygmomanometer"
organization-id
string <uuid>
ticket-duplicates
boolean
Default: true
meta
object

Responses

Request samples

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

Response samples

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

/v1/transtek-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/transtek-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v1/transtek-maps/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "transtek-maps"
required
object
device-type
string
Enum: "" "pulsox" "scale" "sphygmomanometer"
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/transtek-notification

/v1/transtek-notification/

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v2/bodytrace-maps

/v2/bodytrace-maps/

Request Body schema: application/json
required
object
type
required
string
Value: "bodytrace-maps"
required
object
individual-id
required
string <uuid>
barcode
string <= 255 characters
imei
string <= 15 characters
organization-id
string <uuid>
start-time
string <datetime>
ticket-duplicates
boolean
Default: true
meta
object

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "task-id": "string"
}

/v2/nutrition-nutrients-goals

/v2/nutrition-nutrients-goals/

query Parameters
individual-id
required
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": { }
}

/v2/nutrition-nutrients-goals/

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-nutrients-goals"
required
NutrientsGoalPostJS (object) or NutrientsGoalPostJS (object) (NutrientsGoalPostJS)
Any of
individual-id
required
string <uuid>
nutrient-calories
required
integer >= 0
nutrient-protein-pct
required
integer [ 0 .. 100 ]
nutrient-total-carbohydrate-pct
required
integer [ 0 .. 100 ]
nutrient-total-fat-pct
required
integer [ 0 .. 100 ]
organization-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": { }
}

/v2/nutrition-nutrients-goals/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v2/nutrition-nutrients-goals/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

/v2/nutrition-nutrients-goals/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "nutrition-nutrients-goals"
required
NutrientsGoalPatchJS (object) or NutrientsGoalPatchJS (object) (NutrientsGoalPatchJS)
Any of
nutrient-calories
integer >= 0
nutrient-protein-pct
integer [ 0 .. 100 ]
nutrient-total-carbohydrate-pct
integer [ 0 .. 100 ]
nutrient-total-fat-pct
integer [ 0 .. 100 ]
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": { }
}