API docs by Redocly

Pomelo API (v207.0.1-develop.0)

Download OpenAPI specification:

pomelo api docs

v1/analyzed

/v1/analyzed/actigraphy-sleep

Actigraphy sleep analysis return

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/analyzed/hrv

HRV analysis return

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

v1/web

/v1/web/analytic-graph-correlation-group-fetch

fetch correlation graph for group

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
yymmddIndexStart
required
integer > 0
yymmddIndexEnd
required
integer > 0
participantIds
required
Array of strings <uuid> >= 2 items [ items <uuid > ]
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "yymmddIndexStart": 0,
  • "yymmddIndexEnd": 0,
  • "participantIds": [
    ],
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/analytic-graph-correlation-group-multiple-duration-fetch

fetch correlation graph of multiple duration for group

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantIds
required
Array of strings <uuid> >= 2 items [ items <uuid > ]
yymmddDurations
required
object
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "participantIds": [
    ],
  • "yymmddDurations": { },
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/analytic-graph-correlation-individual-fetch

fetch correlation graph for individual

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
yymmddIndexStart
required
integer > 0
yymmddIndexEnd
required
integer > 0
participantId
required
string <uuid>
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "yymmddIndexStart": 0,
  • "yymmddIndexEnd": 0,
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/analytic-graph-correlation-individual-multiple-duration-fetch

fetch correlation graph of multiple durations for individual

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>
yymmddDurations
required
object
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
  • "yymmddDurations": { },
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/analytic-graph-correlation-multiple-group-fetch

fetch correlation graph for multiple groups

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
yymmddIndexStart
required
integer > 0
yymmddIndexEnd
required
integer > 0
groups
required
object
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "yymmddIndexStart": 0,
  • "yymmddIndexEnd": 0,
  • "groups": { },
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/analytic-graph-correlation-multiple-group-multiple-duration-fetch

fetch correlation graph of multiple durations for multiple groups

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
groups
required
object
yymmddDurations
required
object
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "groups": { },
  • "yymmddDurations": { },
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/analytic-graph-correlation-multiple-individual-fetch

fetch correlation graph for multiple individual

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
yymmddIndexStart
required
integer > 0
yymmddIndexEnd
required
integer > 0
participantIds
required
Array of strings <uuid> >= 2 items [ items <uuid > ]
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "yymmddIndexStart": 0,
  • "yymmddIndexEnd": 0,
  • "participantIds": [
    ],
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/analytic-graph-correlation-multiple-individual-multiple-duration-fetch

fetch correlation graph of multiple durations for multiple individuals

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantIds
required
Array of strings <uuid> >= 2 items [ items <uuid > ]
yymmddDurations
required
object
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "participantIds": [
    ],
  • "yymmddDurations": { },
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/analytic-graph-correlation-variable-list-fetch

DEPRECATED: use analytic-variable-list-fetch instead

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "projectId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/analytic-graph-trend-group-fetch

fetch trend graph for group

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
yymmddIndexStart
required
integer > 0
yymmddIndexEnd
required
integer > 0
participantIds
required
Array of strings <uuid> >= 2 items [ items <uuid > ]
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "yymmddIndexStart": 0,
  • "yymmddIndexEnd": 0,
  • "participantIds": [
    ],
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/analytic-graph-trend-group-multiple-duration-fetch

fetch trend graph of multiple duration for group

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantIds
required
Array of strings <uuid> >= 2 items [ items <uuid > ]
yymmddDurations
required
object
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "participantIds": [
    ],
  • "yymmddDurations": { },
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/analytic-graph-trend-individual-fetch

fetch trend graph for individual

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
yymmddIndexStart
required
integer > 0
yymmddIndexEnd
required
integer > 0
participantId
required
string <uuid>
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "yymmddIndexStart": 0,
  • "yymmddIndexEnd": 0,
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/analytic-graph-trend-individual-multiple-duration-fetch

fetch trend graph of multiple durations for individual

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>
yymmddDurations
required
object
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
  • "yymmddDurations": { },
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/analytic-graph-trend-multiple-group-fetch

fetch trend graph for multiple groups

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
yymmddIndexStart
required
integer > 0
yymmddIndexEnd
required
integer > 0
groups
required
object
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "yymmddIndexStart": 0,
  • "yymmddIndexEnd": 0,
  • "groups": { },
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/analytic-graph-trend-multiple-individual-fetch

fetch trend graph for multiple individual

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
yymmddIndexStart
required
integer > 0
yymmddIndexEnd
required
integer > 0
participantIds
required
Array of strings <uuid> >= 2 items [ items <uuid > ]
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "yymmddIndexStart": 0,
  • "yymmddIndexEnd": 0,
  • "participantIds": [
    ],
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/analytic-variable-list-fetch

fetch list of variables available for analysis

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "projectId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/batch-adherence

get the adherence of all participants in a batch

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
batchId
required
string <uuid>
startDate
required
integer
page
number >= 0
Default: 0

Responses

Request samples

Content type
application/json
{
  • "batchId": "17a18241-3ad8-4424-b60a-a1d5981ec47a",
  • "startDate": "2026-07-10T03:42:14.855Z",
  • "page": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": {
    }
}

/v1/web/batch-fetch

fetch a single batch

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
page
integer >= 0
Default: 0
orderBy
string
orderDescending
boolean
Default: true
batchId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "orderBy": "string",
  • "orderDescending": true,
  • "batchId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": {
    }
}

/v1/web/stream-data-fetch

fetch the stream data by object id list

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
objectIdList
required
Array of strings

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/stream-data-metadata-fetch

fetch the stream metadata index by completion id

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
completionId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "completionId": "554726a4-b03b-4845-be92-0aeac89d18d8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/developer-token-create

create a developer token for an identity

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
name
required
string non-empty

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/developer-token-delete

delete a developerToken

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
developerTokenId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "developerTokenId": "9e2c23bb-93e9-4143-b77c-54eefe772b34"
}

Response samples

Content type
application/json
{ }

/v1/web/developer-token-list-fetch

fetch an identity's developerToken list

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
page
number >= 0
Default: 0

Responses

Request samples

Content type
application/json
{
  • "page": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v1/web/dexcom-integration-create

create a dexcom integration

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
name
required
string <= 50 characters
description
required
string <= 250 characters
investigator
required
string <= 50 characters
organization
required
string <= 50 characters
countries
required
string <= 250 characters
contactDescription
required
string <= 250 characters
workspaceId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "aestas accusator congregatio",
  • "description": "Desino credo spectaculum carmen barba adulescens.",
  • "investigator": "delicate natus",
  • "organization": "pecco eveniet",
  • "countries": "Tardus eum arguo cum aureus solus coerceo aureus.",
  • "contactDescription": "Ademptio amplexus demoror vindico thesaurus spoliatio.",
  • "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/dexcom-integration-delete

delete a dexcom integration

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
dexcomIntegrationId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "dexcomIntegrationId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{ }

/v1/web/dexcom-integration-list-fetch

fetch workspace dexcom integrations

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
workspaceId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "workspaceId": "efe2b8bb-2f2f-4b46-9cad-9c583eab2bab"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/global-workspace-list-fetch

fetch global workspaces with projects

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/identity-announcement-read

mark identity announcement as read

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
identityAnnouncementId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "identityAnnouncementId": "bde96ecf-9e54-4580-b038-7cfe7fef2e51"
}

Response samples

Content type
application/json
{ }

/v1/web/identity-authenticate

authenticate an identity with email and password

Request Body schema: application/json
email
required
string <email> <= 250 characters
password
required
string
mfaTypePreference
string
trustedDeviceToken
string

Responses

Request samples

Content type
application/json
{
  • "email": "pomelo-test-73f09cfa-7b72-4e7a-a4d3-623a07b5cb33.test@pomelo.click",
  • "password": "QS2lbtdO7pUOISW",
  • "mfaTypePreference": "SMS",
  • "trustedDeviceToken": "0x4aBF8DDDF3"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/identity-create

create a new identity

Request Body schema: application/json
email
required
string <email> <= 250 characters
password
required
string >= 8 characters
locale
string <= 100 characters
countryCode
string <= 100 characters
timeZone
string <= 100 characters

Responses

Request samples

Content type
application/json
{
  • "email": "pomelo-test-6b15612e-1cf9-4451-abb1-d263f2ef1bc5.test@pomelo.click",
  • "password": "zOX8g8Mtsbjkfv8",
  • "locale": "el",
  • "countryCode": "AT",
  • "timeZone": "America/Detroit"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/identity-deactivate

deactivate identity, close all active projects, and remove workspace collaborators

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/web/identity-email-avaliable

check if email available. condition: no duplicate active

Request Body schema: application/json
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "pomelo-test-c56a2f3c-a733-4444-9418-10bfc5b21b8f.test@pomelo.click"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/identity-email-update-request

request update an the identity's email

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/web/identity-email-update-submit

update an identity's email

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
verificationCode
string
email
required
string <email> <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "verificationCode": "2331924352",
  • "email": "pomelo-test-aaf9f943-4c10-4a74-81e6-ddddd9c884ca.test@pomelo.click"
}

Response samples

Content type
application/json
{ }

/v1/web/identity-email-verify-request

request a new identity verification code email

Request Body schema: application/json
email
required
string <email>

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com"
}

Response samples

Content type
application/json
{ }

/v1/web/identity-email-verify-submit

verify the email for an identity

Request Body schema: application/json
email
required
string <email>
verificationCode
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "pomelo-test-b9f6ed3e-3ecb-46e3-801e-9eb32bdd70ff.test@pomelo.click",
  • "verificationCode": "0868397622"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/identity-mfa-verification-code-submit

submit a verificationCode

Request Body schema: application/json
email
required
string <email> <= 250 characters
verificationCode
required
string <= 12 characters
requestId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "email": "pomelo-test-d66401b0-ae56-447c-b288-ab9b38f3d74b.test@pomelo.click",
  • "verificationCode": "8047474996",
  • "requestId": "e7d0ef10-d172-4e33-aea2-eb052795b600"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/identity-mfa-enabled-update

enable or disable MFA on the authenticated identity

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
enabled
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{ }

/v1/web/identity-otp-seed-create

request a new otp seed

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/identity-password-reset-request

request a password reset email

Request Body schema: application/json
email
required
string <email> <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "email": "pomelo-test-8fc7d2bd-19bf-4317-87ef-d902374ea1e7.test@pomelo.click"
}

Response samples

Content type
application/json
{ }

/v1/web/identity-password-reset-submit

request a password reset email

Request Body schema: application/json
verificationCode
required
string <= 12 characters
email
required
string <email> <= 250 characters
password
required
string >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "verificationCode": "0008260164",
  • "email": "pomelo-test-4a9575c3-e837-4136-87e1-a34f7b049761.test@pomelo.click",
  • "password": "2Z9PKUtLdeO5iwu"
}

Response samples

Content type
application/json
{ }

/v1/web/identity-phone-register-request

request a new identity phone verification code

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
phoneNumber
required
string <= 50 characters
phoneCountryCode
required
string <= 10 characters

Responses

Request samples

Content type
application/json
{
  • "phoneNumber": "6880713501",
  • "phoneCountryCode": "+886"
}

Response samples

Content type
application/json
{ }

/v1/web/identity-phone-register-verify

verify the and register a phone to an identity

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
phoneNumber
required
string <= 50 characters
phoneCountryCode
required
string <= 10 characters
verificationCode
required
string <= 12 characters

Responses

Request samples

Content type
application/json
{
  • "phoneNumber": "4356966716",
  • "phoneCountryCode": "+886",
  • "verificationCode": "86299"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/identity-project-settings-create

create identity project settings

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
object

Responses

Request samples

Content type
application/json
{
  • "projectId": "85ff108f-e53c-4fc1-8f2c-9a5d6ce70190",
  • "visualizerSidebarSetting": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/identity-project-settings-delete

delete identity project settings

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
identityProjectSettingsIds
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

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

Response samples

Content type
application/json
{ }

/v1/web/identity-project-settings-list-fetch

fetch project settings list for identity

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/identity-project-settings-update

update identity project settings

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
identityProjectSettingsId
required
string <uuid>
object

Responses

Request samples

Content type
application/json
{
  • "identityProjectSettingsId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "visualizerSidebarSetting": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/identity-recovery-code-list-create

create a recoveryCodeList for an identity

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/identity-refresh-token-submit

get a new accessToken and refreshToken

Request Body schema: application/json
refreshToken
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/identity-settings-update

should update identity's settings with corresponding payload provided

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
webAutoTimeoutLogoutEnabled
boolean

Responses

Request samples

Content type
application/json
{
  • "webAutoTimeoutLogoutEnabled": true
}

Response samples

Content type
application/json
{ }

/v1/web/identity-unread-notification-list-fetch

fetch all unread notifications

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/identity-workspace-collaborator-list-fetch

fetch an identity's workspace own collaborators

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
page
number >= 0
Default: 0

Responses

Request samples

Content type
application/json
{
  • "page": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v1/web/identity-workspace-list-fetch

fetch a list of all the workspaces for the authorized identity

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
page
number >= 0
Default: 0

Responses

Request samples

Content type
application/json
{
  • "page": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v1/web/invite-create

create invite

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
email
required
string <email>
required
object or object

Responses

Request samples

Content type
application/json
{
  • "email": "pomelo-test-10597.florence@kiipo.com",
  • "form": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/invite-list-fetch

fetch invite list

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/mark-participant-complete

DEPRECATED: use participant-complete-status-update instead

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>
force
required
boolean

Responses

Request samples

Content type
application/json
{
  • "participantId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "force": true
}

Response samples

Content type
application/json
{ }

/v1/web/method-dexcom-backfill-metadata-fetch

request dexcom backfill

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
Any of
methodId
string <uuid>
startDate
required
integer

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/method-dexcom-backfill-request

request dexcom backfill

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
methodId
string <uuid>
startDate
required
integer

Responses

Request samples

Content type
application/json
{
  • "methodId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "startDate": "2025-07-17T16:38:42.770Z"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/method-fetch

fetch a single method

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

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

Responses

Request samples

Content type
application/json
{
  • "methodId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/method-task-index-order-update

set the index order for a list of tasks in a method

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
methodId
required
string <uuid>
taskIdList
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "methodId": "a79e32ca-882c-452b-a096-350276aed28d",
  • "taskIdList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/method-update

update the method metadata

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
methodId
required
string <uuid>
name
string <= 50 characters
description
string <= 250 characters
garminDeviceEnable
boolean
garminConnectEnable
boolean
garminStreamEnable
boolean
movesenseDeviceEnable
boolean
dexcomIntegrationId
string or null <uuid>

Responses

Request samples

Content type
application/json
{
  • "methodId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "name": "architecto laborum",
  • "description": "Adflicto valde cras color amissio distinctio deripio cultellus.",
  • "garminDeviceEnable": true,
  • "garminConnectEnable": true,
  • "garminStreamEnable": true,
  • "movesenseDeviceEnable": true,
  • "dexcomIntegrationId": "46199614-158e-4a97-a074-f3fa7c770624"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/participant-analysis-data-fetch

fetch the participant analysis data by yymmddIndex

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>
yymmddIndex
required
number
dataType
required
string
Enum: "actigraphy_sleep" "hrv"
projection
object or null

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
  • "yymmddIndex": 231011,
  • "dataType": "actigraphy_sleep",
  • "projection": { }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/participant-complete-status-update

update participant completion status

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
Any of
participantId
required
string <uuid>
complete
required
any
Value: true
force
required
boolean

Responses

Request samples

Content type
application/json
{
  • "participantId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "complete": false
}

Response samples

Content type
application/json
{ }

/v1/web/participant-credentials-fetch

fetch a participant with its login credentials

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

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

Responses

Request samples

Content type
application/json
{
  • "participantId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/participant-credentials-regenerate

regenerate a participant with its login credentials

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

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

Responses

Request samples

Content type
application/json
{
  • "participantId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/participant-date-range-summary-update-request

request participant summary update in date range

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>
yymmddIndexStart
required
number
yymmddIndexEnd
required
number
type
required
string
Enum: "garminDeviceDaily" "garminDeviceHrvDaily"

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
  • "yymmddIndexStart": 231011,
  • "yymmddIndexEnd": 231011,
  • "type": "garminDeviceDaily"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/participant-delete

delete a participant

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "participantId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{ }

/v1/web/participant-fetch

fetch a single participant

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

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

Responses

Request samples

Content type
application/json
{
  • "participantId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/participant-list-send-push-notification

send a push notification to a list of participants

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantIdList
required
Array of strings <uuid> [ items <uuid > ]
title
required
string [ 1 .. 250 ] characters
content
required
string [ 1 .. 1000 ] characters

Responses

Request samples

Content type
application/json
{
  • "participantIdList": [
    ],
  • "title": "string",
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/participant-list-set-completed

set participant as completed

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantIdList
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

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

Response samples

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

/v1/web/participant-list-unset-completed

unset participant as completed

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantIdList
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

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

Response samples

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

/v1/web/participant-tag-add

associate a tag with participant

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>
tagIds
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "participantId": "e0f28bb3-4a24-4f82-a67d-9dad27bfcf21",
  • "tagIds": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/participant-tag-list-fetch

list tags associated with participant

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "participantId": "99d04c2b-44e0-42a5-a45d-f49e27331783"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/participant-tag-remove

disassociate a tag from participant

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>
tagIds
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "participantId": "3e2e0441-c331-4d35-a794-ca2c30c02dcf",
  • "tagIds": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/participant-task-records-fetch

fetch the participant task records by yymmddIndex

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>
yymmddIndices
required
Array of numbers
taskIdList
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
  • "yymmddIndices": [
    ],
  • "taskIdList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/participant-update

update a single participant

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
string <uuid>
note
string <= 1500 characters
firstName
string or null <= 50 characters
lastName
string or null <= 50 characters
email
string or null <= 250 characters
insignia
string or null <= 50 characters

Responses

Request samples

Content type
application/json
{
  • "participantId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "note": "Caecus adeptio testimonium.",
  • "firstName": "Suzanne",
  • "lastName": "Volkman",
  • "email": "pomelo-test-931b82f4-5a8e-42ee-86f9-abdb0dc37002.test@pomelo.click",
  • "insignia": "0xCebBf"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/profile-create

create a profile

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
lastName
required
string <= 50 characters
firstName
required
string <= 50 characters
title
string or null <= 50 characters

Responses

Request samples

Content type
application/json
{
  • "lastName": "Carlton",
  • "firstName": "Mohr",
  • "title": "Dynamic Intranet Analyst"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/profile-image-upload

upload a profile image

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
image
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
{
  • "image": "an image file"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/profile-update

update a profile

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
lastName
string <= 50 characters
firstName
string <= 50 characters
title
string or null <= 50 characters

Responses

Request samples

Content type
application/json
{
  • "lastName": "Blanca",
  • "firstName": "Schinner",
  • "title": "Central Integration Facilitator"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-analysis-data-job-state-fetch

fetch project anaylsis data job state

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string
analysisDataTypeList
required
Array of strings
Items Enum: "actigraphy_sleep" "hrv"

Responses

Request samples

Content type
application/json
{
  • "projectId": "10c4c8c4-0225-4940-985c-2f3ab6608398",
  • "analysisDataTypeList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-analysis-data-request

request project analysis data

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string
analysisDataTypeList
required
Array of strings
Items Enum: "actigraphy_sleep" "hrv"
yymmddRange
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "projectId": "af95250c-2f7b-4383-af18-e386299ea6cc",
  • "analysisDataTypeList": [
    ],
  • "yymmddRange": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-audit-trail-create

create a project audit trail

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
action
required
string
Enum: "create" "read" "update" "delete"
object or null
object or null

Responses

Request samples

Content type
application/json
{
  • "projectId": "04c9a0a4-bc15-42a0-9f12-6efb1dfc2d3d",
  • "action": "create",
  • "before": null,
  • "after": null
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-audit-trail-list-fetch

fetch project audit trail list

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
page
number >= 0
Default: 0

Responses

Request samples

Content type
application/json
{
  • "projectId": "56f3a7fe-66d9-4b7c-a06b-12288486742c",
  • "page": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v1/web/project-create

create a new project

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
name
required
string <= 50 characters
investigator
string <= 50 characters
organization
string <= 50 characters
description
string <= 250 characters
contactDescription
string <= 250 characters
participantInstructions
string <= 250 characters
workspaceId
string <uuid>
type
string
Enum: "sample" "template" "user"
backgroundSyncIntervalSeconds
integer or null > 0
object

Responses

Request samples

Content type
application/json
{
  • "name": "cervus theatrum",
  • "investigator": "audentia vos",
  • "organization": "praesentium aspernatur",
  • "description": "Illum suffoco tui coma administratio viridis sperno deorsum aqua.",
  • "contactDescription": "Turpis adulescens trans ascisco ager pauci.",
  • "participantInstructions": "Aperte summisse claro terminatio abduco cubitum angulus necessitatibus animadverto venustas.",
  • "workspaceId": "a7b65fb1-c267-4d3c-be2c-dcbaa6f2059a",
  • "type": "user",
  • "backgroundSyncIntervalSeconds": 0,
  • "scheduleConfig": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-data-download-flow-cancel

cancel project data download flow

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "projectId": "5bfa4a8e-3883-4868-8c59-3ce15425c69e"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-data-download-flow-metadata-fetch

fetch project data download flow metadata

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "projectId": "7819c0a0-7a1d-4864-8712-4daa0a06eb65"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-data-download-flow-metadata-list-fetch

fetch a paginated history of project data download flow metadata (latest first)

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
page
number >= 0
Default: 0

Responses

Request samples

Content type
application/json
{
  • "projectId": "e24aa88c-a668-40b5-88d2-f215932c8e02",
  • "page": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v1/web/project-data-download-flow-request

request project data download flow

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
participantIds
required
Array of strings <uuid> [ items <uuid > ]
startDate
string <date-time>
endDate
string <date-time>
force
boolean

Responses

Request samples

Content type
application/json
{
  • "projectId": "4f20aef6-2ae4-4261-842d-fe40b7ede352",
  • "participantIds": [
    ],
  • "startDate": "2025-08-23T10:30:00.134Z",
  • "endDate": "2026-07-09T09:36:16.833Z",
  • "force": false
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-data-download-metadata-fetch

fetch project data download metadata

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
participantIds
Array of strings <uuid> [ items <uuid > ]
startDate
string <date-time>
endDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "projectId": "b41529f0-68a4-490e-bb57-e1ff0be629eb",
  • "participantIds": [
    ],
  • "startDate": "2025-09-02T17:09:55.254Z",
  • "endDate": "2026-07-09T19:25:45.574Z"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-data-update-metadata-fetch

fetch project data update metadata

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string

Responses

Request samples

Content type
application/json
{
  • "projectId": "22493ab7-4582-400f-9254-d631caa61a11"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-data-update-request

request project data update

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string

Responses

Request samples

Content type
application/json
{
  • "projectId": "d33f4c13-d33a-4946-9d88-6d237f941a2c"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-data-zip-metadata-fetch

DEPRECATED: use project-data-download-flow-metadata-fetch (single) or project-data-download-flow-metadata-list-fetch (history) instead

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
participantIds
required
Array of strings <uuid> [ items <uuid > ]
startDate
string <date-time>
endDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "projectId": "4d2890f2-8a99-4f1f-a668-d12e4680ce8e",
  • "participantIds": [
    ],
  • "startDate": "2025-09-06T12:15:59.565Z",
  • "endDate": "2026-07-10T01:05:39.346Z"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-data-zip-metadata-update

DEPRECATED: downloadedAt is now stamped automatically by the exchange-link access endpoint (src/api/endpoint/v1_download/project_data_zip_download.ts); no replacement needed

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
inputHash
required
string
downloadedAt
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "inputHash": "xWIra3ioBFK0T+tO0L+UTXm4WLcfzZgGpU3ANAUiD/hYYiLkAD3hFhzSEQ6QbnkToYqA3BiazTkTTEirnDwNTfQVCrQVDHiCc3L8",
  • "downloadedAt": "2026-07-09T03:58:23.132Z"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": { }
}

/v1/web/project-duplicate

duplicate a project

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
projectName
required
string <= 50 characters
workspaceId
string <uuid>
object
overwriteScheduleConfig
boolean

Responses

Request samples

Content type
application/json
{
  • "projectId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "projectName": "pecus damno",
  • "workspaceId": "adbe4d52-0f3e-4176-aa97-752d48007790",
  • "scheduleConfig": {
    },
  • "overwriteScheduleConfig": true
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-extension-list-fetch

list project extensions of provided projects

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectIds
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/project-fetch

fetch a project and its graph

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

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

Responses

Request samples

Content type
application/json
{
  • "projectId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-garmin-connect-wear-time-data-fetch

get the garmin connect wear time of all participants in given yymmdd indexes

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
yymmddIndexList
required
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "projectId": "77040a1f-d5e9-4986-8436-d1885d2f36d6",
  • "yymmddIndexList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-garmin-direct-bbi-data-digest

get the garmin direct bbi data digest of all participants in given yymmdd indexes

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
yymmddIndexList
required
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "projectId": "0f724cc7-dc8e-403c-bcf3-d8215db8c6b4",
  • "yymmddIndexList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-garmin-direct-data-digest

get the garmin direct data digest of all participants in given year-month indexes

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
yymmIndexList
required
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "projectId": "ee715e18-b9d5-4313-970c-8b38f6670e8d",
  • "yymmIndexList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-garmin-direct-step-data-digest

get the garmin direct step data digest of all participants in given yymmdd indexes

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
yymmddIndexList
required
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "projectId": "55478237-b647-409a-87fb-ac4c99465574",
  • "yymmddIndexList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-list-fetch

fetch projects associated to your identity

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
page
number >= 0
Default: 0

Responses

Request samples

Content type
application/json
{
  • "page": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v1/web/project-participant-data-last-update-time-fetch

get the data last update time of all participants

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
dataType
string

Responses

Request samples

Content type
application/json
{
  • "projectId": "aff8e6a9-148e-4822-82d5-088a1ef9f54e",
  • "dataType": "string"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-participant-issues-fetch

get the data collection issue of all participants in a project

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
localYymmdd
required
string

Responses

Request samples

Content type
application/json
{
  • "projectId": "b7905007-75bf-4149-af95-2f0f08a69f95",
  • "localYymmdd": "string"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-participant-list-csv-fetch

fetch participant list's csv

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

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

Responses

Request samples

Content type
application/json
{
  • "batchId": "5579c111-9c50-47e2-af92-f16d52e63189"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-realtime-data-fetch

fetch project realtime data

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string
bufferTime
required
number
activeTimeThreshold
number

Responses

Request samples

Content type
application/json
{
  • "projectId": "string",
  • "bufferTime": 0,
  • "activeTimeThreshold": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": { }
}

/v1/web/project-reset

hard delete all participants and set project to draft

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "projectId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{ }

/v1/web/project-schedule-config-create

create schedule config for project

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
frequency
string or null
reference
string or null
absoluteReferenceYymmdd
integer or null [ 100000 .. 999999 ]

Responses

Request samples

Content type
application/json
{
  • "projectId": "2b4a4794-4288-452a-84d0-54b0be24ba4b",
  • "frequency": "daily",
  • "reference": "absolute",
  • "absoluteReferenceYymmdd": "270215"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-schedule-config-delete

delete project schedule config

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "projectId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{ }

/v1/web/project-schedule-config-fetch

fetch project schedule config

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "projectId": "49d7a8ea-b30f-4ce3-88ce-3ad5cf3cc970"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-schedule-config-update

update project schedule config

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
frequency
string or null
reference
string or null
absoluteReferenceYymmdd
integer or null [ 100000 .. 999999 ]

Responses

Request samples

Content type
application/json
{
  • "projectId": "a3d855ed-b089-404a-a016-902bc9d86126",
  • "frequency": "daily",
  • "reference": "absolute",
  • "absoluteReferenceYymmdd": "261211"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-status-update

update a project status

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
string <uuid>
status
required
string
Enum: "draft" "completed" "live" "deleted"

Responses

Request samples

Content type
application/json
{
  • "projectId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "status": "draft"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-tag-create

create a tag under project

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "projectId": "b25795c5-6b54-4aba-95b9-08eace99ec8d",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/project-tag-delete

delete a tag under project

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
tagIds
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "projectId": "6d561bf4-b9eb-4beb-ae12-53d967a588e5",
  • "tagIds": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/project-tag-index-order-update

reorder project tags

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
tagIds
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "projectId": "fa337a8b-4854-472c-9673-ddf388bd1d08",
  • "tagIds": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/project-tag-list-fetch

list tags under project

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "projectId": "04489c57-fe11-4fc0-8e94-abfe0bc3cf86"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/project-tag-update

update a tag under project

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
Any of
projectId
required
string <uuid>
tagId
required
string <uuid>
color
required
string
value
string <= 1000 characters

Responses

Request samples

Content type
application/json
{
  • "projectId": "fc119fc2-9122-441e-bc7d-33eb3177ae29",
  • "tagId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "color": "ecb751",
  • "value": "decumbo"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-update

update a project

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
name
string <= 50 characters
investigator
string <= 50 characters
organization
string <= 50 characters
description
string <= 250 characters
contactDescription
string <= 250 characters
participantInstructions
string <= 250 characters
Array of objects or null
type
string
Enum: "sample" "template" "user"
backgroundSyncIntervalSeconds
integer or null > 0

Responses

Request samples

Content type
application/json
{
  • "projectId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "name": "at defleo",
  • "investigator": "abbas sed",
  • "organization": "aetas vociferor",
  • "description": "Correptius sed spiritus quis arcesso consectetur ullus.",
  • "contactDescription": "Voveo cursim temptatio valde.",
  • "participantInstructions": "Careo angelus concedo suppono capillus centum.",
  • "visibleGraphDataInfoList": [
    ],
  • "type": "user",
  • "backgroundSyncIntervalSeconds": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/project-workspace-update

transfer a project to a different workspace/identity. the identity must have roleProjectWorkspaceUpdate on the original workspace and roleProjectCreate on the future workspace

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
string <uuid>
workspaceId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "projectId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "workspaceId": "5ee9aa68-e9f4-4fa5-baa0-80a72649e8e0"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/questionnaire-display-strategy-delete

delete a QuestionnaireDisplayStrategy

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
questionnaireId
required
string <uuid>
displayStrategyIdList
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "questionnaireId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "displayStrategyIdList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/questionnaire-display-strategy-upsert

upsert a QuestionnaireDisplayStrategy

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
questionnaireId
required
string <uuid>
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "questionnaireId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "displayStrategyList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/questionnaire-image-upload-url-generate

create a presigned url for uploading an image

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
imageMimeType
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/schedule-time-slot-list-generate

Generate schedule time slot list

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
scheduleIdList
required
Array of strings <uuid> [ items <uuid > ]
absoluteStartDate
required
integer
startDate
required
integer
endDate
required
integer
baseSeed
required
string

Responses

Request samples

Content type
application/json
{
  • "scheduleIdList": [
    ],
  • "absoluteStartDate": 0,
  • "startDate": 0,
  • "endDate": 0,
  • "baseSeed": "string"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/task-create

create a task with optional task schedules, schedule reminders, or event tracker

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
required
object or object or object or object or object
Array of objects
createEventTracker
boolean

Responses

Request samples

Content type
application/json
{
  • "task": {
    },
  • "scheduleList": [
    ],
  • "createEventTracker": true
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-delete

delete a task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

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

Responses

Request samples

Content type
application/json
{
  • "taskId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{ }

/v1/web/task-duplicate

create a new task WARNING: taskSet is not supported yet

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
taskId
required
string <uuid>
methodId
string <uuid>
name
string <= 50 characters

Responses

Request samples

Content type
application/json
{
  • "taskId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "methodId": "3b899b60-5934-4e42-b343-30196204d1ca",
  • "name": "contra laudantium"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-event-tracker-create

create a task event tracker

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
taskId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "taskId": "e5f5d3f3-3405-4984-98f3-1d2cd3331812"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-event-tracker-delete

delete a task event tracker

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

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

Responses

Request samples

Content type
application/json
{
  • "id": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{ }

/v1/web/task-event-tracker-fetch

fetch a task event tracker

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
taskId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "taskId": "2e778ae5-5937-49f6-8068-fb059a469286"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-event-tracker-update

update a task event tracker

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

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

Responses

Request samples

Content type
application/json
{
  • "id": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "inactive": false
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-garmin-device-create

create a new garmin device task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
methodId
required
string <uuid>
object

Responses

Request samples

Content type
application/json
{
  • "methodId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "garminDevice": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-garmin-device-update

update a garmin device task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
taskId
required
string <uuid>
required
object

Responses

Request samples

Content type
application/json
{
  • "taskId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "garminDevice": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-questionnaire-create

create a new questionnaire task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
methodId
required
string <uuid>
name
required
string <= 50 characters
description
required
string <= 1500 characters
scheduleRepeat
boolean or null
scheduleDescription
string or null <= 250 characters
color
string or null
Array of objects or objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "methodId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "name": "apud coerceo",
  • "description": "Adaugeo vester magni statua.",
  • "scheduleRepeat": false,
  • "scheduleDescription": "Decipio adsum agnitio animadverto.",
  • "color": "ecb751",
  • "reminderList": [
    ],
  • "sectionList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-questionnaire-update

update a new questionnaire task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
id
string <uuid>
updatedAt
string <date-time>
createdAt
string <date-time>
color
string or null
Array of objects or objects
workspaceId
string <uuid>
projectId
string <uuid>
methodId
string <uuid>
taskSetParentId
string or null <uuid>
scheduleDescription
string or null <= 250 characters
scheduleRepeat
boolean or null
required
boolean
enabled
boolean
index
integer
type
string
todo
any
timer
any
required
object
garminDevice
any
taskSet
any
stopwatchGarminStream
any
stopwatchMovesenseStream
any
scheduleList
any
eventTracker
any
jitaiTaskConfigList
any

Responses

Request samples

Content type
application/json
{
  • "id": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "updatedAt": "2026-07-09T08:59:15.164Z",
  • "createdAt": "2026-01-07T14:40:21.212Z",
  • "color": "ecb751",
  • "reminderList": [
    ],
  • "workspaceId": "09c27394-ef19-496d-957b-d0f79d0b7f1b",
  • "projectId": "11e71eff-f5ad-4580-9c2f-7acd400b0d59",
  • "methodId": "2b5d109f-f02f-4553-b826-faefc64b3350",
  • "taskSetParentId": null,
  • "scheduleDescription": "Adhaero stella vindico.",
  • "scheduleRepeat": false,
  • "required": false,
  • "enabled": false,
  • "index": 0,
  • "type": "todo",
  • "todo": null,
  • "timer": null,
  • "questionnaire": {
    },
  • "garminDevice": null,
  • "taskSet": null,
  • "stopwatchGarminStream": null,
  • "stopwatchMovesenseStream": null,
  • "scheduleList": null,
  • "eventTracker": null,
  • "jitaiTaskConfigList": null
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-schedule-create

create task schedule

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
taskId
required
string <uuid>
type
required
string
scheduleYear
integer or null >= 0
scheduleMonth
integer or null >= 0
scheduleDay
integer or null >= 0
scheduleHour
integer or null >= 0
scheduleMinute
integer or null >= 0
scheduleSecond
integer or null >= 0
scheduleWeekdays
integer or null [ 1 .. 1234567 ]
relativeStartDayOrYymmdd
integer or null > 0
relativeEndDayOrYymmdd
integer or null > 0
startTime
string or null^([01]\d|2[0-3]):([0-5]\d)(?::([0-5]\d))?$
endTime
string or null^(\d{2,}):([0-5]\d)(?::([0-5]\d))?$
emaType
string or null
emaOcurrences
integer or null > 0
emaIntervalSeconds
integer or null > 0
emaMinimumGapSeconds
integer or null > 0
emaExpirationSeconds
integer or null > 0

Responses

Request samples

Content type
application/json
{
  • "taskId": "a93d902a-bb40-477b-8b72-259ecc134434",
  • "type": "absolute",
  • "scheduleYear": 2024,
  • "scheduleMonth": 12,
  • "scheduleDay": 12,
  • "scheduleHour": 13,
  • "scheduleMinute": 25,
  • "scheduleSecond": 45,
  • "scheduleWeekdays": 1234567,
  • "relativeStartDayOrYymmdd": 241212,
  • "relativeEndDayOrYymmdd": 241213,
  • "startTime": "23:58",
  • "endTime": "23:59",
  • "emaType": "random",
  • "emaOcurrences": 2,
  • "emaIntervalSeconds": 3600,
  • "emaMinimumGapSeconds": 3600,
  • "emaExpirationSeconds": 3600
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-schedule-delete

delete task schedule, use null value to unset property

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

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

Responses

Request samples

Content type
application/json
{
  • "id": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{ }

/v1/web/task-schedule-list-fetch

list schedule under task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
taskId
required
string <uuid>
excludeInactive
boolean
excludeNonCurrent
boolean

Responses

Request samples

Content type
application/json
{
  • "taskId": "ad60f650-46c3-471d-9814-2ff178cc636e",
  • "excludeInactive": true,
  • "excludeNonCurrent": true
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/task-schedule-reminder-update

replace task schedule reminders

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
taskScheduleId
required
string <uuid>
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "taskScheduleId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "reminderList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/task-schedule-sync-notify

send silent push notification participant to notify task schedule sync

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Response samples

Content type
application/json
{ }

/v1/web/task-schedule-update

update task schedule, use null value to unset property

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
id
required
string <uuid>
updatedAt
integer
createdAt
integer
taskId
string <uuid>
type
string
inactive
boolean
current
boolean
scheduleYear
integer or null >= 0
scheduleMonth
integer or null >= 0
scheduleDay
integer or null >= 0
scheduleHour
integer or null >= 0
scheduleMinute
integer or null >= 0
scheduleSecond
integer or null >= 0
scheduleWeekdays
integer or null [ 1 .. 1234567 ]
relativeStartDayOrYymmdd
integer or null > 0
relativeEndDayOrYymmdd
integer or null > 0
startTime
string or null^([01]\d|2[0-3]):([0-5]\d)(?::([0-5]\d))?$
endTime
string or null^(\d{2,}):([0-5]\d)(?::([0-5]\d))?$
emaType
string or null
emaOcurrences
integer or null > 0
emaIntervalSeconds
integer or null > 0
emaMinimumGapSeconds
integer or null > 0
emaExpirationSeconds
integer or null > 0

Responses

Request samples

Content type
application/json
{
  • "id": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "updatedAt": "2026-07-09T08:59:15.164Z",
  • "createdAt": "2026-01-07T14:40:21.212Z",
  • "taskId": "d495ca54-7f43-4eab-85be-91f5ff14da86",
  • "type": "absolute",
  • "inactive": false,
  • "current": true,
  • "scheduleYear": 2024,
  • "scheduleMonth": 12,
  • "scheduleDay": 12,
  • "scheduleHour": 13,
  • "scheduleMinute": 25,
  • "scheduleSecond": 45,
  • "scheduleWeekdays": 1234567,
  • "relativeStartDayOrYymmdd": 241212,
  • "relativeEndDayOrYymmdd": 241213,
  • "startTime": "23:58",
  • "endTime": "23:59",
  • "emaType": "random",
  • "emaOcurrences": 2,
  • "emaIntervalSeconds": 3600,
  • "emaMinimumGapSeconds": 3600,
  • "emaExpirationSeconds": 3600
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-set-add-item

create a new task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
taskSetTaskId
string <uuid>
taskSetItemId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "taskSetTaskId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "taskSetItemId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-set-create

create a new task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
name
required
string <= 50 characters
description
string <= 250 characters
methodId
required
string <uuid>
scheduleDescription
string or null <= 250 characters
scheduleRepeat
boolean or null
color
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "vilitas vobis",
  • "description": "Curto volo crebro quae itaque aptus commodi.",
  • "methodId": "950d0422-6b99-41c6-8eff-fcc693f025d4",
  • "scheduleDescription": "Quis cras calamitas sustineo summopere deduco aspicio.",
  • "scheduleRepeat": false,
  • "color": "ecb751"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-stopwatch-garmin-stream-create

create a garmin stopwatch task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
methodId
required
string <uuid>
color
string or null
Array of objects or objects
scheduleRepeat
boolean or null
scheduleDescription
string or null <= 250 characters
name
required
string <= 50 characters
description
required
string <= 250 characters
accEnable
required
boolean
accHz
number
timeLimitSeconds
number

Responses

Request samples

Content type
application/json
{
  • "methodId": "df1bd310-92d6-4b24-ac6c-fcd0eb4ec0eb",
  • "color": "ecb751",
  • "reminderList": [
    ],
  • "scheduleRepeat": false,
  • "scheduleDescription": "Amicitia utrimque balbus vinculum utrimque cado.",
  • "name": "ante numquam",
  • "description": "Viduo ademptio vinco.",
  • "accEnable": true,
  • "accHz": 100,
  • "timeLimitSeconds": 900
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-stopwatch-garmin-stream-update

update a garmin stopwatch task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
taskId
required
string <uuid>
color
string or null
Array of objects or objects or null
scheduleRepeat
boolean or null
scheduleDescription
string or null <= 250 characters
name
string or null <= 50 characters
description
string or null <= 250 characters
accEnable
boolean or null
accHz
number or null
ascentEnable
boolean or null
bbiEnable
boolean or null
bodyBatteryEnable
boolean or null
caloriesEnable
boolean or null
heartRateEnable
boolean or null
intensityEnable
boolean or null
pulseOxEnable
boolean or null
respirationEnable
boolean or null
stepEnable
boolean or null
stressEnable
boolean or null
realtimeUpload
boolean or null
timeLimitSeconds
number

Responses

Request samples

Content type
application/json
{
  • "taskId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "color": "ecb751",
  • "reminderList": [
    ],
  • "scheduleRepeat": false,
  • "scheduleDescription": "Comptus sopor calamitas verecundia incidunt cumque trucido timor crinis vero.",
  • "name": "solvo itaque",
  • "description": "Curia thymum sopor thymbra vilitas auctor aufero demitto custodia victoria.",
  • "accEnable": true,
  • "accHz": 25,
  • "ascentEnable": true,
  • "bbiEnable": true,
  • "bodyBatteryEnable": true,
  • "caloriesEnable": true,
  • "heartRateEnable": true,
  • "intensityEnable": true,
  • "pulseOxEnable": true,
  • "respirationEnable": true,
  • "stepEnable": true,
  • "stressEnable": true,
  • "realtimeUpload": true,
  • "timeLimitSeconds": 900
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-stopwatch-movesense-stream-create

create a movesense stopwatch task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
methodId
required
string <uuid>
color
string or null
Array of objects or objects
scheduleRepeat
boolean or null
scheduleDescription
string or null <= 250 characters
name
required
string <= 50 characters
description
required
string <= 250 characters
rrEnable
required
boolean
imuEnable
required
boolean
accEnable
required
boolean
ecgEnable
required
boolean
gyroscopeEnable
required
boolean
magnetometerEnable
required
boolean
ecgHz
number or null
Enum: null 125 128 200 250 256 500 512
imuHz
number or null
Enum: null 13 26 52 104 208
accHz
number or null
Enum: null 13 26 52 104 208
gyroscopeHz
number or null
Enum: null 13 26 52 104 208
magnetometerHz
number or null
Enum: null 13 26 52 104 208
timeLimitSeconds
number

Responses

Request samples

Content type
application/json
{
  • "methodId": "4eb34d89-5856-48d2-85ad-2d16a554beb7",
  • "color": "ecb751",
  • "reminderList": [
    ],
  • "scheduleRepeat": false,
  • "scheduleDescription": "Temperantia at decimus vinum tenuis vacuus volubilis succedo vestrum subiungo.",
  • "name": "quidem vesica hic",
  • "description": "averto dicta dolor cuppedia",
  • "rrEnable": false,
  • "imuEnable": false,
  • "accEnable": false,
  • "ecgEnable": false,
  • "gyroscopeEnable": false,
  • "magnetometerEnable": false,
  • "ecgHz": 125,
  • "imuHz": 13,
  • "accHz": 13,
  • "gyroscopeHz": 13,
  • "magnetometerHz": 13,
  • "timeLimitSeconds": 900
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-stopwatch-movesense-stream-update

update a movesense stopwatch task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
taskId
required
string <uuid>
color
string or null
Array of objects or objects or null
scheduleRepeat
boolean or null
scheduleDescription
string or null <= 250 characters
name
string or null <= 50 characters
description
string or null <= 250 characters
rrEnable
boolean or null
imuEnable
boolean or null
accEnable
boolean or null
ecgEnable
boolean or null
gyroscopeEnable
boolean or null
magnetometerEnable
boolean or null
ecgHz
number or null
Enum: null 125 128 200 250 256 500 512
imuHz
number or null
Enum: null 13 26 52 104 208
accHz
number or null
Enum: null 13 26 52 104 208
gyroscopeHz
number or null
Enum: null 13 26 52 104 208
magnetometerHz
number or null
Enum: null 13 26 52 104 208
timeLimitSeconds
number

Responses

Request samples

Content type
application/json
{
  • "taskId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "color": "ecb751",
  • "reminderList": [
    ],
  • "scheduleRepeat": false,
  • "scheduleDescription": "Acer praesentium soluta denique nemo subseco.",
  • "name": "sum admitto spargo",
  • "description": "cubo depraedor vereor callide",
  • "rrEnable": false,
  • "imuEnable": false,
  • "accEnable": false,
  • "ecgEnable": false,
  • "gyroscopeEnable": false,
  • "magnetometerEnable": false,
  • "ecgHz": 125,
  • "imuHz": 13,
  • "accHz": 13,
  • "gyroscopeHz": 13,
  • "magnetometerHz": 13,
  • "timeLimitSeconds": 900
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-timer-create

create a new timer task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
name
required
string <= 50 characters
description
required
string <= 250 characters
scheduleRepeat
boolean or null
scheduleDescription
string or null <= 250 characters
color
string or null
methodId
required
string <uuid>
Array of objects or objects

Responses

Request samples

Content type
application/json
{
  • "name": "cernuus pecus",
  • "description": "Asporto eaque quaerat abeo comitatus collum creber templum defleo corrupti.",
  • "scheduleRepeat": false,
  • "scheduleDescription": "Communis blandior vapulus cupio verbera vociferor certus appono.",
  • "color": "ecb751",
  • "methodId": "67cafcee-9cc7-4316-a40d-72327f1408b9",
  • "reminderList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-timer-update

update a timer task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
name
string <= 50 characters
description
string <= 250 characters
scheduleRepeat
boolean or null
scheduleDescription
string or null <= 250 characters
color
string or null
taskId
required
string <uuid>
Array of objects or objects

Responses

Request samples

Content type
application/json
{
  • "name": "pariatur virga",
  • "description": "Beneficium totam aedificium trepide aurum vulnero spero celer.",
  • "scheduleRepeat": false,
  • "scheduleDescription": "Triduana commodo stillicidium dedecor certus cupressus optio solum.",
  • "color": "ecb751",
  • "taskId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "reminderList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-todo-create

create a new task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
name
required
string <= 50 characters
description
required
string <= 250 characters
methodId
required
string <uuid>
scheduleRepeat
boolean or null
scheduleDescription
string or null <= 250 characters
color
string or null
Array of objects or objects

Responses

Request samples

Content type
application/json
{
  • "name": "admoneo administratio",
  • "description": "Tertius cognatus surgo vicissitudo capio.",
  • "methodId": "4b701f52-5542-4bd5-945f-ffc8b7f46cff",
  • "scheduleRepeat": false,
  • "scheduleDescription": "Crapula iusto truculenter avarus urbs cultura.",
  • "color": "ecb751",
  • "reminderList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-todo-update

update a todo task

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
name
string <= 50 characters
description
string <= 250 characters
scheduleRepeat
boolean or null
scheduleDescription
string or null <= 250 characters
color
string or null
taskId
required
string <uuid>
Array of objects or objects

Responses

Request samples

Content type
application/json
{
  • "name": "stultus tutis",
  • "description": "Uxor cometes acceptus curia adduco aro cursim.",
  • "scheduleRepeat": false,
  • "scheduleDescription": "Torrens varius sto audax tener abundans adfectus arcesso.",
  • "color": "ecb751",
  • "taskId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "reminderList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/task-update

update task model specific metadata (for any task type)

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
taskId
required
string <uuid>
color
string or null
index
integer
enabled
boolean
scheduleRepeat
boolean or null
scheduleDescription
string or null <= 250 characters
Array of objects or objects

Responses

Request samples

Content type
application/json
{
  • "taskId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "color": "ecb751",
  • "index": 0,
  • "enabled": false,
  • "scheduleRepeat": false,
  • "scheduleDescription": "Aestas vix tremo.",
  • "reminderList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/trusted-device-create

create a trusted device for an identity

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/trusted-device-delete

delete a trusted device for an identity

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
trustedDeviceToken
string

Responses

Request samples

Content type
application/json
{
  • "trustedDeviceToken": "0x700A221ffF0Dd07B5dB6"
}

Response samples

Content type
application/json
{ }

/v1/web/visualizer-daily-summary-data-fetch

fetch the daily summary graph data for visualizer

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>
yymmddIndexStart
required
number
yymmddIndexEnd
required
number
dataTypeList
Array of strings or null
Enum: "activity" "activity_details" "activity_files" "activity_manually_updated" "activity_move_iq" "health_hrv_summary" "health_body_compositions" "health_dailies" "health_epochs" "health_snapshot" "health_pulse_ox" "health_respiration" "health_sleeps" "health_stress" "health_skin_temperature" "health_third_party_dailies" "health_user_metrics" "health_blood_pressure" "women_health_mct"
projection
object or null

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
  • "yymmddIndexStart": 231011,
  • "yymmddIndexEnd": 231111,
  • "dataTypeList": [
    ],
  • "projection": { }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/dexcom-data-fetch

fetch dexcom data by yymmddIndex

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>
yymmddIndexes
required
Array of numbers
projection
object or null

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
  • "yymmddIndexes": [
    ],
  • "projection": { }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/visualizer-garmin-direct-daily-summary-data-fetch

fetch garmin direct daily summary data for visualizer

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>
yymmddIndexList
Array of numbers
projection
object or null

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
  • "yymmddIndexList": [
    ],
  • "projection": { }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/garmin-direct-data-fetch

fetch the garmin direct data by yymmddIndex

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>
yymmddIndex
required
number
dataTypeList
Array of strings or null
Enum: "garmin_bbi" "garmin_enhanced_bbi" "garmin_step" "garmin_pulse_ox" "garmin_acc" "garmin_heart_rate" "garmin_respiration" "garmin_stress" "garmin_zero_crossing" "garmin_actigraphy" "garmin_actigraphy2" "garmin_actigraphy3" "garmin_temperature" "garmin_wrist_status"
projection
object or null

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
  • "yymmddIndex": 231011,
  • "dataTypeList": [
    ],
  • "projection": { }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/log-capture

capture logs from the web app

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
appVersion
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "appVersion": "string",
  • "logList": [
    ]
}

Response samples

Content type
application/json
{ }

/v1/web/workspace-all-questionnaire-fetch

fetch all questionnaires for a workspace

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
workspaceId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "workspaceId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/workspace-collaborator-create

invite a workspace collaborator

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
Any of
email
required
string <email> <= 250 characters
workspaceId
required
string <uuid>
type
required
any
Value: "admin"

Responses

Request samples

Content type
application/json
{
  • "email": "pomelo-test-9765f344-4ab7-4608-9d0f-924a52ef10d8.test@pomelo.click",
  • "workspaceId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "type": "project_collaborator",
  • "projectCollaboratorList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/workspace-collaborator-delete

delete a WorkspaceCollaborator

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
workspaceCollaboratorId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "workspaceCollaboratorId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{ }

/v1/web/workspace-collaborator-list-fetch

fetch a list of collaborators for a workspace

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
workspaceId
required
string <uuid>
page
number >= 0
Default: 0
projectId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "workspaceId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "page": 0,
  • "projectId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v1/web/workspace-collaborator-update

update a WorkspaceCollaborator; WARNING: this api deletes workspace collaborator when no child project collaborator remains

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
Any of
workspaceCollaboratorId
required
string <uuid>
type
required
any
Value: "admin"

Responses

Request samples

Content type
application/json
{
  • "workspaceCollaboratorId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "type": "project_collaborator",
  • "projectCollaboratorAction": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/workspace-favorite-create

create workspace favorite

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "projectId": "f7e3e285-55f8-427c-afe6-e3a74f8d8ebd"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/web/workspace-favorite-delete

delete workspace favorite

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
workspaceFavoriteId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "workspaceFavoriteId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{ }

/v1/web/workspace-favorite-list-fetch

fetch workspace favorite list

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/web/workspace-update

update a workspace

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
workspaceId
required
string <uuid>
name
string <= 50 characters

Responses

Request samples

Content type
application/json
{
  • "workspaceId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "name": "unus auctus"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

v1/pompom

/v1/pompom/dexcom-oauth-callback

handle dexcom oauth callback

query Parameters
code
string
state
string
error
string

Responses

Response samples

Content type
application/json
{ }

/v1/pompom/garmin-oauth-callback

handle garmin oauth callback

query Parameters
oauth_token
string
oauth_verifier
string

Responses

Response samples

Content type
application/json
{ }

/v1/pompom/os-stats

get server os stats

Responses

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/pompom/participant-garmin-connect-grant-url-fetch

fetch participant garmin connect grant url

Request Body schema: application/json
secret
required
string
participantId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "secret": "string",
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7"
}

Response samples

Content type
application/json
{}

/v1/pompom/changelog

fetch metadata about deployment and version from history

Responses

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/pompom/test-account-participant-login-code

generate a participant login code for testers

Responses

Response samples

Content type
application/json
"your code is 14625"

v1/garmin

/v1/garmin/connect-hook-activity-details

garmin connect hook for activity details

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-activity

garmin connect hook for activities

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-activity-files

garmin connect hook for activity files

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-activity-manually-updated

garmin connect hook for manually updated activities

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-activity-move-iq

garmin connect hook for activity move iq

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-deregistration

garmin connect hook for deregistration

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-health-blood-pressure

garmin connect hook for health BloodPressure

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-health-body-compositions

garmin connect hook for health body composition

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-health-dailies

garmin connect hook for health dailies

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-health-epochs

garmin connect hook for health epoch

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-health-hrv-summary

garmin connect hook for health hrv summary

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-health-pulse-ox

garmin connect hook for health PulseOx

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-health-respiration

garmin connect hook for health Respiration

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-health-skin-temperature

garmin connect hook for health SkinTemperature

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-health-sleeps

garmin connect hook for health sleeps

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-health-snapshot

garmin connect hook for health snapshot

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-health-stress

garmin connect hook for health Stress

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-health-third-party-dailies

garmin connect hook for health ThirdPartyDailies

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-health-user-metrics

garmin connect hook for health UserMetrics

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/garmin/connect-hook-women-health-mct

garmin connect hook for women health MCT

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

v1/common

/v1/common/garmin-device-support

get metadata about which features a device supports

Responses

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/common/realtime-data-fetch

public access to realtime data

Request Body schema: application/json
secret
required
string
projectId
required
string
bufferTime
required
number
activeTimeThreshold
number

Responses

Request samples

Content type
application/json
{
  • "secret": "string",
  • "projectId": "string",
  • "bufferTime": 0,
  • "activeTimeThreshold": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": { }
}

v1/mobile

/v1/mobile/get_generic_file_upload_url

create s3 presigned url for upload file to generic bucket

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
fileType
required
any
Value: "SdkLog"
filePath
required
string
fileName
required
string

Responses

Request samples

Content type
application/json
{
  • "fileType": "SdkLog",
  • "filePath": "string",
  • "fileName": "string"
}

Response samples

Content type
application/json
{}

/v1/mobile/heart_beat_upload

recieve realtime stream data

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/mobile/jitai_event_upload

upload a participant's jitai events

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
required
Array of objects

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": { }
}

/v1/mobile/force-update-metadata-fetch

fetch latest force_update_metadata for this stage

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/mobile/log-capture

capture logs from the mobile app

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
mobileDeviceType
required
string
mobileDeviceOsVersion
required
string
garminDeviceType
string
garminDeviceFirmware
string
appVersion
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "mobileDeviceType": "string",
  • "mobileDeviceOsVersion": "string",
  • "garminDeviceType": "string",
  • "garminDeviceFirmware": "string",
  • "appVersion": "string",
  • "logList": [
    ]
}

Response samples

Content type
application/json
{ }

/v1/mobile/activities_upload

recieve mobile activities

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
Array of objects

Responses

Request samples

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

Response samples

Content type
application/json
{ }

/v1/mobile/participant-contract-sign

record that a participant has agreed to sign the contract

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/mobile/participant-dexcom-grant-url-fetch

fetch participant dexcom grant url

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{}

/v1/mobile/participant-dexcom-integration-fetch

fetch dexcom integration with target method id

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

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

Responses

Request samples

Content type
application/json
{
  • "methodId": "a79e32ca-882c-452b-a096-350276aed28d"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/mobile/participant-dexcom-link

link a dexcom acount to participant

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
dexcomAppId
required
string
accessToken
required
string
refreshToken
required
string
accessTokenExpireTime
required
integer

Responses

Request samples

Content type
application/json
{
  • "dexcomAppId": "B8zgZKQEhUWUzw9",
  • "accessToken": "xSPbmcQpu0/pmEA",
  • "refreshToken": "ryudvXsve/CA6/Q",
  • "accessTokenExpireTime": "2026-07-09T11:24:32.347Z"
}

Response samples

Content type
application/json
{ }

/v1/mobile/participant-garmin-connect-account-delete

delete participant's garmin connect account

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/mobile/participant-garmin-connect-grant-url-fetch

fetch participant garmin connect grant url

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{}

/v1/mobile/participant-garmin-connect-link

link a garmin connect account to participant

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
userId
required
string
userOauthTokenKey
required
string
userOauthTokenSecret
required
string

Responses

Request samples

Content type
application/json
{
  • "userId": "0x3d6de7dAC8",
  • "userOauthTokenKey": "0xc79DcC64aF",
  • "userOauthTokenSecret": "0xbdDA25B34A"
}

Response samples

Content type
application/json
{ }

/v1/mobile/participant-garmin-device-query-event-list-submit

upload a list of records that represents a interaction to a garmin device

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
Array (non-empty)
uploadTimezone
string
garminDeviceType
required
string
mobileDeviceType
required
string
Enum: "ios" "android"
mobileDeviceVersion
required
string
queryStartUnixTimestamp
required
number
queryEndUnixTimestamp
required
number
queryType
required
string
Enum: "initial" "verification"
data
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

/v1/mobile/participant-garmin-device-query-event-submit

upload a record that represents a interaction to a garmin device

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
uploadTimezone
string
garminDeviceType
required
string
mobileDeviceType
string
Enum: "ios" "android"
queryStartUnixTimestamp
required
number
queryEndUnixTimestamp
required
number
queryType
required
string
Enum: "initial" "verification"
data
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
{
  • "uploadTimezone": "string",
  • "garminDeviceType": "string",
  • "mobileDeviceType": "ios",
  • "queryStartUnixTimestamp": 0,
  • "queryEndUnixTimestamp": 0,
  • "queryType": "initial",
  • "data": [ ]
}

Response samples

Content type
application/json
{ }

/v1/mobile/participant-login-code-state-fetch

authenticate an participant with email and password

Request Body schema: application/json
loginCode
required
string <= 12 characters

Responses

Request samples

Content type
application/json
{
  • "loginCode": "123456"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/mobile/participant-logout

remove participant's session accessToken and refreshToken

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{ }

/v1/mobile/participant-metadata-fetch

fetch a participant's metadata

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/mobile/participant-notification-list-fetch

fetch a participant's ParticipantNotification list

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
page
required
integer >= 0
orderBy
string
orderDescending
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "orderBy": "string",
  • "orderDescending": true
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v1/mobile/participant-notification-set-viewed-date

set a ParticipantNotification's viewedDate

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantNotificationId
required
string <uuid>
viewedDate
required
integer

Responses

Request samples

Content type
application/json
{
  • "participantNotificationId": "864c9083-6e55-4105-ad66-0331c0a00a6c",
  • "viewedDate": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/mobile/participant-project-description-fetch

fetch a participant's project metadata

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/mobile/participant-project-method-fetch

fetch a participant's project metadata

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/mobile/participant-push-device-set

add or update a participant's push notification credentials

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
deviceToken
required
string <= 400 characters
deviceType
required
string

Responses

Request samples

Content type
application/json
{
  • "deviceToken": "0xcCCB405bc4",
  • "deviceType": "ios"
}

Response samples

Content type
application/json
{ }

/v1/mobile/participant-record-submit

upload participant data

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
garminDeviceType
string
uploadTimezone
string
uploadTimezoneOffsetInSeconds
number
lastAppOpenDate
integer
garminDeviceSyncTimeList
Array of numbers
garminDeviceBatteryPercentage
number [ 0 .. 1 ]
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects <= 500 items

Responses

Request samples

Content type
application/json
{
  • "garminDeviceType": "string",
  • "uploadTimezone": "string",
  • "uploadTimezoneOffsetInSeconds": 0,
  • "lastAppOpenDate": 0,
  • "garminDeviceSyncTimeList": 1783654934509,
  • "garminDeviceBatteryPercentage": 0.79,
  • "data": [
    ]
}

Response samples

Content type
application/json
{ }

/v1/mobile/participant-record-submit-garmin-bbi

upload participant garmin bbi data

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
taskId
required
string <uuid>
uploadTimezone
string
garminDeviceType
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "uploadTimezone": "string",
  • "garminDeviceType": "string",
  • "data": [
    ]
}

Response samples

Content type
application/json
{ }

/v1/mobile/participant-refresh-token-submit

get a new accessToken and refreshToken

Request Body schema: application/json
refreshToken
required
string

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "0x0dc00f82b9"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/mobile/participant-schedule-task-history-fetch

fetch a participant's schedule task complete history in list

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
startDate
integer
endDate
integer

Responses

Request samples

Content type
application/json
{
  • "startDate": 0,
  • "endDate": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/mobile/participant-schedule-time-slot-list-fetch

fetch a participant's schedule time slot list

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
scheduleIdList
Array of strings <uuid> [ items <uuid > ]
startDate
integer
endDate
integer

Responses

Request samples

Content type
application/json
{
  • "scheduleIdList": [
    ],
  • "startDate": 0,
  • "endDate": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/mobile/participant-schedule-time-slot-list-generate

generate a participant's schedule time slot list

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
scheduleIdList
required
Array of strings <uuid> [ items <uuid > ]
startDate
required
integer
endDate
required
integer

Responses

Request samples

Content type
application/json
{
  • "scheduleIdList": [
    ],
  • "startDate": 0,
  • "endDate": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/mobile/participant-schedule-time-slot-list-upload

upload a participant's schedule time slot list

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
required
Array of objects

Responses

Request samples

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

Response samples

Content type
application/json
{ }

/v1/mobile/participant-status-update

update a participant status

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
timezone
required
string or null
timeOffesetToUTCInMs
number or null
deviceType
required
string or null
deviceFirmware
string or null
deviceBatteryPercentage
required
number or null
deviceUUID
string or null <uuid>
deviceMac
string or null
unixTimestampLastAppOpen
required
number or null
unixTimestampLastGarminDeviceSync
required
number or null
mobileType
string or null
Enum: "ios" "android" null
mobileOsVersion
string or null
movesenseDeviceSerial
string or null
movesenseDeviceFirmware
string or null
movesenseDeviceLastBatteryPercentage
number or null
movesenseDeviceType
string or null
Enum: null "big_flash" "medical"
appVersion
string or null

Responses

Request samples

Content type
application/json
{
  • "timezone": "string",
  • "timeOffesetToUTCInMs": 0,
  • "deviceType": "string",
  • "deviceFirmware": "string",
  • "deviceBatteryPercentage": 0,
  • "deviceUUID": "9b149b7f-6529-4c61-96a0-21d27269f796",
  • "deviceMac": "string",
  • "unixTimestampLastAppOpen": 0,
  • "unixTimestampLastGarminDeviceSync": 0,
  • "mobileType": "ios",
  • "mobileOsVersion": "string",
  • "movesenseDeviceSerial": "string",
  • "movesenseDeviceFirmware": "string",
  • "movesenseDeviceLastBatteryPercentage": 0,
  • "movesenseDeviceType": null,
  • "appVersion": "string"
}

Response samples

Content type
application/json
{ }

/v1/mobile/participant-task-completion-list-fetch

fetch a participant's task completion list

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
filterEventTracker
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "filterEventTracker": false
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/mobile/streamdata_realtime_upload

recieve realtime stream data

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
Array of objects

Responses

Request samples

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

Response samples

Content type
application/json
{ }

/v1/mobile/submit_generic_file_uploaded_index

submit index data after file uploaded to S3 bucket

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
fileType
required
any
Value: "SdkLog"
filePath
required
string
fileName
required
string
url
required
string
size
required
number

Responses

Request samples

Content type
application/json
{
  • "fileType": "SdkLog",
  • "filePath": "string",
  • "fileName": "string",
  • "url": "string",
  • "size": 0
}

Response samples

Content type
application/json
{ }

v2/web

/v2/web/participant-batch-create

create a participant

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
batchId
string <uuid>
csvString
string

Responses

Request samples

Content type
application/json
{
  • "batchId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "csvString": "string"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v2/web/participant-daily-data-digest

get the data digest detail of all participants on given date

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
participantId
required
string <uuid>
yymmddIndex
required
number
requestGarminDirectData
boolean
requestGarminConnectData
boolean
requestDexcomData
boolean

Responses

Request samples

Content type
application/json
{
  • "participantId": "b11dfbc4-9f12-42d3-b200-cd235494b85c",
  • "yymmddIndex": 0,
  • "requestGarminDirectData": true,
  • "requestGarminConnectData": true,
  • "requestDexcomData": true
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v2/web/project-data-digest

get the data summary of all participants in given year-month indexes

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
yymmIndexList
required
Array of numbers
requestTaskData
boolean
requestScheduleTaskData
boolean
requestGarminData
boolean
requestDexcomData
boolean

Responses

Request samples

Content type
application/json
{
  • "projectId": "4f5acb11-f2f2-4aa0-9755-a2b0d76263d6",
  • "yymmIndexList": [
    ],
  • "requestTaskData": true,
  • "requestScheduleTaskData": true,
  • "requestGarminData": true,
  • "requestDexcomData": true
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v2/web/project-participant-list

get the participants info and status in a project

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "projectId": "af94371c-e3ad-4a20-a7fc-e827560747d9"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v2/web/analytic-graph-correlation-multiple-group-fetch

fetch correlation graph for multiple groups

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
groups
required
object
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "groups": { },
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v2/web/analytic-graph-correlation-multiple-individual-fetch

fetch correlation graph for multiple individual

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
required
Array of objects >= 2 items
required
Array of objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects or objects >= 2 items
object

Responses

Request samples

Content type
application/json
{
  • "participants": [
    ],
  • "variables": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v2/web/method-task-index-order-update

set the index order for a list of tasks in a method

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
methodId
required
string <uuid>
taskIdList
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "methodId": "a79e32ca-882c-452b-a096-350276aed28d",
  • "taskIdList": [
    ]
}

Response samples

Content type
application/json
{ }

/v2/web/participant-create

create a participant with v2 login credentials

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
batchId
string <uuid>
insignia
string or null <= 50 characters
note
string <= 1500 characters
email
string or null <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "batchId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "insignia": "0xdFA6C",
  • "note": "Animi cunctatio consuasor coniecto brevis ager deleniti.",
  • "email": "pomelo-test-381e2d00-8d7c-4f3f-b5bc-57dae31dd8f3.test@pomelo.click"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v2/web/project-data-download-metadata-fetch

fetch project data download metadata with pagination

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
projectId
required
string <uuid>
participantIds
Array of strings <uuid> [ items <uuid > ]
startDate
string <date-time>
endDate
string <date-time>
continuation
string
pageSize
integer [ 1 .. 200 ]

Target batch size (1-200). A single response may return MORE than pageSize objects (up to 2*pageSize - 1), because results are accumulated in whole S3-page units. Drive pagination off continuation; do not assume objects.length <= pageSize.

Responses

Request samples

Content type
application/json
{
  • "projectId": "a1a74a37-49c7-4fa9-8d52-611df17df6a2",
  • "participantIds": [
    ],
  • "startDate": "2026-01-08T11:52:03.683Z",
  • "endDate": "2026-07-09T05:02:49.126Z",
  • "continuation": "o/uOitrMnn9SrgMAqOnm5BCaM0O5Xzdl3SHBlzT0Q2uL1GkbY3YLWdv0yMXa/vZF6GaiaFciwe+OtQ8YbMvT4gJH1QsFYyfoeazM",
  • "pageSize": 100
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v2/web/task-questionnaire-update

update a questionnaire task with id

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
name
string <= 50 characters
description
string <= 1500 characters
index
integer
enabled
boolean
scheduleRepeat
boolean or null
scheduleDescription
string or null <= 250 characters
color
string or null
taskId
required
string <uuid>
Array of objects or objects

Responses

Request samples

Content type
application/json
{
  • "name": "utrimque quasi",
  • "description": "Defaeco utique carus uterque avaritia terra molestias bellum vulnero.",
  • "index": 0,
  • "enabled": false,
  • "scheduleRepeat": false,
  • "scheduleDescription": "Cetera tollo spargo.",
  • "color": "ecb751",
  • "taskId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "reminderList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v2/web/task-schedule-delete

set task schedule inactive

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

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

Responses

Request samples

Content type
application/json
{
  • "id": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "inplace": false
}

Response samples

Content type
application/json
{ }

/v2/web/task-schedule-update

update task schedule, this endpoint will set task schedule inactive and create a new one

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
id
required
string <uuid>
updatedAt
integer
createdAt
integer
taskId
string <uuid>
type
string
inactive
boolean
current
boolean
scheduleYear
integer or null >= 0
scheduleMonth
integer or null >= 0
scheduleDay
integer or null >= 0
scheduleHour
integer or null >= 0
scheduleMinute
integer or null >= 0
scheduleSecond
integer or null >= 0
scheduleWeekdays
integer or null [ 1 .. 1234567 ]
relativeStartDayOrYymmdd
integer or null > 0
relativeEndDayOrYymmdd
integer or null > 0
startTime
string or null^([01]\d|2[0-3]):([0-5]\d)(?::([0-5]\d))?$
endTime
string or null^(\d{2,}):([0-5]\d)(?::([0-5]\d))?$
emaType
string or null
emaOcurrences
integer or null > 0
emaIntervalSeconds
integer or null > 0
emaMinimumGapSeconds
integer or null > 0
emaExpirationSeconds
integer or null > 0
inplace
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "updatedAt": "2026-07-09T08:59:15.164Z",
  • "createdAt": "2026-01-07T14:40:21.212Z",
  • "taskId": "6bb51132-67ca-4d22-b964-51557bcb77af",
  • "type": "absolute",
  • "inactive": true,
  • "current": false,
  • "scheduleYear": 2024,
  • "scheduleMonth": 12,
  • "scheduleDay": 12,
  • "scheduleHour": 13,
  • "scheduleMinute": 25,
  • "scheduleSecond": 45,
  • "scheduleWeekdays": 1234567,
  • "relativeStartDayOrYymmdd": 241212,
  • "relativeEndDayOrYymmdd": 241213,
  • "startTime": "23:58",
  • "endTime": "23:59",
  • "emaType": "random",
  • "emaOcurrences": 2,
  • "emaIntervalSeconds": 3600,
  • "emaMinimumGapSeconds": 3600,
  • "emaExpirationSeconds": 3600,
  • "inplace": false
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

v1/download

/v1/download/project-data-zip

exchange project data zip download token

query Parameters
token
string

Responses

Response samples

Content type
application/json
{ }

v1/supervisor

/v1/supervisor/admin-identity-create

create admin identity

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
email
required
string <email> <= 250 characters
password
required
string >= 8 characters
locale
string <= 100 characters
countryCode
string <= 100 characters
timeZone
string <= 100 characters

Responses

Request samples

Content type
application/json
{
  • "email": "pomelo-test-67136b01-7bce-4fe6-ac2e-2e0f9a0c9440.test@pomelo.click",
  • "password": "H7D_i3m1MUKMDg9",
  • "locale": "sk",
  • "countryCode": "TW",
  • "timeZone": "Antarctica/Rothera"
}

Response samples

Content type
application/json
{ }

/v1/supervisor/announcement-image-upload-url-generate

create a presigned url for uploading an announcement image

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
imageMimeType
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/authenticate

authenticate a supervisor

Request Body schema: application/json
email
required
string <email>
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "pomelo-test-5815438f-a121-41ce-b713-42e08683d2c8.test@pomelo.click",
  • "password": "VTilvrFLTY48Ifc"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/connect-backfill-metadata-fetch

fetch garmin connect backfill job metadata

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
jobId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/connect-backfill-request

request garmin connect backfill

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
projectId
required
string <uuid>
summaryStartTimeInSeconds
required
number
summaryEndTimeInSeconds
required
number

Responses

Request samples

Content type
application/json
{
  • "projectId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "summaryStartTimeInSeconds": 0,
  • "summaryEndTimeInSeconds": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/dexcom-app-create

create a dexcom app

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
dexcomIntegrationId
required
string <uuid>
name
required
string <= 50 characters
description
required
string <= 250 characters
region
required
string
Enum: "us" "eu" "sandbox"
clientId
required
string
clientSecret
required
string

Responses

Request samples

Content type
application/json
{
  • "dexcomIntegrationId": "a48924ed-c9b3-40cb-9c30-3121b2ddddb3",
  • "name": "brevis anser vobis",
  • "description": "Iusto advenio tondeo thesaurus.",
  • "region": "us",
  • "clientId": "AKrwpkqGQ4egKIg",
  • "clientSecret": "yyj29rjGzxQhMrV"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/dexcom-app-delete

delete a dexcom app

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

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

Responses

Request samples

Content type
application/json
{
  • "dexcomAppId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{ }

/v1/supervisor/dexcom-app-update

update a dexcom app

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
dexcomAppId
string <uuid>
name
required
string <= 50 characters
description
required
string <= 250 characters
region
required
string
Enum: "us" "eu" "sandbox"
clientId
required
string
clientSecret
required
string

Responses

Request samples

Content type
application/json
{
  • "dexcomAppId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "name": "viriliter aeger succurro",
  • "description": "Sonitus socius caritas articulus tantillus sumo.",
  • "region": "us",
  • "clientId": "UbdMTThgm8GZQso",
  • "clientSecret": "eHtsMMSNXcyXZpT"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/event-garmin-connect-account-list-fetch

get garmin connect account events by participant id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

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

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/supervisor/force-update-metadata-fetch

fetch latest force_update_metadata for this stage

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/force-update-metadata-update

update force_update_metadata for this stage

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
_id
array or boolean or number or object or string or null
createdAt
integer
minimumVersionIOS
required
string or null
minimumBuildIdIOS
required
string or null
recommendedVersionIOS
required
string or null
recommendedBuildIdIOS
required
string or null
minimumVersionAndroid
required
string or null
minimumBuildIdAndroid
required
string or null
recommendedVersionAndroid
required
string or null
recommendedBuildIdAndroid
required
string or null

Responses

Request samples

Content type
application/json
{
  • "_id": [ ],
  • "createdAt": 0,
  • "minimumVersionIOS": "string",
  • "minimumBuildIdIOS": "string",
  • "recommendedVersionIOS": "string",
  • "recommendedBuildIdIOS": "string",
  • "minimumVersionAndroid": "string",
  • "minimumBuildIdAndroid": "string",
  • "recommendedVersionAndroid": "string",
  • "recommendedBuildIdAndroid": "string"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/garmin-device-enhanced-bbi-enable-update

update enhanced bbi enable from a garmin device task

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
garminDeviceId
required
string <uuid>
enhancedBbiEnable
required
boolean

Responses

Request samples

Content type
application/json
{
  • "garminDeviceId": "2dac7de5-43c2-40e8-a40f-132a76588a9a",
  • "enhancedBbiEnable": true
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/garmin-official-project-id-fetch

get current garmin official project id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/garmin-official-project-id-update

update garmin official project id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

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

Responses

Request samples

Content type
application/json
{
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Response samples

Content type
application/json
{ }

/v1/supervisor/heap-snapshot

take a heap snapshot and upload it to s3

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {}
}

/v1/supervisor/identity-announcement-create

create a identity notification

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
title
required
string <= 250 characters
content
required
string <= 1000 characters
enabled
boolean
Default: false
mediaUrl
string or null <= 2000 characters
publishDate
integer or null
link
string or null <= 2000 characters

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/identity-announcement-list-fetch

fetch all

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
page
required
integer >= 0
orderBy
string
orderDescending
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "orderBy": "string",
  • "orderDescending": true
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v1/supervisor/identity-announcement-update

update a identity announcement

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
id
required
string <uuid>
title
string <= 250 characters
content
string <= 1000 characters
enabled
boolean
mediaUrl
string or null <= 2000 characters
publishDate
integer or null
link
string or null <= 2000 characters

Responses

Request samples

Content type
application/json
{
  • "id": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "title": "Canto pectus valetudo optio auctus cupiditate agnosco vorax.",
  • "content": "Articulus tribuo asporto caute audentia quaerat curvo vel velut denuncio.",
  • "enabled": true,
  • "mediaUrl": "https://grubby-venom.org/",
  • "publishDate": 1783654934619,
  • "link": "https://rural-halt.biz"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/identity-collaborator-project-list-fetch

fetch an identity's collaborator projects

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
identityId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "identityId": "803e8baf-a9d2-485c-8b57-63cd8e3f6f27"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v1/supervisor/identity-deactivate

deactivate identity, close all active projects, and remove workspace collaborators

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
identityId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256"
}

Response samples

Content type
application/json
{ }

/v1/supervisor/identity-delete

CASCADE delete an identity from the database

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
identityId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256"
}

Response samples

Content type
application/json
{ }

/v1/supervisor/identity-email-update-request

request update an the identity's email

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

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

Responses

Request samples

Content type
application/json
{
  • "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256"
}

Response samples

Content type
application/json
{ }

/v1/supervisor/identity-email-update-submit

update an identity's email

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
identityId
string <uuid>
verificationCode
string
email
required
string <email> <= 250 characters

Responses

Request samples

Content type
application/json
{
  • "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
  • "verificationCode": "3287973081",
  • "email": "pomelo-test-8755e63e-804c-4e67-a2c2-a94c5b8a743c.test@pomelo.click"
}

Response samples

Content type
application/json
{ }

/v1/supervisor/identity-fetch

fetch identity with target id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

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

Responses

Request samples

Content type
application/json
{
  • "identityId": "315d2376-f380-41a4-85f2-8073226e5a75"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/identity-manual-verify

manualy verify an idenity (sets emailVerifed to true)

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

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

Responses

Request samples

Content type
application/json
{
  • "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256"
}

Response samples

Content type
application/json
{ }

/v1/supervisor/identity-search

search identity(s)

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
page
number >= 0
Default: 0
orderBy
string
orderDescending
boolean
Default: true
object

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "orderBy": "string",
  • "orderDescending": true,
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v1/supervisor/identity-settings-update

update target identity's settings with target identityId

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
identityId
required
string <uuid>
required
object

Responses

Request samples

Content type
application/json
{
  • "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "id": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "updatedAt": "2026-07-09T08:59:15.164Z",
  • "createdAt": "2026-01-07T14:40:21.212Z",
  • "identityId": "f90bd312-10fc-4fd9-b302-072c76f8d795",
  • "timeZone": "America/Anguilla",
  • "countryCode": "SJ",
  • "locale": "uk",
  • "betaEnabled": true,
  • "enhancedBbiEnabled": true,
  • "betaType": "internal",
  • "webAutoTimeoutLogoutEnabled": true
}

/v1/supervisor/identity-workspace-list-fetch

fetch a list of all workspaces owned by an identity

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
page
number >= 0
Default: 0
orderDescending
boolean
Default: true
orderBy
string
identityId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "orderDescending": true,
  • "orderBy": "string",
  • "identityId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v1/supervisor/supervisor-participant-activate

should activate participant or participants in a project

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
participantId
string <uuid>
projectId
string <uuid>
timezone
string

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "timezone": "string"
}

Response samples

Content type
application/json
{ }

/v1/supervisor/participant-activity-log-list-fetch

fetch activity by participant id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
participantId
string <uuid>
page
number >= 0
Default: 0

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
  • "page": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v1/supervisor/participant-garmin-connect-account-delete

remove garmin connect account by participant id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
participantId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7"
}

Response samples

Content type
application/json
{ }

/v1/supervisor/participant-garmin-connect-grant-url-fetch

fetch participant garmin connect grant url

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
participantId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7"
}

Response samples

Content type
application/json
{}

/v1/supervisor/participant-garmin-device-query-event-list-fetch

fetch garmin device query event from a participant with paging

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
participantId
string <uuid>
page
number >= 0
Default: 0

Responses

Request samples

Content type
application/json
{
  • "participantId": "9f6624b5-5f99-42b6-899f-30f2b369cbd7",
  • "page": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v1/supervisor/participant-metadata-fetch

fetch single participant's metadata

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
participantId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "participantId": "c8227145-f7f0-48a2-978e-8975fd859468"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/participant-metadata-list-fetch

get a list of participants and their metadata

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
batchId
required
string <uuid>
startDate
required
integer
page
number >= 0
Default: 0

Responses

Request samples

Content type
application/json
{
  • "batchId": "351bd7eb-aa15-462e-8bc9-f5c016812a1e",
  • "startDate": "2026-07-10T03:42:14.667Z",
  • "page": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": {
    }
}

/v1/supervisor/participant-search

fetch participant and it's identity and project info by participant id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
participantId
string <uuid>
participantEmail
string <email>

Responses

Request samples

Content type
application/json
{
  • "participantId": "4705cc1c-9548-4ffd-851b-cbf0760e2b62",
  • "participantEmail": "user@example.com"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/supervisor/pomelo-metadata-fetch

fetch metadata about a pomelo

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/product-capability-list-fetch

fetch all available product capabilities and its descriptions

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": { }
}

/v1/supervisor/product-create

add a product to database

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
name
required
string <= 50 characters
price
number
capabilityList
required
Array of strings
Items Enum: "hrv_graph" "actigraphy_graph" "participant_limit_20"
plan
string or null
Enum: "basic" "advanced" null

Responses

Request samples

Content type
application/json
{
  • "name": "deporto qui",
  • "price": 0,
  • "capabilityList": [
    ],
  • "plan": "advanced"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/product-delete

should be able to delete a product with target id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

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

Responses

Request samples

Content type
application/json
{
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113"
}

Response samples

Content type
application/json
{ }

/v1/supervisor/product-list-fetch

fetch add products in database

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/supervisor/product-update

update a product with id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
id
string <uuid>
name
string <= 50 characters
price
number
capabilityList
Array of strings
Items Enum: "hrv_graph" "actigraphy_graph" "participant_limit_20"
plan
string or null
Enum: "basic" "advanced" null

Responses

Request samples

Content type
application/json
{
  • "id": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "name": "eligendi sum",
  • "price": 0,
  • "capabilityList": [
    ],
  • "plan": "advanced"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/project-analysis-data-job-state-fetch

fetch project analysis data job state

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
projectId
required
string <uuid>
analysisDataTypeList
required
Array of strings
Items Enum: "actigraphy_sleep" "hrv"

Responses

Request samples

Content type
application/json
{
  • "projectId": "dd34a6d8-ed0c-4f34-8907-9e927f17d0bd",
  • "analysisDataTypeList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/project-analysis-data-request

request project analysis data

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
projectId
required
string
analysisDataTypeList
required
Array of strings
Items Enum: "actigraphy_sleep" "hrv"
yymmddRange
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "projectId": "b8892b61-0d20-4c1b-9f8e-00696c5ccd8d",
  • "analysisDataTypeList": [
    ],
  • "yymmddRange": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/project-data-digest

request project data digest

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
projectIds
required
Array of strings
yymmddIndexList
required
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "projectIds": [
    ],
  • "yymmddIndexList": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/project-data-download-metadata-fetch

fetch project data download metadata

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
projectId
required
string <uuid>
participantIds
Array of strings <uuid> [ items <uuid > ]
startDate
string <date-time>
endDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "projectId": "b16e453c-0e29-4b1f-9adf-60f24b43b087",
  • "participantIds": [
    ],
  • "startDate": "2026-05-08T02:55:41.475Z",
  • "endDate": "2026-07-09T07:54:05.562Z"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/project-data-update-metadata-fetch

fetch project data update metadata

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
projectId
required
string

Responses

Request samples

Content type
application/json
{
  • "projectId": "109c799b-cbb2-476a-bdf9-7f4ab813a35a"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/project-data-update-request

request project data update

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
projectId
required
string

Responses

Request samples

Content type
application/json
{
  • "projectId": "dc8f5eb3-087f-45fe-8a7c-36bac464689f"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/project-extension-image-upload

upload a project extension image

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
projectId
string <uuid>
image
array or boolean or number or object or string or null

Responses

Request samples

Content type
application/json
{
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "image": "an image file"
}

Response samples

Content type
application/json
{}

/v1/supervisor/project-metadata-fetch

fetch metadata about a project

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

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

Responses

Request samples

Content type
application/json
{
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/purchase-create

add a purchase with target identity id and product id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
workspaceId
required
string <uuid>
productId
required
string <uuid>
expireAt
integer or null

Responses

Request samples

Content type
application/json
{
  • "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
  • "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",
  • "expireAt": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/purchase-delete

delete a purchase with id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
purchaseId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "purchaseId": "e9b59bb6-ba5b-48ce-918b-5f842e450f10"
}

Response samples

Content type
application/json
{ }

/v1/supervisor/purchase-update

update a purchase with id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
id
required
string <uuid>
expireAt
integer or null

Responses

Request samples

Content type
application/json
{
  • "id": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "expireAt": "2026-07-09T06:32:53.097Z"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/s3-bucket-create

create s3 bucket information entry for identity

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
region
required
string
resourceArn
required
string^arn:aws:s3:::[^\s/]+$
identityId
required
string <uuid>
syncIntervalSeconds
required
number > 0

Responses

Request samples

Content type
application/json
{
  • "region": "us-east-1",
  • "resourceArn": "arn:aws:s3:::destination",
  • "identityId": "c3039212-1af2-4cb8-9456-85391e50a81c",
  • "syncIntervalSeconds": 3600
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/s3-bucket-delete

delete s3 bucket information entry for identity

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

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

Responses

Request samples

Content type
application/json
{
  • "s3BucketId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/s3-bucket-list-fetch

fetch s3 bucket information entry list for identity

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
identityId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "identityId": "c3b35317-3126-4160-8d4b-8073e8962df2"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/supervisor/s3-bucket-policy-fetch

fetch s3 bucket policy template for bucket, payload should be converted into json string before deliver for integration

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
s3BucketId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "s3BucketId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/s3-bucket-transfer-list-fetch

list past s3 bucket transfers

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
identityId
required
string <uuid>
includeReport
boolean
searchAfter
integer

Responses

Request samples

Content type
application/json
{
  • "identityId": "ebc92baa-b430-498d-b30d-132ff32a5256",
  • "includeReport": true,
  • "searchAfter": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ],
  • "searchAfter": 0
}

/v1/supervisor/s3-bucket-update

update s3 bucket information entry for identity

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
s3BucketId
required
string <uuid>
region
string
resourceArn
string^arn:aws:s3:::[^\s/]+$
syncIntervalSeconds
number > 0

Responses

Request samples

Content type
application/json
{
  • "s3BucketId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "region": "us-east-1",
  • "resourceArn": "arn:aws:s3:::destination",
  • "syncIntervalSeconds": 3600
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/super-lookup

look up any id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

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

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/workspace-metadata-fetch

fetch metadata about a workspace

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
workspaceId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "workspaceId": "8c69333e-ca70-451a-b2ce-44b31c336805"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/workspace-participant-limit-update

update a participantLimit (number can only go up)

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
note
string <= 1500 characters
workspaceId
required
string <uuid>
participantLimit
required
integer >= 1

Responses

Request samples

Content type
application/json
{
  • "note": "string",
  • "workspaceId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "participantLimit": 100
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v1/supervisor/workspace-purchase-list-fetch

should fetch all purchases target workspace id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
workspaceId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": [
    ]
}

/v1/supervisor/workspace-support-collaborator-state-fetch

fetch weather the support@labfront.com account have been added to workspace's collaborator

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
workspaceId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "workspaceId": "5205c663-077d-4649-8f2a-0d143aacfbf8"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": {
    }
}

/v1/supervisor/workspace-support-collaborator-state-update

add or remove support@labfront.com account to workspace's collaborator

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
workspaceId
required
string <uuid>
isSupportInCollaborator
required
boolean

Responses

Request samples

Content type
application/json
{
  • "workspaceId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "isSupportInCollaborator": true
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": {
    }
}

v2/mobile

/v2/mobile/participant-authenticate

authenticate an participant with a login code, then invalid the loginCode

Request Body schema: application/json
loginCode
required
string <= 12 characters
timezone
string

Responses

Request samples

Content type
application/json
{
  • "loginCode": "123456",
  • "timezone": "string"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v2/mobile/participant-garmin-device-query-event-list-submit

upload a list of records that represents a interaction to a garmin device

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
timezone
required
string
garminDeviceType
required
string
mobileDeviceType
required
string
Enum: "ios" "android"
mobileDeviceVersion
required
string
Array of objects non-empty

Responses

Request samples

Content type
application/json
{
  • "timezone": "string",
  • "garminDeviceType": "string",
  • "mobileDeviceType": "ios",
  • "mobileDeviceVersion": "string",
  • "queryEventDataList": [
    ]
}

Response samples

Content type
application/json
{ }

/v2/mobile/participant-record-submit

upload participant data

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
Array
Any of
taskId
required
string <uuid>
taskType
required
any
Value: "task_set"
timezone
string
timeOffsetToUTCInMs
number
taskSetItterationId
string or null <uuid>
scheduleTimeSlotId
string or null
eventTrackerId
string or null
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

/v2/mobile/participant-record-submit-garmin-bbi

upload participant garmin bbi data

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
taskId
required
string <uuid>
timezone
required
string
garminDeviceType
required
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "timezone": "string",
  • "garminDeviceType": "string",
  • "sampleDataList": [
    ]
}

Response samples

Content type
application/json
{ }

v2/supervisor

/v2/supervisor/connect-backfill-metadata-fetch

fetch garmin connect backfill job metadata

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
jobId
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v2/supervisor/connect-backfill-request

request garmin connect backfill

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
participantId
required
string <uuid>
summaryStartTimeInSeconds
required
number
summaryEndTimeInSeconds
required
number

Responses

Request samples

Content type
application/json
{
  • "participantId": "5205c663-077d-4649-8f2a-0d143aacfbf8",
  • "summaryStartTimeInSeconds": 0,
  • "summaryEndTimeInSeconds": 0
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

/v2/supervisor/identity-list-fetch

fetch a list of all identitys

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
page
number >= 0
Default: 0
orderBy
string
orderDescending
boolean
Default: true

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "orderBy": "string",
  • "orderDescending": true
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "page": {
    },
  • "payload": [
    ]
}

/v2/supervisor/project-data-download-metadata-fetch

fetch project data download metadata by project id

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
projectId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "projectId": "399b503c-7c76-4c23-8b6d-7dc7456981e9"
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}

v3/mobile

/v3/mobile/participant-garmin-data-chunk-submit

upload participant garmin device record

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
Array
Any of
createTime
required
number
taskId
required
string <uuid>
timezone
string
garminDeviceType
required
string
dataType
required
any
Value: "garmin_acc"
setEnhancedBBI
boolean
required
Array of objects

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

/v3/mobile/participant-stream-data-submit

upload participant device stream data record

header Parameters
Authorization
required
string
Example: Bearer <access token>

access token is required

Request Body schema: application/json
Array
Any of
createTime
required
number
taskId
required
string <uuid>
taskType
required
string
timezone
string
timeOffsetToUTCInMs
required
number
dataType
required
any
Value: "garmin_acc"
completionId
required
string <uuid>
sampleRate
number or null
required
Array of objects

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{ }

v3/supervisor

/v3/supervisor/project-data-download-metadata-fetch

fetch project data download metadata with pagination

header Parameters
x-supervisor-token
required
string
Example: <supervisor token>

supervisor token is required

Request Body schema: application/json
projectId
required
string <uuid>
continuation
string
pageSize
integer [ 1 .. 200 ]

Target batch size (1-200). A single response may return MORE than pageSize objects (up to 2*pageSize - 1), because results are accumulated in whole S3-page units. Drive pagination off continuation; do not assume objects.length <= pageSize.

Responses

Request samples

Content type
application/json
{
  • "projectId": "dd017e2d-ef37-4170-b168-66c9a801b5ad",
  • "continuation": "uWeQKhorrjNKXK3eW79pszsc6IDgbOPqM1eb6ugIst55okC8JIDXu57Pv1XXUCGGksFWUO/vjuXE3L+VzHeyjIpdTzhRg8kkZEUx",
  • "pageSize": 100
}

Response samples

Content type
application/json
{
  • "type": "SUCCESS",
  • "payload": {
    }
}