Skip to main content
API docs by Redocly

Carium API (R2025010800)

Welcome to the Carium API reference documentation!

All Carium functionality is available via the API. Here you can find all the details you need to properly formulate calls and interpret responses.

APIs here adhere to convention listed in our API Conventions unless otherwise specified.

This documentation is a filtered, cleaned, and organized subset of the OpenAPI specifications for the Carium API. For a comprehensive list of all available endpoints, see the full specifications for the services listed below.

Application Version Comprehensive Source
caredb 24.27.0 Caredb Swagger3.json
courier 9.137.0 Courier Swagger3.json
cronkite 7.2.0 Cronkite Swagger3.json
dataengine 4.91.0 Dataengine Swagger3.json
drow 0.96.0 Drow Swagger3.json
identity 18.2.0 Identity Swagger3.json
integrator 5.59.0 Integrator Swagger3.json
lachesis 7.131.0 Lachesis Swagger3.json
oracle 0.36.0 Oracle Swagger3.json
overlord 10.70.0 Overlord Swagger3.json
pylon 5.8.4 Pylon Swagger3.json
showboat 10.211.0 Showboat Swagger3.json
sked 0.101.0 Sked Swagger3.json

© 2024 Carium, Inc. All rights reserved.

Authentication

Login

Request Body schema: application/json
Any of
password
required
string
username
required
string
access-token-expiration-seconds
integer [ 1 .. 3600 ]

Access token lifetime in seconds. Do not specify for longest allowable duration.

interactive
boolean
Default: true

Is this login due to immediate user presence

locale
string
refresh-token-expiration-seconds
integer >= 1

Refresh token lifetime in seconds. Do not specify for longest allowable duration.

service-document-agreements
Array of strings <uuid> [ items <uuid > ]

List of service document IDs being agreed to during this login. These may be required to log in.

simulated-queue-delay
integer >= 1

(Developer feature) Simulate background job delay by number of milliseconds

sticky-access-token-expiration
boolean
totp-code
string

TOTP Code for Two Factor Authentication

Responses

Request samples

Content type
application/json
Example
{
  • "access-token-expiration-seconds": 1,
  • "interactive": true,
  • "locale": "string",
  • "password": "string",
  • "refresh-token-expiration-seconds": 1,
  • "service-document-agreements": [
    ],
  • "simulated-queue-delay": 1,
  • "sticky-access-token-expiration": true,
  • "totp-code": "string",
  • "username": "string"
}

Response samples

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

Logout

This endpoint will log the current session out. All outstanding access tokens will be invalidated.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

Forgot Password

Request Body schema: application/json
username
required
string <= 255 characters
locale
string <= 8 characters

Responses

Request samples

Content type
application/json
{
  • "locale": "string",
  • "username": "string"
}

Response samples

Content type
application/vnd.api+json
null

Check Password Strength

Request Body schema: application/json
password
required
string [ 1 .. 255 ] characters

The password for which to calculate strength.

check-pwned
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "check-pwned": false,
  • "password": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "pwned": {
    },
  • "strength": {
    },
  • "suggestions": [
    ]
}

Get Password Validation Rules

Responses

Response samples

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

Resend Contact Information Verification

Request Body schema: application/json
Any of
username
required
string <= 255 characters

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
null

Homefeed

List 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 (ShowboatPageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (ShowboatPageOffset) >= 0
Default: 0

Responses

Response samples

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

Get Homefeed Log

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

Delete Homefeed Log

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Hide Homefeed Log

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": { }
}

Respond to Homefeed Log

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

Individual Groups

List Groups Deprecated

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

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

filter[eligible-individual-id]
string <uuid>
Example: filter[eligible-individual-id]=11111111-1111-1111-1111-111111111111
filter[exclude-ids]
Array of strings <uuid> [ items <uuid > ]
Example: filter[exclude-ids]=11111111-1111-1111-1111-111111111111
filter[include-inactive]
boolean
Default: false
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[leader-id]
string <uuid>
Example: filter[leader-id]=11111111-1111-1111-1111-111111111111
filter[node-type]
string
Enum: "division" "group"
filter[parent-group-id]
string <uuid>
Example: filter[parent-group-id]=11111111-1111-1111-1111-111111111111
filter[tags]
Array of strings[ items <= 127 characters ]
filter[text]
string <= 255 characters
filter[tree-node-type]
string
Enum: "leaf" "non-leaf"
ids
Array of strings <uuid> [ items <uuid > ]
Example: ids=11111111-1111-1111-1111-111111111111
name
string <= 255 characters
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (IdentityPageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (IdentityPageOffset) >= 0
Default: 0
type
Array of strings
Default: "regular&type=provider_only"
Items Enum: "all_participants" "provider_only" "regular" "unassigned"
with-individuals
boolean
Deprecated
Default: false

Responses

Response samples

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

Create Group

Request Body schema: application/json
required
object
type
required
string
Value: "individual-groups"
required
object or object
One of
name
required
string
organization-id
required
string <uuid>
individual-ids
Array of strings <uuid> [ items <uuid > ]
leader-ids
Array of strings <uuid> [ items <uuid > ]
node-type
string
Default: "group"
Enum: "division" "group"
tags
Array of strings[ items <= 127 characters ]
type
string
Default: "regular"
Enum: "provider_only" "regular"
meta
object

Responses

Request samples

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

Response samples

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

Delete Group

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Get Specific Group

path Parameters
id
required
string

Resource identifier

query Parameters
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Response samples

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

Update Group

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "individual-groups"
required
object
leader-ids
Array of strings <uuid> [ items <uuid > ]
name
string <= 255 characters
tags
Array of strings[ items <= 127 characters ]
id
string <uuid>
meta
object

Responses

Request samples

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

Response samples

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

Add Individuals to Group

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-ids
required
Array of strings <uuid> non-empty [ items <uuid > ]
remove-from-group
string <uuid>
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "individual-ids": [
    ],
  • "remove-from-group": "11111111-1111-1111-1111-111111111111",
  • "with-individuals": false,
  • "with-members": false
}

Response samples

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

Add Leaders to Group

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
user-ids
required
Array of strings <uuid> non-empty [ items <uuid > ]
remove-from-group
string <uuid>
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "remove-from-group": "11111111-1111-1111-1111-111111111111",
  • "user-emails": [
    ],
  • "with-individuals": false,
  • "with-members": false
}

Response samples

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

Add Members to Group

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
user-ids
required
Array of strings <uuid> non-empty [ items <uuid > ]
remove-from-group
string <uuid>
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "remove-from-group": "11111111-1111-1111-1111-111111111111",
  • "user-emails": [
    ],
  • "with-individuals": false,
  • "with-members": false
}

Response samples

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

Get Eligible Members

path Parameters
id
required
string

Resource identifier

query Parameters
filter[registration-invite]
string
Enum: "accepted" "failed" "none" "sent"
filter[text]
string <= 255 characters
filter[verified]
boolean
for-children
boolean
member-type
string
Default: "leader"
Enum: "individual" "leader" "member"
page[limit]
integer (IdentityPageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (IdentityPageOffset) >= 0
Default: 0

Responses

Response samples

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

Move Group

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
to-parent-group-id
required
string <uuid>

Responses

Request samples

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

Response samples

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

Remove Individuals from Group

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-ids
required
Array of strings <uuid> non-empty [ items <uuid > ]
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "individual-ids": [
    ],
  • "with-individuals": false,
  • "with-members": false
}

Response samples

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

Remove Leaders from Group

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
user-ids
required
Array of strings <uuid> non-empty [ items <uuid > ]
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "user-emails": [
    ],
  • "with-individuals": false,
  • "with-members": false
}

Response samples

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

Remove Members from Group

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
One of
user-ids
required
Array of strings <uuid> non-empty [ items <uuid > ]
with-individuals
boolean
Default: false
with-members
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "user-emails": [
    ],
  • "with-individuals": false,
  • "with-members": false
}

Response samples

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

Individuals

List Individuals

query Parameters
fields
Array of strings
Items Enum: "action-completion-pct" "birth-date" "communication-preferences" "created-time" "current-action-completion-pct" "email" "email-verified" "first-name" "last-activity-time" "last-appointment-time" "last-article-read-time" "last-blood-glucose" "last-blood-glucose-context" "last-blood-glucose-state" "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" "last-text-status" "phone-verified" "preferred-name" "registered" "registration-completed-time" "registration-invite" "sms-mode" "state" "unack-journal-count"
filter[account-type]
string
Default: "regular"
Enum: "provider" "regular"
filter[birth-date]
string <date>
filter[email-verified]
boolean
filter[email]
string <= 255 characters
filter[exclude-self]
boolean
Default: false
filter[first-name]
string <= 255 characters
filter[individual-group-id]
string <uuid>
Example: filter[individual-group-id]=11111111-1111-1111-1111-111111111111
filter[individual-ids]
Array of strings <uuid> [ items <uuid > ]
Example: filter[individual-ids]=11111111-1111-1111-1111-111111111111
filter[last-name]
string <= 255 characters
filter[last-text-status]
string
Enum: "created" "failed" "sent"
filter[only-in-groups-with-leader-id]
string <uuid>
Example: filter[only-in-groups-with-leader-id]=11111111-1111-1111-1111-111111111111
filter[phone-verified]
boolean
filter[phone]
string <= 255 characters
filter[registered]
boolean
filter[registration-invite]
string
Enum: "accepted" "failed" "none" "sent"
filter[sms-mode]
string
Enum: "disabled" "enabled" "optout"
filter[state]
string
Enum: "archived" "confirmed" "disabled" "force_reset_password" "init" "registered" "registered_disabled"
filter[tag-ids]
Array of strings <uuid> [ items <uuid > ]
Example: filter[tag-ids]=11111111-1111-1111-1111-111111111111
filter[workflowtype-name]
Array of strings[ items <= 255 characters ]
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (CaredbPageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (CaredbPageOffset) >= 0
Default: 0
sort
Array of strings
Default: "last-name"
Items Enum: "-action-completion-pct" "-birth-date" "-communication-preferences" "-created-time" "-current-action-completion-pct" "-email" "-email-verified" "-first-name" "-last-activity-time" "-last-appointment-time" "-last-article-read-time" "-last-blood-glucose" "-last-blood-glucose-context" "-last-blood-glucose-state" "-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" "-last-text-status" "-phone-verified" "-preferred-name" "-registration-completed-time" "-registration-invite" "-sms-mode" "-state" "-unack-journal-count" "action-completion-pct" "birth-date" "communication-preferences" "created-time" "current-action-completion-pct" "email" "email-verified" "first-name" "last-activity-time" "last-appointment-time" "last-article-read-time" "last-blood-glucose" "last-blood-glucose-context" "last-blood-glucose-state" "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" "last-text-status" "phone-verified" "preferred-name" "registration-completed-time" "registration-invite" "sms-mode" "state" "unack-journal-count"

Responses

Response samples

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

Get Individual

path Parameters
id
required
string

Resource identifier

query Parameters
fields
Array of strings
Items Enum: "action-completion-pct" "birth-date" "communication-preferences" "created-time" "current-action-completion-pct" "email" "email-verified" "first-name" "last-activity-time" "last-appointment-time" "last-article-read-time" "last-blood-glucose" "last-blood-glucose-context" "last-blood-glucose-state" "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" "last-text-status" "phone-verified" "preferred-name" "registered" "registration-completed-time" "registration-invite" "sms-mode" "state" "unack-journal-count"

Responses

Response samples

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

Learning Content

List Articles

returns article summary based on article-version ids OR individual-id

query Parameters
article-content-ids
Array of strings <uuid> [ items <uuid > ]
Example: article-content-ids=11111111-1111-1111-1111-111111111111

article-content ids

filter[article-name]
string <= 255 characters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
include-assigned-count
boolean
Deprecated
Default: false
include-view-stats
boolean
Default: false
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (CaredbPageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (CaredbPageOffset) >= 0
Default: 0
query
string <= 255 characters

search term for searching tags, title and description

sort
Array of strings
Items Enum: "-assigned-date" "-published-date" "-tags" "-views" "assigned-date" "published-date" "tags" "views"
sort-by
Array of strings
Deprecated
Items Enum: "-published-date" "-tags" "-views" "published-date" "tags" "views"

deprecated, use 'sort' option

Responses

Response samples

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

Create Article

Request Body schema:
Any of
article-name
required
string <= 255 characters
content-type
required
string
organization-id
required
string <uuid>
photo-type
required
string
Enum: "image/avif" "image/bmp" "image/gif" "image/heic" "image/jpeg" "image/png" "image/tiff" "image/webp"
title
required
string <= 255 characters
assigned-count
integer
content-filename
string
content-id
string <uuid>
Deprecated
description
string <= 255 characters
locale
string
Default: "en_US"
Enum: "en_US" "es_US"
parent-id
string <uuid>
photo-filename
string
tags
string

Comma separated list of tags

Responses

Request samples

Content type
{
  • "data": {
    },
  • "meta": { }
}

Response samples

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

Delete Article

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Get Article

path Parameters
id
required
string

Resource identifier

query Parameters
include-view-stats
boolean
Default: false
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

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

Update Article

path Parameters
id
required
string

Resource identifier

Request Body schema:
Any of
description
string <= 255 characters
tags
string

Comma separated list of tags

title
string <= 255 characters

Responses

Request samples

Content type
{
  • "description": "string",
  • "tags": "string",
  • "title": "string",
  • "url": "string"
}

Response samples

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

Add Photo to Article

path Parameters
id
required
string

Resource identifier

Request Body schema: multipart/form-data
photo
required
string <binary>
photo-type
required
string <= 127 characters
photo-filename
string <= 255 characters

Responses

Response samples

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

Add Tags to Article

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
tag-ids
Array of strings[ items <= 32 characters ]

Responses

Request samples

Content type
application/json
{
  • "tag-ids": [
    ]
}

Response samples

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

Add Version to Article

path Parameters
id
required
string

Resource identifier

Request Body schema:
url
required
string
update-assignment
boolean
Default: false

Responses

Request samples

Content type
{
  • "update-assignment": false,
  • "url": "string"
}

Response samples

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

Assign Content to Article

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
Any of
all-participants
required
any
Value: true
follow-group
boolean
Default: true
reassign
boolean
Default: false
send_notification
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "follow-group": true,
  • "individual-group-ids": [
    ],
  • "individual-ids": [
    ],
  • "reassign": false,
  • "send_notification": true
}

Response samples

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

Delete Article Version

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Get Article Content Metadata

returns article content metadata

path Parameters
id
required
string

Resource identifier

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

Responses

Response samples

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

Get Article Content

returns article content

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
{
  • "errors": [
    ]
}

Process Content Upload

path Parameters
id
required
string

Resource identifier

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{ }

Remove Tags from Article

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
tag-ids
Array of strings[ items <= 32 characters ]

Responses

Request samples

Content type
application/json
{
  • "tag-ids": [
    ]
}

Response samples

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

Unassign Content from Article

path Parameters
id
required
string

Resource identifier

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

Responses

Request samples

Content type
application/json
{
  • "individual-group-ids": [
    ],
  • "individual-ids": [
    ]
}

Response samples

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

Messaging

Create Channel

Creates a new channel

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-channels"
required
object
object
enabled
boolean
floating
boolean
Default: false
individual-group-id
string <uuid>
individual-ids
Array of strings <uuid> [ items <uuid > ]
label
string <= 255 characters
name
string <= 128 characters
organization-id
string <uuid>
subscription-type
string
Default: "open"
Enum: "none" "open" "single"
text-number-id
string <uuid>
meta
object

Responses

Request samples

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

Response samples

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

List Channels

Returns channels

query Parameters
filter[archived]
boolean
filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

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

filter[floating]
boolean
filter[individual-group-id]
string <uuid>
Example: filter[individual-group-id]=11111111-1111-1111-1111-111111111111
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 [ 1 .. 50 ]
Default: 50
page[offset]
integer (CourierPageOffset) >= 0
Default: 0
participant-id
string <uuid>
Example: participant-id=11111111-1111-1111-1111-111111111111
use-group-name
boolean
Default: true

Responses

Response samples

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

Delete Channel

Deletes a channel

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Get Channel

Returns specific channel

path Parameters
id
required
string

Resource identifier

query Parameters
include-individual-group
boolean
Deprecated
Default: false
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
use-group-name
boolean
Default: true

Responses

Response samples

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

Update Channel

Modifies an existing channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-channels"
required
Array of objects or objects
Array
Any of
op
required
string
Value: "replace"
path
required
string <= 255 characters
value
required
any
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": { }
}

Archive Channel

Archive a channel

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": { }
}

Unarchive Channel

Unarchive a channel

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": { }
}

Subscribe to Channel

Add subscriber to the channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-ids
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "individual-ids": [
    ]
}

Response samples

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

Unsubscribe from Channel

Remove subscriber from the channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-ids
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "individual-ids": [
    ]
}

Response samples

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

Update Channel SMS Options

Enable/disable SMS path for this messaging channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
active
required
boolean
initial-message
string <= 1024 characters
object
en_US
required
string <= 1024 characters
es_US
required
string <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "initial-message": "string",
  • "initial-message-js": {
    }
}

Response samples

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

Update Channel Preferences

Modify channel preferences

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
Array of objects
Array
name
required
string
Value: "notify"
value
string <= 255 characters
individual-id
string <uuid>

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": { }
}

Send Message

Posts a new message

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-messages"
required
object
channel-id
required
string <uuid>
message
required
string <= 99999 characters
auto-ack
string
Enum: "" "all" "participants" "providers" "sender"
draft
boolean
Default: false
include-destinations
Array of strings[ items <= 16 characters ]
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": { }
}

List Messages

Returns messages in specified group, posted by specified user, and belonging to specified subscription.

query Parameters
channel-id
required
string <uuid>
Example: channel-id=11111111-1111-1111-1111-111111111111
acknowledged
boolean
filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

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

filter[cmp-posted-time]
Array of strings <= 2 items [ items <= 40 characters ]

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

filter[text]
string <= 255 characters
include-phrases
boolean
Default: false
include-read-receipts
boolean
Default: false
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (CourierPageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (CourierPageOffset) >= 0
Default: 0
thumbnail
boolean
Default: false
user-id
string <uuid>
Example: user-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

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

Delete Message

Deletes a message

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Get Message

Returns a single message from the given id

path Parameters
id
required
string

Resource identifier

query Parameters
include-phrases
boolean
Default: false
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
thumbnail
boolean
Default: false

Responses

Response samples

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

Update Message

Modifies an existing message

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-messages"
required
object
draft
boolean
individual-id
string <uuid>
Deprecated
message
string <= 99999 characters
removed
boolean
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": { }
}

Acknowledge Message

Acknowledge a message, and all messages before this

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
allow-past
boolean
Default: false
individual-id
string <uuid>

Responses

Request samples

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

Response samples

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

Add Reaction to Message

add a user-reaction to a message

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
reaction-type
required
string
Enum: "dislike" "like" "lol" "love" "sad" "wow"
individual-id
string <uuid>

Responses

Request samples

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

Response samples

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

Delete Reaction from Message

delete a user-reaction from a message

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
reaction-type
required
string
Enum: "dislike" "like" "lol" "love" "sad" "wow"
individual-id
string <uuid>

Responses

Request samples

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

Response samples

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

Get Message Receipts

get receipts of this message

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
{
  • "read": [
    ],
  • "unread": [
    ]
}

Multi-Factor Authentication

List TOTP Configurations

Get a list of all TotpConfigurations for a user.

query Parameters
filter[user-id]
string <uuid>
Example: filter[user-id]=11111111-1111-1111-1111-111111111111

The ID of the User to get TotpConfiguration for. Defaults to the current user. The caller may only request their own configurations unless the caller is an administrator.

Responses

Response samples

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

Initiate TOTP Setup

Initiate setup of TOTP MFA for the users account. After initialization, the configuration will still need to be enabled.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

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

Delete TOTP Configuration

You can only delete configurations that are both owned by you and not that are enabled. You must disable the configuration before deleting it.

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Enable TOTP Configuration

Enable (activate) a TotpConfiguration. This requires providing two consecutive totp codes and the users password. Once enabled, future sign-ins will require a totp code as MFA in addition to the password.

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
codes
required
Array of strings = 2 items [ items <= 255 characters ]

A list of valid TOTP Codes. We require two consecutive codes.

password
required
string <= 255 characters

The current users password

Responses

Request samples

Content type
application/json
{
  • "codes": [
    ],
  • "password": "string"
}

Response samples

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

Disable TOTP Configuration

Disable (deactivates) a TotpConfiguration without deleting it. This will remove the requirement for a totp code to be entered during sign-in.

path Parameters
id
required
string

Resource identifier

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

The current users password

Responses

Request samples

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

Response samples

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

Nutrition

Lookup Food Item

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": { }
}

Search for Food

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": { }
}

Get Query Results

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

List Favorite Items

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

Responses

Response samples

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

Add Favorite Item

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": { }
}

Delete Favorite Item

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Get Favorite Item

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

List Meal Plans

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

Responses

Response samples

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

Create Meal Plan

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": { }
}

Delete Meal Plan

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Get Meal Plan

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

Update Meal Plan

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": { }
}

Log Meal Plan

Log a meal plan being implemented for an occasion

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": { }
}

List Meals

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

Responses

Response samples

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

Create Meal

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": { }
}

Delete Meal

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Get Meal

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

Update Meal

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": { }
}

Log Meal

Log a meal being eaten for an occasion

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": { }
}

Pathways

List Pathways Spec

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[name]
string <= 255 characters
page[limit]
integer (OverlordPageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (OverlordPageOffset) >= 0
Default: 0
sort
Array of strings
Default: "created"
Items Enum: "-created" "-name" "-version-name" "created" "name" "version-name"

Responses

Response samples

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

Get Specific Pathway Spec

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

List Pathways Spec Stages

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

Responses

Response samples

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

Create Pathway Instance

Request Body schema: application/json
required
object
type
required
string
Value: "pathway-instances"
required
object
individual-id
required
string <uuid>
version-id
required
string <uuid>
auto-start
boolean
Default: false
description
string <= 255 characters
initial-spec-stage-id
string <uuid>
store-schema
object
meta
object

Responses

Request samples

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

Response samples

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

List Pathway Instance

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
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[spec-id]
string <uuid>
Example: filter[spec-id]=11111111-1111-1111-1111-111111111111
filter[stage-spec-id]
string <uuid>
Example: filter[stage-spec-id]=11111111-1111-1111-1111-111111111111
filter[state]
string
Enum: "archived" "completed" "created" "started"
filter[version-id]
string <uuid>
Example: filter[version-id]=11111111-1111-1111-1111-111111111111
include[store]
Array of strings[ items <= 64 characters ]
page[limit]
integer (OverlordPageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (OverlordPageOffset) >= 0
Default: 0
sort
Array of strings
Default: "created"
Items Enum: "-created" "-stage-created" "-stage-title" "-started" "created" "stage-created" "stage-title" "started"

Responses

Response samples

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

Get Specific Pathway Instance

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

Timeseries

Submit Timeseries Data

Request Body schema: application/json
required
object
type
required
string
Value: "time-series"
required
object
Array of objects
Array
source
string <= 50 characters
Default: ""
tz-offset-mins
integer
property name*
additional property
any
individual-copy
boolean
Default: true
individual-id
string <uuid>
organization-id
string <uuid>
type
string
Enum: "ActiveEnergyBurned" "ActiveTime" "AerobicSteps" "AirQualityIndex" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassGoal" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Covid19" "DailyActivity" "DailyHeartRate" "Distance" "Dqv" "FeelingRating" "FluActivity" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Medication" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
tz-offset-mins
integer
meta
object

Responses

Request samples

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

Response samples

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

Retrieve Timeseries Data

query Parameters
begin-datetime
required
string <datetime>
end-datetime
required
string <datetime>
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
type
required
string
Enum: "ActiveEnergyBurned" "ActiveTime" "AerobicSteps" "AirQualityIndex" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassGoal" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Covid19" "DailyActivity" "DailyHeartRate" "Distance" "Dqv" "FeelingRating" "FluActivity" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Medication" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
filter-field
string <= 255 characters
filter-values
Array of strings[ items <= 255 characters ]
include-count
boolean
Default: true
include-created-at
boolean
Default: false
include-prior
boolean
Default: false

When true, include record just before provided time range (does not work with DailyActivity or SleepAnalysis)

organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer [ 1 .. 1000 ]
Default: 500
page[offset]
integer (LachesisPageOffset) >= 0
Default: 0
reverse
boolean
source
string <= 255 characters

Responses

Response samples

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

Delete Timeseries Data

path Parameters
id
required
string

Resource identifier

query Parameters
type
required
string
Enum: "ActiveEnergyBurned" "ActiveTime" "AerobicSteps" "AirQualityIndex" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassGoal" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Covid19" "DailyActivity" "DailyHeartRate" "Distance" "Dqv" "FeelingRating" "FluActivity" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Medication" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
begin-time
string <datetime>
end-time
string <datetime>
include-participant
boolean
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
source
string <= 255 characters
time
string <datetime>

Responses

Response samples

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

Bulk Delete Timeseries Data

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "time-series"
required
object
data
required
Array of objects
organization-id
string <uuid>
type
string
Enum: "ActiveEnergyBurned" "ActiveTime" "AerobicSteps" "AirQualityIndex" "Auscultation" "BloodGlucose" "BloodPressure" "BodyFatPercentage" "BodyMass" "BodyMassGoal" "BodyMassIndex" "BodyMassLean" "BodyTemperature" "Covid19" "DailyActivity" "DailyHeartRate" "Distance" "Dqv" "FeelingRating" "FluActivity" "ForcedExpiratoryVolume" "HbA1c" "Height" "Hematocrit" "Hemoglobin" "Medication" "Mindfulness" "OxygenSaturation" "PeakFlow" "PeriodicPulse" "PollenGrassIndex" "PollenRagweedIndex" "PollenTreeIndex" "PotassiumLevel" "Pulse" "SkinTemperature" "SleepAnalysis" "Steps" "Vo2Max" "WaistCircumference" "WaterIntake"
meta
object

Responses

Request samples

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

Response samples

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

List Timeseries Sources

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

Responses

Response samples

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

Delete Source

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

Get Specific Source

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

Todos

List Todo Entries

query Parameters
filter[assigned-individual-id]
string <uuid>
Example: filter[assigned-individual-id]=11111111-1111-1111-1111-111111111111
filter[care-plan-id]
string <uuid>
Example: filter[care-plan-id]=11111111-1111-1111-1111-111111111111
filter[cmp-last-modified-at]
Array of strings <= 2 items [ items <= 40 characters ]

compare timestamp against last-modified-at time.specify [comparitor][datetime]. comparators supported >, <, <=, >=use multiple to build a bounded time frame.

filter[due-end-time]
string <datetime>
filter[due-start-time]
string <datetime>
filter[es-match-phrase-prefix]
Array of strings non-empty [ items <= 255 characters ]
filter[es-match-text]
string <= 255 characters
filter[es-query-string]
string <= 255 characters
filter[include-done]
boolean
Default: false
filter[include-inactive]
boolean
Deprecated
Default: false
filter[individual-group-id]
string <uuid>
Example: filter[individual-group-id]=11111111-1111-1111-1111-111111111111
filter[provider-only]
boolean
Default: false
filter[reference-in-individual-group-id]
string <uuid>
Example: filter[reference-in-individual-group-id]=11111111-1111-1111-1111-111111111111
filter[reference-individual-id]
string <uuid>
Example: filter[reference-individual-id]=11111111-1111-1111-1111-111111111111
filter[tags]
Array of strings[ items <= 127 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 (CaredbPageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (CaredbPageOffset) >= 0
Default: 0
sort
Array of strings
Items Enum: "-assigned-at" "-completed-at" "-created-at" "-due-time" "-last-modified-at" "assigned-at" "completed-at" "created-at" "due-time" "last-modified-at"

Responses

Response samples

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

Create Todo Entry

Request Body schema: application/json
required
object
type
required
string
Value: "todo-entries"
required
object
text
required
string <= 9999 characters
care-plan-id
string <uuid>
context-url
string <= 2048 characters
due-time
string <datetime>
external-id
string <= 255 characters
individual-group-id
string <uuid>
individual-id
string <uuid>
notes
string <= 9999 characters
organization-id
string <uuid>
provider-notes
string <= 9999 characters
publish-update
boolean
Default: false
Array of objects
Array
id
required
string <uuid>
type
required
string
Enum: "individual" "pathway"
data
object
status-id
string <uuid>
tags
Array of strings[ items <= 127 characters ]
with-notification
boolean
Default: true

Used when individual-id is specified and calling user is an org member or an organization-id is specified

meta
object

Responses

Request samples

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

Response samples

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

Delete Todo Entry

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Get Todo Entry

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

Update Todo Entry

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "todo-entries"
required
Array of objects

JSON Patch format for describing changes to a JSON document. see jsonpatch.com. Supported (op, path)s are: ('remove', '/individual-group-id'), ('remove', '/individual-id'), ('replace', '/context-url'), ('replace', '/done'), ('replace', '/due-time'), ('replace', '/individual-group-id'), ('replace', '/individual-id'), ('replace', '/notes'), ('replace', '/provider-notes'), ('replace', '/references'), ('replace', '/status-id'), ('replace', '/tags'), ('replace', '/text').

Array
op
required
string
Enum: "add" "remove" "replace"
path
required
string <= 255 characters

Path in document to operate on. Starts with "/" which represents the root document

value
any
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": { }
}

List Todo Tags

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

Responses

Response samples

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

Create Todo Tag

Request Body schema: application/json
required
object
type
required
string
Value: "todo-entries-tags"
required
object
name
required
string <= 127 characters
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": { }
}

Delete Todo Tag

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Get Todo Tag

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

List Todo Statuses

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

Responses

Response samples

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

Create Todo Status

Request Body schema: application/json
required
object
type
required
string
Value: "todo-entries-statuses"
required
object
display
required
string <= 255 characters
organization-id
required
string <uuid>
definition
string <= 255 characters
is-default
boolean
Default: false
meta
object

Responses

Request samples

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

Response samples

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

Delete Todo Status

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Get Todo Status

path Parameters
id
required
string

Resource identifier

Responses

Response samples

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

Update Todo Status

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "todo-entries-statuses"
required
object
definition
string <= 255 characters
display
string <= 255 characters
is-default
boolean
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": { }
}