Management API

Endpoints for management authentication, user management, study administration, messaging, and participant administration.

Auth

Authentication & Session

Sign in with identity provider POST

Extend session POST

Get renew token GET

List permissions and roles GET

Studies

Study management

List all studies GET

Create a new study POST

Get study configuration by key GET

Delete a study by key DELETE

Export study configuration, surveys, and rules GET

Update default status of a study PUT

Update status of a study PUT

Update display properties of a study PUT

Update file upload configuration of a study PUT

Surveys

Survey management

List survey infos for a study GET

Create a new survey in a study POST

Get latest survey by key GET

Update survey definition POST

Unpublish a survey POST

List all survey versions GET

Get a specific survey version GET

Delete a survey version DELETE

Study rules

Get current published study rules GET

Publish a new version of study rules POST

List all study rules versions GET

Get a study rules version by ID GET

Delete a study rules version DELETE

Study variables

List study variables GET

Create a new study variable POST

Get a study variable by key GET

Delete a study variable DELETE

Update study variable definition PUT

Update study variable value PUT

Study counters

List all study counter values GET

Set a study counter value for scope POST

Remove a study counter value DELETE

Increment a study counter value PUT

Study permissions

Permissions for a study

List study permissions GET

Add a study permission POST

Remove a study permission DELETE

Notifications

Notification subscriptions

List notification subscriptions GET

Update notification subscriptions PUT

Code lists

Study code lists

List code list keys GET

List codes of a study code list GET

Add codes to a study code list POST

Remove a code from a study code list DELETE

Participants

Participant operations

Create virtual participant POST

List participant responses GET

Submit participant response POST

Submit participant event POST

Remove or replace a participant study session POST

Merge participants POST

Edit participant PUT

Get participants count GET

Start participants export task POST

Get participants export task status GET

Get participants export task result GET

List participants GET

Get participant GET

Accounts

Account tracking and identification

Update study track-account flag PUT

Updates whether account tracking is enabled for the given study.

Reports

Participant reports

Submit participant report POST

Update participant report PUT

Get report items count GET

Start report export task POST

Get report export task status GET

Get report export task result GET

List available report keys GET

List reports GET

Get report by ID GET

Responses

Response exports & queries

List survey info GET

Get responses count GET

Start responses export task POST

Get responses export task status GET

Get responses export task result GET

List daily response exports GET

Get daily response export by ID GET

List confidential response exports GET

Start confidential responses export task POST

Get confidential response export by ID GET

List survey responses GET

Delete survey responses DELETE

Get survey response by ID GET

Delete survey response DELETE

Files

File management for studies

List files GET

Get file by ID GET

Delete file DELETE

Messaging

Messaging templates & scheduled emails

List global email templates GET

Save global email template POST

Get global email template by type GET

Delete global email template DELETE

List all study email templates GET

List study email templates GET

Save study email template POST

Get study email template by type GET

Delete study email template DELETE

Save SMS template POST

Get SMS template by type GET

List scheduled emails GET

Save scheduled email POST

Get scheduled email GET

Delete scheduled email DELETE

User management

Management user accounts and permissions

List management users GET

Get management user GET

Delete management user DELETE

List user permissions GET

Add permission to user POST

Delete user permission DELETE

Update permission limiter PUT

Request participant user deletion POST

Service accounts

Service account management

List service accounts GET

Create service account POST

Get service account GET

Delete service account DELETE

Update service account PUT

List service account API keys GET

Create service account API key POST

Delete service account API key DELETE

List service account permissions GET

Add permission to service account POST

Delete service account permission DELETE

Update service account permission limiter PUT

App roles

App role templates & assignments

List app roles for user GET

Add app role to user POST

Remove app role from user DELETE

List app role templates GET

Create app role template POST

Get app role template GET

Update app role template PUT

Delete app role template DELETE

Delete app role templates for app DELETE

List app roles GET

Delete app roles for app DELETE

Actions

Run actions on participants

Run actions on a participant POST

Run actions on multiple participants POST

Get actions task status GET

Get actions task result GET

Run actions on previous responses for a participant POST

Run actions on previous responses for multiple participants POST

Get previous-responses actions task status GET

Get previous-responses actions task result GET