MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {ACCESS_TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Token based authentication

You can retrieve your access token by calling api/login endpoint.

Access tokens are valid 7 days, then expire. You can obtain new access token with expiring access token by calling /api/token/refresh. You can only refresh still valid tokens, otherwise new request to api/login will be required.

Cookie based authentication

You can also authenticate using cookie-based sessions. Before calling any other endpoints you have to obtain XSRF cookie by hitting /sanctum/csrf-cookie endpoint. In return you receive XSRF-TOKEN cookie, which content you have to attach to each request as X-XSRF-TOKEN header.

Then call /login endpoint. When your authenticated session is created, call any endpoint using X-XSRF-TOKEN header.

Multi-Factor Authorization (MFA)

User can protect its account setting up the MFA as email or one-time passwords (OTP). If mfa_enabled is set to 1 and mfa_method is set to any of email or otp values, user will have to use preferred method as second factor on login.

If mfa_method is email, API will automatically send MFA code to user's email inbox.

Most of API endpoints are secured with additional layer and cannot be properly called without this second-factor authorization done. Instead of endpoint response API will reply with message "MFA is required for this request." and HTTP code 401 Unauthorized. That means user did not successfully authorized itself with second-factor.

Multi-Factor Authorization (MFA) - Remember Session

The user has the option to remember their device, which means they won't have to enter the MFA code for 30 days. If using a Token based authentication, you need to add a header named X-MFA-Session-Token with the value {mfa_token} obtained from the /verify endpoint.

Appendix A. Laravel validation rules

List of validation codes returned for Laravel's built-in validation rules:

Code
Description
MUST_BE_ACCEPTED
The field must be accepted. Value must be one of: 1, true, "yes" or "on".
MUST_BE_ACCEPTED_IF:other:value
The field must be accepted if other field equals to value. Accepted values are the same as in MUST_BE_ACCEPTED.
MUST_BE_ACTIVE_URL
The field must be an active URL address with a valid A or AAAA record according to the dns_get_record PHP function.
MUST_BE_AFTER:date
The field must be a date that is after a specified date.
MUST_BE_AFTER_OR_EQUAL:date
The field must be a date that is after or equal to a specified date.
MUST_CONTAIN_ONLY_LETTERS
The field must contain only letters.
MUST_CONTAIN_ONLY_LETTERS_NUMBERS_DASHES_UNDERSCORES
The field must contain only letters, numbers, dashes and underscores.
MUST_CONTAIN_ONLY_LETTERS_NUMBERS
The field must contain only letters and numbers.
MUST_BE_ARRAY
The field must be an array.
MUST_BE_BEFORE:date
The field must be a date that is before a specified date.
MUST_BE_BEFORE_OR_EQUAL:date
The field must be a date that is before or equal to a specified date.
BETWEEN:NUMBERS:min:max
The field must be a number between min and max.
BETWEEN:FILE_KB:min:max
The field must be a file with a size between min and max KB.
BETWEEN:STRING_LENGTH:min:max
The field must be a string with a length between min and max.
BETWEEN:ARRAY_COUNT:min:max
The field must be an array with between min and max elements.
MUST_BE_BOOLEAN
The field must be a boolean. Accepted values include: true, false, 1, 0, "1" and "0".
MUST_BE_CONFIRMED
The field must have a matching confirmation field named {field}_confirmation.
MUST_BE_CURRENT_PASSWORD
The field must match the authenticated user's current password.
MUST_BE_DATE
The field must be a valid date according to the strtotime PHP function.
MUST_EQUAL_DATE:date
The field must be a date equal to the specified date.
MUST_BE_DATE_FORMAT:format
The field must match the given date format.
MUST_BE_DIFFERENT:other
The field must have a different value than the field named other.
MUST_HAVE_DIGITS:digits
The field must be numeric and contain exactly digits digits.
MUST_HAVE_DIGITS_BETWEEN:min:max
The field must be numeric and contain between min and max digits.
INVALID_IMAGE_DIMENSIONS
The uploaded image has invalid dimensions.
MUST_BE_DISTINCT
The field's values must not contain any duplicates.
MUST_BE_EMAIL
The field must be a valid email address.
MUST_END_WITH:value
The field must end with value.
MUST_EXIST:table.column
The field's value must already exist in the specified database table and column.
MUST_BE_FILE
The field must be a file.
MUST_HAVE_A_VALUE
The field must have a non-empty value.
GREATER_THAN:NUMBER:value
The field must be numeric and greater than value.
GREATER_THAN:FILE_KB:value
The field must be a file with a size greater than value KB.
GREATER_THAN:STRING_LENGTH:value
The field must be a string with a length greater than value.
GREATER_THAN:ARRAY_COUNT:value
The field must be an array with have more than value elements.
GREATER_THAN_OR_EQUALS:NUMBER:value
The field must be numeric and greater than or equal to value.
GREATER_THAN_OR_EQUALS:FILE_KB:value
The field must be a file with a size greater than or equal to value KB.
GREATER_THAN_OR_EQUALS:STRING_LENGTH:value
The field must be a string with a length greater than or equal to value.
GREATER_THAN_OR_EQUALS:ARRAY_COUNT:value
The field must be an array with at least value elements.
MUST_BE_IMAGE
The field must be an image.
MUST_BE_IN:values
The field value must be on of the values list.
MUST_BE_IN_ARRAY:other
The field's value must exist in the other field values.
MUST_BE_INTEGER
The field must be an integer.
MUST_BE_IP_ADDRESS
The field must be a valid IP address.
MUST_BE_IPV4_ADDRESS
The field must be a valid IPv4 address.
MUST_BE_IPV6_ADDRESS
The field must be a valid IPv6 address.
MUST_BE_JSON
The field must contain valid JSON.
LESS_THAN:NUMBER:value
The field must be numeric and less than value.
LESS_THAN:FILE_KB:value
The field must be a file with a size less than value KB.
LESS_THAN:STRING_LENGTH:value
The field must be a string with a length less than value.
LESS_THAN:ARRAY_COUNT:value
The field must be an array with fewer than value elements.
LESS_THAN_OR_EQUALS:NUMBER:value
The field must be numeric and less than or equal to value.
LESS_THAN_OR_EQUALS:FILE_KB:value
The field must be a file with a size less than or equal to value KB.
LESS_THAN_OR_EQUALS:STRING_LENGTH:value
The field must be a string with a length less than or equal to value.
LESS_THAN_OR_EQUALS:ARRAY_COUNT:value
The field must be an array with no more than value elements.
MAXIMUM:NUMBER:value
The field must be numeric and must not exceed the value.
MAXIMUM:FILE_KB:value
The field must be a file with a size no greater than value KB.
MAXIMUM:STRING_LENGTH:value
The field must be a string with a maximum length equal to value.
MAXIMUM:ARRAY_COUNT:value
The field must be an array with no more than value elements.
MUST_BE_MIME_OF:values
The field must be a file with one of the given file extensions, for example: pdf, png, mpeg.
Note that the rule uses file extensions, but Laravel internally verifies the actual MIME type using the file's contents.
MUST_BE_MIMETYPE_OF:values
The field must be a file matching one of the specified MIME types, such as: application/pdf, image/png, video/mpeg.
MINIMUM:NUMBER:min
The field must be numeric and at least value.
MINIMUM:FILE_KB:min
The field must be a file with a size of at least value KB.
MINIMUM:STRING_LENGTH:min
The field must be a string with a minimum length equal to value.
MINIMUM:ARRAY_COUNT:min
The field must be an array with at least value elements.
MUST_BE_MULTIPLE_OF:value
The field must be multiple of value.
MUST_NOT_BE_IN:values
The field's value must not be on of the values list. This is the opposite of MUST_BE_IN rule.
INVALID_FORMAT
The field does not match the given regular expression.
MUST_BE_NUMERIC
The field must be numeric.
MUST_BE_PRESENT
The field must be present, but can be empty.
REQUIRED
The field must be present and not empty.
Field is considered empty if its value is null, an empty string, an empty array or a file input with no file uploaded.
REQUIRED_IF:other:value
The field must be present and not empty if other field is equal to value.
REQUIRED_UNLESS:other:values
The field must be present and not empty unless other field is equal to value.
REQUIRED_WITH:values
The field must be present and not empty if any of the fields in values are present and not empty.
REQUIRED_WITH_ALL:values
The field must be present and not empty if all of the fields in values are present and not empty.
REQUIRED_WITHOUT:values
The field must be present and not empty if any of the fields in values are not present or empty.
REQUIRED_WITHOUT_ALL:values
The field must be present and not empty if all of the fields in values are not present or empty.
PROHIBITED
The field must be empty or not present in the request.
PROHIBITED_IF:other:value
The field must be empty or not present if other field is equal to value.
PROHIBITED_UNLESS:other:value
The field must be empty or not present unless other field is equal to value.
PROHIBITS:other
If the field is present, the other field can't be present at the same time.
MUST_BE_SAME:other
The field must have the same value as the other field.
SIZE:NUMBER:size
The field must be numeric and equal to size.
SIZE:FILE_KB:size
The field must be a file with a size of size KB.
SIZE:STRING_LENGTH:size
The field must be a string with a length equal to size.
SIZE:ARRAY_COUNT:size
The field must be an array with exactly size elements.
MUST_START_WITH:value
The field must start with value.
MUST_BE_STRING
The field must be a string.
MUST_BE_TIMEZONE
The field must be a valid timezone according to the timezone_identifiers_list PHP function.
MUST_BE_UNIQUE:table.column
The field's value must not already exist in the specified database table and column.
FAILED_TO_UPLOAD
File upload failed.
MUST_BE_URL
The field must be a valid URL address.
MUST_BE_UUID
The field must be a valid UUID.

More detailed information about validation rules can be found in Laravel documentation.

Appendix B. Custom validation rules

List of custom validation rules messages:

Code
Description
RULES:CONFIG_MODES_LIMIT_RULE:EXCEEDED:max
Checks whether the device's config modes limit has been reached. Fails when the number of config modes assigned to the device already equals to max.
RULES:FILE_UPLOADS_MAX_TOTAL_SIZE_RULE:EXCEEDED:max_size
Checks whether the total size of all uploaded files in the request exceeds the specified limit. Fails if the total size is greater than max_size KB.
RULES:IS_TIMESTAMP_RULE:INVALID_VALUE
Checks whether the value is a valid timestamp. Fails if it's not.
RULES:IS_TIMEZONE_RULE:INVALID_VALUE
Checks whether the value is a valid timezone. Fails if it's not. List of valid timezones is available at the /api/timezones endpoint.
RULES:NOT_EXIST_IN_OTHER_REGIONS_RULE:DEVICE_IDENTIFIER_IN_USE
Checks whether the device identifier (serial or Bluetooth ID) is already in use in another region. Fails if it is.
RULES:NOT_EXIST_IN_OTHER_REGIONS_RULE:USER_EMAIL_IN_USE
Checks whether the user's email is already in use in another region. Fails if it is.
RULES:NOT_INFECTED_RULE:FILE_INFECTED_OR_UPLOAD_ISSUE
Checks whether the uploaded file is infected. Fails if the upload fails or AV software reports an issue.
RULES:PATIENT_DEVICE_RULE:NOT_ASSIGNED
Checks the patient-device assignment. Fails if the device is not assigned to the user.
RULES:PORTRAIT_VIDEO_RULE:UNREADABLE_VIDEO
RULES:PORTRAIT_VIDEO_RULE:NOT_PORTRAIT
Checks whether the uploaded video is portrait-oriented (height greater than width), accounting for rotation metadata. Returns UNREADABLE_VIDEO if the video file could not be read, or NOT_PORTRAIT if it is landscape or square.
RULES:P2P_SESSION_MEMBER_RULE:NOT_A_MEMBER
Checks whether the current user is the member of the P2P session they are trying to access. Fails if the user is not a session's patient or clinician.
RULES:URL_EXISTS_RULE:EXPECTED_CONTENT_TYPE:content_type
RULES:URL_EXISTS_RULE:NOT_FOUND
Checks whether the specified URL exists and returns an HTTP 200 response.
If content_type was specified, the rule also verifies the returned Content-Type header. If it doesn't match, the error code will include EXPECTED_CONTENT_TYPE:content_type.
Otherwise, it only checks the status code and returns NOT_FOUND if it's not 200.
Fails if HTTP code is not 200 or the Content-Type doesn't match the expected value (if specified).
PASSWORD:MUST_CONTAIN_AT_LEAST_ONE_LOWERCASE
Checks whether the password contains at least one lowercase letter.
PASSWORD:MUST_CONTAIN_AT_LEAST_ONE_UPPERCASE
Checks whether the password contains at least one uppercase letter.
PASSWORD:MUST_CONTAIN_AT_LEAST_ONE_NUMBER
Checks whether the password contains at least one number.
PASSWORD:MUST_CONTAIN_AT_LEAST_ONE_SYMBOL
Checks whether the password contains at least one symbol.

Ably

API endpoints for Ably realtime authentication

Get Ably token

requires authentication

Returns Ably JWT scoped to the channels available to the logged-in user. For clinicians, passing patient returns a token scoped only to the channels of the given patient.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/ably/token?patient=1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/ably/token"
);

const params = {
    "patient": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6ImFwcElkLmtleUlkIn0.eyJpYXQiOjE3NjEyMDY0MDAsImV4cCI6MTc2MTIxMDAwMCwieC1hYmx5LWNsaWVudElkIjoiMSIsIngtYWJseS1jYXBhYmlsaXR5Ijoie1wibWVldGluZzoxXCI6W1wic3Vic2NyaWJlXCIsXCJwdWJsaXNoXCJdfSJ9.c2lnbmF0dXJl"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to get Ably token",
    "code": "ABLY:TOKEN:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "ABLY:TOKEN:USER_NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error: Ably token not generated",
    "code": "ABLY:TOKEN:SERVER_ERROR"
}

Request   

GET api/ably/token

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

patient   integer  optional  

Patient ID. Used only for clinicians, ignored for patients. Example: 1

Acadle

Endpoints related to Acadle integration

Acadle SSO

requires authentication

Creates the SSO authorization link. The link expires after 60 seconds, but can be re-generated without any limits.

Example request:
curl --request POST \
    "http://localhost:8000/api/acadle/sso" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/acadle/sso"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "sso_url": "https://adp.acadle.com/sso/authenticate/callback?ssoToken=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3MzczNzU3OTksImV4cCI6MTczNzM3NTg1OSwiZmlyc3RuYW1lIjoiVG9tIiwibGFzdG5hbWUiOiJTbWl0aCIsImVtYWlsIjoidGVzdEBleGFtcGxlLmNvbSIsInVzZXJuYW1lIjpudWxsLCJ0aW1lem9uZSI6IlVUQyJ9.VzE2q6V53bdYJM7aB6CWWxDqcxF4gpdiEF80dD9j-5k",
    "sso_expires": 1737375859
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to use Acadle",
    "code": "ACADLE:SSO:INSUFFICIENT_PERMISSION"
}

Example response (403, Survey required):


{
    "message": "Completing the survey is required to proceed to Acadle",
    "code": "ACADLE:SSO:SURVEY_REQUIRED"
}

Request   

POST api/acadle/sso

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Check Acadle survey status

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/acadle/survey/status" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/acadle/survey/status"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "survey_sent": false,
    "survey_id": null
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to use Acadle",
    "code": "ACADLE:SURVEY_STATUS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/acadle/survey/status

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get Acadle survey data

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/acadle/survey" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/acadle/survey"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (201):


{
    "id": 1,
    "user_id": 301,
    "cpo_number": "680495714",
    "country": "Trinidad and Tobago",
    "medical_training": "physician",
    "myo_exp_zeus": "1",
    "has_demo_hand_access": 0,
    "wants_demo_hand": 0,
    "myo_exp_covvi": 1,
    "myo_exp_fillauer": 0,
    "myo_exp_ossur": 1,
    "myo_exp_ottobock": 1,
    "myo_exp_steeper": 1,
    "myo_exp_taska": 0,
    "myo_exp_vincent": 0,
    "myo_exp_pattern_recognition": 0,
    "myo_exp_other": "Ratione repellat nobis vitae error rem molestiae.",
    "partial_hand_protheses": "5",
    "below_elbow_protheses_single_action": "1",
    "below_elbow_protheses_multi_action": "3",
    "above_elbow_protheses": "0",
    "shoulder_protheses": "4",
    "zeus_components_description": "Officia facere consequatur porro quam.",
    "contact_name": "Joseph",
    "contact_surname": "Schoen",
    "company_name": "Sauer Ltd",
    "street": "1211 Veda Prairie Apt. 995",
    "city": "Port Zander",
    "postal_code": "91515",
    "email": "lwyman@volkman.org",
    "phone": "669-847-1071",
    "phone_country": "sr",
    "device_side": "L",
    "created_at": "2026-10-26T11:55:50.000000Z",
    "updated_at": "2026-10-26T11:55:50.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to use Acadle",
    "code": "ACADLE:SURVEY_RESULTS:INSUFFICIENT_PERMISSION"
}

Example response (404, Survey not found):


{
    "message": "Survey not found",
    "code": "ACADLE:SURVEY_RESULTS:SURVEY_NOT_FOUND"
}

Request   

GET api/acadle/survey

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Response

Response Fields

id   integer   

Survey ID.

user_id   integer   

Associated user ID.

cpo_number   string   

CPO number.

country   string   

Country code.

medical_training   string   

Medical training level.

myo_exp_zeus   string   

Zeus myo experience.

myo_exp_covvi   string   

Covvi myo experience.

myo_exp_fillauer   string   

Fillauer myo experience.

myo_exp_ossur   string   

Ossur myo experience.

myo_exp_ottobock   string   

Ottobock myo experience.

myo_exp_steeper   string   

Steeper myo experience.

myo_exp_taska   string   

Taska myo experience.

myo_exp_vincent   string   

Vincent myo experience.

myo_exp_pattern_recognition   string   

Pattern recognition myo experience.

myo_exp_other   string   

Other myo experience.

has_demo_hand_access   boolean   

Whether the user has demo hand access.

wants_demo_hand   boolean   

Whether the user wants a demo hand.

partial_hand_protheses   string   

Partial hand prostheses experience.

below_elbow_protheses_single_action   string   

Below elbow single action prostheses experience.

below_elbow_protheses_multi_action   string   

Below elbow multi-action prostheses experience.

above_elbow_protheses   string   

Above elbow prostheses experience.

shoulder_protheses   string   

Shoulder prostheses experience.

zeus_components_description   string   

Zeus components description.

contact_name   string   

Contact first name.

contact_surname   string   

Contact last name.

company_name   string   

Company name.

street   string   

Street address.

city   string   

City.

postal_code   string   

Postal code.

email   string   

Contact email.

phone   string   

Contact phone.

phone_country   string   

Phone country code.

device_side   string   

Device side.

Must be one of:
  • L
  • R
created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Get Acadle survey data (SuperAdmin)

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/acadle/survey/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/acadle/survey/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (201):


{
    "id": 2,
    "user_id": 302,
    "cpo_number": "22281",
    "country": "United States Minor Outlying Islands",
    "medical_training": "physiotherapist",
    "myo_exp_zeus": "1",
    "has_demo_hand_access": 0,
    "wants_demo_hand": 0,
    "myo_exp_covvi": 0,
    "myo_exp_fillauer": 0,
    "myo_exp_ossur": 1,
    "myo_exp_ottobock": 0,
    "myo_exp_steeper": 1,
    "myo_exp_taska": 1,
    "myo_exp_vincent": 0,
    "myo_exp_pattern_recognition": 1,
    "myo_exp_other": "Qui debitis deleniti et cum.",
    "partial_hand_protheses": "3",
    "below_elbow_protheses_single_action": "1",
    "below_elbow_protheses_multi_action": "4",
    "above_elbow_protheses": "1",
    "shoulder_protheses": "5",
    "zeus_components_description": "Qui illo architecto ex amet facere id deleniti blanditiis.",
    "contact_name": "Wilburn",
    "contact_surname": "Murphy",
    "company_name": "Lind, Lueilwitz and Dietrich",
    "street": "78012 Jamel Loaf Apt. 803",
    "city": "West Chaunceyview",
    "postal_code": "60265",
    "email": "astrosin@krajcik.com",
    "phone": "+18087842636",
    "phone_country": "sc",
    "device_side": "L",
    "created_at": "2026-10-26T11:55:51.000000Z",
    "updated_at": "2026-10-26T11:55:51.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to use Acadle",
    "code": "ACADLE:SURVEY_RESULTS_ADMIN:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "ACADLE:SURVEY_RESULTS_ADMIN:USER_NOT_FOUND"
}

Example response (404, Survey not found):


{
    "message": "Survey not found",
    "code": "ACADLE:SURVEY_RESULTS_ADMIN:SURVEY_NOT_FOUND"
}

Request   

GET api/acadle/survey/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Response

Response Fields

id   integer   

Survey ID.

user_id   integer   

Associated user ID.

cpo_number   string   

CPO number.

country   string   

Country code.

medical_training   string   

Medical training level.

myo_exp_zeus   string   

Zeus myo experience.

myo_exp_covvi   string   

Covvi myo experience.

myo_exp_fillauer   string   

Fillauer myo experience.

myo_exp_ossur   string   

Ossur myo experience.

myo_exp_ottobock   string   

Ottobock myo experience.

myo_exp_steeper   string   

Steeper myo experience.

myo_exp_taska   string   

Taska myo experience.

myo_exp_vincent   string   

Vincent myo experience.

myo_exp_pattern_recognition   string   

Pattern recognition myo experience.

myo_exp_other   string   

Other myo experience.

has_demo_hand_access   boolean   

Whether the user has demo hand access.

wants_demo_hand   boolean   

Whether the user wants a demo hand.

partial_hand_protheses   string   

Partial hand prostheses experience.

below_elbow_protheses_single_action   string   

Below elbow single action prostheses experience.

below_elbow_protheses_multi_action   string   

Below elbow multi-action prostheses experience.

above_elbow_protheses   string   

Above elbow prostheses experience.

shoulder_protheses   string   

Shoulder prostheses experience.

zeus_components_description   string   

Zeus components description.

contact_name   string   

Contact first name.

contact_surname   string   

Contact last name.

company_name   string   

Company name.

street   string   

Street address.

city   string   

City.

postal_code   string   

Postal code.

email   string   

Contact email.

phone   string   

Contact phone.

phone_country   string   

Phone country code.

device_side   string   

Device side.

Must be one of:
  • L
  • R
created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

List all Acadle surveys (SuperAdmin)

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/acadle/surveys?search=john" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/acadle/surveys"
);

const params = {
    "search": "john",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 3,
            "user_id": 303,
            "cpo_number": "838",
            "country": "Luxembourg",
            "medical_training": "biomedical_engineer",
            "myo_exp_zeus": "0",
            "has_demo_hand_access": 0,
            "wants_demo_hand": 0,
            "myo_exp_covvi": 1,
            "myo_exp_fillauer": 0,
            "myo_exp_ossur": 1,
            "myo_exp_ottobock": 1,
            "myo_exp_steeper": 0,
            "myo_exp_taska": 0,
            "myo_exp_vincent": 0,
            "myo_exp_pattern_recognition": 0,
            "myo_exp_other": "Molestiae voluptas corrupti quos sunt magni beatae nulla.",
            "partial_hand_protheses": "5",
            "below_elbow_protheses_single_action": "0",
            "below_elbow_protheses_multi_action": "2",
            "above_elbow_protheses": "0",
            "shoulder_protheses": "3",
            "zeus_components_description": "Beatae eligendi velit quia dolorum.",
            "contact_name": "Fiona",
            "contact_surname": "Jakubowski",
            "company_name": "Lang-Rowe",
            "street": "1926 Ora Park Apt. 965",
            "city": "North Harmony",
            "postal_code": "45078-2546",
            "email": "gbrakus@heathcote.biz",
            "phone": "+1-872-289-0234",
            "phone_country": "uz",
            "device_side": "R",
            "created_at": "2026-10-26T11:55:52.000000Z",
            "updated_at": "2026-10-26T11:55:52.000000Z"
        },
        {
            "id": 4,
            "user_id": 304,
            "cpo_number": "1",
            "country": "Mauritius",
            "medical_training": "clinician",
            "myo_exp_zeus": "1",
            "has_demo_hand_access": 1,
            "wants_demo_hand": 1,
            "myo_exp_covvi": 0,
            "myo_exp_fillauer": 1,
            "myo_exp_ossur": 1,
            "myo_exp_ottobock": 0,
            "myo_exp_steeper": 1,
            "myo_exp_taska": 0,
            "myo_exp_vincent": 1,
            "myo_exp_pattern_recognition": 1,
            "myo_exp_other": "Error dicta molestiae et vel blanditiis unde officiis consequatur.",
            "partial_hand_protheses": "2",
            "below_elbow_protheses_single_action": "0",
            "below_elbow_protheses_multi_action": "3",
            "above_elbow_protheses": "0",
            "shoulder_protheses": "2",
            "zeus_components_description": "Exercitationem laborum aliquid nostrum dolorum.",
            "contact_name": "Aurelio",
            "contact_surname": "Kuphal",
            "company_name": "Sawayn, Schneider and Rohan",
            "street": "37617 Jude Knoll Suite 028",
            "city": "West Brayantown",
            "postal_code": "06271-8195",
            "email": "upollich@hodkiewicz.com",
            "phone": "1-302-308-5272",
            "phone_country": "jp",
            "device_side": "R",
            "created_at": "2026-10-26T11:55:53.000000Z",
            "updated_at": "2026-10-26T11:55:53.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to use Acadle",
    "code": "ACADLE:SURVEYS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/acadle/surveys

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

search   string  optional  

Filter surveys by searching in: user name, user email, contact name, contact surname, contact email, CPO number. Example: john

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: user).

sortby   string  optional  

Sort by field (available: date, user_name, user_email, contact_name, contact_surname, country, medical_training, cpo_number). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

Survey ID.

user_id   integer   

Associated user ID.

cpo_number   string   

CPO number.

country   string   

Country code.

medical_training   string   

Medical training level.

myo_exp_zeus   string   

Zeus myo experience.

myo_exp_covvi   string   

Covvi myo experience.

myo_exp_fillauer   string   

Fillauer myo experience.

myo_exp_ossur   string   

Ossur myo experience.

myo_exp_ottobock   string   

Ottobock myo experience.

myo_exp_steeper   string   

Steeper myo experience.

myo_exp_taska   string   

Taska myo experience.

myo_exp_vincent   string   

Vincent myo experience.

myo_exp_pattern_recognition   string   

Pattern recognition myo experience.

myo_exp_other   string   

Other myo experience.

has_demo_hand_access   boolean   

Whether the user has demo hand access.

wants_demo_hand   boolean   

Whether the user wants a demo hand.

partial_hand_protheses   string   

Partial hand prostheses experience.

below_elbow_protheses_single_action   string   

Below elbow single action prostheses experience.

below_elbow_protheses_multi_action   string   

Below elbow multi-action prostheses experience.

above_elbow_protheses   string   

Above elbow prostheses experience.

shoulder_protheses   string   

Shoulder prostheses experience.

zeus_components_description   string   

Zeus components description.

contact_name   string   

Contact first name.

contact_surname   string   

Contact last name.

company_name   string   

Company name.

street   string   

Street address.

city   string   

City.

postal_code   string   

Postal code.

email   string   

Contact email.

phone   string   

Contact phone.

phone_country   string   

Phone country code.

device_side   string   

Device side.

Must be one of:
  • L
  • R
created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Send Acadle survey

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/acadle/survey" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"cpo_number\": 5323,
    \"country\": \"Saudi Arabia\",
    \"medical_training\": \"physician\",
    \"myo_exp_zeus\": false,
    \"myo_exp_covvi\": false,
    \"myo_exp_fillauer\": false,
    \"myo_exp_ossur\": false,
    \"myo_exp_ottobock\": false,
    \"myo_exp_steeper\": false,
    \"myo_exp_taska\": false,
    \"myo_exp_vincent\": false,
    \"myo_exp_pattern_recognition\": false,
    \"myo_exp_other\": \"Quis dolorem est error voluptatem molestias.\",
    \"has_demo_hand_access\": false,
    \"wants_demo_hand\": false,
    \"partial_hand_protheses\": \"1-5\",
    \"below_elbow_protheses_single_action\": \"1-5\",
    \"below_elbow_protheses_multi_action\": \"5-10\",
    \"above_elbow_protheses\": \"50+\",
    \"shoulder_protheses\": \"1-5\",
    \"zeus_components_description\": \"Doloremque dicta ipsum est fugiat.\",
    \"contact_name\": \"Judah\",
    \"company_name\": \"Huels-Dickinson\",
    \"street\": \"9518 Elisabeth Grove Suite 495\",
    \"city\": \"East Beaulah\",
    \"postal_code\": \"03398-4868\",
    \"email\": \"medhurst.dino@hamill.net\",
    \"phone\": \"463-818-1064\",
    \"phone_country\": \"GT\",
    \"device_side\": \"R\"
}"

const url = new URL(
    "http://localhost:8000/api/acadle/survey"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "cpo_number": 5323,
    "country": "Saudi Arabia",
    "medical_training": "physician",
    "myo_exp_zeus": false,
    "myo_exp_covvi": false,
    "myo_exp_fillauer": false,
    "myo_exp_ossur": false,
    "myo_exp_ottobock": false,
    "myo_exp_steeper": false,
    "myo_exp_taska": false,
    "myo_exp_vincent": false,
    "myo_exp_pattern_recognition": false,
    "myo_exp_other": "Quis dolorem est error voluptatem molestias.",
    "has_demo_hand_access": false,
    "wants_demo_hand": false,
    "partial_hand_protheses": "1-5",
    "below_elbow_protheses_single_action": "1-5",
    "below_elbow_protheses_multi_action": "5-10",
    "above_elbow_protheses": "50+",
    "shoulder_protheses": "1-5",
    "zeus_components_description": "Doloremque dicta ipsum est fugiat.",
    "contact_name": "Judah",
    "company_name": "Huels-Dickinson",
    "street": "9518 Elisabeth Grove Suite 495",
    "city": "East Beaulah",
    "postal_code": "03398-4868",
    "email": "medhurst.dino@hamill.net",
    "phone": "463-818-1064",
    "phone_country": "GT",
    "device_side": "R"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 5,
    "user_id": 305,
    "cpo_number": "58893",
    "country": "Reunion",
    "medical_training": "physiotherapist",
    "myo_exp_zeus": "1",
    "has_demo_hand_access": 0,
    "wants_demo_hand": 1,
    "myo_exp_covvi": 0,
    "myo_exp_fillauer": 1,
    "myo_exp_ossur": 0,
    "myo_exp_ottobock": 1,
    "myo_exp_steeper": 1,
    "myo_exp_taska": 1,
    "myo_exp_vincent": 1,
    "myo_exp_pattern_recognition": 0,
    "myo_exp_other": "Adipisci quae hic suscipit debitis ipsam.",
    "partial_hand_protheses": "0",
    "below_elbow_protheses_single_action": "5",
    "below_elbow_protheses_multi_action": "2",
    "above_elbow_protheses": "0",
    "shoulder_protheses": "1",
    "zeus_components_description": "Officiis autem ut et aut cumque.",
    "contact_name": "Brendan",
    "contact_surname": "McLaughlin",
    "company_name": "Kihn, Sawayn and Oberbrunner",
    "street": "74516 Mante Track Suite 481",
    "city": "Lake Victorchester",
    "postal_code": "74629-5886",
    "email": "onie.mayert@johnson.com",
    "phone": "1-912-514-8454",
    "phone_country": "vn",
    "device_side": "R",
    "created_at": "2026-10-26T11:55:54.000000Z",
    "updated_at": "2026-10-26T11:55:54.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to use Acadle",
    "code": "ACADLE:SURVEY_SEND:INSUFFICIENT_PERMISSION"
}

Example response (403, Survey already sent):


{
    "message": "Survey already sent",
    "code": "ACADLE:SURVEY_SEND:SURVEY_ALREADY_SENT"
}

Request   

POST api/acadle/survey

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

cpo_number   string  optional  

CPO Number. Example: 5323

country   string   

Country name. Example: Saudi Arabia

medical_training   string   

Clinician's medical/clinical training. Example: physician

Must be one of:
  • clinician
  • physiotherapist
  • physician
  • biomedical_engineer
  • other
  • prosthetist
myo_exp_zeus   boolean   

Does clinician have an experience working with Zeus hands. Example: false

myo_exp_covvi   boolean   

Does clinician have an experience working with Covvi hands. Example: false

myo_exp_fillauer   boolean   

Does clinician have an experience working with Fillauer hands. Example: false

myo_exp_ossur   boolean   

Does clinician have an experience working with Ossur hands. Example: false

myo_exp_ottobock   boolean   

Does clinician have an experience working with Ottobock hands. Example: false

myo_exp_steeper   boolean   

Does clinician have an experience working with Steeper hands. Example: false

myo_exp_taska   boolean   

Does clinician have an experience working with Taska hands. Example: false

myo_exp_vincent   boolean   

Does clinician have an experience working with Vincent hands. Example: false

myo_exp_pattern_recognition   boolean   

Does clinician have an experience working with Pattern Recognition. Example: false

myo_exp_other   string  optional  

Does clinician have an experience working with any other hands. MINIMUM:STRING_LENGTH:3. Example: Quis dolorem est error voluptatem molestias.

has_demo_hand_access   boolean   

Does clinician have access to a demo hand. Example: false

wants_demo_hand   boolean   

Does clinician want a demo hand. Example: false

partial_hand_protheses   string  optional  

How many prostheses of type partial hand does clinician make per year. Example: 1-5

below_elbow_protheses_single_action   string  optional  

How many prostheses of type below elbow (single-action) does clinician make per year. Example: 1-5

below_elbow_protheses_multi_action   string  optional  

How many prostheses of type below elbow (multi-action) does clinician make per year. Example: 5-10

above_elbow_protheses   string  optional  

How many prostheses of type above elbow does clinician make per year. Example: 50+

shoulder_protheses   string  optional  

How many prostheses of type shoulder does clinician make per year. Example: 1-5

zeus_components_description   string  optional  

Description which components would clinician like to use with a Zeus hand. MINIMUM:STRING_LENGTH:10. Example: Doloremque dicta ipsum est fugiat.

contact_name   string  optional  

Contact information: full name. This field is required when wants_demo_hand is true. Example: Judah

company_name   string  optional  

Contact information: company name. This field is required when wants_demo_hand is true. Example: Huels-Dickinson

street   string  optional  

Contact information: street. This field is required when wants_demo_hand is true. Example: 9518 Elisabeth Grove Suite 495

city   string  optional  

Contact information: city/state. This field is required when wants_demo_hand is true. Example: East Beaulah

postal_code   string  optional  

Contact information: postal code. This field is required when wants_demo_hand is true. Example: 03398-4868

email   string  optional  

Contact information: email. This field is required when wants_demo_hand is true. MUST_BE_EMAIL. Example: medhurst.dino@hamill.net

phone   string  optional  

Contact information: phone. This field is required when wants_demo_hand is true. Example: 463-818-1064

phone_country   string  optional  

Contact information: phone country. This field is required when wants_demo_hand is true. SIZE:STRING_LENGTH:2. Example: GT

device_side   string  optional  

The side of the hand. This field is required when wants_demo_hand is true. Example: R

Must be one of:
  • L
  • R

Response

Response Fields

id   integer   

Survey ID.

user_id   integer   

Associated user ID.

cpo_number   string   

CPO number.

country   string   

Country code.

medical_training   string   

Medical training level.

myo_exp_zeus   string   

Zeus myo experience.

myo_exp_covvi   string   

Covvi myo experience.

myo_exp_fillauer   string   

Fillauer myo experience.

myo_exp_ossur   string   

Ossur myo experience.

myo_exp_ottobock   string   

Ottobock myo experience.

myo_exp_steeper   string   

Steeper myo experience.

myo_exp_taska   string   

Taska myo experience.

myo_exp_vincent   string   

Vincent myo experience.

myo_exp_pattern_recognition   string   

Pattern recognition myo experience.

myo_exp_other   string   

Other myo experience.

has_demo_hand_access   boolean   

Whether the user has demo hand access.

wants_demo_hand   boolean   

Whether the user wants a demo hand.

partial_hand_protheses   string   

Partial hand prostheses experience.

below_elbow_protheses_single_action   string   

Below elbow single action prostheses experience.

below_elbow_protheses_multi_action   string   

Below elbow multi-action prostheses experience.

above_elbow_protheses   string   

Above elbow prostheses experience.

shoulder_protheses   string   

Shoulder prostheses experience.

zeus_components_description   string   

Zeus components description.

contact_name   string   

Contact first name.

contact_surname   string   

Contact last name.

company_name   string   

Company name.

street   string   

Street address.

city   string   

City.

postal_code   string   

Postal code.

email   string   

Contact email.

phone   string   

Contact phone.

phone_country   string   

Phone country code.

device_side   string   

Device side.

Must be one of:
  • L
  • R
created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Activation codes

API endpoints for activation codes

Get activation codes

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/activation-codes" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/activation-codes"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "code": "7ANYW6",
            "created_by": 41,
            "used_by": 42,
            "used_at": null,
            "active": 0,
            "created_at": "2026-10-26T11:53:33.000000Z",
            "updated_at": "2026-10-26T11:53:33.000000Z"
        },
        {
            "id": 2,
            "code": "38PG55",
            "created_by": 43,
            "used_by": 44,
            "used_at": null,
            "active": 1,
            "created_at": "2026-10-26T11:53:34.000000Z",
            "updated_at": "2026-10-26T11:53:34.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage activation codes",
    "code": "ACTIVATION_CODE:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/activation-codes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

sortby   string  optional  

Sort by field (available: date). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

Activation code ID.

code   string   

Activation code value.

created_by   integer   

ID of the user who created this code.

used_by   integer   

ID of the user who used this code.

used_at   string   

Timestamp when the code was used.

active   boolean   

Whether the code is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

creator   object   

User who created this code.

user   object   

User who used this code.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Get active activation codes

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/activation-codes/active" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/activation-codes/active"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 3,
            "code": "RQL37Y",
            "created_by": 45,
            "used_by": 46,
            "used_at": null,
            "active": 0,
            "created_at": "2026-10-26T11:53:35.000000Z",
            "updated_at": "2026-10-26T11:53:35.000000Z"
        },
        {
            "id": 4,
            "code": "CHGJBR",
            "created_by": 47,
            "used_by": 48,
            "used_at": null,
            "active": 1,
            "created_at": "2026-10-26T11:53:36.000000Z",
            "updated_at": "2026-10-26T11:53:36.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage activation codes",
    "code": "ACTIVATION_CODE:ACTIVE:INSUFFICIENT_PERMISSION"
}

Request   

GET api/activation-codes/active

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Response

Response Fields

items   object   
id   integer   

Activation code ID.

code   string   

Activation code value.

created_by   integer   

ID of the user who created this code.

used_by   integer   

ID of the user who used this code.

used_at   string   

Timestamp when the code was used.

active   boolean   

Whether the code is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

creator   object   

User who created this code.

user   object   

User who used this code.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Find activation code

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/activation-codes/find/sunt" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/activation-codes/find/sunt"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 5,
    "code": "BNLA2R",
    "created_by": null,
    "used_by": null,
    "used_at": null,
    "active": 0,
    "created_at": "2026-10-26T11:53:36.000000Z",
    "updated_at": "2026-10-26T11:53:36.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage activation codes",
    "code": "ACTIVATION_CODE:FIND:INSUFFICIENT_PERMISSION"
}

Example response (404, Activation code not found):


{
    "message": "Activation code not found",
    "code": "ACTIVATION_CODE:FIND:CODE_NOT_FOUND"
}

Request   

GET api/activation-codes/find/{code}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

code   string   

Activation code (not ID). Example: sunt

Response

Response Fields

id   integer   

Activation code ID.

code   string   

Activation code value.

created_by   integer   

ID of the user who created this code.

used_by   integer   

ID of the user who used this code.

used_at   string   

Timestamp when the code was used.

active   boolean   

Whether the code is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

creator   object   

User who created this code.

user   object   

User who used this code.

Create activation code

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/activation-codes" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/activation-codes"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (201):


{
    "id": 6,
    "code": "NFLEK2",
    "created_by": null,
    "used_by": null,
    "used_at": null,
    "active": 0,
    "created_at": "2026-10-26T11:53:36.000000Z",
    "updated_at": "2026-10-26T11:53:36.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage activation codes",
    "code": "ACTIVATION_CODE:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Server error):


{
    "message": "Server error: activation code not created",
    "code": "ACTIVATION_CODE:CREATE:SERVER_ERROR"
}

Request   

POST api/activation-codes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Response

Response Fields

id   integer   

Activation code ID.

code   string   

Activation code value.

created_by   integer   

ID of the user who created this code.

used_by   integer   

ID of the user who used this code.

used_at   string   

Timestamp when the code was used.

active   boolean   

Whether the code is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

creator   object   

User who created this code.

user   object   

User who used this code.

Create activation code (multi-region)

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/activation-codes/14" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/activation-codes/14"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (201):


{
    "id": 7,
    "code": "RFEKVK",
    "created_by": null,
    "used_by": null,
    "used_at": null,
    "active": 1,
    "created_at": "2026-10-26T11:53:36.000000Z",
    "updated_at": "2026-10-26T11:53:36.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage activation codes",
    "code": "ACTIVATION_CODE:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/activation-codes/{code}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

code   integer   

Example: 14

Response

Response Fields

id   integer   

Activation code ID.

code   string   

Activation code value.

created_by   integer   

ID of the user who created this code.

used_by   integer   

ID of the user who used this code.

used_at   string   

Timestamp when the code was used.

active   boolean   

Whether the code is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

creator   object   

User who created this code.

user   object   

User who used this code.

Deactivate activation code

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/activation-codes/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/activation-codes/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202):


{
    "id": 8,
    "code": "7ZZZRT",
    "created_by": null,
    "used_by": null,
    "used_at": null,
    "active": 0,
    "created_at": "2026-10-26T11:53:36.000000Z",
    "updated_at": "2026-10-26T11:53:36.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage activation codes",
    "code": "ACTIVATION_CODE:DEACTIVATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Activation code is not active):


{
    "message": "Cannot deactivate: code is not active",
    "code": "ACTIVATION_CODE:DEACTIVATE:CODE_NOT_ACTIVE"
}

Example response (404, Activation code not found):


{
    "message": "Activation code not found",
    "code": "ACTIVATION_CODE:DEACTIVATE:CODE_NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error: activation code not deactivated",
    "code": "ACTIVATION_CODE:DEACTIVATE:SERVER_ERROR"
}

Request   

DELETE api/activation-codes/{codeId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

codeId   integer   

Activation code ID. Example: 1

Response

Response Fields

id   integer   

Activation code ID.

code   string   

Activation code value.

created_by   integer   

ID of the user who created this code.

used_by   integer   

ID of the user who used this code.

used_at   string   

Timestamp when the code was used.

active   boolean   

Whether the code is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

creator   object   

User who created this code.

user   object   

User who used this code.

Analytics consent

API endpoints for analytics consent state and reporting

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/analytics-consent" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/analytics-consent"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, Current consent state):


{
    "decision": "granted",
    "decided_at": "2026-08-06T09:15:00.000000Z",
    "consent_text_version": "clinician-2026-08-v1",
    "current_version": "clinician-2026-08-v1",
    "should_ask": false,
    "visitor_id": "e3b0c44298fc1c14"
}

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/analytics-consent" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"decision\": \"granted\",
    \"consent_text_version\": \"clinician-2026-08-v1\",
    \"surface\": \"onboarding_modal\"
}"

const url = new URL(
    "http://localhost:8000/api/analytics-consent"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "decision": "granted",
    "consent_text_version": "clinician-2026-08-v1",
    "surface": "onboarding_modal"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, Consent state after the decision):


{
    "decision": "granted",
    "decided_at": "2026-08-06T09:15:00.000000Z",
    "consent_text_version": "clinician-2026-08-v1",
    "current_version": "clinician-2026-08-v1",
    "should_ask": false,
    "visitor_id": "e3b0c44298fc1c14"
}

Example response (403, Account has no consent audience):


{
    "message": "Analytics consent is not applicable to this account",
    "code": "ANALYTICS_CONSENT:SET:NO_AUDIENCE"
}

Example response (422, Submitted consent text version is not current):


{
    "message": "The submitted consent text version is no longer current",
    "code": "ANALYTICS_CONSENT:SET:STALE_VERSION"
}

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/analytics-consent/metrics?from=2026-08-01&to=2026-08-31&interval=day&version=clinician-2026-08-v1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/analytics-consent/metrics"
);

const params = {
    "from": "2026-08-01",
    "to": "2026-08-31",
    "interval": "day",
    "version": "clinician-2026-08-v1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, Consent metrics per audience):


{
    "clinician": {
        "series": [
            {
                "period": "2026-08-01",
                "grants": 12,
                "declines": 3,
                "withdrawals": 1
            }
        ],
        "current": {
            "granted": 128,
            "denied": 14,
            "never_asked": 37
        }
    },
    "patient": {
        "series": [
            {
                "period": "2026-08-01",
                "grants": 41,
                "declines": 9,
                "withdrawals": 2
            }
        ],
        "current": {
            "granted": 512,
            "denied": 63,
            "never_asked": 210
        }
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view analytics consent data",
    "code": "ANALYTICS_CONSENT:METRICS:INSUFFICIENT_PERMISSION"
}

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/analytics-consent/patient-funnel?from=2026-08-01&to=2026-08-31" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/analytics-consent/patient-funnel"
);

const params = {
    "from": "2026-08-01",
    "to": "2026-08-31",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, Patient creation funnel per clinician):


{
    "clinicians": [
        {
            "clinician_id": 17,
            "created": 8,
            "failed": 2
        },
        {
            "clinician_id": 42,
            "created": 3,
            "failed": 0
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view analytics consent data",
    "code": "ANALYTICS_CONSENT:FUNNEL:INSUFFICIENT_PERMISSION"
}

Get a patient's analytics consent status

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/user/1/analytics-consent" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/user/1/analytics-consent"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, Patient consent decision):


{
    "decision": "granted"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view analytics consent data",
    "code": "ANALYTICS_CONSENT:PATIENT_STATUS:INSUFFICIENT_PERMISSION"
}

Example response (404, Patient not found):


{
    "message": "User not found",
    "code": "ANALYTICS_CONSENT:PATIENT_STATUS:USER_NOT_FOUND"
}

Request   

GET api/user/{id}/analytics-consent

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Patient user ID. Example: 1

Authentication

API endpoints for managing authentication

Login user

Example request:
curl --request POST \
    "http://localhost:8000/api/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"test@example.com\",
    \"password\": \"secretpassword\"
}"

const url = new URL(
    "http://localhost:8000/api/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "test@example.com",
    "password": "secretpassword"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "access_token": "7|x7de9EgE0xiBNLgHU91DHvhj85HVgTG1bekCssIA",
    "expires": "2021-10-25 17:05:25"
}

Example response (403, Too many attempts):


{
    "message": "Login: too many attempts",
    "code": "GENERAL:TOO_MANY_ATTEMPTS"
}

Example response (422, Invalid credentials):


{
    "message": "The given data was invalid.",
    "errors": {
        "email": [
            "Given credentials not found"
        ]
    },
    "code": "AUTH:LOGIN:INVALID_CREDENTIALS"
}

Request   

POST api/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

User email. MUST_BE_EMAIL. Example: test@example.com

password   string   

User password. Example: secretpassword

Register user

Example request:
curl --request POST \
    "http://localhost:8000/api/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"region\": \"us\",
    \"name\": \"Tom Smith\",
    \"email\": \"name@domain.com\",
    \"password\": \"Test123!\",
    \"phone\": \"+17654853458\",
    \"phone_country\": \"US\",
    \"language\": \"en\",
    \"clinic_name\": \"Hills, Goldner and Okuneva\",
    \"clinic_location\": \"Stephanieberg\",
    \"address1\": \"7831 Kessler Mission\",
    \"address2\": \"West Mckayla, IN 02459\",
    \"mfa_enabled\": true,
    \"mfa_method\": \"email\",
    \"activation_code\": \"1A2B3C\"
}"

const url = new URL(
    "http://localhost:8000/api/register"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "region": "us",
    "name": "Tom Smith",
    "email": "name@domain.com",
    "password": "Test123!",
    "phone": "+17654853458",
    "phone_country": "US",
    "language": "en",
    "clinic_name": "Hills, Goldner and Okuneva",
    "clinic_location": "Stephanieberg",
    "address1": "7831 Kessler Mission",
    "address2": "West Mckayla, IN 02459",
    "mfa_enabled": true,
    "mfa_method": "email",
    "activation_code": "1A2B3C"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 2,
    "mrn": "ZQTX4X7B1793015589",
    "name": "Kellie Gorczany III",
    "email": "1793015589wilma.ruecker@example.net",
    "language": "en",
    "phone": "(872) 670-0549",
    "phone_country": "ZA",
    "phone_verified_at": null,
    "address1": "9226 Willms Lane Suite 358",
    "address2": "North Thalia, VT 08787-6887",
    "postal_code": "95494-2882",
    "city": "Jacobs LLC",
    "country": "ES",
    "clinic_name": "Kearaburgh",
    "clinic_location": "4732 Strosin Hill Apt. 153\nMonahanmouth, KS 46236",
    "image": null,
    "public_image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "is_ambassador": 0,
    "test_account": false,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2026-10-26T11:53:09.000000Z",
    "updated_at": "2026-10-26T11:53:09.000000Z",
    "invitation_status": "accepted",
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 3,
            "name": "ClinicAdmin"
        }
    ]
}

Example response (403, Too many attempts):


{
    "message": "Register: too many attempts",
    "code": "GENERAL:TOO_MANY_ATTEMPTS"
}

Example response (403, E-mail in use (in another region)):


{
    "message": "E-mail address already in use (in another region)",
    "code": "AUTH:REGISTER:EMAIL_IN_USE"
}

Example response (403, Activation code is incorrect):


{
    "message": "Activation code is incorrect",
    "code": "AUTH:REGISTER:INCORRECT_CODE"
}

Example response (500, Server error):


{
    "message": "Server error: user not created",
    "code": "AUTH:REGISTER:SERVER_ERROR"
}

Request   

POST api/register

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

region   string   

User region. Example: us

name   string   

User name. Example: Tom Smith

email   string   

User e-mail address. MUST_BE_EMAIL. Example: name@domain.com

password   string   

User password. Example: Test123!

phone   string   

User phone number. Example: +17654853458

phone_country   string   

Phone number's country (2 characters). SIZE:STRING_LENGTH:2. Example: US

language   string   

User language. Example: en

clinic_name   string  optional  

Clinic name. Example: Hills, Goldner and Okuneva

clinic_location   string  optional  

Clinic location. Example: Stephanieberg

address1   string  optional  

Address line 1. Example: 7831 Kessler Mission

address2   string  optional  

Address line 2. Example: West Mckayla, IN 02459

mfa_enabled   boolean  optional  

MFA enabled. Example: true

mfa_method   string  optional  

MFA method. Example: email

Must be one of:
  • email
  • sms
activation_code   string   

Activation code. SIZE:STRING_LENGTH:6. Example: 1A2B3C

Response

Response Fields

id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

Register mobile user

Example request:
curl --request POST \
    "http://localhost:8000/api/mobile/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"region\": \"us\",
    \"name\": \"Tom Smith\",
    \"email\": \"name@domain.com\",
    \"password\": \"Test123!\",
    \"language\": \"en\",
    \"terms_accepted\": true
}"

const url = new URL(
    "http://localhost:8000/api/mobile/register"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "region": "us",
    "name": "Tom Smith",
    "email": "name@domain.com",
    "password": "Test123!",
    "language": "en",
    "terms_accepted": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "mrn": "L4WK3HV21793015590",
    "name": "Orion Mante",
    "email": "1793015590kolby.okon@example.net",
    "language": "en",
    "phone": "1-763-438-9710",
    "phone_country": "CO",
    "phone_verified_at": null,
    "address1": "886 Gaston Wall Apt. 887",
    "address2": "South Margaret, KY 10734-0827",
    "postal_code": "76650",
    "city": "Bode-Runolfsson",
    "country": "NL",
    "clinic_name": "South Nikko",
    "clinic_location": "301 Adrain Vista\nWest Danykabury, AL 21228-8085",
    "image": null,
    "public_image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "is_ambassador": 0,
    "test_account": false,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2026-10-26T11:53:10.000000Z",
    "updated_at": "2026-10-26T11:53:10.000000Z",
    "invitation_status": "accepted",
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 3,
            "name": "ClinicAdmin"
        }
    ]
}

Example response (403, Too many attempts):


{
    "message": "Register: too many attempts",
    "code": "GENERAL:TOO_MANY_ATTEMPTS"
}

Example response (403, E-mail in use (in another region)):


{
    "message": "E-mail address already in use (in another region)",
    "code": "AUTH:MOBILE_REGISTER:EMAIL_IN_USE"
}

Example response (500, Server error):


{
    "message": "Server error: user not created",
    "code": "AUTH:MOBILE_REGISTER:SERVER_ERROR"
}

Request   

POST api/mobile/register

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

region   string   

User region. Example: us

name   string   

User name. Example: Tom Smith

email   string   

User e-mail address. MUST_BE_EMAIL. Example: name@domain.com

password   string   

User password. Example: Test123!

language   string  optional  

User language. Example: en

terms_accepted   boolean   

User accepted terms. Must be accepted. Example: true

Response

Response Fields

id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

Request password reset

Request sending password reset email message with token that allows to change the password

Example request:
curl --request POST \
    "http://localhost:8000/api/password/reset" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"test@example.com\"
}"

const url = new URL(
    "http://localhost:8000/api/password/reset"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "test@example.com"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "code": "passwords.sent",
    "message": "Reset password link successfully sent"
}

Example response (400, Throttled request):


{
    "code": "passwords.throttled",
    "message": "You have requested password reset recently"
}

Request   

POST api/password/reset

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

User email. MUST_BE_EMAIL. Example: test@example.com

Verify password reset token

Check if token is valid before using it to reset password

Example request:
curl --request POST \
    "http://localhost:8000/api/password/reset/verify" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"158bed12188492617e43ecfcca43f5990b3f5f0383b5083247389482b70af019\",
    \"email\": \"test@example.com\"
}"

const url = new URL(
    "http://localhost:8000/api/password/reset/verify"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "token": "158bed12188492617e43ecfcca43f5990b3f5f0383b5083247389482b70af019",
    "email": "test@example.com"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "message": "Valid token",
    "code": "AUTH:PASSWORD_RESET_VERIFY:VALID_TOKEN"
}

Example response (400, Invalid token):


{
    "message": "Invalid token",
    "code": "AUTH:PASSWORD_RESET_VERIFY:INVALID_TOKEN"
}

Request   

POST api/password/reset/verify

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

Password reset token. Example: 158bed12188492617e43ecfcca43f5990b3f5f0383b5083247389482b70af019

email   string   

User email. MUST_BE_EMAIL. Example: test@example.com

Change password with token

Change user password using password reset token sent to email address

Example request:
curl --request POST \
    "http://localhost:8000/api/password/reset/change" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"158bed12188492617e43ecfcca43f5990b3f5f0383b5083247389482b70af019\",
    \"email\": \"test@example.com\",
    \"password\": \"secretpassword\"
}"

const url = new URL(
    "http://localhost:8000/api/password/reset/change"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "token": "158bed12188492617e43ecfcca43f5990b3f5f0383b5083247389482b70af019",
    "email": "test@example.com",
    "password": "secretpassword"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "code": "passwords.reset",
    "message": "Password changed successfully"
}

Example response (400, Invalid token):


{
    "code": "passwords.token",
    "message": "Invalid token"
}

Example response (404, User not found):


{
    "code": "passwords.user",
    "message": "User not found"
}

Request   

POST api/password/reset/change

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

Password reset token. Example: 158bed12188492617e43ecfcca43f5990b3f5f0383b5083247389482b70af019

email   string   

User email. MUST_BE_EMAIL. Example: test@example.com

password   string   

User new password. Example: secretpassword

Logout current device

requires authentication

Logout and delete current access token

Example request:
curl --request POST \
    "http://localhost:8000/api/logout" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/logout"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (202):


[]

Request   

POST api/logout

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Logout everywhere

requires authentication

Logout and delete all access tokens owned by account

Example request:
curl --request POST \
    "http://localhost:8000/api/logout/everywhere" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/logout/everywhere"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (202):


[]

Request   

POST api/logout/everywhere

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Refresh access token

requires authentication

Refresh the new access token from the expiring token

Example request:
curl --request POST \
    "http://localhost:8000/api/token/refresh" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/token/refresh"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "access_token": "7|x7de9EgE0xiBNLgHU91DHvhj85HVgTG1bekCssIA",
    "expires": "2021-10-25 17:05:25"
}

Request   

POST api/token/refresh

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Check MFA status

requires authentication

Check any of available MFA methods. Supported methods: email, sms, otp.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/mfa/status" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/mfa/status"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "enabled": 1,
    "method": "email",
    "phone": 1,
    "otp": 1
}

Request   

GET api/mfa/status

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Response

Response Fields

enabled   string   

Determines if user enabled MFA

method   string   

Preferred MFA method

phone   string   

Determines if user has verified phone number and sms channel could be used

otp   string   

Determines if user has setup OTP with authenticator application

Use recovery code

requires authentication

Use generated recovery code in order to access account in case when other MFA methods couldn't be used. This method only checks if code is valid, implement account access scenario on your own. Sent code is removed and couldn't be used anymore. If remaining_codes counter equals zero, generate a new set.

Example request:
curl --request POST \
    "http://localhost:8000/api/mfa/recovery-code" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"ZZASRM6S\"
}"

const url = new URL(
    "http://localhost:8000/api/mfa/recovery-code"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "ZZASRM6S"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "access_token": "7|x7de9EgE0xiBNLgHU91DHvhj85HVgTG1bekCssIA",
    "expires": "2021-10-25 17:05:25",
    "remaining_codes": 9
}

Example response (401, Invalid code):


{
    "message": "Invalid code",
    "code": "AUTH:USE_RECOVERY_CODE:INVALID_CODE"
}

Request   

POST api/mfa/recovery-code

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

code   string   

Recovery code. Example: ZZASRM6S

Send MFA code

requires authentication

Send multi-factor authentication code via selected channel. Code is valid for 15 minutes.

Example request:
curl --request POST \
    "http://localhost:8000/api/mfa/send" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"channel\": \"email\"
}"

const url = new URL(
    "http://localhost:8000/api/mfa/send"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "channel": "email"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "message": "Code sent",
    "code": "AUTH:SEND_MFA:SENT"
}

Example response (400, Channel SMS, phone number not verified):


{
    "message": "Phone number is not verified",
    "code": "AUTH:SEND_MFA:PHONE_NUMBER_NOT_VERIFIED"
}

Example response (500, Channel SMS, provider problem):


{
    "message": "Code sending failed",
    "code": "AUTH:SEND_MFA:SERVER_ERROR"
}

Request   

POST api/mfa/send

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

channel   string   

Authentication channel. Example: email

Must be one of:
  • email
  • sms

Verify MFA code

requires authentication

Verify multi-factor code obtained from selected channel.

Example request:
curl --request POST \
    "http://localhost:8000/api/mfa/verify" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"channel\": \"email\",
    \"remember_mfa_session\": true,
    \"code\": \"445566\",
    \"machine_key\": \"35282880-244a-4328-9435-2aaf432f3619\"
}"

const url = new URL(
    "http://localhost:8000/api/mfa/verify"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "channel": "email",
    "remember_mfa_session": true,
    "code": "445566",
    "machine_key": "35282880-244a-4328-9435-2aaf432f3619"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK, token auth):


{
    "access_token": "7|x7de9EgE0xiBNLgHU91DHvhj85HVgTG1bekCssIA",
    "expires": "2021-10-25 17:05:25",
    "mfa_token": "fd63e55c-2a67-44b2-95b9-a771778e9971",
    "mfa_expires": "2023-04-25 21:00:00"
}

Example response (200, OK, cookie auth):


{
    "message": "OK",
    "mfa_token": "fd63e55c-2a67-44b2-95b9-a771778e9971",
    "mfa_expires": "2023-04-25 21:00:00"
}

Example response (401, Invalid code):


{
    "message": "Invalid code",
    "code": "AUTH:VERIFY_MFA:INVALID_CODE"
}

Request   

POST api/mfa/verify

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

channel   string   

Authentication channel. Example: email

Must be one of:
  • email
  • sms
remember_mfa_session   boolean  optional  

Do not require MFA code. By default, for 30 days. Example: true

code   string   

Authentication code. Example: 445566

machine_key   string  optional  

Unique machine identifier. Example: 35282880-244a-4328-9435-2aaf432f3619

Verify phone number

requires authentication

Verify phone number with text message

Example request:
curl --request POST \
    "http://localhost:8000/api/mfa/phone/verify" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"445566\"
}"

const url = new URL(
    "http://localhost:8000/api/mfa/phone/verify"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "445566"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "message": "Phone number verified",
    "code": "AUTH:VERIFY_PHONE:VERIFIED"
}

Example response (401, Invalid code):


{
    "message": "Invalid code",
    "code": "AUTH:VERIFY_PHONE:INVALID_CODE"
}

Request   

POST api/mfa/phone/verify

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

code   string   

Verification code. Example: 445566

Verify MFA OTP

requires authentication

Verify one-time password (OTP). If verification is successful, new access token with additional permissions will be generated.

Example request:
curl --request POST \
    "http://localhost:8000/api/mfa/otp/verify" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"445566\"
}"

const url = new URL(
    "http://localhost:8000/api/mfa/otp/verify"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "code": "445566"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK, token auth):


{
    "access_token": "7|x7de9EgE0xiBNLgHU91DHvhj85HVgTG1bekCssIA",
    "expires": "2021-10-25 17:05:25"
}

Example response (200, OK, cookie auth):


{
    "message": "OK"
}

Example response (401, Invalid code):


{
    "message": "Invalid code",
    "code": "AUTH:VERIFY_MFA_OTP:INVALID_CODE"
}

Request   

POST api/mfa/otp/verify

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

code   string   

One-time password from app. Example: 445566

Change password

requires authentication

Change authenticated user password

Example request:
curl --request POST \
    "http://localhost:8000/api/password/change" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"old_password\": \"oldpassword\",
    \"new_password\": \"newpassword\"
}"

const url = new URL(
    "http://localhost:8000/api/password/change"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "old_password": "oldpassword",
    "new_password": "newpassword"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "message": "Password changed successfully",
    "code": "AUTH:PASSWORD_CHANGE:CHANGED"
}

Example response (422, Invalid old password):


{
    "message": "The given data was invalid.",
    "errors": {
        "old_password": [
            "Old password is incorrect"
        ]
    },
    "code": "AUTH:PASSWORD_CHANGE:INVALID_OLD_PASSWORD"
}

Request   

POST api/password/change

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

old_password   string   

User old password. Example: oldpassword

new_password   string   

User new password. Example: newpassword

Set MFA status

requires authentication

Set MFA status and preferred method. Supported methods: email, sms, otp.

Example request:
curl --request POST \
    "http://localhost:8000/api/mfa/status" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"enabled\": true,
    \"method\": \"email\"
}"

const url = new URL(
    "http://localhost:8000/api/mfa/status"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "enabled": true,
    "method": "email"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "enabled": 1,
    "method": "email",
    "phone": 1,
    "otp": 1
}

Request   

POST api/mfa/status

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

enabled   boolean  optional  

Use MFA after login. Example: true

method   string  optional  

Preferred MFA method. Example: email

Must be one of:
  • email
  • sms
  • otp

Generate recovery codes

requires authentication

Generate recovery codes for authenticated user and revoke old ones. User could use these codes in case when couldn't use any of MFA methods (e.g. lost device with OTP app or device is not accessible right now).

Example request:
curl --request GET \
    --get "http://localhost:8000/api/mfa/recovery-codes" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/mfa/recovery-codes"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "recovery_codes": [
        "A3H8PF8P",
        "IZ8CGK2H",
        "DTYENLLT",
        "0RKEZFST",
        "9MPW91BS",
        "S38Z6HS6",
        "UF5ATOKP",
        "HSZXP8EL",
        "ZZASRM6S",
        "07GR4CD1"
    ]
}

Request   

GET api/mfa/recovery-codes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Setup MFA OTP

requires authentication

Setup multi-factor authentication with one-time passwords (OTP). Use secret on your own or generate QR code with given url. Then user could scan QR code with authentication app (e.g. Microsoft Authenticator, Authy). If secret has been already generated, new secret will override existing one and revoke previous setup.

Example request:
curl --request POST \
    "http://localhost:8000/api/mfa/otp/setup" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/mfa/otp/setup"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "secret": "VXGJ6JMIAWWDFXYDLKO3VG3RSGTS34BGMVTGQIEHMVVMJ2JBGCSNPQZDV4B6OMDIGI4UKCVCVKVMA7EASLHZEJWW4ZNKLAUTSZYN7EA",
    "url": "otpauth://totp/AetherDigitalTherapy?issuer=AetherDigitalTherapy&secret=VXGJ6JMIAWWDFXYDLKO3VG3RSGTS34BGMVTGQIEHMVVMJ2JBGCSNPQZDV4B6OMDIGI4UKCVCVKVMA7EASLHZEJWW4ZNKLAUTSZYN7EA",
    "recovery_codes": [
        "A3H8PF8P",
        "IZ8CGK2H",
        "DTYENLLT",
        "0RKEZFST",
        "9MPW91BS",
        "S38Z6HS6",
        "UF5ATOKP",
        "HSZXP8EL",
        "ZZASRM6S",
        "07GR4CD1"
    ]
}

Request   

POST api/mfa/otp/setup

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Login user (SPA)

Authorize user and create cookie-based session. Hit GET /sanctum/csrf-cookie endpoint to retrieve XSRF-TOKEN cookie. Then attach X-XSRF-TOKEN HTTP header to any request to authorize. See more: Laravel Sanctum documentation

Example request:
curl --request POST \
    "http://localhost:8000/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"test@example.com\",
    \"password\": \"secretpassword\"
}"

const url = new URL(
    "http://localhost:8000/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "test@example.com",
    "password": "secretpassword"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 332,
    "mrn": "3T62H5FH1793015768",
    "name": "Ms. Wilhelmine Yundt PhD",
    "email": "1793015768destiney.carroll@example.com",
    "language": "en",
    "phone": "1-206-801-7905",
    "phone_country": "NZ",
    "phone_verified_at": null,
    "address1": "69868 Haag Tunnel Apt. 802",
    "address2": "Klingland, NH 30966-4251",
    "postal_code": "24659-3579",
    "city": "Willms Group",
    "country": "NO",
    "clinic_name": "North Alvafurt",
    "clinic_location": "5112 Amparo Village Suite 210\nFunkmouth, RI 27139",
    "image": null,
    "public_image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "is_ambassador": 0,
    "test_account": false,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2026-10-26T11:56:09.000000Z",
    "updated_at": "2026-10-26T11:56:09.000000Z",
    "invitation_status": null,
    "acadle_invitation_status": null,
    "roles": []
}

Example response (403, Too many attempts):


{
    "message": "Login: too many attempts",
    "code": "GENERAL:TOO_MANY_ATTEMPTS"
}

Example response (422, Invalid credentials):


{
    "message": "The given data was invalid.",
    "errors": {
        "email": [
            "Given credentials not found"
        ]
    },
    "code": "AUTH:LOGIN_COOKIE:INVALID_CREDENTIALS"
}

Request   

POST login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

User email. MUST_BE_EMAIL. Example: test@example.com

password   string   

User password. Example: secretpassword

Response

Response Fields

id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

Chat

API endpoints for chat management

Authorize a user

requires authentication

This method authorizes a user using Ably service. Endpoint used only by Ably SDK

Check more details on https://ably.com/docs/auth/token

Example request:
curl --request GET \
    --get "http://localhost:8000/api/chat/authorize-user" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/chat/authorize-user"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "api.responses.general.unauthenticated",
    "code": "GENERAL:UNAUTHENTICATED"
}

Request   

GET api/chat/authorize-user

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

List all chat rooms

requires authentication

This method retrieves all chat rooms. Possible extend options:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/chat/rooms" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/chat/rooms"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 100,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "owner": null,
            "patient_id": null,
            "encryption_key": "wpwADEkvcRT9l+3Qnfp3F4SCHuSep0rGg4uGCB4uSvk=",
            "name": "culpa",
            "friendly_name": "culpa",
            "created_at": "2026-10-26T11:55:45.000000Z",
            "deleted_at": null,
            "updated_at": "2026-10-26T11:55:45.000000Z"
        },
        {
            "id": 2,
            "owner": null,
            "patient_id": null,
            "encryption_key": "Xdp5k0hVExuva+HxgvEtF5OuvJODzhA2PALY0Iu2pGo=",
            "name": "sint",
            "friendly_name": "sint",
            "created_at": "2026-10-26T11:55:45.000000Z",
            "deleted_at": null,
            "updated_at": "2026-10-26T11:55:45.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list chat room",
    "code": "CHAT:LIST_ROOMS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/chat/rooms

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 100).

page   integer  optional  

Page number (Default: 1).

Response

Response Fields

items   object   
id   integer   

Chat room ID.

name   string   

Chat room name (channel SID).

friendly_name   string   

Human-readable chat room name.

owner   integer   

User ID of the room owner.

patient_id   integer   

Associated patient user ID.

encryption_key   string   

Encryption key for the chat room.

deleted_at   string   

Soft delete timestamp.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

messages   object[]   

Chat room messages.

last_message   object   

Last message in the chat room.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Retrieve a chat room

requires authentication

This method retrieves a single chat room identified by roomId. Possible extend options:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/chat/room/ut" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/chat/room/ut"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 3,
    "owner": null,
    "patient_id": null,
    "encryption_key": "E2gwvjoCWmP1kBnwjD1zWglWEEKAuczvlik96XyH9wc=",
    "name": "vel",
    "friendly_name": "vel",
    "created_at": "2026-10-26T11:55:46.000000Z",
    "deleted_at": null,
    "updated_at": "2026-10-26T11:55:46.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view chat room",
    "code": "CHAT:GET_ROOM:INSUFFICIENT_PERMISSION"
}

Example response (404, Chat room not found):


{
    "message": "Chat room not found",
    "code": "CHAT:GET_ROOM:ROOM_NOT_FOUND"
}

Request   

GET api/chat/room/{roomName}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

roomName   string   

Example: ut

Response

Response Fields

id   integer   

Chat room ID.

name   string   

Chat room name (channel SID).

friendly_name   string   

Human-readable chat room name.

owner   integer   

User ID of the room owner.

patient_id   integer   

Associated patient user ID.

encryption_key   string   

Encryption key for the chat room.

deleted_at   string   

Soft delete timestamp.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

messages   object[]   

Chat room messages.

last_message   object   

Last message in the chat room.

Create a new chat room

requires authentication

This method creates a new chat room using the authenticated user's ID, a name for the room, and a list of participants.

    The list of participants should contain the IDs of the users who will be participants in the room.
Example request:
curl --request POST \
    "http://localhost:8000/api/chat/room" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"owner\": 1,
    \"name\": \"my-chat\",
    \"patient_id\": 1,
    \"participants\": [
        \"1\"
    ]
}"

const url = new URL(
    "http://localhost:8000/api/chat/room"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "owner": 1,
    "name": "my-chat",
    "patient_id": 1,
    "participants": [
        "1"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 4,
    "owner": null,
    "patient_id": null,
    "encryption_key": "2qVQ7Ya+JQRvG2dvqbr0RhIKyOUTvLfLNEjp94vVqEw=",
    "name": "consequatur",
    "friendly_name": "consequatur",
    "created_at": "2026-10-26T11:55:46.000000Z",
    "deleted_at": null,
    "updated_at": "2026-10-26T11:55:46.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view chat room",
    "code": "CHAT:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/chat/room

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

owner   string   

The id of an existing record in the App\Models\User table. Example: 1

name   string   

Name of chat room. MAXIMUM:STRING_LENGTH:255. Example: my-chat

patient_id   string   

The id of an existing record in the App\Models\User table. Example: 1

participants   string[]  optional  

Chat room participant. The id of an existing record in the App\Models\User table.

Response

Response Fields

id   integer   

Chat room ID.

name   string   

Chat room name (channel SID).

friendly_name   string   

Human-readable chat room name.

owner   integer   

User ID of the room owner.

patient_id   integer   

Associated patient user ID.

encryption_key   string   

Encryption key for the chat room.

deleted_at   string   

Soft delete timestamp.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

messages   object[]   

Chat room messages.

last_message   object   

Last message in the chat room.

Update an existing chat room

requires authentication

This method updates an existing chat room using the authenticated user's ID, a new name for the room, and a list of participants.

    The list of participants should contain the IDs of the users who will be participants in the room.
Example request:
curl --request PUT \
    "http://localhost:8000/api/chat/room/quas" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"owner\": 1,
    \"name\": \"my-chat\",
    \"participants\": [
        \"1\"
    ],
    \"participants_del\": [
        \"1\"
    ]
}"

const url = new URL(
    "http://localhost:8000/api/chat/room/quas"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "owner": 1,
    "name": "my-chat",
    "participants": [
        "1"
    ],
    "participants_del": [
        "1"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 5,
    "owner": null,
    "patient_id": null,
    "encryption_key": "uWBRqEULlXDpnRWkIWZS6DBxgs/pO/S2Z0PWyFDdKSk=",
    "name": "et",
    "friendly_name": "et",
    "created_at": "2026-10-26T11:55:46.000000Z",
    "deleted_at": null,
    "updated_at": "2026-10-26T11:55:46.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update chat room",
    "code": "CHAT:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Chat room not found):


{
    "message": "Chat room not found",
    "code": "CHAT:UPDATE:ROOM_NOT_FOUND"
}

Request   

PUT api/chat/room/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the room. Example: quas

Body Parameters

owner   string  optional  

The id of an existing record in the App\Models\User table. Example: 1

name   string  optional  

Name of chat room. MAXIMUM:STRING_LENGTH:255. Example: my-chat

participants   string[]  optional  

Chat room participant. The id of an existing record in the App\Models\User table.

participants_del   string[]  optional  

Chat room participant to be deleted. The id of an existing record in the App\Models\User table.

Response

Response Fields

id   integer   

Chat room ID.

name   string   

Chat room name (channel SID).

friendly_name   string   

Human-readable chat room name.

owner   integer   

User ID of the room owner.

patient_id   integer   

Associated patient user ID.

encryption_key   string   

Encryption key for the chat room.

deleted_at   string   

Soft delete timestamp.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

messages   object[]   

Chat room messages.

last_message   object   

Last message in the chat room.

Chat room archives

requires authentication

Get archived messages for room Possible extend options:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/chat/room/aspernatur/archive" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/chat/room/aspernatur/archive"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "paginator": {
        "total": 1,
        "count": 1,
        "perpage": 5,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": "651a8e4868d5dc27c0000cc2",
            "channel": "chat.messages.room.44.56bf7d37-4ed6-4db4-947b-d68a1066677c.communication-channel",
            "clientId": "95",
            "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
            "data": "{\"encryptedMessage\":{\"message\":\"z6z1zNihCjlEePltz+BG8g==\",\"initialVector\":\"7376fcbf0b32fbdcd5c5b62c087b7600\"},\"user\":{\"id\":95,\"name\":\"Bartosz Druga firmaa\",\"email\":\"bartosz+drugafirma@refericon.pl\",\"image\":\"https://aether-dev-bucket.s3.amazonaws.com/users/7T6im01PAj4cahksWHllrL7se2SQ9buquIjGGFtp.jpg\",\"permissions\":[],\"roles\":[{\"id\":2,\"name\":\"Clinician\"}]},\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"recipients\":[{\"delivered\":true,\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"seen\":false,\"clientId\":\"95\"},{\"delivered\":true,\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"seen\":false,\"clientId\":\"44\"},{\"delivered\":true,\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"seen\":false,\"clientId\":\"1250\"},{\"delivered\":true,\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"seen\":false,\"clientId\":\"3067\"}]}",
            "name": "message",
            "recipients": [
                {
                    "delivered": true,
                    "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
                    "seen": true,
                    "clientId": "95"
                },
                {
                    "delivered": true,
                    "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
                    "seen": false,
                    "clientId": "44"
                },
                {
                    "delivered": true,
                    "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
                    "seen": false,
                    "clientId": "1250"
                },
                {
                    "delivered": true,
                    "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
                    "seen": false,
                    "clientId": "3067"
                }
            ],
            "timestamp": 1696239176715,
            "created_at": "2023-10-02 09:32:56"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view archived messages",
    "code": "CHAT:GET_ARCHIVES:INSUFFICIENT_PERMISSION"
}

Example response (404, Chat room not found):


{
    "message": "Chat room not found",
    "code": "CHAT:GET_ARCHIVES:ROOM_NOT_FOUND"
}

Request   

GET api/chat/room/{id}/archive

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the room. Example: aspernatur

Query Parameters

perpage   integer  optional  

Elements per page (Default: 100).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: author).

sortby   string  optional  

Sort by field (available: timestamp). Default: timestamp, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Unread messages

requires authentication

Get unread messaged for chat room. Possible extend options:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/chat/messages/unread?room=6" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/chat/messages/unread"
);

const params = {
    "room": "6",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "paginator": {
        "total": 1,
        "count": 1,
        "perpage": 5,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": "651a8e4868d5dc27c0000cc2",
            "channel": "chat.messages.room.44.56bf7d37-4ed6-4db4-947b-d68a1066677c.communication-channel",
            "clientId": "95",
            "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
            "data": "{\"encryptedMessage\":{\"message\":\"z6z1zNihCjlEePltz+BG8g==\",\"initialVector\":\"7376fcbf0b32fbdcd5c5b62c087b7600\"},\"user\":{\"id\":95,\"name\":\"Bartosz Druga firmaa\",\"email\":\"bartosz+drugafirma@refericon.pl\",\"image\":\"https://aether-dev-bucket.s3.amazonaws.com/users/7T6im01PAj4cahksWHllrL7se2SQ9buquIjGGFtp.jpg\",\"permissions\":[],\"roles\":[{\"id\":2,\"name\":\"Clinician\"}]},\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"recipients\":[{\"delivered\":true,\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"seen\":false,\"clientId\":\"95\"},{\"delivered\":true,\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"seen\":false,\"clientId\":\"44\"},{\"delivered\":true,\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"seen\":false,\"clientId\":\"1250\"},{\"delivered\":true,\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"seen\":false,\"clientId\":\"3067\"}]}",
            "name": "message",
            "recipients": [
                {
                    "delivered": true,
                    "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
                    "seen": true,
                    "clientId": "95"
                },
                {
                    "delivered": true,
                    "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
                    "seen": false,
                    "clientId": "44"
                },
                {
                    "delivered": true,
                    "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
                    "seen": false,
                    "clientId": "1250"
                },
                {
                    "delivered": true,
                    "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
                    "seen": false,
                    "clientId": "3067"
                }
            ],
            "timestamp": 1696239176715,
            "created_at": "2023-10-02 09:32:56"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view unread messages list",
    "code": "CHAT:UNREAD_MESSAGES:INSUFFICIENT_PERMISSION"
}

Request   

GET api/chat/messages/unread

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

room   integer  optional  

Filter unread messages by room. Provide single ID (room=1), array of IDs (room[]=1&room[]=2) or comma-separated list of IDs (room=1,2). Example: 6

perpage   integer  optional  

Elements per page (Default: 100).

page   integer  optional  

Page number (Default: 1).

Delete chat message

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/chat/messages/1?msgId=atque" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/chat/messages/1"
);

const params = {
    "msgId": "atque",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "paginator": {
        "total": 1,
        "count": 1,
        "perpage": 5,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": "651a8e4868d5dc27c0000cc2",
            "channel": "chat.messages.room.44.56bf7d37-4ed6-4db4-947b-d68a1066677c.communication-channel",
            "clientId": "95",
            "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
            "data": "{\"encryptedMessage\":{\"message\":\"z6z1zNihCjlEePltz+BG8g==\",\"initialVector\":\"7376fcbf0b32fbdcd5c5b62c087b7600\"},\"user\":{\"id\":95,\"name\":\"Bartosz Druga firmaa\",\"email\":\"bartosz+drugafirma@refericon.pl\",\"image\":\"https://aether-dev-bucket.s3.amazonaws.com/users/7T6im01PAj4cahksWHllrL7se2SQ9buquIjGGFtp.jpg\",\"permissions\":[],\"roles\":[{\"id\":2,\"name\":\"Clinician\"}]},\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"recipients\":[{\"delivered\":true,\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"seen\":false,\"clientId\":\"95\"},{\"delivered\":true,\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"seen\":false,\"clientId\":\"44\"},{\"delivered\":true,\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"seen\":false,\"clientId\":\"1250\"},{\"delivered\":true,\"msgId\":\"b8673175-01e6-4b6d-9032-226d3df20637\",\"seen\":false,\"clientId\":\"3067\"}]}",
            "name": "message",
            "recipients": [
                {
                    "delivered": true,
                    "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
                    "seen": true,
                    "clientId": "95"
                },
                {
                    "delivered": true,
                    "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
                    "seen": false,
                    "clientId": "44"
                },
                {
                    "delivered": true,
                    "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
                    "seen": false,
                    "clientId": "1250"
                },
                {
                    "delivered": true,
                    "msgId": "b8673175-01e6-4b6d-9032-226d3df20637",
                    "seen": false,
                    "clientId": "3067"
                }
            ],
            "timestamp": 1696239176715,
            "created_at": "2023-10-02 09:32:56"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete message",
    "code": "CHAT:DELETE_MESSAGE:INSUFFICIENT_PERMISSION"
}

Example response (404, Message not found):


{
    "message": "Chat message not found",
    "code": "CHAT:DELETE_MESSAGE:MESSAGE_NOT_FOUND"
}

Request   

DELETE api/chat/messages/{msgId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

msgId   integer   

Example: 1

Query Parameters

msgId   string   

Message ID. Example: atque

Get tickets list for chat room

requires authentication

Possible extend options:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/chat/tickets/ea?status=sit&sender=7&recipient=20" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/chat/tickets/ea"
);

const params = {
    "status": "sit",
    "sender": "7",
    "recipient": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 87,
            "sender_id": 293,
            "recipient_id": 294,
            "device_id": null,
            "meeting_date": "2026-10-26 11:55:46",
            "meeting_type": "online_meeting",
            "contact_email": "marilie.hagenes@yahoo.com",
            "status": "new",
            "created_at": "2026-10-26T11:55:47.000000Z",
            "updated_at": "2026-10-26T11:55:47.000000Z",
            "sender": {
                "id": 293,
                "mrn": "8H8NMTJ81793015746",
                "name": "Ms. Marisa Predovic III",
                "email": "1793015746kiehn.trevion@example.com",
                "language": "en",
                "phone": "+14589419454",
                "phone_country": "EE",
                "phone_verified_at": null,
                "address1": "8585 Violette Course Apt. 697",
                "address2": "Allisonburgh, NH 98632-7292",
                "postal_code": "79606",
                "city": "Reilly Inc",
                "country": "FR",
                "clinic_name": "Hettingermouth",
                "clinic_location": "7796 Volkman Plains\nNorth Saraibury, NE 53068",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:55:46.000000Z",
                "updated_at": "2026-10-26T11:55:46.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "recipient": {
                "id": 294,
                "mrn": "YPMDACST1793015746",
                "name": "Dr. Melany Kuphal II",
                "email": "1793015746rquitzon@example.com",
                "language": "en",
                "phone": "1-520-956-5412",
                "phone_country": "NO",
                "phone_verified_at": null,
                "address1": "40731 Albin Roads",
                "address2": "Kerlukeport, NH 36059-7541",
                "postal_code": "95924-0929",
                "city": "Walker LLC",
                "country": "PT",
                "clinic_name": "East Lulu",
                "clinic_location": "410 Trantow Roads Suite 427\nEast Chyna, HI 82325",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:55:46.000000Z",
                "updated_at": "2026-10-26T11:55:46.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "device": null,
            "messages": []
        },
        {
            "id": 88,
            "sender_id": 295,
            "recipient_id": 296,
            "device_id": null,
            "meeting_date": "2026-10-26 11:55:47",
            "meeting_type": "online_meeting",
            "contact_email": "madge73@gmail.com",
            "status": "new",
            "created_at": "2026-10-26T11:55:48.000000Z",
            "updated_at": "2026-10-26T11:55:48.000000Z",
            "sender": {
                "id": 295,
                "mrn": "UXZZAPNW1793015747",
                "name": "Dr. Norene Cremin",
                "email": "1793015747rosie.olson@example.org",
                "language": "en",
                "phone": "(469) 240-2081",
                "phone_country": "VC",
                "phone_verified_at": null,
                "address1": "46553 Dillan Ridges Apt. 923",
                "address2": "Farrellshire, WY 34342",
                "postal_code": "05767-0006",
                "city": "Abbott LLC",
                "country": "SK",
                "clinic_name": "Lake Antwonstad",
                "clinic_location": "125 Alanna Run\nMayerfort, ND 77091-3065",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:55:47.000000Z",
                "updated_at": "2026-10-26T11:55:47.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "recipient": {
                "id": 296,
                "mrn": "YG9LQTBT1793015747",
                "name": "Prof. Marcos DuBuque",
                "email": "1793015747oreichert@example.org",
                "language": "en",
                "phone": "515-727-3168",
                "phone_country": "NR",
                "phone_verified_at": null,
                "address1": "68118 Ebba Path Apt. 602",
                "address2": "East Timmy, GA 02806-2526",
                "postal_code": "43069",
                "city": "Wolf, Sauer and Weissnat",
                "country": "DK",
                "clinic_name": "Lake Chrisville",
                "clinic_location": "58722 Estrella Mission\nLake Shaina, IL 53813-5895",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:55:47.000000Z",
                "updated_at": "2026-10-26T11:55:47.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "device": null,
            "messages": []
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view chat room tickets",
    "code": "CHAT:LIST_TICKETS:INSUFFICIENT_PERMISSION"
}

Example response (404, Chat room not found):


{
    "message": "Chat room not found",
    "code": "CHAT:LIST_TICKETS:ROOM_NOT_FOUND"
}

Request   

GET api/chat/tickets/{roomId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

roomId   string   

Example: ea

Query Parameters

status   string  optional  

Filter tickets by status (available: new,in_progress,closed,reopened. Example: sit

sender   integer  optional  

Filter tickets by sender. Example: 7

recipient   integer  optional  

Filter tickets by recipient. Example: 20

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: sender, recipient, messages, messages.attachments, messages.sender).

sortby   string  optional  

Sort by field (available: date). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

Support ticket ID.

sender_id   integer   

ID of the user who created the ticket.

recipient_id   integer   

ID of the recipient user.

device_id   integer   

Associated device ID.

meeting_date   string   

Scheduled meeting date.

meeting_type   string   

Meeting type.

Must be one of:
  • online
  • in-person
contact_email   string   

Contact email address.

status   string   

Ticket status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

sender   object   

User who created the ticket.

recipient   object   

Recipient user.

device   object   

Associated device.

messages   object[]   

Ticket messages.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

List of available patients for chat

requires authentication

Possible extend options:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/chat/available-patients" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/chat/available-patients"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 297,
            "mrn": "6GNK8PRH1793015748",
            "name": "Grady Brekke",
            "email": "1793015748grady.haley@example.net",
            "language": "en",
            "phone": "+1.763.315.9683",
            "phone_country": "NZ",
            "phone_verified_at": null,
            "address1": "9327 Timmy Green",
            "address2": "Farrellview, TX 49890",
            "postal_code": "24707-6959",
            "city": "Satterfield, Ryan and Abbott",
            "country": "EE",
            "clinic_name": "Powlowskifurt",
            "clinic_location": "2781 McCullough Cove Suite 775\nEast Maverick, SC 55151",
            "image": null,
            "public_image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "is_ambassador": 0,
            "test_account": false,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2026-10-26T11:55:48.000000Z",
            "updated_at": "2026-10-26T11:55:48.000000Z",
            "invitation_status": "accepted",
            "acadle_invitation_status": null,
            "devices": [
                {
                    "id": 154,
                    "serial": "0c5ae6ac-958e-3a45-be36-4f1af0e1c52b",
                    "bluetooth_id": "477fdb00-761a-3df2-a089-5c8757cdadc5",
                    "company_id": null,
                    "model_id": null,
                    "amputee_id": 297,
                    "clinician_id": null,
                    "firmware_version_id": null,
                    "pcb_version_id": null,
                    "reverse_magnets": 0,
                    "is_electrode": 0,
                    "active": 1,
                    "last_activity_at": "0000-00-00 00:00:00",
                    "first_connected_at": null,
                    "measurements": null,
                    "created_at": "2026-10-26T11:55:48.000000Z",
                    "updated_at": "2026-10-26T11:55:48.000000Z",
                    "first_config_change_at": null
                }
            ],
            "roles": [
                {
                    "id": 4,
                    "name": "Clinician"
                }
            ]
        },
        {
            "id": 298,
            "mrn": "WJG27C621793015748",
            "name": "Dr. Sylvan Kertzmann",
            "email": "1793015748matteo43@example.net",
            "language": "en",
            "phone": "+16209206596",
            "phone_country": "IE",
            "phone_verified_at": null,
            "address1": "5828 Lacey Loop",
            "address2": "Greggmouth, NE 13837-4409",
            "postal_code": "23351",
            "city": "Corkery, Sauer and Jacobson",
            "country": "SI",
            "clinic_name": "West Michelside",
            "clinic_location": "710 Micah Unions Suite 986\nLednershire, WA 47104-5084",
            "image": null,
            "public_image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "is_ambassador": 0,
            "test_account": false,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2026-10-26T11:55:48.000000Z",
            "updated_at": "2026-10-26T11:55:48.000000Z",
            "invitation_status": null,
            "acadle_invitation_status": null,
            "devices": [
                {
                    "id": 155,
                    "serial": "3bbb41ca-02a8-30fc-bbba-3ddf4a6317e0",
                    "bluetooth_id": "a91d5d6b-8b8c-36b9-a145-47c268a0f0ee",
                    "company_id": null,
                    "model_id": null,
                    "amputee_id": 298,
                    "clinician_id": null,
                    "firmware_version_id": null,
                    "pcb_version_id": null,
                    "reverse_magnets": 0,
                    "is_electrode": 0,
                    "active": 1,
                    "last_activity_at": "0000-00-00 00:00:00",
                    "first_connected_at": null,
                    "measurements": null,
                    "created_at": "2026-10-26T11:55:49.000000Z",
                    "updated_at": "2026-10-26T11:55:49.000000Z",
                    "first_config_change_at": null
                }
            ],
            "roles": [
                {
                    "id": 6,
                    "name": "Amputee"
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list available patients",
    "code": "CHAT:LIST_PATIENTS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/chat/available-patients

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Response

Response Fields

items   object   
id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

List of available participants for chat

requires authentication

Possible extend options:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/chat/room/1/available-participants" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/chat/room/1/available-participants"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 299,
            "mrn": "7KYJQXX91793015749",
            "name": "Mr. David Rolfson MD",
            "email": "1793015749luettgen.kiana@example.net",
            "language": "en",
            "phone": "276.465.0308",
            "phone_country": "SZ",
            "phone_verified_at": null,
            "address1": "75129 Rogahn Spur Apt. 548",
            "address2": "South Lurline, RI 85787-7703",
            "postal_code": "26074-2592",
            "city": "Bernier-Weissnat",
            "country": "LU",
            "clinic_name": "Gersonville",
            "clinic_location": "2265 Kreiger Estate\nEast Adantown, MN 68496",
            "image": null,
            "public_image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "is_ambassador": 0,
            "test_account": false,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2026-10-26T11:55:49.000000Z",
            "updated_at": "2026-10-26T11:55:49.000000Z",
            "invitation_status": null,
            "acadle_invitation_status": null,
            "roles": [
                {
                    "id": 2,
                    "name": "CommunityAdmin"
                }
            ]
        },
        {
            "id": 300,
            "mrn": "Q4TF2J461793015749",
            "name": "Arturo Hermann",
            "email": "1793015749mafalda.price@example.org",
            "language": "en",
            "phone": "+1 (785) 521-2503",
            "phone_country": "SE",
            "phone_verified_at": null,
            "address1": "78185 Ortiz Station Suite 337",
            "address2": "Port Cordell, IL 57887-3143",
            "postal_code": "35648-1381",
            "city": "Streich-O'Conner",
            "country": "IN",
            "clinic_name": "Karinemouth",
            "clinic_location": "2228 Reynolds Meadows Suite 074\nLazaroside, IN 48458",
            "image": null,
            "public_image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "is_ambassador": 0,
            "test_account": false,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2026-10-26T11:55:49.000000Z",
            "updated_at": "2026-10-26T11:55:49.000000Z",
            "invitation_status": null,
            "acadle_invitation_status": null,
            "roles": [
                {
                    "id": 6,
                    "name": "Amputee"
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list available participants",
    "code": "CHAT:LIST_PARTICIPANTS:INSUFFICIENT_PERMISSION"
}

Example response (404, Chat room not found):


{
    "message": "Chat room not found",
    "code": "CHAT:LIST_PARTICIPANTS:ROOM_NOT_FOUND"
}

Request   

GET api/chat/room/{id}/available-participants

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Chat room ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: roles, permissions).

Response

Response Fields

items   object   
id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Community

Endpoints related to community videos

List community videos

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/community/videos?include_unpublished=" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/videos"
);

const params = {
    "include_unpublished": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 1,
        "count": 1,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "origin_region": "us",
            "request_id": "us-4428bf54-08a7-43ec-b312-54874c2ef5d8",
            "user_id": 1,
            "author_id": 2,
            "author_name": "Tom S.",
            "author_image": "https://example-bucket.s3.us-east-2.amazonaws.com/ambassadors/example.png",
            "video_url": "/videos/1215397088",
            "player_embed_url": "https://player.vimeo.com/video/1215397088?h=3bb25b045c",
            "thumbnail_url": "https://i.vimeocdn.com/video/2186556744-c0e3e0986946410a9a851a8b8acbc3be6c2b0e3b68ee0db18db107d0a1dd3204-d?region=us",
            "description": "community_videos.production.1",
            "translation_status": "SUCCESS",
            "processing_status": "ready",
            "published_at": "2026-07-31T12:59:20.000000Z",
            "created_at": "2026-07-31T12:59:20.000000Z",
            "updated_at": "2026-07-31T12:59:20.000000Z",
            "status": "published"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view community videos",
    "code": "COMMUNITY_VIDEOS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/community/videos

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

include_unpublished   boolean  optional  

SuperAdmin/CommunityAdmin only: Include videos regardless of publish status (draft/uploading/processing/scheduled/unpublished/failed). Example: false

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: categories, comments, reactions).

Get community video

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/community/videos/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/videos/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "origin_region": "us",
    "request_id": "us-4428bf54-08a7-43ec-b312-54874c2ef5d8",
    "user_id": 1,
    "author_id": 2,
    "author_name": "Tom S.",
    "author_image": "https://example-bucket.s3.us-east-2.amazonaws.com/ambassadors/example.png",
    "video_url": "/videos/1215397088",
    "player_embed_url": "https://player.vimeo.com/video/1215397088?h=3bb25b045c",
    "thumbnail_url": "https://i.vimeocdn.com/video/2186556744-c0e3e0986946410a9a851a8b8acbc3be6c2b0e3b68ee0db18db107d0a1dd3204-d?region=us",
    "description": "community_videos.production.1",
    "translation_status": "SUCCESS",
    "processing_status": "ready",
    "published_at": "2026-07-31T12:59:20.000000Z",
    "created_at": "2026-07-31T12:59:20.000000Z",
    "updated_at": "2026-07-31T12:59:20.000000Z",
    "status": "published"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view community videos",
    "code": "COMMUNITY_VIDEOS:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Video not found):


{
    "message": "Community video not found",
    "code": "COMMUNITY_VIDEOS:GET:VIDEO_NOT_FOUND"
}

Request   

GET api/community/videos/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community video ID. Example: 1

Query Parameters

extend   string  optional  

Comma-separated list of relation extensions (available: categories, comments, reactions).

Upload community video

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/community/videos" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "author_id=1"\
    --form "description=A short clip about adapting to a new prosthesis."\
    --form "video=@/tmp/phpAqSOol" 
const url = new URL(
    "http://localhost:8000/api/community/videos"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('author_id', '1');
body.append('description', 'A short clip about adapting to a new prosthesis.');
body.append('video', document.querySelector('input[name="video"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_VIDEOS:UPLOAD:INSUFFICIENT_PERMISSION"
}

Request   

POST api/community/videos

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

video   file   

Video file. Any format accepted by Vimeo, max 500MB. Must be a file. MAXIMUM:FILE_KB:512000. Example: /tmp/phpAqSOol

author_id   integer   

ID of the community ambassador shown as the video author. This is the id field returned by GET /community/ambassadors (a shared, cross-region ambassador ID) — not a regional user ID. Example: 1

description   string  optional  

Video description (source text sent to SimpleLocalize for translation). Example: A short clip about adapting to a new prosthesis.

Update community video

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/community/videos/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"author_id\": 1,
    \"description\": \"A short clip about adapting to a new prosthesis.\"
}"

const url = new URL(
    "http://localhost:8000/api/community/videos/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "author_id": 1,
    "description": "A short clip about adapting to a new prosthesis."
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 1,
    "origin_region": "us",
    "request_id": "us-4428bf54-08a7-43ec-b312-54874c2ef5d8",
    "user_id": 1,
    "author_id": 2,
    "author_name": "Tom S.",
    "author_image": "https://example-bucket.s3.us-east-2.amazonaws.com/ambassadors/example.png",
    "video_url": "/videos/1215397088",
    "player_embed_url": "https://player.vimeo.com/video/1215397088?h=3bb25b045c",
    "thumbnail_url": "https://i.vimeocdn.com/video/2186556744-c0e3e0986946410a9a851a8b8acbc3be6c2b0e3b68ee0db18db107d0a1dd3204-d?region=us",
    "description": "community_videos.production.us.1",
    "translation_status": "STARTED",
    "processing_status": "ready",
    "published_at": "2026-07-31T12:59:20.000000Z",
    "created_at": "2026-07-31T12:59:20.000000Z",
    "updated_at": "2026-07-31T12:59:20.000000Z",
    "status": "published"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_VIDEOS:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Video not found):


{
    "message": "Community video not found",
    "code": "COMMUNITY_VIDEOS:UPDATE:VIDEO_NOT_FOUND"
}

Request   

PUT api/community/videos/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community video ID. Example: 1

Body Parameters

author_id   integer  optional  

ID of the community ambassador shown as the video author. This is the id field returned by GET /community/ambassadors (a shared, cross-region ambassador ID) — not a regional user ID. Example: 1

description   string  optional  

Video description. Example: A short clip about adapting to a new prosthesis.

Publish community video

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/community/videos/1/publish" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"published_at\": \"2026-08-25 12:00:00\"
}"

const url = new URL(
    "http://localhost:8000/api/community/videos/1/publish"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "published_at": "2026-08-25 12:00:00"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "origin_region": "us",
    "request_id": "us-4428bf54-08a7-43ec-b312-54874c2ef5d8",
    "user_id": 1,
    "author_id": 2,
    "author_name": "Tom S.",
    "author_image": "https://example-bucket.s3.us-east-2.amazonaws.com/ambassadors/example.png",
    "video_url": "/videos/1215397088",
    "player_embed_url": "https://player.vimeo.com/video/1215397088?h=3bb25b045c",
    "thumbnail_url": "https://i.vimeocdn.com/video/2186556744-c0e3e0986946410a9a851a8b8acbc3be6c2b0e3b68ee0db18db107d0a1dd3204-d?region=us",
    "description": "community_videos.production.us.1",
    "translation_status": "SUCCESS",
    "processing_status": "ready",
    "published_at": "2026-07-31T12:59:20.000000Z",
    "created_at": "2026-07-31T12:59:20.000000Z",
    "updated_at": "2026-07-31T12:59:20.000000Z",
    "status": "published"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_VIDEOS:PUBLISH:INSUFFICIENT_PERMISSION"
}

Example response (404, Video not found):


{
    "message": "Community video not found",
    "code": "COMMUNITY_VIDEOS:PUBLISH:VIDEO_NOT_FOUND"
}

Request   

POST api/community/videos/{id}/publish

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community video ID. Example: 1

Body Parameters

published_at   string  optional  

Date and time to publish the video at. A future date schedules the video. If not present, the video is published immediately. MUST_BE_DATE. Example: 2026-08-25 12:00:00

Unpublish community video

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/community/videos/1/unpublish" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/videos/1/unpublish"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "origin_region": "us",
    "request_id": "us-4428bf54-08a7-43ec-b312-54874c2ef5d8",
    "user_id": 1,
    "author_id": 2,
    "author_name": "Tom S.",
    "author_image": "https://example-bucket.s3.us-east-2.amazonaws.com/ambassadors/example.png",
    "video_url": "/videos/1215397088",
    "player_embed_url": "https://player.vimeo.com/video/1215397088?h=3bb25b045c",
    "thumbnail_url": "https://i.vimeocdn.com/video/2186556744-c0e3e0986946410a9a851a8b8acbc3be6c2b0e3b68ee0db18db107d0a1dd3204-d?region=us",
    "description": "community_videos.production.us.1",
    "translation_status": "SUCCESS",
    "processing_status": "ready",
    "published_at": "9999-12-31T23:59:59.000000Z",
    "created_at": "2026-07-31T12:59:20.000000Z",
    "updated_at": "2026-07-31T12:59:20.000000Z",
    "status": "unpublished"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_VIDEOS:UNPUBLISH:INSUFFICIENT_PERMISSION"
}

Example response (404, Video not found):


{
    "message": "Community video not found",
    "code": "COMMUNITY_VIDEOS:UNPUBLISH:VIDEO_NOT_FOUND"
}

Request   

POST api/community/videos/{id}/unpublish

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community video ID. Example: 1

React to community video

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/community/videos/1/react" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/videos/1/react"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, Current reaction state):


{
    "status": true
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to react to community videos",
    "code": "COMMUNITY_VIDEOS:REACT:INSUFFICIENT_PERMISSION"
}

Example response (404, Video not found):


{
    "message": "Community video not found",
    "code": "COMMUNITY_VIDEOS:REACT:VIDEO_NOT_FOUND"
}

Request   

POST api/community/videos/{id}/react

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community video ID. Example: 1

Update community video categories

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/community/videos/1/categories" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"categories\": [
        1,
        2
    ]
}"

const url = new URL(
    "http://localhost:8000/api/community/videos/1/categories"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "categories": [
        1,
        2
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "origin_region": "us",
    "request_id": "us-4428bf54-08a7-43ec-b312-54874c2ef5d8",
    "user_id": 1,
    "author_id": 2,
    "author_name": "Tom S.",
    "author_image": "https://example-bucket.s3.us-east-2.amazonaws.com/ambassadors/example.png",
    "video_url": "/videos/1215397088",
    "player_embed_url": "https://player.vimeo.com/video/1215397088?h=3bb25b045c",
    "thumbnail_url": "https://i.vimeocdn.com/video/2186556744-c0e3e0986946410a9a851a8b8acbc3be6c2b0e3b68ee0db18db107d0a1dd3204-d?region=us",
    "description": "community_videos.production.1",
    "translation_status": "SUCCESS",
    "processing_status": "ready",
    "published_at": "2026-07-31T12:59:20.000000Z",
    "created_at": "2026-07-31T12:59:20.000000Z",
    "updated_at": "2026-07-31T12:59:20.000000Z",
    "status": "published",
    "categories": [
        {
            "id": 1,
            "name": "community_categories.production.1",
            "is_archived": false,
            "translation_status": "SUCCESS",
            "created_at": "2026-07-31T12:59:20.000000Z",
            "updated_at": "2026-07-31T12:59:20.000000Z",
            "thumbnail_url": "https://i.vimeocdn.com/video/2186556744-c0e3e0986946410a9a851a8b8acbc3be6c2b0e3b68ee0db18db107d0a1dd3204-d?region=us"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_VIDEOS:UPDATE_CATEGORIES:INSUFFICIENT_PERMISSION"
}

Example response (404, Video not found):


{
    "message": "Community video not found",
    "code": "COMMUNITY_VIDEOS:UPDATE_CATEGORIES:VIDEO_NOT_FOUND"
}

Request   

PUT api/community/videos/{id}/categories

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community video ID. Example: 1

Body Parameters

categories   integer[]   

Full list of category IDs to assign to the video (max 2). Replaces the existing set entirely — send the complete desired list, not just additions. An empty array removes all categories from the video.

List community categories

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/community/categories" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/categories"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 1,
        "count": 1,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "name": "community_categories.production.us.1",
            "is_archived": false,
            "translation_status": "SUCCESS",
            "created_at": "2026-07-31T12:59:20.000000Z",
            "updated_at": "2026-07-31T12:59:20.000000Z",
            "thumbnail_url": "https://i.vimeocdn.com/video/2186556744-c0e3e0986946410a9a851a8b8acbc3be6c2b0e3b68ee0db18db107d0a1dd3204-d_540x960?region=us"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view community videos",
    "code": "COMMUNITY_CATEGORIES:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/community/categories

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Create community category

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/community/categories" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Sports\"
}"

const url = new URL(
    "http://localhost:8000/api/community/categories"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Sports"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 1,
    "name": "community_categories.production.us.1",
    "is_archived": false,
    "translation_status": "STARTED",
    "created_at": "2026-07-31T12:59:20.000000Z",
    "updated_at": "2026-07-31T12:59:20.000000Z",
    "thumbnail_url": null
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_CATEGORIES:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/community/categories

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Category name. Example: Sports

Update community category

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/community/categories/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Sports\"
}"

const url = new URL(
    "http://localhost:8000/api/community/categories/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Sports"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 1,
    "name": "community_categories.production.us.1",
    "is_archived": false,
    "translation_status": "STARTED",
    "created_at": "2026-07-31T12:59:20.000000Z",
    "updated_at": "2026-08-14T09:00:00.000000Z",
    "thumbnail_url": "https://i.vimeocdn.com/video/2186556744-c0e3e0986946410a9a851a8b8acbc3be6c2b0e3b68ee0db18db107d0a1dd3204-d_540x960?region=us"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_CATEGORIES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Category not found):


{
    "message": "Community category not found",
    "code": "COMMUNITY_CATEGORIES:UPDATE:CATEGORY_NOT_FOUND"
}

Request   

PUT api/community/categories/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community category ID. Example: 1

Body Parameters

name   string  optional  

Category name. Example: Sports

Archive community category

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/community/categories/1/archive" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/categories/1/archive"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "name": "community_categories.production.us.1",
    "is_archived": true,
    "translation_status": "SUCCESS",
    "created_at": "2026-07-31T12:59:20.000000Z",
    "updated_at": "2026-08-14T09:00:00.000000Z",
    "thumbnail_url": "https://i.vimeocdn.com/video/2186556744-c0e3e0986946410a9a851a8b8acbc3be6c2b0e3b68ee0db18db107d0a1dd3204-d_540x960?region=us"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_CATEGORIES:ARCHIVE:INSUFFICIENT_PERMISSION"
}

Example response (404, Category not found):


{
    "message": "Community category not found",
    "code": "COMMUNITY_CATEGORIES:ARCHIVE:CATEGORY_NOT_FOUND"
}

Request   

POST api/community/categories/{id}/archive

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community category ID. Example: 1

Unarchive community category

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/community/categories/1/unarchive" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/categories/1/unarchive"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "name": "community_categories.production.us.1",
    "is_archived": false,
    "translation_status": "SUCCESS",
    "created_at": "2026-07-31T12:59:20.000000Z",
    "updated_at": "2026-08-14T09:00:00.000000Z",
    "thumbnail_url": "https://i.vimeocdn.com/video/2186556744-c0e3e0986946410a9a851a8b8acbc3be6c2b0e3b68ee0db18db107d0a1dd3204-d_540x960?region=us"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_CATEGORIES:UNARCHIVE:INSUFFICIENT_PERMISSION"
}

Example response (404, Category not found):


{
    "message": "Community category not found",
    "code": "COMMUNITY_CATEGORIES:UNARCHIVE:CATEGORY_NOT_FOUND"
}

Request   

POST api/community/categories/{id}/unarchive

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community category ID. Example: 1

List community category suggestions

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/community/categories/suggestions" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/categories/suggestions"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 1,
        "count": 1,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "origin_region": "us",
            "request_id": "us-4428bf54-08a7-43ec-b312-54874c2ef5d8",
            "user_id": 1,
            "search_term": "Swimming",
            "created_at": "2026-08-14T09:00:00.000000Z",
            "updated_at": "2026-08-14T09:00:00.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_CATEGORY_SUGGESTIONS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/community/categories/suggestions

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Create community category suggestion

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/community/categories/suggestions" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"search_term\": \"Swimming\"
}"

const url = new URL(
    "http://localhost:8000/api/community/categories/suggestions"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "search_term": "Swimming"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 1,
    "origin_region": "us",
    "request_id": "us-4428bf54-08a7-43ec-b312-54874c2ef5d8",
    "user_id": 1,
    "search_term": "Swimming",
    "created_at": "2026-08-14T09:00:00.000000Z",
    "updated_at": "2026-08-14T09:00:00.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to suggest community categories",
    "code": "COMMUNITY_CATEGORY_SUGGESTIONS:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/community/categories/suggestions

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

search_term   string   

Category name the patient searched for. Example: Swimming

List all community comments

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/community/comments?status[]=pending&status[]=rejected" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/comments"
);

const params = {
    "status[0]": "pending",
    "status[1]": "rejected",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 3,
        "count": 3,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "video_id": 1,
            "parent_comment_id": null,
            "display_name": "John D.",
            "is_ambassador": false,
            "content": "Great video, thank you!",
            "status": "approved",
            "rejection_reason": null,
            "created_at": "2026-07-31T12:59:20.000000Z",
            "updated_at": "2026-07-31T12:59:20.000000Z"
        },
        {
            "id": 2,
            "video_id": 2,
            "parent_comment_id": null,
            "display_name": "Anna K.",
            "is_ambassador": false,
            "content": "How long did it take you to get used to the prosthesis?",
            "status": "pending",
            "rejection_reason": null,
            "created_at": "2026-08-05T09:12:00.000000Z",
            "updated_at": "2026-08-05T09:12:00.000000Z"
        },
        {
            "id": 5,
            "video_id": 1,
            "parent_comment_id": 1,
            "display_name": "John D.",
            "is_ambassador": false,
            "content": "Great video, thank you so much!",
            "status": "pending",
            "rejection_reason": null,
            "created_at": "2026-09-10T14:30:00.000000Z",
            "updated_at": "2026-09-10T14:30:00.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_COMMENTS:LIST_ALL:INSUFFICIENT_PERMISSION"
}

Request   

GET api/community/comments

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

status   string[]  optional  

Filter comments by status. Provide array of values (status[]=pending&status[]=rejected). Omit entirely to return comments with all statuses (pending, approved, rejected).

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

sortby   string  optional  

Sort by field (available: date). Default: date, asc.

sortdir   string  optional  

Sort direction (available: asc, desc).

List community comments

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/community/videos/1/comments" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/videos/1/comments"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 1,
        "count": 1,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "video_id": 1,
            "parent_comment_id": null,
            "display_name": "John D.",
            "is_ambassador": false,
            "content": "Great video, thank you!",
            "status": "approved",
            "rejection_reason": null,
            "created_at": "2026-07-31T12:59:20.000000Z",
            "updated_at": "2026-07-31T12:59:20.000000Z"
        }
    ],
    "items_pending": [],
    "items_rejected": []
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to comment on community videos",
    "code": "COMMUNITY_COMMENTS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/community/videos/{id}/comments

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community video ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

sortby   string  optional  

Sort by field (available: date). Default: date, asc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Create community comment

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/community/videos/1/comments" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"content\": \"Great video, thank you!\"
}"

const url = new URL(
    "http://localhost:8000/api/community/videos/1/comments"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "content": "Great video, thank you!"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 1,
    "video_id": 1,
    "parent_comment_id": null,
    "display_name": "John D.",
    "is_ambassador": false,
    "content": "Great video, thank you!",
    "status": "pending",
    "rejection_reason": null,
    "created_at": "2026-07-31T12:59:20.000000Z",
    "updated_at": "2026-07-31T12:59:20.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to comment on community videos",
    "code": "COMMUNITY_COMMENTS:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/community/videos/{id}/comments

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community video ID. Example: 1

Body Parameters

content   string   

Comment content. Example: Great video, thank you!

Update community comment

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/community/videos/1/comments/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"content\": \"Great video, thank you!\"
}"

const url = new URL(
    "http://localhost:8000/api/community/videos/1/comments/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "content": "Great video, thank you!"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 2,
    "video_id": 1,
    "parent_comment_id": 1,
    "display_name": "John D.",
    "is_ambassador": false,
    "content": "Great video, thank you! (edited)",
    "status": "pending",
    "rejection_reason": null,
    "created_at": "2026-07-31T12:59:20.000000Z",
    "updated_at": "2026-07-31T12:59:20.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to comment on community videos",
    "code": "COMMUNITY_COMMENTS:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Comment not found):


{
    "message": "Community comment not found",
    "code": "COMMUNITY_COMMENTS:UPDATE:COMMENT_NOT_FOUND"
}

Request   

PUT api/community/videos/{id}/comments/{commentId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community video ID. Example: 1

commentId   integer   

Community comment ID. Example: 1

Body Parameters

content   string   

Comment content. Example: Great video, thank you!

Delete community comment

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/community/videos/1/comments/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/videos/1/comments/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Community comment deleted"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to comment on community videos",
    "code": "COMMUNITY_COMMENTS:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Comment not found):


{
    "message": "Community comment not found",
    "code": "COMMUNITY_COMMENTS:DELETE:COMMENT_NOT_FOUND"
}

Request   

DELETE api/community/videos/{id}/comments/{commentId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community video ID. Example: 1

commentId   integer   

Community comment ID. Example: 1

Approve community comment

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/community/videos/1/comments/1/approve" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/videos/1/comments/1/approve"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "video_id": 1,
    "parent_comment_id": null,
    "display_name": "John D.",
    "is_ambassador": false,
    "content": "Great video, thank you!",
    "status": "approved",
    "rejection_reason": null,
    "created_at": "2026-07-31T12:59:20.000000Z",
    "updated_at": "2026-07-31T12:59:20.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_COMMENTS:APPROVE:INSUFFICIENT_PERMISSION"
}

Example response (404, Comment not found):


{
    "message": "Community comment not found",
    "code": "COMMUNITY_COMMENTS:APPROVE:COMMENT_NOT_FOUND"
}

Request   

POST api/community/videos/{id}/comments/{commentId}/approve

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community video ID. Example: 1

commentId   integer   

Community comment ID. Example: 1

Reject community comment

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/community/videos/1/comments/1/reject" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reason\": \"Contains inappropriate language.\"
}"

const url = new URL(
    "http://localhost:8000/api/community/videos/1/comments/1/reject"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reason": "Contains inappropriate language."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "video_id": 1,
    "parent_comment_id": null,
    "display_name": "John D.",
    "is_ambassador": false,
    "content": "Great video, thank you!",
    "status": "rejected",
    "rejection_reason": "Contains inappropriate language.",
    "created_at": "2026-07-31T12:59:20.000000Z",
    "updated_at": "2026-07-31T12:59:20.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_COMMENTS:REJECT:INSUFFICIENT_PERMISSION"
}

Example response (404, Comment not found):


{
    "message": "Community comment not found",
    "code": "COMMUNITY_COMMENTS:REJECT:COMMENT_NOT_FOUND"
}

Request   

POST api/community/videos/{id}/comments/{commentId}/reject

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Community video ID. Example: 1

commentId   integer   

Community comment ID. Example: 1

Body Parameters

reason   string   

Reason for rejecting the comment. Example: Contains inappropriate language.

Get community statistics

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/community/statistics?date_from=2026-08-10&date_to=2026-08-14" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/statistics"
);

const params = {
    "date_from": "2026-08-10",
    "date_to": "2026-08-14",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "date_from": "2026-08-10",
    "date_to": "2026-08-14",
    "engaged_users_count": 42,
    "content_resonance_percent": 63.5,
    "push_uploads_percent": 27.3
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_STATISTICS:GET:INSUFFICIENT_PERMISSION"
}

Request   

GET api/community/statistics

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

date_from   string  optional  

Start date (Y-m-d). Defaults to the start of the current ISO week (UTC). Example: 2026-08-10

date_to   string  optional  

End date (Y-m-d). Defaults to now. Example: 2026-08-14

Record community tab open

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/community/statistics/tab-open" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/statistics/tab-open"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Community statistic recorded",
    "code": "COMMUNITY_STATISTICS:RECORD:SUCCESS"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view community videos",
    "code": "COMMUNITY_STATISTICS:TAB_OPEN:INSUFFICIENT_PERMISSION"
}

Request   

POST api/community/statistics/tab-open

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

List community ambassadors

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/community/ambassadors" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/community/ambassadors"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 1,
        "count": 1,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "origin_region": "us",
            "user_id": 1,
            "name": "Tom S.",
            "public_image": "https://example-bucket.s3.us-east-2.amazonaws.com/ambassadors/example.png"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_AMBASSADORS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/community/ambassadors

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Upload ambassador public image

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/community/ambassadors/1/public-image" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "public_image=@/tmp/phprcOY07" 
const url = new URL(
    "http://localhost:8000/api/community/ambassadors/1/public-image"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('public_image', document.querySelector('input[name="public_image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "id": 331,
    "name": "Herbert Muller",
    "public_image": null
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage community videos",
    "code": "COMMUNITY_AMBASSADORS:UPLOAD_PUBLIC_IMAGE:INSUFFICIENT_PERMISSION"
}

Example response (403, User is not an ambassador):


{
    "message": "This user is not a community ambassador",
    "code": "COMMUNITY_AMBASSADORS:UPLOAD_PUBLIC_IMAGE:NOT_AN_AMBASSADOR"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "COMMUNITY_AMBASSADORS:UPLOAD_PUBLIC_IMAGE:USER_NOT_FOUND"
}

Request   

POST api/community/ambassadors/{id}/public-image

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

id   integer   

Ambassador's regional user ID (only works for ambassadors native to this region — not the shared ambassador id used as a video's author_id). Example: 1

Body Parameters

public_image   file   

Public avatar image file. MUST_BE_IMAGE MAXIMUM:FILE_KB:5120. Example: /tmp/phprcOY07

Response

Response Fields

id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

Config

API endpoints for device config management

Get device config

requires authentication

Definitions:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1/config?_format=illum" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/config"
);

const params = {
    "_format": "illum",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, Normal/compact response):


{
    "common": {
        "gripPairsConfig": [
            1,
            4,
            2,
            3,
            6,
            7,
            9,
            8
        ],
        "controlConfig": [
            0,
            1,
            0,
            0,
            0
        ],
        "emgThresholds": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
        ],
        "interval": [
            100
        ],
        "gripSequentialConfig": [
            1,
            2,
            4,
            3,
            0,
            255,
            6,
            7,
            9,
            8,
            255,
            255
        ]
    },
    "modes": [
        {
            "id": 100,
            "name": "Mode 1",
            "slot": 0,
            "config": {
                "interval": [
                    300
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        },
        {
            "id": 101,
            "name": "Mode 2",
            "slot": 1,
            "config": {
                "interval": [
                    400
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        },
        {
            "id": 102,
            "name": "Mode 3",
            "slot": 2,
            "config": {
                "interval": [
                    500
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        }
    ]
}

Example response (200):


[
    {
        "id": 1,
        "device_id": 22,
        "mode_id": 1,
        "key": "voluptatibus",
        "value": "ea",
        "created_at": "2026-10-26T11:53:36.000000Z",
        "updated_at": "2026-10-26T11:53:36.000000Z",
        "mode": {
            "id": 1,
            "device_id": 23,
            "slot": null,
            "name": "Dolorem fugit non molestias dolor doloribus et voluptatem.",
            "active": 1,
            "created_at": "2026-10-26T11:53:36.000000Z",
            "updated_at": "2026-10-26T11:53:36.000000Z"
        }
    },
    {
        "id": 2,
        "device_id": 24,
        "mode_id": 2,
        "key": "maiores",
        "value": "commodi",
        "created_at": "2026-10-26T11:53:36.000000Z",
        "updated_at": "2026-10-26T11:53:36.000000Z",
        "mode": {
            "id": 2,
            "device_id": 25,
            "slot": null,
            "name": "Molestiae dolore officia aperiam amet id odit aut.",
            "active": 0,
            "created_at": "2026-10-26T11:53:36.000000Z",
            "updated_at": "2026-10-26T11:53:36.000000Z"
        }
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view device config",
    "code": "CONFIG:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG:GET:DEVICE_NOT_FOUND"
}

Request   

GET api/device/{deviceId}/config

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Query Parameters

_format   string  optional  

Config format. Pass collection to receive config as resource collection. Example: illum

Response

Response Fields

id   integer   

Config entry ID.

device_id   integer   

Associated device ID.

mode_id   integer   

Associated config mode ID.

key   string   

Config key.

value   string   

Config value.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

mode   object   

Associated config mode.

Update device config

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/config" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Remote session 2022-05-30\",
    \"common\": \"{\\\"gripPairsConfig\\\": [1, 4, 2, 3, 6, 7, 9, 8], \\\"controlConfig\\\": [0, 1, 0, 0, 0], \\\"gripSequentialConfig\\\": [1, 2, 4, 3, 0, 255, 6, 7, 9, 8, 255, 255]\",
    \"updateNote\": true,
    \"source\": \"guide\",
    \"modes\": [
        {
            \"id\": 1,
            \"config\": \"{\\\"gripPairsConfig\\\": [1, 4, 2, 3, 6, 7, 9, 8], \\\"controlConfig\\\": [0, 1, 0, 0, 0], \\\"gripSequentialConfig\\\": [1, 2, 4, 3, 0, 255, 6, 7, 9, 8, 255, 255]\"
        }
    ]
}"

const url = new URL(
    "http://localhost:8000/api/device/1/config"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Remote session 2022-05-30",
    "common": "{\"gripPairsConfig\": [1, 4, 2, 3, 6, 7, 9, 8], \"controlConfig\": [0, 1, 0, 0, 0], \"gripSequentialConfig\": [1, 2, 4, 3, 0, 255, 6, 7, 9, 8, 255, 255]",
    "updateNote": true,
    "source": "guide",
    "modes": [
        {
            "id": 1,
            "config": "{\"gripPairsConfig\": [1, 4, 2, 3, 6, 7, 9, 8], \"controlConfig\": [0, 1, 0, 0, 0], \"gripSequentialConfig\": [1, 2, 4, 3, 0, 255, 6, 7, 9, 8, 255, 255]"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "common": {
        "gripPairsConfig": [
            1,
            4,
            2,
            3,
            6,
            7,
            9,
            8
        ],
        "controlConfig": [
            0,
            1,
            0,
            0,
            0
        ],
        "emgThresholds": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
        ],
        "interval": [
            100
        ],
        "gripSequentialConfig": [
            1,
            2,
            4,
            3,
            0,
            255,
            6,
            7,
            9,
            8,
            255,
            255
        ]
    },
    "modes": [
        {
            "id": 100,
            "name": "Mode 1",
            "slot": 0,
            "config": {
                "interval": [
                    300
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        },
        {
            "id": 101,
            "name": "Mode 2",
            "slot": 1,
            "config": {
                "interval": [
                    400
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        },
        {
            "id": 102,
            "name": "Mode 3",
            "slot": 2,
            "config": {
                "interval": [
                    500
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update device config",
    "code": "CONFIG:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG:UPDATE:DEVICE_NOT_FOUND"
}

Example response (422, Invalid config):


{
    "message": "Config has some problems and cannot be saved.",
    "errors": {
        "modes": {
            "mode_3": "Config mode 3 does not belong to device 12."
        },
        "values": {
            "common.inputSite": "Invalid value [\"11\"] for key inputSite - contains string values.",
            "common.gripsPositions.1.initial": "Invalid value [200,\"100\",\"100\",\"100\",\"100\"] for key gripsPositions.1.initial - contains string values.",
            "mode_1.inputSite": "Invalid value [\"11\"] for key inputSite - contains string values.",
            "mode_1.gripsPositions.0.initial": "Invalid value [\"200\",\"100\",\"100\",\"100\",\"100\"] for key gripsPositions.1.initial - contains string values."
        }
    },
    "code": "CONFIG:UPDATE:INVALID_CONFIG"
}

Request   

POST api/device/{deviceId}/config

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Body Parameters

name   string  optional  

Config history entry name (session name). Example: Remote session 2022-05-30

common   string  optional  

Common config as JSON string. MUST_BE_JSON. Example: {"gripPairsConfig": [1, 4, 2, 3, 6, 7, 9, 8], "controlConfig": [0, 1, 0, 0, 0], "gripSequentialConfig": [1, 2, 4, 3, 0, 255, 6, 7, 9, 8, 255, 255]

updateNote   boolean  optional  

Add config history note with content equal to name parameter. Example: true

source   string  optional  

Where this config save was initiated from. Defaults to configurator when not present. Example: guide

Must be one of:
  • configurator
  • guide
  • mobile
modes   object[]  optional  
id   string  optional  

Config mode ID. The id of an existing record in the App\Models\ConfigMode table. Example: 1

config   string  optional  

Config specific for mode as JSON string. MUST_BE_JSON. Example: {"gripPairsConfig": [1, 4, 2, 3, 6, 7, 9, 8], "controlConfig": [0, 1, 0, 0, 0], "gripSequentialConfig": [1, 2, 4, 3, 0, 255, 6, 7, 9, 8, 255, 255]

Get device config history

requires authentication

For amputees only restore points are returned.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1/config/history?restore_point=1&factory_reset_point=1&date_from=1642003200&date_to=1642003200" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"restore_point\": false,
    \"factory_reset_point\": true
}"

const url = new URL(
    "http://localhost:8000/api/device/1/config/history"
);

const params = {
    "restore_point": "1",
    "factory_reset_point": "1",
    "date_from": "1642003200",
    "date_to": "1642003200",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "restore_point": false,
    "factory_reset_point": true
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, Normal/compact response):


{
    "common": {
        "gripPairsConfig": [
            1,
            4,
            2,
            3,
            6,
            7,
            9,
            8
        ],
        "controlConfig": [
            0,
            1,
            0,
            0,
            0
        ],
        "emgThresholds": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
        ],
        "interval": [
            100
        ],
        "gripSequentialConfig": [
            1,
            2,
            4,
            3,
            0,
            255,
            6,
            7,
            9,
            8,
            255,
            255
        ]
    },
    "modes": [
        {
            "id": 100,
            "name": "Mode 1",
            "slot": 0,
            "config": {
                "interval": [
                    300
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        },
        {
            "id": 101,
            "name": "Mode 2",
            "slot": 1,
            "config": {
                "interval": [
                    400
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        },
        {
            "id": 102,
            "name": "Mode 3",
            "slot": 2,
            "config": {
                "interval": [
                    500
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        }
    ]
}

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "user_id": null,
            "device_id": 26,
            "index": null,
            "name": "Officia doloremque sit quam beatae maiores nobis.",
            "config": "{\"common\":{\"fingerStrength\":[1,400],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[2,16,22,29,49],\"limit\":[6,75,63,30,88]},\"1\":{\"initial\":[20,5,6,15,56],\"limit\":[38,73,37,88,89]},\"2\":{\"initial\":[3,49,61,25,43],\"limit\":[25,84,80,52,54]},\"3\":{\"initial\":[9,51,42,30,17],\"limit\":[59,91,54,76,58]},\"4\":{\"initial\":[14,65,25,12,6],\"limit\":[16,87,63,64,69]},\"5\":{\"initial\":[38,43,55,39,42],\"limit\":[55,65,68,91,90]},\"6\":{\"initial\":[3,18,4,38,5],\"limit\":[81,86,69,75,56]},\"7\":{\"initial\":[23,39,34,9,44],\"limit\":[58,78,80,57,86]},\"8\":{\"initial\":[28,52,55,2,46],\"limit\":[77,57,55,79,90]},\"9\":{\"initial\":[76,6,62,9,8],\"limit\":[93,44,88,22,65]},\"10\":{\"initial\":[12,17,6,75,9],\"limit\":[94,55,32,77,26]},\"11\":{\"initial\":[10,16,32,18,27],\"limit\":[69,40,35,87,43]},\"12\":{\"initial\":[2,9,35,1,21],\"limit\":[83,35,72,60,22]},\"13\":{\"initial\":[2,31,13,66,2],\"limit\":[86,92,36,87,63]}},\"inputSite\":[1]},\"modes\":[{\"id\":3,\"name\":\"Aut voluptate molestias dolore enim mollitia itaque ab.\",\"slot\":0,\"config\":{\"autoGrasp\":[0,0],\"coContractionTimings\":[200,100],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[80,30,70,40,40,30,60,90,40,60],\"gripPairsConfig\":[9,11,7,3,12,13,6,2],\"gripSequentialConfig\":[8,255,7,3,4,6,255,5,1,255,13,255],\"gripSwitchingMode\":[1],\"holdOpen\":[1500,1500],\"pulseTimings\":[430,300,620,80],\"softGrip\":[0],\"speedControlStrategy\":[0]}},{\"id\":4,\"name\":\"Ut asperiores delectus amet quas illum.\",\"slot\":1,\"config\":{\"autoGrasp\":[0,100],\"coContractionTimings\":[300,100],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[10,70,30,20,10,0,0,70,70,80],\"gripPairsConfig\":[9,6,10,5,8,4,3,12],\"gripSequentialConfig\":[1,9,255,255,255,13,12,255,255,10,255,255],\"gripSwitchingMode\":[3],\"holdOpen\":[2000,2500],\"pulseTimings\":[670,310,710,730],\"softGrip\":[1],\"speedControlStrategy\":[0]}},{\"id\":5,\"name\":\"Numquam delectus voluptas quis ut sit occaecati molestiae.\",\"slot\":2,\"config\":{\"autoGrasp\":[0,0],\"coContractionTimings\":[500,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[100,0,80,80,0,10,0,20,70,100],\"gripPairsConfig\":[12,9,10,4,7,6,5,1],\"gripSequentialConfig\":[255,5,11,255,255,255,13,255,7,8,1,3],\"gripSwitchingMode\":[3],\"holdOpen\":[2000,2500],\"pulseTimings\":[750,650,30,740],\"softGrip\":[1],\"speedControlStrategy\":[0]}}]}",
            "restore_point": 1,
            "factory_reset_point": 0,
            "source": "configurator",
            "changed_by": 50,
            "firmware_version_id": null,
            "created_at": "2026-10-26T11:53:37.000000Z",
            "updated_at": "2026-10-26T11:53:37.000000Z",
            "author": {
                "id": 50,
                "mrn": "BLX5C5JJ1793015617",
                "name": "Mrs. Trinity Gusikowski",
                "email": "1793015617madelynn66@example.org",
                "language": "en",
                "phone": "+1 (785) 828-3273",
                "phone_country": "TH",
                "phone_verified_at": null,
                "address1": "40601 Wintheiser Inlet",
                "address2": "Lake Blanca, IA 53612",
                "postal_code": "02259",
                "city": "Moore, Mertz and Boehm",
                "country": "ES",
                "clinic_name": "Gilestown",
                "clinic_location": "850 Reid Path\nAnkundingtown, MI 49280-4726",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:53:37.000000Z",
                "updated_at": "2026-10-26T11:53:37.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "entries": [
                {
                    "id": 1,
                    "config_history_id": 1,
                    "config_id": 3,
                    "old_value": "earum",
                    "new_value": "excepturi",
                    "created_at": "2026-10-26T11:53:38.000000Z",
                    "updated_at": "2026-10-26T11:53:38.000000Z",
                    "config_entry": {
                        "id": 3,
                        "device_id": 34,
                        "mode_id": null,
                        "key": "est",
                        "value": "cumque",
                        "created_at": "2026-10-26T11:53:38.000000Z",
                        "updated_at": "2026-10-26T11:53:38.000000Z"
                    }
                }
            ]
        },
        {
            "id": 3,
            "user_id": null,
            "device_id": 35,
            "index": null,
            "name": "Quos modi cupiditate aut.",
            "config": "{\"common\":{\"fingerStrength\":[1,500],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[4,10,30,4,43],\"limit\":[9,25,52,35,48]},\"1\":{\"initial\":[79,14,4,5,3],\"limit\":[80,31,76,66,13]},\"2\":{\"initial\":[35,32,18,84,31],\"limit\":[43,65,62,84,52]},\"3\":{\"initial\":[72,8,20,8,63],\"limit\":[87,43,74,84,69]},\"4\":{\"initial\":[19,27,18,73,35],\"limit\":[70,60,64,90,36]},\"5\":{\"initial\":[60,20,50,10,76],\"limit\":[71,44,68,41,85]},\"6\":{\"initial\":[84,6,49,8,5],\"limit\":[90,26,63,77,62]},\"7\":{\"initial\":[37,83,17,46,60],\"limit\":[72,87,54,53,92]},\"8\":{\"initial\":[68,7,26,60,37],\"limit\":[86,93,49,79,81]},\"9\":{\"initial\":[43,1,12,13,3],\"limit\":[63,73,63,24,42]},\"10\":{\"initial\":[24,47,66,74,26],\"limit\":[87,65,74,89,43]},\"11\":{\"initial\":[2,57,25,22,1],\"limit\":[59,81,25,87,36]},\"12\":{\"initial\":[28,48,9,20,26],\"limit\":[88,64,27,75,67]},\"13\":{\"initial\":[21,1,38,14,49],\"limit\":[92,35,79,41,93]}},\"inputSite\":[1]},\"modes\":[{\"id\":9,\"name\":\"Iusto necessitatibus et numquam iusto.\",\"slot\":0,\"config\":{\"autoGrasp\":[0,100],\"coContractionTimings\":[200,100],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[100,100,80,80,70,10,80,30,0,10],\"gripPairsConfig\":[3,10,8,2,9,13,1,12],\"gripSequentialConfig\":[8,255,2,9,255,1,11,255,13,7,4,5],\"gripSwitchingMode\":[3],\"holdOpen\":[1500,2000],\"pulseTimings\":[360,960,80,720],\"softGrip\":[1],\"speedControlStrategy\":[0]}},{\"id\":10,\"name\":\"Voluptatem qui id in ad.\",\"slot\":1,\"config\":{\"autoGrasp\":[1,100],\"coContractionTimings\":[300,100],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[80,80,10,100,70,70,20,60,30,50],\"gripPairsConfig\":[1,13,11,4,10,8,6,5],\"gripSequentialConfig\":[3,13,7,2,12,8,11,9,1,5,4,10],\"gripSwitchingMode\":[1],\"holdOpen\":[2000,2500],\"pulseTimings\":[500,110,280,480],\"softGrip\":[1],\"speedControlStrategy\":[0]}},{\"id\":11,\"name\":\"Eum dolorem molestiae sequi.\",\"slot\":2,\"config\":{\"autoGrasp\":[1,0],\"coContractionTimings\":[300,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[0,0,90,50,80,60,30,0,30,100],\"gripPairsConfig\":[6,12,11,5,7,8,9,10],\"gripSequentialConfig\":[8,4,255,9,5,255,1,255,3,255,255,13],\"gripSwitchingMode\":[3],\"holdOpen\":[2500,2500],\"pulseTimings\":[670,710,80,920],\"softGrip\":[1],\"speedControlStrategy\":[1]}}]}",
            "restore_point": 0,
            "factory_reset_point": 0,
            "source": "configurator",
            "changed_by": 53,
            "firmware_version_id": null,
            "created_at": "2026-10-26T11:53:39.000000Z",
            "updated_at": "2026-10-26T11:53:39.000000Z",
            "author": {
                "id": 53,
                "mrn": "WRKTVQ8M1793015618",
                "name": "Kyla Walsh",
                "email": "1793015618kailey79@example.com",
                "language": "en",
                "phone": "347-632-2581",
                "phone_country": "KH",
                "phone_verified_at": null,
                "address1": "6633 Chandler Trace Suite 683",
                "address2": "Mohrshire, MO 57206-3488",
                "postal_code": "57297",
                "city": "Parisian-Legros",
                "country": "LV",
                "clinic_name": "Richmondtown",
                "clinic_location": "493 Lysanne Ridge\nLake Bernadetteport, WV 45538-1659",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:53:38.000000Z",
                "updated_at": "2026-10-26T11:53:38.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "entries": [
                {
                    "id": 2,
                    "config_history_id": 3,
                    "config_id": 4,
                    "old_value": "beatae",
                    "new_value": "in",
                    "created_at": "2026-10-26T11:53:39.000000Z",
                    "updated_at": "2026-10-26T11:53:39.000000Z",
                    "config_entry": {
                        "id": 4,
                        "device_id": 43,
                        "mode_id": null,
                        "key": "ducimus",
                        "value": "quibusdam",
                        "created_at": "2026-10-26T11:53:39.000000Z",
                        "updated_at": "2026-10-26T11:53:39.000000Z"
                    }
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view device config",
    "code": "CONFIG:HISTORY:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG:HISTORY:DEVICE_NOT_FOUND"
}

Request   

GET api/device/{deviceId}/config/history

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Query Parameters

restore_point   boolean  optional  

Filter config entries by restore point status. Example: 1

factory_reset_point   boolean  optional  

Filter config entries by factory reset point status. Example: 1

date_from   integer  optional  

Filter config entries from date (timestamp). Example: 1642003200

date_to   integer  optional  

Filter config entries to date (timestamp). Example: 1642003200

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: author, entries).

sortby   string  optional  

Sort by field (available: date). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Body Parameters

restore_point   boolean  optional  

Example: false

factory_reset_point   boolean  optional  

Example: true

date_from   string  optional  
date_to   string  optional  

Response

Response Fields

items   object   
id   integer   

Config history entry ID.

device_id   integer   

Associated device ID.

index   integer   

Config history index.

name   string   

Config snapshot name.

config   string   

Serialized config data.

restore_point   boolean   

Whether this entry is a restore point.

factory_reset_point   boolean   

Whether this entry is a factory reset point.

changed_by   integer   

ID of the user who made the change.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who made the change.

entries   object[]   

Individual config history entries.

notes   object[]   

Notes attached to this history entry.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Get device config history entry

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1/config/history/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/config/history/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 5,
    "user_id": null,
    "device_id": 44,
    "index": null,
    "name": "Mollitia autem commodi ipsum ab.",
    "config": "{\"common\":{\"fingerStrength\":[1,200],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[42,4,22,93,19],\"limit\":[79,76,57,93,48]},\"1\":{\"initial\":[18,68,15,20,19],\"limit\":[57,79,52,65,94]},\"2\":{\"initial\":[24,35,40,7,55],\"limit\":[54,76,44,59,62]},\"3\":{\"initial\":[52,16,25,56,10],\"limit\":[82,89,80,89,53]},\"4\":{\"initial\":[7,4,54,41,61],\"limit\":[40,58,93,57,76]},\"5\":{\"initial\":[85,26,33,80,1],\"limit\":[88,90,62,94,8]},\"6\":{\"initial\":[62,37,20,33,4],\"limit\":[73,82,80,64,24]},\"7\":{\"initial\":[33,27,47,72,2],\"limit\":[65,42,79,84,34]},\"8\":{\"initial\":[50,64,12,30,37],\"limit\":[64,75,14,66,75]},\"9\":{\"initial\":[37,53,43,30,16],\"limit\":[86,78,58,46,83]},\"10\":{\"initial\":[7,15,51,48,49],\"limit\":[76,75,84,48,95]},\"11\":{\"initial\":[13,44,31,69,54],\"limit\":[71,79,61,92,61]},\"12\":{\"initial\":[2,23,42,47,15],\"limit\":[75,24,93,80,69]},\"13\":{\"initial\":[44,52,24,52,3],\"limit\":[62,77,55,92,95]}},\"inputSite\":[1]},\"modes\":[{\"id\":15,\"name\":\"Commodi et aliquam saepe aut.\",\"slot\":0,\"config\":{\"autoGrasp\":[1,100],\"coContractionTimings\":[200,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[90,10,40,90,50,20,100,70,30,90],\"gripPairsConfig\":[1,12,4,5,6,3,2,13],\"gripSequentialConfig\":[11,255,13,1,255,255,3,6,7,2,5,12],\"gripSwitchingMode\":[1],\"holdOpen\":[2000,2500],\"pulseTimings\":[670,900,510,750],\"softGrip\":[0],\"speedControlStrategy\":[0]}},{\"id\":16,\"name\":\"Veritatis exercitationem et natus aspernatur omnis assumenda blanditiis.\",\"slot\":1,\"config\":{\"autoGrasp\":[1,0],\"coContractionTimings\":[500,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[100,80,40,90,70,40,20,100,50,30],\"gripPairsConfig\":[5,2,10,12,1,13,8,11],\"gripSequentialConfig\":[255,5,11,255,255,7,9,6,255,255,13,3],\"gripSwitchingMode\":[2],\"holdOpen\":[2000,2500],\"pulseTimings\":[410,610,400,600],\"softGrip\":[0],\"speedControlStrategy\":[0]}},{\"id\":17,\"name\":\"Quam similique quod id temporibus labore quod nisi.\",\"slot\":2,\"config\":{\"autoGrasp\":[1,0],\"coContractionTimings\":[400,100],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[10,90,100,20,90,70,30,80,70,100],\"gripPairsConfig\":[3,9,6,11,2,13,8,7],\"gripSequentialConfig\":[8,12,13,255,10,2,11,5,9,6,3,255],\"gripSwitchingMode\":[3],\"holdOpen\":[1500,2500],\"pulseTimings\":[500,210,490,390],\"softGrip\":[0],\"speedControlStrategy\":[1]}}]}",
    "restore_point": 1,
    "factory_reset_point": 0,
    "source": "configurator",
    "changed_by": 55,
    "firmware_version_id": null,
    "created_at": "2026-10-26T11:53:40.000000Z",
    "updated_at": "2026-10-26T11:53:40.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view device config",
    "code": "CONFIG:HISTORY_ENTRY:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG:HISTORY_ENTRY:DEVICE_NOT_FOUND"
}

Example response (404, Config history entry not found):


{
    "message": "Config history entry not found",
    "code": "CONFIG:HISTORY_ENTRY:HISTORY_ENTRY_NOT_FOUND"
}

Request   

GET api/device/{deviceId}/config/history/{configId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

Query Parameters

extend   string  optional  

Comma-separated list of relation extensions (available: author, entries).

Response

Response Fields

id   integer   

Config history entry ID.

device_id   integer   

Associated device ID.

index   integer   

Config history index.

name   string   

Config snapshot name.

config   string   

Serialized config data.

restore_point   boolean   

Whether this entry is a restore point.

factory_reset_point   boolean   

Whether this entry is a factory reset point.

changed_by   integer   

ID of the user who made the change.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who made the change.

entries   object[]   

Individual config history entries.

notes   object[]   

Notes attached to this history entry.

Update config history

requires authentication

Returns updated config history in response.

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/config/history/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Remote session 2022-05-30\",
    \"restore_point\": true,
    \"factory_reset_point\": false
}"

const url = new URL(
    "http://localhost:8000/api/device/1/config/history/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Remote session 2022-05-30",
    "restore_point": true,
    "factory_reset_point": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 6,
    "user_id": null,
    "device_id": 48,
    "index": null,
    "name": "Mollitia laborum minus nostrum magnam repellat.",
    "config": "{\"common\":{\"fingerStrength\":[1,300],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[32,41,59,42,8],\"limit\":[76,88,70,42,88]},\"1\":{\"initial\":[4,19,25,31,31],\"limit\":[77,66,92,50,44]},\"2\":{\"initial\":[34,19,3,3,3],\"limit\":[66,95,82,85,12]},\"3\":{\"initial\":[23,27,18,68,14],\"limit\":[65,77,75,80,73]},\"4\":{\"initial\":[53,10,14,67,31],\"limit\":[71,72,62,86,80]},\"5\":{\"initial\":[19,36,57,13,63],\"limit\":[65,50,84,66,73]},\"6\":{\"initial\":[17,20,24,25,30],\"limit\":[66,84,48,83,64]},\"7\":{\"initial\":[29,18,35,6,10],\"limit\":[60,71,45,64,35]},\"8\":{\"initial\":[27,12,58,17,9],\"limit\":[73,63,95,30,36]},\"9\":{\"initial\":[41,58,33,38,8],\"limit\":[92,61,59,88,95]},\"10\":{\"initial\":[62,46,5,56,66],\"limit\":[68,80,46,61,87]},\"11\":{\"initial\":[12,69,12,66,43],\"limit\":[28,72,58,79,55]},\"12\":{\"initial\":[1,60,31,23,27],\"limit\":[72,85,58,53,54]},\"13\":{\"initial\":[43,1,21,12,47],\"limit\":[61,75,49,52,91]}},\"inputSite\":[0]},\"modes\":[{\"id\":18,\"name\":\"Sapiente velit ea minus voluptatem velit unde itaque.\",\"slot\":0,\"config\":{\"autoGrasp\":[0,100],\"coContractionTimings\":[200,200],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[10,20,10,30,30,50,30,30,70,60],\"gripPairsConfig\":[4,5,12,10,9,2,7,1],\"gripSequentialConfig\":[6,1,255,255,5,8,7,2,4,9,255,11],\"gripSwitchingMode\":[2],\"holdOpen\":[2000,2000],\"pulseTimings\":[770,50,820,260],\"softGrip\":[1],\"speedControlStrategy\":[1]}},{\"id\":19,\"name\":\"Dignissimos debitis voluptatem minus sint.\",\"slot\":1,\"config\":{\"autoGrasp\":[0,100],\"coContractionTimings\":[400,300],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[30,10,40,20,70,60,30,40,80,100],\"gripPairsConfig\":[6,5,12,8,3,11,7,13],\"gripSequentialConfig\":[6,255,12,3,7,13,2,5,11,255,9,1],\"gripSwitchingMode\":[3],\"holdOpen\":[1500,2000],\"pulseTimings\":[240,80,410,460],\"softGrip\":[1],\"speedControlStrategy\":[0]}},{\"id\":20,\"name\":\"Neque eum modi iure minus.\",\"slot\":2,\"config\":{\"autoGrasp\":[1,0],\"coContractionTimings\":[300,300],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[100,40,30,60,90,70,30,70,40,60],\"gripPairsConfig\":[8,7,5,9,4,10,1,6],\"gripSequentialConfig\":[5,255,255,255,8,9,255,12,255,10,4,13],\"gripSwitchingMode\":[2],\"holdOpen\":[1500,2000],\"pulseTimings\":[700,70,130,490],\"softGrip\":[0],\"speedControlStrategy\":[0]}}]}",
    "restore_point": 0,
    "factory_reset_point": 0,
    "source": "configurator",
    "changed_by": 56,
    "firmware_version_id": null,
    "created_at": "2026-10-26T11:53:41.000000Z",
    "updated_at": "2026-10-26T11:53:41.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update device config",
    "code": "CONFIG:HISTORY_UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Factory reset point already exists):


{
    "message": "Factory reset point does not exist",
    "code": "CONFIG:HISTORY_UPDATE:FACTORY_RESET_POINT_ALREADY_EXISTS"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG:HISTORY_UPDATE:DEVICE_NOT_FOUND"
}

Example response (404, Config history entry not found):


{
    "message": "Config history entry not found",
    "code": "CONFIG:HISTORY_UPDATE:HISTORY_ENTRY_NOT_FOUND"
}

Request   

POST api/device/{deviceId}/config/history/{configId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

Body Parameters

name   string  optional  

Config history entry name. Example: Remote session 2022-05-30

restore_point   boolean  optional  

Restore point status. Example: true

factory_reset_point   boolean  optional  

Point of factory reset. Example: false

Response

Response Fields

id   integer   

Config history entry ID.

device_id   integer   

Associated device ID.

index   integer   

Config history index.

name   string   

Config snapshot name.

config   string   

Serialized config data.

restore_point   boolean   

Whether this entry is a restore point.

factory_reset_point   boolean   

Whether this entry is a factory reset point.

changed_by   integer   

ID of the user who made the change.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who made the change.

entries   object[]   

Individual config history entries.

notes   object[]   

Notes attached to this history entry.

Undo single config history change

requires authentication

Returns updated config in response.

Example request:
curl --request DELETE \
    "http://localhost:8000/api/device/1/config/history/undo/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/config/history/undo/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, Normal/compact response):


{
    "common": {
        "gripPairsConfig": [
            1,
            4,
            2,
            3,
            6,
            7,
            9,
            8
        ],
        "controlConfig": [
            0,
            1,
            0,
            0,
            0
        ],
        "emgThresholds": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
        ],
        "interval": [
            100
        ],
        "gripSequentialConfig": [
            1,
            2,
            4,
            3,
            0,
            255,
            6,
            7,
            9,
            8,
            255,
            255
        ]
    },
    "modes": [
        {
            "id": 100,
            "name": "Mode 1",
            "slot": 0,
            "config": {
                "interval": [
                    300
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        },
        {
            "id": 101,
            "name": "Mode 2",
            "slot": 1,
            "config": {
                "interval": [
                    400
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        },
        {
            "id": 102,
            "name": "Mode 3",
            "slot": 2,
            "config": {
                "interval": [
                    500
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update device config",
    "code": "CONFIG:UNDO:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG:UNDO:DEVICE_NOT_FOUND"
}

Example response (404, Config history entry not found):


{
    "message": "Config history entry not found",
    "code": "CONFIG:UNDO:HISTORY_ENTRY_NOT_FOUND"
}

Request   

DELETE api/device/{deviceId}/config/history/undo/{configId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

Restore config history entry

requires authentication

Restores config from given config history entry (all changes). Sends support ticket if patient is assigned to device, returns config instead.

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/config/restore/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/config/restore/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, Patient not assigned, returns config):


{
    "common": {
        "gripPairsConfig": [
            1,
            4,
            2,
            3,
            6,
            7,
            9,
            8
        ],
        "controlConfig": [
            0,
            1,
            0,
            0,
            0
        ],
        "emgThresholds": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
        ],
        "interval": [
            100
        ],
        "gripSequentialConfig": [
            1,
            2,
            4,
            3,
            0,
            255,
            6,
            7,
            9,
            8,
            255,
            255
        ]
    },
    "modes": [
        {
            "id": 100,
            "name": "Mode 1",
            "slot": 0,
            "config": {
                "interval": [
                    300
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        },
        {
            "id": 101,
            "name": "Mode 2",
            "slot": 1,
            "config": {
                "interval": [
                    400
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        },
        {
            "id": 102,
            "name": "Mode 3",
            "slot": 2,
            "config": {
                "interval": [
                    500
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        }
    ]
}

Example response (202):


{
    "id": 1,
    "sender_id": 57,
    "recipient_id": 58,
    "device_id": null,
    "meeting_date": "2026-10-26 11:53:41",
    "meeting_type": "online_meeting",
    "contact_email": "atowne@hane.com",
    "status": "new",
    "created_at": "2026-10-26T11:53:42.000000Z",
    "updated_at": "2026-10-26T11:53:42.000000Z",
    "sender": {
        "id": 57,
        "mrn": "XZEF9KBH1793015621",
        "name": "Trycia Will",
        "email": "1793015621sandy15@example.org",
        "language": "en",
        "phone": "(520) 291-5478",
        "phone_country": "AD",
        "phone_verified_at": null,
        "address1": "7950 Bartell Road Apt. 923",
        "address2": "Emilyton, VT 48436",
        "postal_code": "34384",
        "city": "Breitenberg-Denesik",
        "country": "LU",
        "clinic_name": "Schoenbury",
        "clinic_location": "346 Joey Mountain Suite 466\nWest Zitaside, OH 51352",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:53:41.000000Z",
        "updated_at": "2026-10-26T11:53:41.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 58,
        "mrn": "6QWMDYHV1793015621",
        "name": "Savanna Gleichner I",
        "email": "1793015621jkozey@example.com",
        "language": "en",
        "phone": "1-714-685-7602",
        "phone_country": "SB",
        "phone_verified_at": null,
        "address1": "57801 Lakin Crossing Suite 202",
        "address2": "Adellafurt, NC 16722",
        "postal_code": "80732-2417",
        "city": "Bednar LLC",
        "country": "CZ",
        "clinic_name": "Immanuelborough",
        "clinic_location": "925 Janelle Viaduct Apt. 241\nWest Mozell, NJ 52395",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:53:41.000000Z",
        "updated_at": "2026-10-26T11:53:41.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": null,
    "messages": [
        {
            "id": 1,
            "ticket_id": 1,
            "sender_id": 59,
            "title": "Mrs.",
            "content": "Quod voluptatum dolor commodi ratione quisquam ea fugit.",
            "is_read": false,
            "created_at": "2026-10-26T11:53:43.000000Z",
            "updated_at": "2026-10-26T11:53:43.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update device config",
    "code": "CONFIG:RESTORE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG:RESTORE:DEVICE_NOT_FOUND"
}

Example response (404, Config history entry not found):


{
    "message": "Config history entry not found",
    "code": "CONFIG:RESTORE:HISTORY_ENTRY_NOT_FOUND"
}

Request   

POST api/device/{deviceId}/config/restore/{configId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

Response

Response Fields

id   integer   

Support ticket ID.

sender_id   integer   

ID of the user who created the ticket.

recipient_id   integer   

ID of the recipient user.

device_id   integer   

Associated device ID.

meeting_date   string   

Scheduled meeting date.

meeting_type   string   

Meeting type.

Must be one of:
  • online
  • in-person
contact_email   string   

Contact email address.

status   string   

Ticket status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

sender   object   

User who created the ticket.

recipient   object   

Recipient user.

device   object   

Associated device.

messages   object[]   

Ticket messages.

Restore to factory reset point

requires authentication

Restores config from the device's factory reset point. Sends a support ticket if the patient is assigned to the device. Returns the array that contains:

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/config/restore-factory-reset" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/config/restore-factory-reset"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "config": {
        "common": {
            "inputSite": [
                1
            ],
            "generalHandSettings": false,
            "batteryBeep": [
                1,
                0
            ],
            "emgGains": false,
            "autoGrasp": false
        },
        "modes": [
            {
                "id": 1,
                "name": "Mode 0",
                "slot": 0,
                "config": {
                    "gripPairsConfig": false,
                    "emgThresholds": false,
                    "emgSpike": false,
                    "controlMode": false
                }
            },
            {
                "id": 1530,
                "name": "Mode 1",
                "slot": 1,
                "config": {
                    "gripPairsConfig": false,
                    "emgThresholds": false,
                    "emgSpike": false,
                    "controlMode": false
                }
            },
            {
                "id": 1531,
                "name": "Mode 2",
                "slot": 2,
                "config": {
                    "gripPairsConfig": false,
                    "emgThresholds": false,
                    "emgSpike": false,
                    "controlMode": false
                }
            }
        ]
    },
    "not_modified": {
        "common": {
            "inputSite": [
                1
            ],
            "batteryBeep": [
                1,
                0
            ],
            "generalHandSettings": [
                1,
                2,
                3,
                4
            ]
        },
        "modes": [
            {
                "userFeedbackType": false,
                "buzzingVolumeSettings": false
            },
            {
                "userFeedbackType": false,
                "buzzingVolumeSettings": false
            },
            {
                "userFeedbackType": false,
                "buzzingVolumeSettings": false
            }
        ]
    },
    "ticket": {
        "id": 1,
        "sender_id": 1,
        "recipient_id": 2,
        "device_id": 1,
        "meeting_date": "2025-07-22T15:00:00.000000Z",
        "meeting_type": "none",
        "contact_email": null,
        "status": "new",
        "created_at": "2025-07-22T15:00:00.000000Z",
        "updated_at": "2025-07-22T15:00:00.000000Z",
        "messages": [
            {
                "id": 1,
                "ticket_id": 1,
                "sender_id": 1,
                "title": "New config update",
                "content": "",
                "is_read": false,
                "created_at": "2025-07-22T15:00:00.000000Z",
                "updated_at": "2025-07-22T15:00:00.000000Z",
                "attachments": [
                    {
                        "id": 6629,
                        "ticket_id": 12973,
                        "ticket_message_id": 6517,
                        "type": "json",
                        "title": "Current config",
                        "attachment": "{\"common\":{},\"modes\":[{\"id\":1,\"name\":\"Mode 0\",\"slot\":0,\"config\":{}},{\"id\":2,\"name\":\"Mode 1\",\"slot\":1,\"config\":{}},{\"id\":3,\"name\":\"Mode 2\",\"slot\":2,\"config\":{}}]}",
                        "created_at": "2025-07-22T15:00:00.000000Z",
                        "updated_at": "2025-07-22T15:00:00.000000Z"
                    },
                    {
                        "id": 6630,
                        "ticket_id": 12973,
                        "ticket_message_id": 6517,
                        "type": "json",
                        "title": "New config",
                        "attachment": "{\"common\":{},\"modes\":[{\"id\":1,\"name\":\"Mode 0\",\"slot\":0,\"config\":{}},{\"id\":2,\"name\":\"Mode 1\",\"slot\":1,\"config\":{}},{\"id\":3,\"name\":\"Mode 2\",\"slot\":2,\"config\":{}}]}",
                        "created_at": "2025-07-22T15:00:00.000000Z",
                        "updated_at": "2025-07-22T15:00:00.000000Z"
                    }
                ]
            }
        ]
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update device config",
    "code": "CONFIG:RESTORE_FACTORY_RESET:INSUFFICIENT_PERMISSION"
}

Example response (403, Config history entry not found):


{
    "message": "Config history entry not found",
    "code": "CONFIG:RESTORE_FACTORY_RESET:NO_RESTORE_POINT"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG:RESTORE_FACTORY_RESET:DEVICE_NOT_FOUND"
}

Request   

POST api/device/{deviceId}/config/restore-factory-reset

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Send test config

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/config/send" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Fixed problem with grips.\",
    \"p2p_session\": 1,
    \"updateConfig\": false,
    \"common\": \"{\\\"gripPairsConfig\\\": [1, 4, 2, 3, 6, 7, 9, 8], \\\"controlConfig\\\": [0, 1, 0, 0, 0], \\\"gripSequentialConfig\\\": [1, 2, 4, 3, 0, 255, 6, 7, 9, 8, 255, 255]\",
    \"source\": \"guide\",
    \"modes\": [
        {
            \"id\": 1,
            \"config\": \"{\\\"gripPairsConfig\\\": [1, 4, 2, 3, 6, 7, 9, 8], \\\"controlConfig\\\": [0, 1, 0, 0, 0], \\\"gripSequentialConfig\\\": [1, 2, 4, 3, 0, 255, 6, 7, 9, 8, 255, 255]\"
        }
    ]
}"

const url = new URL(
    "http://localhost:8000/api/device/1/config/send"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "description": "Fixed problem with grips.",
    "p2p_session": 1,
    "updateConfig": false,
    "common": "{\"gripPairsConfig\": [1, 4, 2, 3, 6, 7, 9, 8], \"controlConfig\": [0, 1, 0, 0, 0], \"gripSequentialConfig\": [1, 2, 4, 3, 0, 255, 6, 7, 9, 8, 255, 255]",
    "source": "guide",
    "modes": [
        {
            "id": 1,
            "config": "{\"gripPairsConfig\": [1, 4, 2, 3, 6, 7, 9, 8], \"controlConfig\": [0, 1, 0, 0, 0], \"gripSequentialConfig\": [1, 2, 4, 3, 0, 255, 6, 7, 9, 8, 255, 255]"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 7,
    "sender_id": 68,
    "recipient_id": 69,
    "device_id": null,
    "meeting_date": "2026-10-26 11:53:47",
    "meeting_type": "online_meeting",
    "contact_email": "malinda.fisher@maggio.com",
    "status": "new",
    "created_at": "2026-10-26T11:53:47.000000Z",
    "updated_at": "2026-10-26T11:53:47.000000Z",
    "sender": {
        "id": 68,
        "mrn": "B9ETTGTV1793015626",
        "name": "Sage Gorczany I",
        "email": "1793015626schaefer.kelli@example.com",
        "language": "en",
        "phone": "947-592-5827",
        "phone_country": "BG",
        "phone_verified_at": null,
        "address1": "7925 Gaylord Drive Suite 801",
        "address2": "South Brandyn, NV 45879",
        "postal_code": "00128",
        "city": "Trantow LLC",
        "country": "FR",
        "clinic_name": "Lake Zetta",
        "clinic_location": "890 Simonis Unions\nWest Wilfredo, CA 49114",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:53:46.000000Z",
        "updated_at": "2026-10-26T11:53:46.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 69,
        "mrn": "ZS4UXZRC1793015627",
        "name": "Linnea Bauch",
        "email": "1793015627isadore.armstrong@example.net",
        "language": "en",
        "phone": "+1 (712) 900-3099",
        "phone_country": "WS",
        "phone_verified_at": null,
        "address1": "43593 Heaney Plain Apt. 836",
        "address2": "Maribeltown, ND 58982-1606",
        "postal_code": "90826-4677",
        "city": "Weber-Fisher",
        "country": "RO",
        "clinic_name": "Garthton",
        "clinic_location": "10754 Fleta Camp\nNew Marcelina, AK 34704",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:53:47.000000Z",
        "updated_at": "2026-10-26T11:53:47.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": null,
    "messages": [
        {
            "id": 4,
            "ticket_id": 7,
            "sender_id": 70,
            "title": "Miss",
            "content": "Perspiciatis ipsum sint tempore in.",
            "is_read": false,
            "created_at": "2026-10-26T11:53:49.000000Z",
            "updated_at": "2026-10-26T11:53:49.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update device config",
    "code": "CONFIG:SEND:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG:SEND:DEVICE_NOT_FOUND"
}

Example response (422, Device does not have an amputee assigned):


{
    "message": "Device does not have an amputee assigned",
    "code": "CONFIG:SEND:NO_PATIENT"
}

Example response (422, Invalid P2P session):


{
    "message": "Invalid P2P session",
    "code": "CONFIG:SEND:INVALID_P2P_SESSION"
}

Example response (422, Invalid config):


{
    "message": "Config has some problems and cannot be saved.",
    "errors": {
        "modes": {
            "mode_3": "Config mode 3 does not belong to device 12."
        },
        "values": {
            "common.inputSite": "Invalid value [\"11\"] for key inputSite - contains string values.",
            "common.gripsPositions.1.initial": "Invalid value [200,\"100\",\"100\",\"100\",\"100\"] for key gripsPositions.1.initial - contains string values.",
            "mode_1.inputSite": "Invalid value [\"11\"] for key inputSite - contains string values.",
            "mode_1.gripsPositions.0.initial": "Invalid value [\"200\",\"100\",\"100\",\"100\",\"100\"] for key gripsPositions.1.initial - contains string values."
        }
    },
    "code": "CONFIG:SEND:INVALID_CONFIG"
}

Request   

POST api/device/{deviceId}/config/send

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Body Parameters

description   string  optional  

Config description to add in message notification. Example: Fixed problem with grips.

p2p_session   integer  optional  

P2P Session ID. If config was prepared during P2P session, pass its ID, if not, pass null. The id of an existing record in the App\Models\P2PSession table. Example: 1

updateConfig   boolean  optional  

Determines if device config should be updated. Example: false

common   string  optional  

Common config as JSON string. MUST_BE_JSON. Example: {"gripPairsConfig": [1, 4, 2, 3, 6, 7, 9, 8], "controlConfig": [0, 1, 0, 0, 0], "gripSequentialConfig": [1, 2, 4, 3, 0, 255, 6, 7, 9, 8, 255, 255]

source   string  optional  

Where this config save was initiated from. Defaults to configurator when not present. Example: guide

Must be one of:
  • configurator
  • guide
  • mobile
modes   object[]  optional  
id   string  optional  

Config mode ID. The id of an existing record in the App\Models\ConfigMode table. Example: 1

config   string  optional  

Config specific for mode as JSON string. MUST_BE_JSON. Example: {"gripPairsConfig": [1, 4, 2, 3, 6, 7, 9, 8], "controlConfig": [0, 1, 0, 0, 0], "gripSequentialConfig": [1, 2, 4, 3, 0, 255, 6, 7, 9, 8, 255, 255]

Response

Response Fields

id   integer   

Support ticket ID.

sender_id   integer   

ID of the user who created the ticket.

recipient_id   integer   

ID of the recipient user.

device_id   integer   

Associated device ID.

meeting_date   string   

Scheduled meeting date.

meeting_type   string   

Meeting type.

Must be one of:
  • online
  • in-person
contact_email   string   

Contact email address.

status   string   

Ticket status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

sender   object   

User who created the ticket.

recipient   object   

Recipient user.

device   object   

Associated device.

messages   object[]   

Ticket messages.

Convert config

requires authentication

Convert config JSON to match given Firmware Version. Keys are moved between common config and modes.

Example request:
curl --request POST \
    "http://localhost:8000/api/config/convert" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"config\": \"[\\\"ut\\\",\\\"autem\\\"]\",
    \"firmware\": 1
}"

const url = new URL(
    "http://localhost:8000/api/config/convert"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "config": "[\"ut\",\"autem\"]",
    "firmware": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "common": {
        "gripPairsConfig": [
            1,
            4,
            2,
            3,
            6,
            7,
            9,
            8
        ],
        "controlConfig": [
            0,
            1,
            0,
            0,
            0
        ],
        "emgThresholds": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
        ],
        "interval": [
            100
        ],
        "gripSequentialConfig": [
            1,
            2,
            4,
            3,
            0,
            255,
            6,
            7,
            9,
            8,
            255,
            255
        ]
    },
    "modes": [
        {
            "id": 100,
            "name": "Mode 1",
            "slot": 0,
            "config": {
                "interval": [
                    300
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        },
        {
            "id": 101,
            "name": "Mode 2",
            "slot": 1,
            "config": {
                "interval": [
                    400
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        },
        {
            "id": 102,
            "name": "Mode 3",
            "slot": 2,
            "config": {
                "interval": [
                    500
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update device config",
    "code": "CONFIG:CONVERT:INSUFFICIENT_PERMISSION"
}

Example response (404, Firmware version not found):


{
    "message": "Firmware version not found",
    "code": "CONFIG:CONVERT:FIRMWARE_NOT_FOUND"
}

Request   

POST api/config/convert

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

config   string   

Full config JSON. MUST_BE_JSON. Example: ["ut","autem"]

firmware   string   

Firmware Version ID to which config should be adjusted. The id of an existing record in the App\Models\FirmwareVersion table. Example: 1

Get config snapshot

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1/config-snapshot" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/config-snapshot"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "device_id": 65,
    "config": "{\"common\":[],\"modes\":[]}",
    "custom_grips": "[]",
    "created_at": "2026-10-26T11:53:52.000000Z",
    "updated_at": "2026-10-26T11:53:52.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view device config",
    "code": "CONFIG_SNAPSHOT:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_SNAPSHOT:GET:DEVICE_NOT_FOUND"
}

Example response (404, Snapshot not found):


{
    "message": "Config snapshot not found",
    "code": "CONFIG_SNAPSHOT:GET:SNAPSHOT_NOT_FOUND"
}

Request   

GET api/device/{deviceId}/config-snapshot

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Update config snapshot

requires authentication

Creates a snapshot of the device's config and custom grips. Replaces any existing snapshot for this device.

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/config-snapshot" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/config-snapshot"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 2,
    "device_id": 67,
    "config": "{\"common\":[],\"modes\":[]}",
    "custom_grips": "[]",
    "created_at": "2026-10-26T11:53:52.000000Z",
    "updated_at": "2026-10-26T11:53:52.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update device config",
    "code": "CONFIG_SNAPSHOT:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_SNAPSHOT:UPDATE:DEVICE_NOT_FOUND"
}

Request   

POST api/device/{deviceId}/config-snapshot

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Config Demo

API endpoints for managing config demos

List config demos

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1/config/demos?accepted=6" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/config/demos"
);

const params = {
    "accepted": "6",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "user_id": null,
            "device_id": 85,
            "message_id": 8,
            "config": "Deleniti quam quia sunt officia ea blanditiis necessitatibus consequatur.",
            "is_accepted": 1,
            "notes": "Repudiandae nostrum aliquam sint voluptates numquam.",
            "created_at": "2026-10-26T11:53:59.000000Z",
            "updated_at": "2026-10-26T11:53:59.000000Z",
            "message": {
                "id": 8,
                "ticket_id": 15,
                "sender_id": 92,
                "title": "Prof.",
                "content": "A similique ad ea occaecati consequatur nobis.",
                "is_read": false,
                "created_at": "2026-10-26T11:53:59.000000Z",
                "updated_at": "2026-10-26T11:53:59.000000Z"
            }
        },
        {
            "id": 2,
            "user_id": null,
            "device_id": 86,
            "message_id": 10,
            "config": "Fuga laborum quaerat accusamus laborum blanditiis.",
            "is_accepted": 1,
            "notes": "Voluptatum voluptatum dolores possimus nihil.",
            "created_at": "2026-10-26T11:54:02.000000Z",
            "updated_at": "2026-10-26T11:54:02.000000Z",
            "message": {
                "id": 10,
                "ticket_id": 18,
                "sender_id": 97,
                "title": "Mrs.",
                "content": "Praesentium quis quod molestiae.",
                "is_read": false,
                "created_at": "2026-10-26T11:54:02.000000Z",
                "updated_at": "2026-10-26T11:54:02.000000Z"
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access config demos",
    "code": "CONFIG_DEMO:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_DEMO:LIST:DEVICE_NOT_FOUND"
}

Request   

GET api/device/{deviceId}/config/demos

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Query Parameters

accepted   integer  optional  

Filter config demos by accepted status. If not specified, all entries will be returned. Pass -1 to get entries not accepted or rejected yet. The value must be one of -1, 0 or 1. Example: 6

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: message, message.ticket, message.attachments).

Update config demo

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/device/1/config/demos/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"is_accepted\": false,
    \"notes\": \"Something is still not working\"
}"

const url = new URL(
    "http://localhost:8000/api/device/1/config/demos/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "is_accepted": false,
    "notes": "Something is still not working"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 3,
    "user_id": null,
    "device_id": 87,
    "message_id": 11,
    "config": "Et consequuntur quas saepe ut nihil explicabo odit.",
    "is_accepted": 0,
    "notes": "Quia et consequatur omnis et optio sit dolorem.",
    "created_at": "2026-10-26T11:54:04.000000Z",
    "updated_at": "2026-10-26T11:54:04.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access config demos",
    "code": "CONFIG_DEMO:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_DEMO:UPDATE:DEVICE_NOT_FOUND"
}

Example response (404, Config demo not found):


{
    "message": "Config demo not found",
    "code": "CONFIG_DEMO:UPDATE:DEMO_NOT_FOUND"
}

Request   

PUT api/device/{deviceId}/config/demos/{demoId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

demoId   integer   

Config demo ID. Example: 1

Body Parameters

is_accepted   boolean  optional  

Determines if demo config was accepted by patient. Example: false

notes   string  optional  

Patient notes about tested config. Example: Something is still not working

Config Modes

API endpoints for managing config modes

List config modes

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1/config-modes" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/config-modes"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 72,
        "device_id": 116,
        "slot": null,
        "name": "Illo qui iste voluptas harum ut.",
        "active": 0,
        "created_at": "2026-10-26T11:54:09.000000Z",
        "updated_at": "2026-10-26T11:54:09.000000Z",
        "device": {
            "id": 116,
            "serial": "88f70912-aaa6-3709-84ab-0223cea7a14c",
            "bluetooth_id": "be06cc46-61f1-3c20-9021-04e791eb149d",
            "company_id": null,
            "model_id": null,
            "amputee_id": 110,
            "clinician_id": null,
            "firmware_version_id": null,
            "pcb_version_id": null,
            "reverse_magnets": 0,
            "is_electrode": 0,
            "active": 1,
            "last_activity_at": "0000-00-00 00:00:00",
            "first_connected_at": null,
            "measurements": null,
            "created_at": "2026-10-26T11:54:09.000000Z",
            "updated_at": "2026-10-26T11:54:09.000000Z",
            "first_config_change_at": null,
            "amputee": {
                "id": 110,
                "mrn": "UEL4C77D1793015649",
                "name": "Monte Walter",
                "email": "1793015649barton.robb@example.net",
                "language": "en",
                "phone": "1-408-360-2856",
                "phone_country": "KG",
                "phone_verified_at": null,
                "address1": "116 Breitenberg Lakes",
                "address2": "Samarashire, WI 20489",
                "postal_code": "06896",
                "city": "Mraz, Schowalter and Buckridge",
                "country": "BG",
                "clinic_name": "Wolftown",
                "clinic_location": "38529 Kihn River\nHermannburgh, IN 78234-6007",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:54:09.000000Z",
                "updated_at": "2026-10-26T11:54:09.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        }
    },
    {
        "id": 73,
        "device_id": 118,
        "slot": null,
        "name": "Repudiandae enim omnis culpa.",
        "active": 1,
        "created_at": "2026-10-26T11:54:10.000000Z",
        "updated_at": "2026-10-26T11:54:10.000000Z",
        "config": {}
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list config modes",
    "code": "CONFIG_MODES:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_MODES:LIST:DEVICE_NOT_FOUND"
}

Request   

GET api/device/{deviceId}/config-modes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Response

Response Fields

id   integer   

Config mode ID.

device_id   integer   

Associated device ID.

slot   integer   

Mode slot index (0, 1 or 2).

name   string   

Mode name.

active   boolean   

Whether the mode is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Get config mode

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1/config-modes/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/config-modes/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 74,
    "device_id": 119,
    "slot": null,
    "name": "Velit placeat ipsa quibusdam et deleniti qui.",
    "active": 1,
    "created_at": "2026-10-26T11:54:10.000000Z",
    "updated_at": "2026-10-26T11:54:10.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list config modes",
    "code": "CONFIG_MODES:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_MODES:GET:DEVICE_NOT_FOUND"
}

Example response (404, Config mode not found):


{
    "message": "Config mode not found",
    "code": "CONFIG_MODES:GET:MODE_NOT_FOUND"
}

Request   

GET api/device/{deviceId}/config-modes/{modeId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

modeId   integer   

Config mode ID. Example: 1

Response

Response Fields

id   integer   

Config mode ID.

device_id   integer   

Associated device ID.

slot   integer   

Mode slot index (0, 1 or 2).

name   string   

Mode name.

active   boolean   

Whether the mode is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Create config mode

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/config-modes" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"slot\": 0,
    \"name\": \"Sport mode\",
    \"active\": true
}"

const url = new URL(
    "http://localhost:8000/api/device/1/config-modes"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "slot": 0,
    "name": "Sport mode",
    "active": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 75,
    "device_id": 120,
    "slot": null,
    "name": "Eum fuga incidunt aspernatur est beatae numquam.",
    "active": 0,
    "created_at": "2026-10-26T11:54:10.000000Z",
    "updated_at": "2026-10-26T11:54:10.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create config modes",
    "code": "CONFIG_MODES:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_MODES:CREATE:DEVICE_NOT_FOUND"
}

Request   

POST api/device/{deviceId}/config-modes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Body Parameters

slot   integer  optional  

Mode index on device. Example: 0

Must be one of:
  • 0
  • 1
  • 2
name   string   

Name of mode. Example: Sport mode

active   boolean  optional  

Active status. Default: 1. Example: true

Response

Response Fields

id   integer   

Config mode ID.

device_id   integer   

Associated device ID.

slot   integer   

Mode slot index (0, 1 or 2).

name   string   

Mode name.

active   boolean   

Whether the mode is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Update config mode

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/device/1/config-modes/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"slot\": 0,
    \"name\": \"Sport mode\",
    \"active\": true
}"

const url = new URL(
    "http://localhost:8000/api/device/1/config-modes/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "slot": 0,
    "name": "Sport mode",
    "active": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 76,
    "device_id": 121,
    "slot": null,
    "name": "Ratione et earum et est.",
    "active": 0,
    "created_at": "2026-10-26T11:54:10.000000Z",
    "updated_at": "2026-10-26T11:54:10.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update config mode",
    "code": "CONFIG_MODES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_MODES:UPDATE:DEVICE_NOT_FOUND"
}

Example response (404, Config mode not found):


{
    "message": "Config mode not found",
    "code": "CONFIG_MODES:UPDATE:MODE_NOT_FOUND"
}

Request   

PUT api/device/{deviceId}/config-modes/{modeId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

modeId   integer   

Config mode ID. Example: 1

Body Parameters

slot   integer  optional  

Mode index on device. Example: 0

Must be one of:
  • 0
  • 1
  • 2
name   string  optional  

Name of mode. Example: Sport mode

active   boolean  optional  

Active status. Default: 1. Example: true

Response

Response Fields

id   integer   

Config mode ID.

device_id   integer   

Associated device ID.

slot   integer   

Mode slot index (0, 1 or 2).

name   string   

Mode name.

active   boolean   

Whether the mode is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Copy device config from template

requires authentication

Copy config template into selected config mode. Sends support ticket if patient is assigned to device, returns config instead.

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/config-modes/1/from-template/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/config-modes/1/from-template/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, Patient not assigned, returns config):


{
    "common": {
        "gripPairsConfig": [
            1,
            4,
            2,
            3,
            6,
            7,
            9,
            8
        ],
        "controlConfig": [
            0,
            1,
            0,
            0,
            0
        ],
        "emgThresholds": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
        ],
        "interval": [
            100
        ],
        "gripSequentialConfig": [
            1,
            2,
            4,
            3,
            0,
            255,
            6,
            7,
            9,
            8,
            255,
            255
        ]
    },
    "modes": [
        {
            "id": 100,
            "name": "Mode 1",
            "slot": 0,
            "config": {
                "interval": [
                    300
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        },
        {
            "id": 101,
            "name": "Mode 2",
            "slot": 1,
            "config": {
                "interval": [
                    400
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        },
        {
            "id": 102,
            "name": "Mode 3",
            "slot": 2,
            "config": {
                "interval": [
                    500
                ],
                "fingerStrength": [
                    1,
                    100
                ],
                "autoGrasp": [
                    0,
                    100
                ],
                "emgSpike": [
                    0,
                    300
                ]
            }
        }
    ]
}

Example response (202):


{
    "id": 21,
    "sender_id": 112,
    "recipient_id": 113,
    "device_id": null,
    "meeting_date": "2026-10-26 11:54:11",
    "meeting_type": "online_meeting",
    "contact_email": "zortiz@yahoo.com",
    "status": "new",
    "created_at": "2026-10-26T11:54:11.000000Z",
    "updated_at": "2026-10-26T11:54:11.000000Z",
    "sender": {
        "id": 112,
        "mrn": "KNELP7V61793015650",
        "name": "Celine Nikolaus",
        "email": "1793015650ueichmann@example.com",
        "language": "en",
        "phone": "+1-283-757-1856",
        "phone_country": "TW",
        "phone_verified_at": null,
        "address1": "37050 Justine Plains Suite 408",
        "address2": "Erdmanbury, MI 50338",
        "postal_code": "87259",
        "city": "Runte-Purdy",
        "country": "LU",
        "clinic_name": "Port Saulland",
        "clinic_location": "2291 Jarrett Court Apt. 427\nSouth Buster, SD 14892",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:54:10.000000Z",
        "updated_at": "2026-10-26T11:54:10.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 113,
        "mrn": "NKNQDQ741793015651",
        "name": "Melissa Emard",
        "email": "1793015651frenner@example.net",
        "language": "en",
        "phone": "+1-463-543-3352",
        "phone_country": "CV",
        "phone_verified_at": null,
        "address1": "111 Don Ways Apt. 581",
        "address2": "South Clintmouth, KS 31600",
        "postal_code": "43702",
        "city": "King PLC",
        "country": "HR",
        "clinic_name": "Mckennahaven",
        "clinic_location": "81456 Jarod Springs Apt. 956\nNew Hectorside, IN 02959",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:54:11.000000Z",
        "updated_at": "2026-10-26T11:54:11.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": null,
    "messages": [
        {
            "id": 12,
            "ticket_id": 21,
            "sender_id": 114,
            "title": "Dr.",
            "content": "Et ad est aut earum.",
            "is_read": false,
            "created_at": "2026-10-26T11:54:13.000000Z",
            "updated_at": "2026-10-26T11:54:13.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update config mode",
    "code": "CONFIG_MODES:COPY_TEMPLATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_MODES:COPY_TEMPLATE:DEVICE_NOT_FOUND"
}

Example response (404, Config mode not found):


{
    "message": "Config mode not found",
    "code": "CONFIG_MODES:COPY_TEMPLATE:MODE_NOT_FOUND"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_MODES:COPY_TEMPLATE:TEMPLATE_NOT_FOUND"
}

Request   

POST api/device/{deviceId}/config-modes/{modeId}/from-template/{templateId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

modeId   integer   

Config mode ID. Example: 1

templateId   integer   

Config template ID. Example: 1

Response

Response Fields

id   integer   

Support ticket ID.

sender_id   integer   

ID of the user who created the ticket.

recipient_id   integer   

ID of the recipient user.

device_id   integer   

Associated device ID.

meeting_date   string   

Scheduled meeting date.

meeting_type   string   

Meeting type.

Must be one of:
  • online
  • in-person
contact_email   string   

Contact email address.

status   string   

Ticket status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

sender   object   

User who created the ticket.

recipient   object   

Recipient user.

device   object   

Associated device.

messages   object[]   

Ticket messages.

Config Notes

API endpoints for config history notes

Get config entry notes list

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1/config/1/notes?user=1&type=public" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/config/1/notes"
);

const params = {
    "user": "1",
    "type": "public",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "config_history_id": 7,
            "user_id": 81,
            "note": "Rerum dignissimos voluptatum similique eligendi.",
            "type": "public",
            "created_at": "2026-10-26T11:53:54.000000Z",
            "updated_at": "2026-10-26T11:53:54.000000Z",
            "author": {
                "id": 81,
                "mrn": "EPXN8RPV1793015633",
                "name": "Zoe Bechtelar",
                "email": "1793015633nigel.roberts@example.org",
                "language": "en",
                "phone": "1-702-225-2462",
                "phone_country": "SM",
                "phone_verified_at": null,
                "address1": "759 Goodwin Squares",
                "address2": "Treutelfurt, NE 38852-7936",
                "postal_code": "26967",
                "city": "Ferry LLC",
                "country": "MT",
                "clinic_name": "Dooleymouth",
                "clinic_location": "17249 Murray Valley\nNew Karenmouth, NJ 45468",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:53:53.000000Z",
                "updated_at": "2026-10-26T11:53:53.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        },
        {
            "id": 2,
            "config_history_id": 8,
            "user_id": 83,
            "note": "Necessitatibus eius laborum magnam rerum voluptatibus et.",
            "type": "public",
            "created_at": "2026-10-26T11:53:55.000000Z",
            "updated_at": "2026-10-26T11:53:55.000000Z",
            "author": {
                "id": 83,
                "mrn": "5997TH4M1793015634",
                "name": "Llewellyn Carroll",
                "email": "1793015634darien.kreiger@example.com",
                "language": "en",
                "phone": "+1 (406) 686-0198",
                "phone_country": "MW",
                "phone_verified_at": null,
                "address1": "338 Fahey Glens Suite 097",
                "address2": "Juanitabury, NM 07857-5240",
                "postal_code": "01075",
                "city": "Russel Ltd",
                "country": "RO",
                "clinic_name": "South Brittanyland",
                "clinic_location": "9452 Wanda Village Suite 912\nNorth Karl, TN 47526-6501",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:53:54.000000Z",
                "updated_at": "2026-10-26T11:53:54.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access config notes",
    "code": "CONFIG_NOTES:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_NOTES:LIST:DEVICE_NOT_FOUND"
}

Example response (404, Config history entry not found):


{
    "message": "Config history entry not found",
    "code": "CONFIG_NOTES:LIST:HISTORY_ENTRY_NOT_FOUND"
}

Request   

GET api/device/{deviceId}/config/{configId}/notes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

Query Parameters

user   integer  optional  

Filter notes by user. Example: 1

type   string  optional  

Filter notes by type (available: public and private) Example: public

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: author).

sortby   string  optional  

Sort by field (available: date). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

Note ID.

config_history_id   integer   

Associated config history entry ID.

user_id   integer   

ID of the user who wrote the note.

note   string   

Note content.

type   string   

Note visibility.

Must be one of:
  • public
  • private
created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who wrote the note.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Get config entry note

requires authentication

Returns single config history entry note in response.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1/config/1/notes/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/config/1/notes/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 3,
    "config_history_id": 9,
    "user_id": 85,
    "note": "Doloribus alias accusamus ducimus corporis soluta saepe facere.",
    "type": "public",
    "created_at": "2026-10-26T11:53:56.000000Z",
    "updated_at": "2026-10-26T11:53:56.000000Z",
    "author": {
        "id": 85,
        "mrn": "EWCYDVFL1793015635",
        "name": "Glennie Bartell",
        "email": "1793015635mkautzer@example.com",
        "language": "en",
        "phone": "1-423-791-4407",
        "phone_country": "GG",
        "phone_verified_at": null,
        "address1": "215 Osinski Unions Apt. 569",
        "address2": "Jonesside, NJ 10260-2031",
        "postal_code": "92784",
        "city": "Feest Inc",
        "country": "RO",
        "clinic_name": "Nicholebury",
        "clinic_location": "691 Simonis Viaduct Apt. 061\nKylefort, MT 09850-8054",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:53:55.000000Z",
        "updated_at": "2026-10-26T11:53:55.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access config notes",
    "code": "CONFIG_NOTES:GET_ENTRY:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_NOTES:GET_ENTRY:DEVICE_NOT_FOUND"
}

Example response (404, Config history entry not found):


{
    "message": "Config history entry not found",
    "code": "CONFIG_NOTES:GET_ENTRY:HISTORY_ENTRY_NOT_FOUND"
}

Example response (404, Config history note not found):


{
    "message": "Config history note not found",
    "code": "CONFIG_NOTES:GET_ENTRY:HISTORY_NOTE_NOT_FOUND"
}

Request   

GET api/device/{deviceId}/config/{configId}/notes/{noteId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

noteId   integer   

Device config entry note ID. Example: 1

Query Parameters

extend   string  optional  

Comma-separated list of relation extensions (available: author).

Response

Response Fields

id   integer   

Note ID.

config_history_id   integer   

Associated config history entry ID.

user_id   integer   

ID of the user who wrote the note.

note   string   

Note content.

type   string   

Note visibility.

Must be one of:
  • public
  • private
created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who wrote the note.

Create config entry note

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/config/1/notes" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"note\": \"Sit voluptatem alias voluptas voluptatem.\",
    \"type\": \"public\"
}"

const url = new URL(
    "http://localhost:8000/api/device/1/config/1/notes"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "note": "Sit voluptatem alias voluptas voluptatem.",
    "type": "public"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 4,
    "config_history_id": 10,
    "user_id": 87,
    "note": "Voluptates nulla blanditiis maxime vitae eos similique.",
    "type": "public",
    "created_at": "2026-10-26T11:53:57.000000Z",
    "updated_at": "2026-10-26T11:53:57.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to add config notes",
    "code": "CONFIG_NOTES:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_NOTES:CREATE:DEVICE_NOT_FOUND"
}

Example response (404, Config history entry not found):


{
    "message": "Config history entry not found",
    "code": "CONFIG_NOTES:CREATE:HISTORY_ENTRY_NOT_FOUND"
}

Request   

POST api/device/{deviceId}/config/{configId}/notes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

Body Parameters

note   string  optional  

Note text. Example: Sit voluptatem alias voluptas voluptatem.

type   string  optional  

Type of the note. Default: public. Example: public

Must be one of:
  • public
  • private

Response

Response Fields

id   integer   

Note ID.

config_history_id   integer   

Associated config history entry ID.

user_id   integer   

ID of the user who wrote the note.

note   string   

Note content.

type   string   

Note visibility.

Must be one of:
  • public
  • private
created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who wrote the note.

Delete config note

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/device/1/config/1/notes/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/config/1/notes/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Config history note deleted",
    "code": "CONFIG_NOTES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete config notes",
    "code": "CONFIG_NOTES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_NOTES:DELETE:DEVICE_NOT_FOUND"
}

Example response (404, Config history entry not found):


{
    "message": "Config history entry not found",
    "code": "CONFIG_NOTES:DELETE:HISTORY_ENTRY_NOT_FOUND"
}

Example response (404, Config history note not found):


{
    "message": "Config history note not found",
    "code": "CONFIG_NOTES:DELETE:HISTORY_NOTE_NOT_FOUND"
}

Request   

DELETE api/device/{deviceId}/config/{configId}/notes/{noteId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

noteId   integer   

Device config entry note ID. Example: 1

Config Schema

API endpoints for config schema management

Get config schema

requires authentication

Returns list of config schema entries for given firmware version.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/versions/firmware/1/schema?filter=modes" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/versions/firmware/1/schema"
);

const params = {
    "filter": "modes",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "firmware_id": 7,
        "key": "voluptas",
        "is_common": 1,
        "type": "firmware",
        "created_at": "2026-10-26T11:55:26.000000Z",
        "updated_at": "2026-10-26T11:55:26.000000Z"
    },
    {
        "id": 2,
        "firmware_id": 9,
        "key": "aliquam",
        "is_common": 0,
        "type": "firmware",
        "created_at": "2026-10-26T11:55:26.000000Z",
        "updated_at": "2026-10-26T11:55:26.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view config schema",
    "code": "CONFIG_SCHEMA:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Firmware version not found):


{
    "message": "Firmware version not found",
    "code": "CONFIG_SCHEMA:GET:FIRMWARE_NOT_FOUND"
}

Request   

GET api/versions/firmware/{firmwareId}/schema

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

firmwareId   integer   

Firmware version ID. Example: 1

Query Parameters

filter   string  optional  

Filter entries by type (available: common, modes). By default all entries all returned. Example: modes

Response

Response Fields

id   integer   

Config schema ID.

firmware_id   integer   

Associated firmware version ID.

key   string   

Config schema key.

is_common   boolean   

Whether this key is shared across all modes.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

firmware   object   

Associated firmware version.

Add config schema

requires authentication

Add one or many config schema entries. Each entry is one key in config. Body of this request is simple array of objects:


            [
                {"key": "key_name", "is_common": 1},
                {"key": "another_name", "is_common": 0},
                ...
            ]
Example request:
curl --request POST \
    "http://localhost:8000/api/versions/firmware/voluptas/schema" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "[
    {
        \"key\": \"gripsPosition.0.initial\",
        \"is_common\": 1,
        \"type\": \"firmware\"
    }
]"

const url = new URL(
    "http://localhost:8000/api/versions/firmware/voluptas/schema"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = [
    {
        "key": "gripsPosition.0.initial",
        "is_common": 1,
        "type": "firmware"
    }
];

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


[
    {
        "id": 3,
        "firmware_id": 11,
        "key": "dignissimos",
        "is_common": 1,
        "type": "firmware",
        "created_at": "2026-10-26T11:55:26.000000Z",
        "updated_at": "2026-10-26T11:55:26.000000Z"
    },
    {
        "id": 4,
        "firmware_id": 13,
        "key": "quis",
        "is_common": 0,
        "type": "firmware",
        "created_at": "2026-10-26T11:55:26.000000Z",
        "updated_at": "2026-10-26T11:55:26.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage config schema",
    "code": "CONFIG_SCHEMA:ADD:INSUFFICIENT_PERMISSION"
}

Example response (404, Firmware version not found):


{
    "message": "Firmware version not found",
    "code": "CONFIG_SCHEMA:ADD:FIRMWARE_NOT_FOUND"
}

Request   

POST api/versions/firmware/{firmwareId}/schema

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

firmwareId   string   

Example: voluptas

Body Parameters

The request body is an array (object[]`). Each item has the following properties:

key   string  optional  

Config key. Example: gripsPosition.0.initial

is_common   integer  optional  

Information if the key belongs to common config (1) or to modes (0). Default: 1. Example: 1

type   string  optional  

Key type: firmware for keys tied to the hand's firmware config, virtual for keys that are not. Default: firmware. Example: firmware

Response

Response Fields

id   integer   

Config schema ID.

firmware_id   integer   

Associated firmware version ID.

key   string   

Config schema key.

is_common   boolean   

Whether this key is shared across all modes.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

firmware   object   

Associated firmware version.

Delete config schema

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/versions/firmware/1/schema/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/versions/firmware/1/schema/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Config schema entry deleted",
    "code": "CONFIG_SCHEMA:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage config schema",
    "code": "CONFIG_SCHEMA:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Firmware version not found):


{
    "message": "Firmware version not found",
    "code": "CONFIG_SCHEMA:DELETE:FIRMWARE_NOT_FOUND"
}

Example response (404, Config schema entry not found):


{
    "message": "Config schema entry not found",
    "code": "CONFIG_SCHEMA:DELETE:SCHEMA_NOT_FOUND"
}

Request   

DELETE api/versions/firmware/{firmwareId}/schema/{schemaId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

firmwareId   integer   

Firmware version ID. Example: 1

schemaId   integer   

Config schema ID. Example: 1

Config Templates

API endpoints for managing config templates

Get config templates list

requires authentication

Entries where author is present are private and owned by its author. Entries where author is null should be considered as global templates prepared by Aether team.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/config/templates?search=sport&author=1&scope=me" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/config/templates"
);

const params = {
    "search": "sport",
    "author": "1",
    "scope": "me",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "name": "Ut voluptatem possimus est id at.",
            "description": "Recusandae perspiciatis magni quaerat voluptatem quo eum.",
            "author_id": 101,
            "company_id": null,
            "config": "{\"autoGrasp\":[0,100],\"coContractionTimings\":[300,100],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[30,90,0,70,40,30,90,50,0,60],\"gripPairsConfig\":[13,4,10,9,6,2,5,12],\"gripSequentialConfig\":[255,11,255,12,6,8,5,255,7,255,255,255],\"gripSwitchingMode\":[2],\"holdOpen\":[2000,2500],\"pulseTimings\":[380,200,390,520],\"softGrip\":[0],\"speedControlStrategy\":[1]}",
            "created_at": "2026-10-26T11:54:04.000000Z",
            "updated_at": "2026-10-26T11:54:04.000000Z",
            "author": {
                "id": 101,
                "mrn": "MP2M95971793015644",
                "name": "Pearl Hills",
                "email": "1793015644kovacek.dorris@example.org",
                "language": "en",
                "phone": "1-458-748-6306",
                "phone_country": "EE",
                "phone_verified_at": null,
                "address1": "4661 Franecki Glens Apt. 324",
                "address2": "West Nichole, OK 35619",
                "postal_code": "47192-2370",
                "city": "Schuster-Dooley",
                "country": "HR",
                "clinic_name": "Port Brandyn",
                "clinic_location": "143 Vidal Stream Apt. 669\nMaximusport, AR 92718",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:54:04.000000Z",
                "updated_at": "2026-10-26T11:54:04.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        },
        {
            "id": 2,
            "name": "Et ea sequi libero tempora dolor quas quam.",
            "description": "Perferendis nemo quaerat excepturi accusamus repellendus laudantium cupiditate assumenda.",
            "author_id": 102,
            "company_id": null,
            "config": "{\"autoGrasp\":[0,0],\"coContractionTimings\":[500,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[70,90,60,60,10,60,60,50,100,100],\"gripPairsConfig\":[13,2,5,12,7,3,11,10],\"gripSequentialConfig\":[12,1,255,6,255,5,13,9,11,4,7,255],\"gripSwitchingMode\":[3],\"holdOpen\":[1500,2000],\"pulseTimings\":[390,710,980,630],\"softGrip\":[0],\"speedControlStrategy\":[1]}",
            "created_at": "2026-10-26T11:54:05.000000Z",
            "updated_at": "2026-10-26T11:54:05.000000Z",
            "author": {
                "id": 102,
                "mrn": "WN698GWH1793015644",
                "name": "Mr. Jamar Cremin Sr.",
                "email": "1793015644ferry.sabrina@example.com",
                "language": "en",
                "phone": "1-641-255-3815",
                "phone_country": "PK",
                "phone_verified_at": null,
                "address1": "92043 Graciela Field",
                "address2": "South Maximeberg, AZ 55135",
                "postal_code": "52727-3422",
                "city": "Weissnat PLC",
                "country": "ES",
                "clinic_name": "Lake Patriciahaven",
                "clinic_location": "24676 Weissnat Trace Suite 118\nRhiannonton, MO 11087",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:54:04.000000Z",
                "updated_at": "2026-10-26T11:54:04.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list config templates",
    "code": "CONFIG_TEMPLATES:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/config/templates

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

search   string  optional  

Filter config templates by name. Example: sport

author   integer  optional  

Super Admin only: Filter config templates by author. Example: 1

scope   string  optional  

ClinicAdmin/Clinician/ClinicianSupport only: Filter config templates by scope. The value must be one of:

  • me (entries where current user is author),
  • global (entries added by Aether).
Example: `me`
perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: author).

Response

Response Fields

items   object   
id   integer   

Config template ID.

name   string   

Template name.

description   string   

Template description.

author_id   integer   

ID of the user who created the template.

company_id   integer   

Associated company ID.

config   string   

Serialized config data.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who created the template.

notes   object[]   

Notes attached to this template.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Get config template

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/config/templates/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/config/templates/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 3,
    "name": "Et quo sed et quos et ipsum voluptate.",
    "description": "Maiores enim velit maiores blanditiis nihil ut dignissimos.",
    "author_id": 103,
    "company_id": null,
    "config": "{\"autoGrasp\":[1,0],\"coContractionTimings\":[100,100],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[20,50,90,100,70,70,80,0,10,90],\"gripPairsConfig\":[9,8,5,12,4,1,13,2],\"gripSequentialConfig\":[5,4,8,2,255,11,255,10,255,12,9,255],\"gripSwitchingMode\":[1],\"holdOpen\":[1500,2000],\"pulseTimings\":[790,530,740,500],\"softGrip\":[1],\"speedControlStrategy\":[1]}",
    "created_at": "2026-10-26T11:54:05.000000Z",
    "updated_at": "2026-10-26T11:54:05.000000Z",
    "author": {
        "id": 103,
        "mrn": "D5G8N87D1793015645",
        "name": "Rosalia Kerluke",
        "email": "1793015645nitzsche.retta@example.net",
        "language": "en",
        "phone": "+1 (281) 827-5718",
        "phone_country": "MZ",
        "phone_verified_at": null,
        "address1": "54926 Heathcote Centers Apt. 610",
        "address2": "Millertown, MA 35202",
        "postal_code": "53318",
        "city": "Balistreri, Rath and Towne",
        "country": "GB",
        "clinic_name": "Leilaton",
        "clinic_location": "86985 Imogene Greens Apt. 736\nNew Rosina, MS 11568-2452",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:54:05.000000Z",
        "updated_at": "2026-10-26T11:54:05.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view config template",
    "code": "CONFIG_TEMPLATES:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_TEMPLATES:GET:TEMPLATE_NOT_FOUND"
}

Request   

GET api/config/templates/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Config template ID. Example: 1

Query Parameters

extend   string  optional  

Comma-separated list of relation extensions (available: author).

Response

Response Fields

id   integer   

Config template ID.

name   string   

Template name.

description   string   

Template description.

author_id   integer   

ID of the user who created the template.

company_id   integer   

Associated company ID.

config   string   

Serialized config data.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who created the template.

notes   object[]   

Notes attached to this template.

Create new config template

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/config/templates" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Default config for Aether Zeus\",
    \"description\": \"Description of the config template.\",
    \"owner\": \"company\",
    \"author\": 1,
    \"config\": \"{\\\"param_1\\\": [100, 200], \\\"param_2\\\": [100, 200, 300]}\"
}"

const url = new URL(
    "http://localhost:8000/api/config/templates"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Default config for Aether Zeus",
    "description": "Description of the config template.",
    "owner": "company",
    "author": 1,
    "config": "{\"param_1\": [100, 200], \"param_2\": [100, 200, 300]}"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 4,
    "name": "Sit molestiae ab qui debitis aspernatur vel eos hic.",
    "description": "Et illum aperiam earum architecto.",
    "author_id": 104,
    "company_id": null,
    "config": "{\"autoGrasp\":[0,100],\"coContractionTimings\":[500,300],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[100,30,70,60,80,90,70,0,10,100],\"gripPairsConfig\":[9,2,8,10,5,11,1,3],\"gripSequentialConfig\":[255,10,5,13,12,255,7,255,255,6,4,1],\"gripSwitchingMode\":[2],\"holdOpen\":[1500,2500],\"pulseTimings\":[990,710,920,860],\"softGrip\":[1],\"speedControlStrategy\":[1]}",
    "created_at": "2026-10-26T11:54:06.000000Z",
    "updated_at": "2026-10-26T11:54:06.000000Z",
    "author": {
        "id": 104,
        "mrn": "Q9FHD9J41793015645",
        "name": "Dr. Aurelio Wintheiser",
        "email": "1793015645turner.johnson@example.com",
        "language": "en",
        "phone": "843-270-1014",
        "phone_country": "EH",
        "phone_verified_at": null,
        "address1": "717 Bailey Lodge",
        "address2": "Edenshire, OK 90934-6259",
        "postal_code": "75900-3834",
        "city": "Davis, Morissette and Cruickshank",
        "country": "PT",
        "clinic_name": "Dariusberg",
        "clinic_location": "65756 Kilback Ramp Suite 944\nKertzmannland, MT 79804-4840",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:54:05.000000Z",
        "updated_at": "2026-10-26T11:54:05.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create config template",
    "code": "CONFIG_TEMPLATES:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/config/templates

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Name of the config template. Example: Default config for Aether Zeus

description   string  optional  

Description of the config template. Example: Description of the config template.

owner   string  optional  

Mark config template owned by clinician or company. Default: me (clinician). Example: company

Must be one of:
  • me
  • company
author   string  optional  

Super Admin only: User ID to be the author of template. The id of an existing record in the App\Models\User table. Example: 1

config   string   

Full config. MUST_BE_JSON. Example: {"param_1": [100, 200], "param_2": [100, 200, 300]}

Response

Response Fields

id   integer   

Config template ID.

name   string   

Template name.

description   string   

Template description.

author_id   integer   

ID of the user who created the template.

company_id   integer   

Associated company ID.

config   string   

Serialized config data.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who created the template.

notes   object[]   

Notes attached to this template.

Update config template

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/config/templates/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Default config for Aether Zeus\",
    \"description\": \"Description of the config template.\",
    \"owner\": \"company\",
    \"author\": 1,
    \"config\": \"{\\\"param_1\\\": [100, 200], \\\"param_2\\\": [100, 200, 300]}\"
}"

const url = new URL(
    "http://localhost:8000/api/config/templates/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Default config for Aether Zeus",
    "description": "Description of the config template.",
    "owner": "company",
    "author": 1,
    "config": "{\"param_1\": [100, 200], \"param_2\": [100, 200, 300]}"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 5,
    "name": "Facere voluptas sunt nisi dolores rerum mollitia.",
    "description": "Sint quisquam perspiciatis ratione quis.",
    "author_id": 105,
    "company_id": null,
    "config": "{\"autoGrasp\":[1,100],\"coContractionTimings\":[400,200],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[100,20,0,20,0,40,50,20,40,0],\"gripPairsConfig\":[12,13,6,5,9,7,4,3],\"gripSequentialConfig\":[1,8,4,255,10,9,5,255,255,3,255,11],\"gripSwitchingMode\":[2],\"holdOpen\":[1500,2500],\"pulseTimings\":[30,700,590,260],\"softGrip\":[1],\"speedControlStrategy\":[0]}",
    "created_at": "2026-10-26T11:54:06.000000Z",
    "updated_at": "2026-10-26T11:54:06.000000Z",
    "author": {
        "id": 105,
        "mrn": "Q52Z7QX51793015646",
        "name": "Oma Lueilwitz",
        "email": "1793015646antonette.beatty@example.net",
        "language": "en",
        "phone": "(781) 878-1029",
        "phone_country": "SB",
        "phone_verified_at": null,
        "address1": "80314 Barton Lakes Apt. 317",
        "address2": "Bartellshire, UT 43973-5704",
        "postal_code": "51049",
        "city": "Schumm, Glover and O'Connell",
        "country": "GR",
        "clinic_name": "Jerdeberg",
        "clinic_location": "627 Gottlieb Street Suite 366\nItzeltown, GA 17502-9175",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:54:06.000000Z",
        "updated_at": "2026-10-26T11:54:06.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update config template",
    "code": "CONFIG_TEMPLATES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_TEMPLATES:UPDATE:TEMPLATE_NOT_FOUND"
}

Request   

PUT api/config/templates/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Config template ID. Example: 1

Body Parameters

name   string  optional  

Name of the config template. Example: Default config for Aether Zeus

description   string  optional  

Description of the config template. Example: Description of the config template.

owner   string  optional  

Mark config template owned by clinician or company. Default: me (clinician). Example: company

Must be one of:
  • me
  • company
author   string  optional  

Super Admin only: User ID to be the author of template. The id of an existing record in the App\Models\User table. Example: 1

config   string  optional  

Full config. MUST_BE_JSON. Example: {"param_1": [100, 200], "param_2": [100, 200, 300]}

Response

Response Fields

id   integer   

Config template ID.

name   string   

Template name.

description   string   

Template description.

author_id   integer   

ID of the user who created the template.

company_id   integer   

Associated company ID.

config   string   

Serialized config data.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who created the template.

notes   object[]   

Notes attached to this template.

Delete config template

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/config/templates/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/config/templates/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Config template deleted",
    "code": "CONFIG_TEMPLATES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete config template",
    "code": "CONFIG_TEMPLATES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_TEMPLATES:DELETE:TEMPLATE_NOT_FOUND"
}

Request   

DELETE api/config/templates/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Config template ID. Example: 1

Config Templates Notes

API endpoints for config templates notes

Get config templates notes list

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/config/templates/1/notes?user=1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/config/templates/1/notes"
);

const params = {
    "user": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "template_id": 6,
            "user_id": 106,
            "note": "Qui quam quos porro sit est qui dolore.",
            "created_at": "2026-10-26T11:54:07.000000Z",
            "updated_at": "2026-10-26T11:54:07.000000Z",
            "author": {
                "id": 106,
                "mrn": "HC9PGEF91793015647",
                "name": "Rebecca Romaguera",
                "email": "1793015647mohammed79@example.com",
                "language": "en",
                "phone": "(732) 205-9967",
                "phone_country": "IT",
                "phone_verified_at": null,
                "address1": "61903 Paucek Wall Apt. 360",
                "address2": "Schmittville, DC 50850",
                "postal_code": "95623-6899",
                "city": "Hauck, Muller and Becker",
                "country": "LV",
                "clinic_name": "New Moises",
                "clinic_location": "997 Walter Common\nVanshire, AR 21806",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:54:07.000000Z",
                "updated_at": "2026-10-26T11:54:07.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        },
        {
            "id": 2,
            "template_id": 7,
            "user_id": 107,
            "note": "Deserunt cumque impedit dignissimos rem esse possimus adipisci.",
            "created_at": "2026-10-26T11:54:08.000000Z",
            "updated_at": "2026-10-26T11:54:08.000000Z",
            "author": {
                "id": 107,
                "mrn": "536GTEZ71793015647",
                "name": "Walter Lockman",
                "email": "1793015647luettgen.marcella@example.org",
                "language": "en",
                "phone": "859.661.3196",
                "phone_country": "TL",
                "phone_verified_at": null,
                "address1": "80223 Cummings Path",
                "address2": "Port Brielleshire, CO 29292-2286",
                "postal_code": "38350-6703",
                "city": "Abshire LLC",
                "country": "SE",
                "clinic_name": "Brandimouth",
                "clinic_location": "831 Conroy Mill Apt. 373\nHilperthaven, UT 10312-1107",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:54:07.000000Z",
                "updated_at": "2026-10-26T11:54:07.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access config templates notes",
    "code": "CONFIG_TEMPLATE_NOTES:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_TEMPLATE_NOTES:LIST:TEMPLATE_NOT_FOUND"
}

Request   

GET api/config/templates/{id}/notes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Config template ID. Example: 1

Query Parameters

user   integer  optional  

Filter notes by user. Example: 1

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: author).

sortby   string  optional  

Sort by field (available: date). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

Note ID.

template_id   integer   

Associated config template ID.

user_id   integer   

ID of the user who wrote the note.

note   string   

Note content.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who wrote the note.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Get config template note

requires authentication

Returns single config template note in response.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/config/templates/1/notes/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/config/templates/1/notes/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 3,
    "template_id": 8,
    "user_id": 108,
    "note": "Debitis error cupiditate molestias nemo perspiciatis at architecto molestiae.",
    "created_at": "2026-10-26T11:54:08.000000Z",
    "updated_at": "2026-10-26T11:54:08.000000Z",
    "author": {
        "id": 108,
        "mrn": "8K8MXPW71793015648",
        "name": "Prof. Jovan Gleichner",
        "email": "1793015648jaskolski.alexys@example.net",
        "language": "en",
        "phone": "646.501.1831",
        "phone_country": "TT",
        "phone_verified_at": null,
        "address1": "95114 Pacocha Trafficway",
        "address2": "Lake Tomasaberg, MI 30333",
        "postal_code": "61154-5504",
        "city": "Aufderhar and Sons",
        "country": "MT",
        "clinic_name": "Lake Guillermo",
        "clinic_location": "6950 Brandt Path\nBashirianshire, WV 15343",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:54:08.000000Z",
        "updated_at": "2026-10-26T11:54:08.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access config templates notes",
    "code": "CONFIG_TEMPLATE_NOTES:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_TEMPLATE_NOTES:GET:TEMPLATE_NOT_FOUND"
}

Example response (404, Config template note not found):


{
    "message": "Config template note not found",
    "code": "CONFIG_TEMPLATE_NOTES:GET:NOTE_NOT_FOUND"
}

Request   

GET api/config/templates/{id}/notes/{noteId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Config template ID. Example: 1

noteId   integer   

Config template note ID. Example: 1

Query Parameters

extend   string  optional  

Comma-separated list of relation extensions (available: author).

Response

Response Fields

id   integer   

Note ID.

template_id   integer   

Associated config template ID.

user_id   integer   

ID of the user who wrote the note.

note   string   

Note content.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who wrote the note.

Create new config template note

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/config/templates/1/notes" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"note\": \"Nemo dolorem ut non repellat ipsa sit quis.\"
}"

const url = new URL(
    "http://localhost:8000/api/config/templates/1/notes"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "note": "Nemo dolorem ut non repellat ipsa sit quis."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 4,
    "template_id": 9,
    "user_id": 109,
    "note": "Ut voluptatem quaerat error dolor est optio harum dolore.",
    "created_at": "2026-10-26T11:54:09.000000Z",
    "updated_at": "2026-10-26T11:54:09.000000Z",
    "author": {
        "id": 109,
        "mrn": "66GVCHFF1793015648",
        "name": "Alvina Kling",
        "email": "1793015648justus.pacocha@example.org",
        "language": "en",
        "phone": "+1.754.809.7740",
        "phone_country": "SR",
        "phone_verified_at": null,
        "address1": "726 Presley Bridge",
        "address2": "North Madelynn, TX 53655",
        "postal_code": "05793",
        "city": "Bradtke PLC",
        "country": "ES",
        "clinic_name": "Rogersbury",
        "clinic_location": "6256 Grant Dam Suite 813\nWest Kadinville, KS 53196",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:54:08.000000Z",
        "updated_at": "2026-10-26T11:54:08.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to add config templates notes",
    "code": "CONFIG_TEMPLATE_NOTES:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_TEMPLATE_NOTES:CREATE:TEMPLATE_NOT_FOUND"
}

Request   

POST api/config/templates/{id}/notes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Config template ID. Example: 1

Body Parameters

note   string  optional  

Note text. Example: Nemo dolorem ut non repellat ipsa sit quis.

Response

Response Fields

id   integer   

Note ID.

template_id   integer   

Associated config template ID.

user_id   integer   

ID of the user who wrote the note.

note   string   

Note content.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who wrote the note.

Delete config template note

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/config/templates/1/notes/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/config/templates/1/notes/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Config template note deleted",
    "code": "CONFIG_TEMPLATE_NOTES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete config templates notes",
    "code": "CONFIG_TEMPLATE_NOTES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_TEMPLATE_NOTES:DELETE:TEMPLATE_NOT_FOUND"
}

Example response (404, Config template note not found):


{
    "message": "Config template note not found",
    "code": "CONFIG_TEMPLATE_NOTES:DELETE:NOTE_NOT_FOUND"
}

Request   

DELETE api/config/templates/{id}/notes/{noteId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Config template ID. Example: 1

noteId   integer   

Config template note ID. Example: 1

Custom Grips

API endpoints for custom grips management

List custom grips templates

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/custom-grips-templates" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/custom-grips-templates"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "user_id": 260,
            "name": "nicholas.jacobs",
            "initial_position": "[50, 50, 50, 50, 50]",
            "limit_position": "[900, 900, 900, 900, 900]",
            "active_fingers": "[0, 1, 1, 1, 1]",
            "created_at": "2026-10-26T11:55:28.000000Z",
            "updated_at": "2026-10-26T11:55:28.000000Z"
        },
        {
            "id": 2,
            "user_id": 261,
            "name": "mayer.penelope",
            "initial_position": "[50, 50, 50, 50, 50]",
            "limit_position": "[900, 900, 900, 900, 900]",
            "active_fingers": "[0, 1, 1, 1, 1]",
            "created_at": "2026-10-26T11:55:28.000000Z",
            "updated_at": "2026-10-26T11:55:28.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage custom grips templates",
    "code": "CUSTOM_GRIPS_TEMPLATES:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/custom-grips-templates

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Response

Response Fields

items   object   
id   integer   

Custom grip template ID.

user_id   integer   

Owner user ID.

name   string   

Template name.

initial_position   string   

Initial finger positions.

limit_position   string   

Limit finger positions.

active_fingers   string   

Active fingers configuration.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Create custom grip template

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/custom-grips-templates" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Custom Grip Template 1\",
    \"initial_position\": \"[50, 50, 50, 50, 50]\",
    \"limit_position\": \"[900, 900, 900, 900, 900]\",
    \"active_fingers\": \"[0, 1, 1, 1, 1]\"
}"

const url = new URL(
    "http://localhost:8000/api/custom-grips-templates"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Custom Grip Template 1",
    "initial_position": "[50, 50, 50, 50, 50]",
    "limit_position": "[900, 900, 900, 900, 900]",
    "active_fingers": "[0, 1, 1, 1, 1]"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "user_id": 262,
    "name": "johathan.huel",
    "initial_position": "[50, 50, 50, 50, 50]",
    "limit_position": "[900, 900, 900, 900, 900]",
    "active_fingers": "[0, 1, 1, 1, 1]",
    "created_at": "2026-10-26T11:55:29.000000Z",
    "updated_at": "2026-10-26T11:55:29.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage custom grips templates",
    "code": "CUSTOM_GRIPS_TEMPLATES:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Custom grip template name in use):


{
    "message": "Custom grip template name already in use",
    "code": "CUSTOM_GRIPS_TEMPLATES:CREATE:NAME_IN_USE"
}

Request   

POST api/custom-grips-templates

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Name of custom grip template. Example: Custom Grip Template 1

initial_position   string   

Grip initial position. Value should be a string containing the array of values. Example: "[50, 50, 50, 50, 50]". Must start with one of [ Must end with one of ]. Example: [50, 50, 50, 50, 50]

limit_position   string   

Grip limit position. Value should be a string containing the array of values. Example: "[900, 900, 900, 900, 900]". Must start with one of [ Must end with one of ]. Example: [900, 900, 900, 900, 900]

active_fingers   string   

Grip active fingers. Value should be a string containing the array of values. Example: "[0, 1, 1, 1, 1]". Must start with one of [ Must end with one of ]. Example: [0, 1, 1, 1, 1]

Response

Response Fields

id   integer   

Custom grip template ID.

user_id   integer   

Owner user ID.

name   string   

Template name.

initial_position   string   

Initial finger positions.

limit_position   string   

Limit finger positions.

active_fingers   string   

Active fingers configuration.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Delete custom grip template

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/custom-grips-templates/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/custom-grips-templates/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Custom grip deleted",
    "code": "CUSTOM_GRIPS_TEMPLATES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage custom grips templates",
    "code": "CUSTOM_GRIPS_TEMPLATES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Custom grip template not found):


{
    "message": "Custom grip template not found",
    "code": "CUSTOM_GRIPS_TEMPLATES:DELETE:TEMPLATE_NOT_FOUND"
}

Request   

DELETE api/custom-grips-templates/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Custom Grip Template ID. Example: 1

List custom grips

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1/custom-grips" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/custom-grips"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "device_id": 143,
            "name": "joannie39",
            "opposed": 1,
            "grip_number": 0,
            "created_at": "2026-10-26T11:55:29.000000Z",
            "updated_at": "2026-10-26T11:55:29.000000Z"
        },
        {
            "id": 2,
            "device_id": 144,
            "name": "rachel94",
            "opposed": 1,
            "grip_number": 0,
            "created_at": "2026-10-26T11:55:29.000000Z",
            "updated_at": "2026-10-26T11:55:29.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view custom grips",
    "code": "CUSTOM_GRIPS:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CUSTOM_GRIPS:LIST:DEVICE_NOT_FOUND"
}

Request   

GET api/device/{deviceId}/custom-grips

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Response

Response Fields

items   object   
id   integer   

Custom grip ID.

device_id   integer   

Associated device ID.

name   string   

Custom grip name.

opposed   boolean   

Whether the grip is opposed.

grip_number   integer   

Grip slot number.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Create custom grip

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/custom-grips" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Custom Grip 1\",
    \"opposed\": true,
    \"grip_number\": 1
}"

const url = new URL(
    "http://localhost:8000/api/device/1/custom-grips"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Custom Grip 1",
    "opposed": true,
    "grip_number": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "device_id": 145,
    "name": "fbrakus",
    "opposed": 1,
    "grip_number": 0,
    "created_at": "2026-10-26T11:55:29.000000Z",
    "updated_at": "2026-10-26T11:55:29.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage custom grips",
    "code": "CUSTOM_GRIPS:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Custom grip name in use):


{
    "message": "Custom grip name already in use",
    "code": "CUSTOM_GRIPS:CREATE:NAME_IN_USE"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CUSTOM_GRIPS:CREATE:DEVICE_NOT_FOUND"
}

Request   

POST api/device/{deviceId}/custom-grips

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Body Parameters

name   string   

Name of custom grip. Example: Custom Grip 1

opposed   boolean   

Grip opposed status. Example: true

grip_number   integer   

Grip number (not ID). Example: 1

Response

Response Fields

id   integer   

Custom grip ID.

device_id   integer   

Associated device ID.

name   string   

Custom grip name.

opposed   boolean   

Whether the grip is opposed.

grip_number   integer   

Grip slot number.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Update custom grip

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/device/1/custom-grips/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Custom Grip 1\",
    \"opposed\": true,
    \"grip_number\": 1
}"

const url = new URL(
    "http://localhost:8000/api/device/1/custom-grips/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Custom Grip 1",
    "opposed": true,
    "grip_number": 1
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 4,
    "device_id": 146,
    "name": "jones.waldo",
    "opposed": 1,
    "grip_number": 0,
    "created_at": "2026-10-26T11:55:29.000000Z",
    "updated_at": "2026-10-26T11:55:29.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage custom grips",
    "code": "CUSTOM_GRIPS:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Custom grip name in use):


{
    "message": "Custom grip name already in use",
    "code": "CUSTOM_GRIPS:UPDATE:NAME_IN_USE"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CUSTOM_GRIPS:UPDATE:DEVICE_NOT_FOUND"
}

Example response (404, Custom grip not found):


{
    "message": "Custom grip not found",
    "code": "CUSTOM_GRIPS:UPDATE:GRIP_NOT_FOUND"
}

Request   

PUT api/device/{deviceId}/custom-grips/{gripId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

gripId   integer   

Custom Grip ID. Example: 1

Body Parameters

name   string  optional  

Name of custom grip. Example: Custom Grip 1

opposed   boolean  optional  

Grip opposed status. Example: true

grip_number   integer  optional  

Grip number (not ID). Example: 1

Response

Response Fields

id   integer   

Custom grip ID.

device_id   integer   

Associated device ID.

name   string   

Custom grip name.

opposed   boolean   

Whether the grip is opposed.

grip_number   integer   

Grip slot number.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Delete custom grip

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/device/1/custom-grips/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/custom-grips/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Custom grip template deleted",
    "code": "CUSTOM_GRIPS:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage custom grips",
    "code": "CUSTOM_GRIPS:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CUSTOM_GRIPS:DELETE:DEVICE_NOT_FOUND"
}

Example response (404, Custom grip not found):


{
    "message": "Custom grip not found",
    "code": "CUSTOM_GRIPS:DELETE:GRIP_NOT_FOUND"
}

Request   

DELETE api/device/{deviceId}/custom-grips/{gripId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

gripId   integer   

Custom Grip ID. Example: 1

Device Measurements

API endpoints for device measurement history

List device measurements

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/devices/1/measurements" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/devices/1/measurements"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "device_id": 17,
            "data": {
                "unit": "cm",
                "length": 25.15
            },
            "created_at": "2026-10-26T11:53:32.000000Z"
        },
        {
            "id": 2,
            "device_id": 18,
            "data": {
                "unit": "cm",
                "length": 25.21
            },
            "created_at": "2026-10-26T11:53:32.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view device measurements",
    "code": "DEVICE_MEASUREMENTS:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICE_MEASUREMENTS:LIST:DEVICE_NOT_FOUND"
}

Request   

GET api/devices/{deviceId}/measurements

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Create device measurement

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/devices/1/measurements" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": {
        \"length\": 25.4,
        \"unit\": \"cm\"
    }
}"

const url = new URL(
    "http://localhost:8000/api/devices/1/measurements"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "data": {
        "length": 25.4,
        "unit": "cm"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "device_id": 19,
    "data": {
        "unit": "cm",
        "length": 27.49
    },
    "created_at": "2026-10-26T11:53:32.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create device measurements",
    "code": "DEVICE_MEASUREMENTS:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICE_MEASUREMENTS:CREATE:DEVICE_NOT_FOUND"
}

Request   

POST api/devices/{deviceId}/measurements

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Body Parameters

data   object   

Measurement payload (any JSON object).

Delete device measurement

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/measurements/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/measurements/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Device measurement deleted",
    "code": "DEVICE_MEASUREMENTS:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete device measurements",
    "code": "DEVICE_MEASUREMENTS:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Measurement not found):


{
    "message": "Device measurement not found",
    "code": "DEVICE_MEASUREMENTS:DELETE:MEASUREMENT_NOT_FOUND"
}

Request   

DELETE api/measurements/{measurementId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

measurementId   integer   

Measurement ID. Example: 1

Device Models

API endpoints for device models management

Get device models list

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/devices/models?active=1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/devices/models"
);

const params = {
    "active": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 3,
        "name": "Zeus hand v1",
        "type": "leg",
        "orientation": "left",
        "active": 1,
        "created_at": "2026-10-26T11:53:30.000000Z",
        "updated_at": "2026-10-26T11:53:30.000000Z"
    },
    {
        "id": 4,
        "name": "Zeus hand v1",
        "type": "leg",
        "orientation": "left",
        "active": 1,
        "created_at": "2026-10-26T11:53:30.000000Z",
        "updated_at": "2026-10-26T11:53:30.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list device models",
    "code": "DEVICE_MODELS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/devices/models

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

active   integer  optional  

Filter device models by active status (available: 0 - only inactive, 1 - only active, any - all users). Default: 1. Example: 1

Response

Response Fields

id   integer   

Device model ID.

name   string   

Model name.

type   string   

Model type.

orientation   string   

Model orientation.

active   boolean   

Whether the model is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Create device model

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/devices/models" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Zeus hand v1\",
    \"type\": \"hand\",
    \"orientation\": \"right\",
    \"active\": true
}"

const url = new URL(
    "http://localhost:8000/api/devices/models"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Zeus hand v1",
    "type": "hand",
    "orientation": "right",
    "active": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 5,
    "name": "Zeus hand v1",
    "type": "arm",
    "orientation": "right",
    "active": 1,
    "created_at": "2026-10-26T11:53:30.000000Z",
    "updated_at": "2026-10-26T11:53:30.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create device model",
    "code": "DEVICE_MODELS:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/devices/models

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Model name. Example: Zeus hand v1

type   string  optional  

Model type (e.g. hand). Example: hand

orientation   string  optional  

Model orientation if specified. Example: right

active   boolean  optional  

Device model active status (0 - inactive, 1 - active). Example: true

Response

Response Fields

id   integer   

Device model ID.

name   string   

Model name.

type   string   

Model type.

orientation   string   

Model orientation.

active   boolean   

Whether the model is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Update device model

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/devices/models/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Zeus hand v1\",
    \"type\": \"hand\",
    \"orientation\": \"left\",
    \"active\": true
}"

const url = new URL(
    "http://localhost:8000/api/devices/models/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Zeus hand v1",
    "type": "hand",
    "orientation": "left",
    "active": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 6,
    "name": "Zeus hand v1",
    "type": "leg",
    "orientation": "left",
    "active": 1,
    "created_at": "2026-10-26T11:53:30.000000Z",
    "updated_at": "2026-10-26T11:53:30.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update device model",
    "code": "DEVICE_MODELS:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device model not found):


{
    "message": "Device model not found",
    "code": "DEVICE_MODELS:UPDATE:MODEL_NOT_FOUND"
}

Request   

PUT api/devices/models/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

DeviceModel ID. Example: 1

Body Parameters

name   string  optional  

Model name. Example: Zeus hand v1

type   string  optional  

Model type (e.g. hand). Example: hand

orientation   string  optional  

Model orientation if specified. Example: left

active   boolean  optional  

Device model active status (0 - inactive, 1 - active). Example: true

Response

Response Fields

id   integer   

Device model ID.

name   string   

Model name.

type   string   

Model type.

orientation   string   

Model orientation.

active   boolean   

Whether the model is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Device Peripherals

API endpoints for device peripherals management

List device peripherals

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/devices/peripherals" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/devices/peripherals"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "name": "cumque",
            "company": "Medhurst Inc",
            "internal_id": "e7cc1f99-4ea0-380c-9bde-7b4e9c620e03",
            "type": "deserunt",
            "created_at": "2026-10-26T11:53:30.000000Z",
            "updated_at": "2026-10-26T11:53:30.000000Z"
        },
        {
            "id": 2,
            "name": "aliquam",
            "company": "Rohan, Mraz and Bins",
            "internal_id": "d2018c6a-e3c9-331d-8849-f1a099706d72",
            "type": "omnis",
            "created_at": "2026-10-26T11:53:30.000000Z",
            "updated_at": "2026-10-26T11:53:30.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view device peripherals",
    "code": "DEVICE_PERIPHERALS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/devices/peripherals

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Create device peripheral

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/devices/peripherals" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Bluetooth Dongle\",
    \"company\": \"Acme Corp\",
    \"internal_id\": \"BT-DONGLE-001\",
    \"type\": \"bluetooth_dongle\"
}"

const url = new URL(
    "http://localhost:8000/api/devices/peripherals"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Bluetooth Dongle",
    "company": "Acme Corp",
    "internal_id": "BT-DONGLE-001",
    "type": "bluetooth_dongle"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "name": "perferendis",
    "company": "Swift-Larkin",
    "internal_id": "9b268833-37bb-3fb0-ad69-423373d0fe50",
    "type": "sed",
    "created_at": "2026-10-26T11:53:30.000000Z",
    "updated_at": "2026-10-26T11:53:30.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage device peripherals",
    "code": "DEVICE_PERIPHERALS:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/devices/peripherals

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Peripheral device name. Example: Bluetooth Dongle

company   string   

Manufacturer of the peripheral device. Example: Acme Corp

internal_id   string   

Internal identifier of the peripheral device. Example: BT-DONGLE-001

type   string   

Type of the peripheral device. Example: bluetooth_dongle

Update device peripheral

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/devices/peripherals/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Bluetooth Dongle\",
    \"company\": \"Acme Corp\",
    \"internal_id\": \"BT-DONGLE-001\",
    \"type\": \"bluetooth_dongle\"
}"

const url = new URL(
    "http://localhost:8000/api/devices/peripherals/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Bluetooth Dongle",
    "company": "Acme Corp",
    "internal_id": "BT-DONGLE-001",
    "type": "bluetooth_dongle"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 4,
    "name": "atque",
    "company": "Hessel PLC",
    "internal_id": "11328258-7d25-3b82-9f69-d3ee0bbd77d8",
    "type": "sed",
    "created_at": "2026-10-26T11:53:30.000000Z",
    "updated_at": "2026-10-26T11:53:30.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage device peripherals",
    "code": "DEVICE_PERIPHERALS:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Peripheral not found):


{
    "message": "Device peripheral not found",
    "code": "DEVICE_PERIPHERALS:UPDATE:PERIPHERAL_NOT_FOUND"
}

Request   

PUT api/devices/peripherals/{peripheralId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

peripheralId   integer   

Device Peripheral ID. Example: 1

Body Parameters

name   string  optional  

Peripheral device name. Example: Bluetooth Dongle

company   string  optional  

Manufacturer of the peripheral device. Example: Acme Corp

internal_id   string  optional  

Internal identifier of the peripheral device. Example: BT-DONGLE-001

type   string  optional  

Type of the peripheral device. Example: bluetooth_dongle

Delete device peripheral

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/devices/peripherals/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/devices/peripherals/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Device peripheral deleted",
    "code": "DEVICE_PERIPHERALS:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage device peripherals",
    "code": "DEVICE_PERIPHERALS:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Peripheral not found):


{
    "message": "Device peripheral not found",
    "code": "DEVICE_PERIPHERALS:DELETE:PERIPHERAL_NOT_FOUND"
}

Request   

DELETE api/devices/peripherals/{peripheralId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

peripheralId   integer   

Device Peripheral ID. Example: 1

Devices

API endpoints for devices management

Check serial number or bluetooth ID

Public endpoint responding with status of given device serial number or bluetooth ID. If any of these numbers can be found in database, status will be true. Otherwise, status will be false (device does not exist).

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/check/S3R1AL-NUM83R" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"serial\"
}"

const url = new URL(
    "http://localhost:8000/api/device/check/S3R1AL-NUM83R"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "serial"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "status": true
}

Request   

GET api/device/check/{serial}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

serial   string   

Device serial number or bluetooth ID. Example: S3R1AL-NUM83R

Body Parameters

type   string  optional  

Type of checked identifier. Example: serial

Must be one of:
  • serial
  • bluetooth_id

Get devices list

requires authentication

Possible extend options:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/devices?search=S3R1AL-NUM83R&active=-1&amputee=1&clinician=1&model=1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/devices"
);

const params = {
    "search": "S3R1AL-NUM83R",
    "active": "-1",
    "amputee": "1",
    "clinician": "1",
    "model": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 5,
            "serial": "35adefe4-ac4d-3cb0-aad3-3dab2dc4d209",
            "bluetooth_id": "09e863d0-2cc9-377b-9c91-b952ca979db7",
            "company_id": null,
            "model_id": 7,
            "amputee_id": 38,
            "clinician_id": null,
            "firmware_version_id": null,
            "pcb_version_id": null,
            "reverse_magnets": 0,
            "is_electrode": 0,
            "active": 1,
            "last_activity_at": "0000-00-00 00:00:00",
            "first_connected_at": null,
            "measurements": null,
            "created_at": "2026-10-26T11:53:30.000000Z",
            "updated_at": "2026-10-26T11:53:30.000000Z",
            "first_config_change_at": null,
            "model": {
                "id": 7,
                "name": "Zeus hand v1",
                "type": "arm",
                "orientation": "left",
                "active": 1,
                "created_at": "2026-10-26T11:53:30.000000Z",
                "updated_at": "2026-10-26T11:53:30.000000Z"
            },
            "amputee": {
                "id": 38,
                "mrn": "VYD4G2CG1793015610",
                "name": "Kathryn Ferry",
                "email": "1793015610renee.pouros@example.org",
                "language": "en",
                "phone": "947.551.0133",
                "phone_country": "MR",
                "phone_verified_at": null,
                "address1": "16270 Dickens Burg Suite 640",
                "address2": "North Heidimouth, MI 33323",
                "postal_code": "26449",
                "city": "Schinner Inc",
                "country": "FI",
                "clinic_name": "Lake Jettieville",
                "clinic_location": "693 Estella Landing\nWest Zoeystad, MT 09942-6149",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:53:30.000000Z",
                "updated_at": "2026-10-26T11:53:30.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        },
        {
            "id": 6,
            "serial": "e7f8646a-bfc8-3cd4-82cd-0c90e62f5ab6",
            "bluetooth_id": "0d1e235f-6242-3786-95da-97d1897aa90e",
            "company_id": null,
            "model_id": 8,
            "amputee_id": 39,
            "clinician_id": null,
            "firmware_version_id": null,
            "pcb_version_id": null,
            "reverse_magnets": 0,
            "is_electrode": 0,
            "active": 1,
            "last_activity_at": "0000-00-00 00:00:00",
            "first_connected_at": null,
            "measurements": null,
            "created_at": "2026-10-26T11:53:31.000000Z",
            "updated_at": "2026-10-26T11:53:31.000000Z",
            "first_config_change_at": null,
            "model": {
                "id": 8,
                "name": "Zeus hand v1",
                "type": "arm",
                "orientation": "right",
                "active": 1,
                "created_at": "2026-10-26T11:53:30.000000Z",
                "updated_at": "2026-10-26T11:53:30.000000Z"
            },
            "amputee": {
                "id": 39,
                "mrn": "W87XBJ3G1793015610",
                "name": "Roel Bergnaum",
                "email": "1793015610marlin02@example.org",
                "language": "en",
                "phone": "442.941.1036",
                "phone_country": "BT",
                "phone_verified_at": null,
                "address1": "6430 Moore Springs Suite 908",
                "address2": "Lake Una, OR 71157-7077",
                "postal_code": "59347-1610",
                "city": "Torp-Waelchi",
                "country": "GR",
                "clinic_name": "Creminhaven",
                "clinic_location": "624 Gusikowski Gardens\nChaimfort, WV 92600-9960",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:53:30.000000Z",
                "updated_at": "2026-10-26T11:53:30.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list devices",
    "code": "DEVICES:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/devices

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

search   string  optional  

Filter devices by searching in: serial number, bluetooth ID. Example: S3R1AL-NUM83R

active   integer  optional  

Filter devices by active status (available: 0 - only inactive, 1 - only active, -1 - all users). Default: 1. Example: -1

amputee   string  optional  

Filter devices by amputees. Provide single ID (amputee=1), array of IDs (amputee[]=1&amputee[]=2) or comma-separated list of IDs (amputee=1,2). Pass value 0 to get devices unassigned to any amputee. Example: 1

clinician   string  optional  

Filter devices by clinicians. Provide single ID (clinician=1), array of IDs (clinician[]=1&clinician[]=2) or comma-separated list of IDs (clinician=1,2). Pass value 0 to get devices unassigned to any clinician. Example: 1

model   string  optional  

Filter devices by device models. Provide single ID (model=1), array of IDs (model[]=1&model[]=2) or comma-separated list of IDs (model=1,2). Pass value 0 to get devices without model. Example: 1

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: model, amputee, clinicians, peripherals, firmwareVersion, pcbVersion, config, joinedDevices, joinedElectrodes).

sortby   string  optional  

Sort by field (available: serial, amputee_name, date). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

Device ID.

serial   string   

Device serial number.

bluetooth_id   string   

Bluetooth identifier.

model_id   integer   

Device model ID.

amputee_id   integer   

Assigned patient (amputee) user ID.

firmware_version_id   integer   

Firmware version ID.

pcb_version_id   integer   

PCB version ID.

company_id   integer   

Company ID.

reverse_magnets   boolean   

Whether magnets are reversed.

is_electrode   boolean   

Whether this device is an electrode.

active   boolean   

Whether the device is active.

last_activity_at   string   

Last activity timestamp.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

model   object   

Device model details.
id   integer   

Device model ID.

name   string   

Model name.

type   string   

Model type.

orientation   string   

Model orientation.

active   boolean   

Whether the model is active.

amputee   object   

Assigned patient (amputee) user.
id   integer   

User ID.

name   string   

User full name.

email   string   

User email address.

clinicians   object[]   

Clinicians assigned to this device.

firmwareVersion   object   

Firmware version details.
id   integer   

Firmware version ID.

name   string   

Version name.

file_firmware   string   

Firmware file URL.

file_firmware_v2   string   

Firmware v2 file URL.

file_firmware_v3   string   

Firmware v3 file URL.

file_firmware_v4   string   

Firmware v4 file URL.

file_firmware_v5   string   

Firmware v5 file URL.

file_firmware_new_pcb   string   

New PCB firmware file URL.

file_bootloader   string   

Bootloader file URL.

file_bootloader_v2   string   

Bootloader v2 file URL.

file_bootloader_v3   string   

Bootloader v3 file URL.

file_bootloader_v4   string   

Bootloader v4 file URL.

changelog   string   

Changelog file URL.

pcbVersion   object   

PCB version details.
id   integer   

PCB version ID.

name   string   

Version name.

hardware_id   string   

Hardware identifier.

joinedDevices   object[]   

Joined hand devices.

joinedElectrodes   object[]   

Joined electrode devices.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Get device information

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 7,
    "serial": "ab94dcf5-4327-3213-bedb-27f04accf35b",
    "bluetooth_id": "4606c249-9514-36b4-90f3-3eb63ff2c222",
    "company_id": null,
    "model_id": 9,
    "amputee_id": 40,
    "clinician_id": null,
    "firmware_version_id": 1,
    "pcb_version_id": 1,
    "reverse_magnets": 0,
    "is_electrode": 0,
    "active": 1,
    "last_activity_at": "0000-00-00 00:00:00",
    "first_connected_at": null,
    "measurements": null,
    "created_at": "2026-10-26T11:53:31.000000Z",
    "updated_at": "2026-10-26T11:53:31.000000Z",
    "first_config_change_at": null,
    "model": {
        "id": 9,
        "name": "Zeus hand v1",
        "type": "arm",
        "orientation": "right",
        "active": 1,
        "created_at": "2026-10-26T11:53:31.000000Z",
        "updated_at": "2026-10-26T11:53:31.000000Z"
    },
    "amputee": {
        "id": 40,
        "mrn": "2NAGYUKL1793015611",
        "name": "Maye Quitzon",
        "email": "1793015611zfranecki@example.org",
        "language": "en",
        "phone": "+1.925.803.3776",
        "phone_country": "KN",
        "phone_verified_at": null,
        "address1": "20754 Eleanora Burgs Suite 497",
        "address2": "Altenwerthmouth, AR 26581-5278",
        "postal_code": "95246",
        "city": "Bayer-Bednar",
        "country": "AT",
        "clinic_name": "Jaylinburgh",
        "clinic_location": "82327 Kenya Springs\nWest Ambrosetown, IL 42778",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:53:31.000000Z",
        "updated_at": "2026-10-26T11:53:31.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "pcb_version": {
        "id": 1,
        "name": "0.71.41",
        "hardware_id": "",
        "created_at": "2026-10-26T11:53:31.000000Z",
        "updated_at": "2026-10-26T11:53:31.000000Z"
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view device data",
    "code": "DEVICES:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:GET:DEVICE_NOT_FOUND"
}

Request   

GET api/device/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Query Parameters

extend   string  optional  

Comma-separated list of relation extensions (available: model, amputee, firmwareVersion, pcbVersion, clinicians, peripherals, joinedDevices, joinedElectrodes, analyticsContext).

Response

Response Fields

id   integer   

Device ID.

serial   string   

Device serial number.

bluetooth_id   string   

Bluetooth identifier.

model_id   integer   

Device model ID.

amputee_id   integer   

Assigned patient (amputee) user ID.

firmware_version_id   integer   

Firmware version ID.

pcb_version_id   integer   

PCB version ID.

company_id   integer   

Company ID.

reverse_magnets   boolean   

Whether magnets are reversed.

is_electrode   boolean   

Whether this device is an electrode.

active   boolean   

Whether the device is active.

last_activity_at   string   

Last activity timestamp.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

model   object   

Device model details.
id   integer   

Device model ID.

name   string   

Model name.

type   string   

Model type.

orientation   string   

Model orientation.

active   boolean   

Whether the model is active.

amputee   object   

Assigned patient (amputee) user.
id   integer   

User ID.

name   string   

User full name.

email   string   

User email address.

clinicians   object[]   

Clinicians assigned to this device.

firmwareVersion   object   

Firmware version details.
id   integer   

Firmware version ID.

name   string   

Version name.

file_firmware   string   

Firmware file URL.

file_firmware_v2   string   

Firmware v2 file URL.

file_firmware_v3   string   

Firmware v3 file URL.

file_firmware_v4   string   

Firmware v4 file URL.

file_firmware_v5   string   

Firmware v5 file URL.

file_firmware_new_pcb   string   

New PCB firmware file URL.

file_bootloader   string   

Bootloader file URL.

file_bootloader_v2   string   

Bootloader v2 file URL.

file_bootloader_v3   string   

Bootloader v3 file URL.

file_bootloader_v4   string   

Bootloader v4 file URL.

changelog   string   

Changelog file URL.

pcbVersion   object   

PCB version details.
id   integer   

PCB version ID.

name   string   

Version name.

hardware_id   string   

Hardware identifier.

joinedDevices   object[]   

Joined hand devices.

joinedElectrodes   object[]   

Joined electrode devices.

Create new device

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"serial\": \"S3R1AL-NUM83R\",
    \"bluetooth_id\": \"BL0123456789\",
    \"model_id\": 1,
    \"amputee_id\": 1,
    \"clinicians\": [
        2
    ],
    \"peripherals\": [
        1
    ],
    \"firmware_version_id\": 1,
    \"pcb_version_id\": 1,
    \"reverse_magnets\": false,
    \"is_electrode\": false,
    \"active\": true,
    \"last_activity_at\": \"2022-08-15 12:00:00\",
    \"first_connected_at\": \"2022-08-15 12:00:00\",
    \"measurements\": \"{\\\"length\\\": 25.4, \\\"unit\\\": \\\"cm\\\"}\"
}"

const url = new URL(
    "http://localhost:8000/api/device"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "serial": "S3R1AL-NUM83R",
    "bluetooth_id": "BL0123456789",
    "model_id": 1,
    "amputee_id": 1,
    "clinicians": [
        2
    ],
    "peripherals": [
        1
    ],
    "firmware_version_id": 1,
    "pcb_version_id": 1,
    "reverse_magnets": false,
    "is_electrode": false,
    "active": true,
    "last_activity_at": "2022-08-15 12:00:00",
    "first_connected_at": "2022-08-15 12:00:00",
    "measurements": "{\"length\": 25.4, \"unit\": \"cm\"}"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 8,
    "serial": "a06efd91-bd0d-32eb-a4eb-eec70667db67",
    "bluetooth_id": "a1c1a896-0e88-30d8-b123-abbfad686c0c",
    "company_id": null,
    "model_id": null,
    "amputee_id": null,
    "clinician_id": null,
    "firmware_version_id": null,
    "pcb_version_id": null,
    "reverse_magnets": 0,
    "is_electrode": 0,
    "active": 1,
    "last_activity_at": "0000-00-00 00:00:00",
    "first_connected_at": null,
    "measurements": null,
    "created_at": "2026-10-26T11:53:31.000000Z",
    "updated_at": "2026-10-26T11:53:31.000000Z",
    "first_config_change_at": null
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create device",
    "code": "DEVICES:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Firmware has no schema):


{
    "message": "Cannot create: firmware has no schema",
    "code": "DEVICES:CREATE:NO_FIRMWARE_SCHEMA"
}

Example response (500, Server error):


{
    "message": "Server error: device not created",
    "code": "DEVICES:CREATE:SERVER_ERROR"
}

Request   

POST api/device

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

serial   string   

Device serial number. Example: S3R1AL-NUM83R

bluetooth_id   string   

Device Bluetooth ID. Example: BL0123456789

model_id   string   

Device Model ID. The id of an existing record in the App\Models\DeviceModel table. Example: 1

amputee_id   string  optional  

Device amputee ID. The id of an existing record in the App\Models\User table. Example: 1

clinicians   integer[]  optional  

Clinician ID. The id of an existing record in the App\Models\User table.

peripherals   integer[]  optional  

Peripheral device ID. The id of an existing record in the App\Models\DevicePeripheral table.

firmware_version_id   string  optional  

Firmware Version ID. The id of an existing record in the App\Models\FirmwareVersion table. Example: 1

pcb_version_id   string  optional  

PCB Version ID. The id of an existing record in the App\Models\PCBVersion table. Example: 1

reverse_magnets   boolean  optional  

Device reverse magnets. Default: 0. Example: false

is_electrode   boolean  optional  

Super Admin only: Device is electrode. Default: 0. Example: false

active   boolean  optional  

Device active status (0 - inactive, 1 - active). Example: true

last_activity_at   string  optional  

Device last activity date. Update this value each time device connects to the mobile app. Always shift local datetime to UTC timezone. Must be a valid date in the format Y-m-d H:i:s. Example: 2022-08-15 12:00:00

first_connected_at   string  optional  

Date the device first connected to ADP. Must be a valid date in the format Y-m-d H:i:s. Example: 2022-08-15 12:00:00

measurements   string  optional  

Device measurements. MUST_BE_JSON. Example: {"length": 25.4, "unit": "cm"}

Response

Response Fields

id   integer   

Device ID.

serial   string   

Device serial number.

bluetooth_id   string   

Bluetooth identifier.

model_id   integer   

Device model ID.

amputee_id   integer   

Assigned patient (amputee) user ID.

firmware_version_id   integer   

Firmware version ID.

pcb_version_id   integer   

PCB version ID.

company_id   integer   

Company ID.

reverse_magnets   boolean   

Whether magnets are reversed.

is_electrode   boolean   

Whether this device is an electrode.

active   boolean   

Whether the device is active.

last_activity_at   string   

Last activity timestamp.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

model   object   

Device model details.
id   integer   

Device model ID.

name   string   

Model name.

type   string   

Model type.

orientation   string   

Model orientation.

active   boolean   

Whether the model is active.

amputee   object   

Assigned patient (amputee) user.
id   integer   

User ID.

name   string   

User full name.

email   string   

User email address.

clinicians   object[]   

Clinicians assigned to this device.

firmwareVersion   object   

Firmware version details.
id   integer   

Firmware version ID.

name   string   

Version name.

file_firmware   string   

Firmware file URL.

file_firmware_v2   string   

Firmware v2 file URL.

file_firmware_v3   string   

Firmware v3 file URL.

file_firmware_v4   string   

Firmware v4 file URL.

file_firmware_v5   string   

Firmware v5 file URL.

file_firmware_new_pcb   string   

New PCB firmware file URL.

file_bootloader   string   

Bootloader file URL.

file_bootloader_v2   string   

Bootloader v2 file URL.

file_bootloader_v3   string   

Bootloader v3 file URL.

file_bootloader_v4   string   

Bootloader v4 file URL.

changelog   string   

Changelog file URL.

pcbVersion   object   

PCB version details.
id   integer   

PCB version ID.

name   string   

Version name.

hardware_id   string   

Hardware identifier.

joinedDevices   object[]   

Joined hand devices.

joinedElectrodes   object[]   

Joined electrode devices.

Update device

requires authentication

Amputee of device can update only these fields: serial, bluetooth_id, firmware_version_id, pcb_version_id

Example request:
curl --request PUT \
    "http://localhost:8000/api/device/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"serial\": \"S3R1AL-NUM83R\",
    \"bluetooth_id\": \"BL0123456789\",
    \"model_id\": 1,
    \"amputee_id\": 1,
    \"clinicians\": [
        2
    ],
    \"peripherals\": [
        1
    ],
    \"firmware_version_id\": 1,
    \"pcb_version_id\": 1,
    \"reverse_magnets\": false,
    \"is_electrode\": false,
    \"active\": true,
    \"last_activity_at\": \"2022-08-15 12:00:00\",
    \"first_connected_at\": \"2022-08-15 12:00:00\",
    \"measurements\": \"{\\\"length\\\": 25.4, \\\"unit\\\": \\\"cm\\\"}\"
}"

const url = new URL(
    "http://localhost:8000/api/device/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "serial": "S3R1AL-NUM83R",
    "bluetooth_id": "BL0123456789",
    "model_id": 1,
    "amputee_id": 1,
    "clinicians": [
        2
    ],
    "peripherals": [
        1
    ],
    "firmware_version_id": 1,
    "pcb_version_id": 1,
    "reverse_magnets": false,
    "is_electrode": false,
    "active": true,
    "last_activity_at": "2022-08-15 12:00:00",
    "first_connected_at": "2022-08-15 12:00:00",
    "measurements": "{\"length\": 25.4, \"unit\": \"cm\"}"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 9,
    "serial": "4742f78e-3b2c-367a-a806-48269e379a3d",
    "bluetooth_id": "54050209-d80e-3055-a137-b131d5683de6",
    "company_id": null,
    "model_id": null,
    "amputee_id": null,
    "clinician_id": null,
    "firmware_version_id": null,
    "pcb_version_id": null,
    "reverse_magnets": 0,
    "is_electrode": 0,
    "active": 1,
    "last_activity_at": "0000-00-00 00:00:00",
    "first_connected_at": null,
    "measurements": null,
    "created_at": "2026-10-26T11:53:31.000000Z",
    "updated_at": "2026-10-26T11:53:31.000000Z",
    "first_config_change_at": null
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update device",
    "code": "DEVICES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Firmware has no schema):


{
    "message": "Cannot update: firmware has no schema",
    "code": "DEVICES:UPDATE:NO_FIRMWARE_SCHEMA"
}

Example response (403):


{
    "message": "Cannot update: no clinicians left for patient relation",
    "code": "DEVICES:UPDATE:NO_CLINICIANS"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:UPDATE:DEVICE_NOT_FOUND"
}

Request   

PUT api/device/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Body Parameters

serial   string  optional  

Device serial number. Example: S3R1AL-NUM83R

bluetooth_id   string  optional  

Device Bluetooth ID. Example: BL0123456789

model_id   string  optional  

Device Model ID. The id of an existing record in the App\Models\DeviceModel table. Example: 1

amputee_id   string  optional  

Device amputee ID. Pass null to remove assignment. The id of an existing record in the App\Models\User table. Example: 1

clinicians   integer[]  optional  

Clinician ID. The id of an existing record in the App\Models\User table.

peripherals   integer[]  optional  

Peripheral device ID. The id of an existing record in the App\Models\DevicePeripheral table.

firmware_version_id   string  optional  

Firmware Version ID. The id of an existing record in the App\Models\FirmwareVersion table. Example: 1

pcb_version_id   string  optional  

PCB Version ID. The id of an existing record in the App\Models\PCBVersion table. Example: 1

reverse_magnets   boolean  optional  

Device reverse magnets. Default: 0. Example: false

is_electrode   boolean  optional  

Super Admin only: Device is electrode. Default: 0. Example: false

active   boolean  optional  

Device active status (0 - inactive, 1 - active). Example: true

last_activity_at   string  optional  

Device last activity date. Update this value each time device connects to the mobile app. Always shift local datetime to UTC timezone. Must be a valid date in the format Y-m-d H:i:s. Example: 2022-08-15 12:00:00

first_connected_at   string  optional  

Date the device first connected to ADP. Must be a valid date in the format Y-m-d H:i:s. Example: 2022-08-15 12:00:00

measurements   string  optional  

Device measurements. MUST_BE_JSON. Example: {"length": 25.4, "unit": "cm"}

Response

Response Fields

id   integer   

Device ID.

serial   string   

Device serial number.

bluetooth_id   string   

Bluetooth identifier.

model_id   integer   

Device model ID.

amputee_id   integer   

Assigned patient (amputee) user ID.

firmware_version_id   integer   

Firmware version ID.

pcb_version_id   integer   

PCB version ID.

company_id   integer   

Company ID.

reverse_magnets   boolean   

Whether magnets are reversed.

is_electrode   boolean   

Whether this device is an electrode.

active   boolean   

Whether the device is active.

last_activity_at   string   

Last activity timestamp.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

model   object   

Device model details.
id   integer   

Device model ID.

name   string   

Model name.

type   string   

Model type.

orientation   string   

Model orientation.

active   boolean   

Whether the model is active.

amputee   object   

Assigned patient (amputee) user.
id   integer   

User ID.

name   string   

User full name.

email   string   

User email address.

clinicians   object[]   

Clinicians assigned to this device.

firmwareVersion   object   

Firmware version details.
id   integer   

Firmware version ID.

name   string   

Version name.

file_firmware   string   

Firmware file URL.

file_firmware_v2   string   

Firmware v2 file URL.

file_firmware_v3   string   

Firmware v3 file URL.

file_firmware_v4   string   

Firmware v4 file URL.

file_firmware_v5   string   

Firmware v5 file URL.

file_firmware_new_pcb   string   

New PCB firmware file URL.

file_bootloader   string   

Bootloader file URL.

file_bootloader_v2   string   

Bootloader v2 file URL.

file_bootloader_v3   string   

Bootloader v3 file URL.

file_bootloader_v4   string   

Bootloader v4 file URL.

changelog   string   

Changelog file URL.

pcbVersion   object   

PCB version details.
id   integer   

PCB version ID.

name   string   

Version name.

hardware_id   string   

Hardware identifier.

joinedDevices   object[]   

Joined hand devices.

joinedElectrodes   object[]   

Joined electrode devices.

Delete device

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/device/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Device deleted",
    "code": "DEVICES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete device",
    "code": "DEVICES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:DELETE:DEVICE_NOT_FOUND"
}

Request   

DELETE api/device/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Get device hashes

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1/hash" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/hash"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "hash_global": "123456789012345",
    "hash_common_settings": "123456789012345",
    "hash_common_grips": "123456789012345",
    "hash_mode1": "123456789012345",
    "hash_mode2": "123456789012345",
    "hash_mode3": "123456789012345"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access device hashes",
    "code": "DEVICES:GET_HASHES:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:GET_HASHES:DEVICE_NOT_FOUND"
}

Request   

GET api/device/{id}/hash

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Update device hashes

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/hash" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"hash_global\": \"123456789012345\",
    \"hash_common_settings\": \"123456789012345\",
    \"hash_common_grips\": \"123456789012345\",
    \"hash_mode1\": \"123456789012345\",
    \"hash_mode2\": \"123456789012345\",
    \"hash_mode3\": \"123456789012345\"
}"

const url = new URL(
    "http://localhost:8000/api/device/1/hash"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "hash_global": "123456789012345",
    "hash_common_settings": "123456789012345",
    "hash_common_grips": "123456789012345",
    "hash_mode1": "123456789012345",
    "hash_mode2": "123456789012345",
    "hash_mode3": "123456789012345"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202, OK):


{
    "hash_global": "123456789012345",
    "hash_common_settings": "123456789012345",
    "hash_common_grips": "123456789012345",
    "hash_mode1": "123456789012345",
    "hash_mode2": "123456789012345",
    "hash_mode3": "123456789012345"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access device hashes",
    "code": "DEVICES:SET_HASHES:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:SET_HASHES:DEVICE_NOT_FOUND"
}

Request   

POST api/device/{id}/hash

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Body Parameters

hash_global   string  optional  

Global hash. Example: 123456789012345

hash_common_settings   string  optional  

Common settings hash. Example: 123456789012345

hash_common_grips   string  optional  

Common grips hash. Example: 123456789012345

hash_mode1   string  optional  

Mode 1 hash. Example: 123456789012345

hash_mode2   string  optional  

Mode 2 hash. Example: 123456789012345

hash_mode3   string  optional  

Mode 3 hash. Example: 123456789012345

Detach device

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/detach" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/detach"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Device detached",
    "code": "DEVICES:DETACH:DETACHED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to detach device",
    "code": "DEVICES:DETACH:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:DETACH:DEVICE_NOT_FOUND"
}

Request   

POST api/device/{id}/detach

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Add device

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/add/S3R1AL-NUM83R" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/add/S3R1AL-NUM83R"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (202):


{
    "id": 10,
    "serial": "348a17e0-e551-3aa5-ac30-afd5a9cfdff4",
    "bluetooth_id": "1dfa3d89-a814-31d9-9c71-3558f41d2d58",
    "company_id": null,
    "model_id": null,
    "amputee_id": null,
    "clinician_id": null,
    "firmware_version_id": null,
    "pcb_version_id": null,
    "reverse_magnets": 0,
    "is_electrode": 0,
    "active": 1,
    "last_activity_at": "0000-00-00 00:00:00",
    "first_connected_at": null,
    "measurements": null,
    "created_at": "2026-10-26T11:53:32.000000Z",
    "updated_at": "2026-10-26T11:53:32.000000Z",
    "first_config_change_at": null
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to assign devices with code",
    "code": "DEVICES:ASSIGN:INSUFFICIENT_PERMISSION"
}

Example response (403, User reached the temporary limit of attached devices):


{
    "message": "Reached the limit of assigned devices",
    "code": "DEVICES:ASSIGN:LIMIT_REACHED"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:ASSIGN:DEVICE_NOT_FOUND"
}

Request   

POST api/device/add/{serial}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

serial   string   

Device serial number or bluetooth ID. Example: S3R1AL-NUM83R

Response

Response Fields

id   integer   

Device ID.

serial   string   

Device serial number.

bluetooth_id   string   

Bluetooth identifier.

model_id   integer   

Device model ID.

amputee_id   integer   

Assigned patient (amputee) user ID.

firmware_version_id   integer   

Firmware version ID.

pcb_version_id   integer   

PCB version ID.

company_id   integer   

Company ID.

reverse_magnets   boolean   

Whether magnets are reversed.

is_electrode   boolean   

Whether this device is an electrode.

active   boolean   

Whether the device is active.

last_activity_at   string   

Last activity timestamp.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

model   object   

Device model details.
id   integer   

Device model ID.

name   string   

Model name.

type   string   

Model type.

orientation   string   

Model orientation.

active   boolean   

Whether the model is active.

amputee   object   

Assigned patient (amputee) user.
id   integer   

User ID.

name   string   

User full name.

email   string   

User email address.

clinicians   object[]   

Clinicians assigned to this device.

firmwareVersion   object   

Firmware version details.
id   integer   

Firmware version ID.

name   string   

Version name.

file_firmware   string   

Firmware file URL.

file_firmware_v2   string   

Firmware v2 file URL.

file_firmware_v3   string   

Firmware v3 file URL.

file_firmware_v4   string   

Firmware v4 file URL.

file_firmware_v5   string   

Firmware v5 file URL.

file_firmware_new_pcb   string   

New PCB firmware file URL.

file_bootloader   string   

Bootloader file URL.

file_bootloader_v2   string   

Bootloader v2 file URL.

file_bootloader_v3   string   

Bootloader v3 file URL.

file_bootloader_v4   string   

Bootloader v4 file URL.

changelog   string   

Changelog file URL.

pcbVersion   object   

PCB version details.
id   integer   

PCB version ID.

name   string   

Version name.

hardware_id   string   

Hardware identifier.

joinedDevices   object[]   

Joined hand devices.

joinedElectrodes   object[]   

Joined electrode devices.

Connect device

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/connect/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/connect/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "message": "Device connected",
    "code": "DEVICES:CONNECT:CONNECTED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view device data",
    "code": "DEVICES:CONNECT:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:CONNECT:DEVICE_NOT_FOUND"
}

Request   

POST api/device/connect/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Disconnect device

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/disconnect/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/disconnect/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "message": "Device disconnected",
    "code": "DEVICES:DISCONNECT:DISCONNECTED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view device data",
    "code": "DEVICES:DISCONNECT:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:DISCONNECT:DEVICE_NOT_FOUND"
}

Request   

POST api/device/disconnect/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Join devices

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/join/1/2" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"force\": false,
    \"patient\": 1
}"

const url = new URL(
    "http://localhost:8000/api/device/join/1/2"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "force": false,
    "patient": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 11,
    "serial": "c2576d7d-d88b-3e9e-a055-fa3f67fde51c",
    "bluetooth_id": "b217d0bd-3575-3a3c-a19d-2b3fc8a80b8c",
    "company_id": null,
    "model_id": null,
    "amputee_id": null,
    "clinician_id": null,
    "firmware_version_id": null,
    "pcb_version_id": null,
    "reverse_magnets": 0,
    "is_electrode": 0,
    "active": 1,
    "last_activity_at": "0000-00-00 00:00:00",
    "first_connected_at": null,
    "measurements": null,
    "created_at": "2026-10-26T11:53:32.000000Z",
    "updated_at": "2026-10-26T11:53:32.000000Z",
    "first_config_change_at": null,
    "joined_devices": [
        {
            "id": 12,
            "serial": "78241a92-17f2-3755-8a2e-908c9f8803eb",
            "bluetooth_id": "1738ba91-e2fd-3e7a-a2d1-2f1028bca73a",
            "company_id": null,
            "model_id": null,
            "amputee_id": null,
            "clinician_id": null,
            "firmware_version_id": null,
            "pcb_version_id": null,
            "reverse_magnets": 0,
            "is_electrode": 0,
            "active": 1,
            "last_activity_at": "0000-00-00 00:00:00",
            "first_connected_at": null,
            "measurements": null,
            "created_at": "2026-10-26T11:53:32.000000Z",
            "updated_at": "2026-10-26T11:53:32.000000Z",
            "first_config_change_at": null,
            "pivot": {
                "electrode_id": 11,
                "device_id": 12,
                "created_at": "2026-10-26T11:53:32.000000Z",
                "updated_at": "2026-10-26T11:53:32.000000Z"
            }
        }
    ],
    "joined_electrodes": [
        {
            "id": 13,
            "serial": "5a9fe5d5-0ef7-37e3-a13d-3f91c777a961",
            "bluetooth_id": "4330246c-d360-3692-a7f5-106a61f8d405",
            "company_id": null,
            "model_id": null,
            "amputee_id": null,
            "clinician_id": null,
            "firmware_version_id": null,
            "pcb_version_id": null,
            "reverse_magnets": 0,
            "is_electrode": 0,
            "active": 1,
            "last_activity_at": "0000-00-00 00:00:00",
            "first_connected_at": null,
            "measurements": null,
            "created_at": "2026-10-26T11:53:32.000000Z",
            "updated_at": "2026-10-26T11:53:32.000000Z",
            "first_config_change_at": null,
            "pivot": {
                "device_id": 11,
                "electrode_id": 13,
                "created_at": "2026-10-26T11:53:32.000000Z",
                "updated_at": "2026-10-26T11:53:32.000000Z"
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to join devices",
    "code": "DEVICES:JOIN:INSUFFICIENT_PERMISSION"
}

Example response (403, Device 2 has a patient assigned):


{
    "message": "Device 2 has a patient assigned",
    "code": "DEVICES:JOIN:DEVICE2_HAS_PATIENT"
}

Example response (403, Device already has an electrode joined):


{
    "message": "Device already has an electrode joined",
    "code": "DEVICES:JOIN:ALREADY_JOINED"
}

Example response (403, Server error):


{
    "message": "Server error",
    "code": "DEVICES:JOIN:SERVER_ERROR"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:JOIN:DEVICE_NOT_FOUND"
}

Example response (404, Device 1 cannot be an electrode):


{
    "message": "Device 1 cannot be an electrode",
    "code": "DEVICES:JOIN:INCORRECT_DEVICE1_TYPE"
}

Example response (404, Device 2 must be an electrode):


{
    "message": "Device 1 must be an electrode",
    "code": "DEVICES:JOIN:INCORRECT_DEVICE2_TYPE"
}

Example response (404, Both devices have no patient assigned):


{
    "message": "Both devices have no patient assigned",
    "code": "DEVICES:JOIN:NO_PATIENT"
}

Request   

POST api/device/join/{deviceId}/{electrodeId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID (hand). Example: 1

electrodeId   integer   

Device ID (electrode). Example: 2

Body Parameters

force   boolean  optional  

Force assignment even if one or both devices are already joined with other devices. Example: false

patient   integer  optional  

Add or replace patient assignment in joined devices. The id of an existing record in the App\Models\User table. Example: 1

Response

Response Fields

id   integer   

Device ID.

serial   string   

Device serial number.

bluetooth_id   string   

Bluetooth identifier.

model_id   integer   

Device model ID.

amputee_id   integer   

Assigned patient (amputee) user ID.

firmware_version_id   integer   

Firmware version ID.

pcb_version_id   integer   

PCB version ID.

company_id   integer   

Company ID.

reverse_magnets   boolean   

Whether magnets are reversed.

is_electrode   boolean   

Whether this device is an electrode.

active   boolean   

Whether the device is active.

last_activity_at   string   

Last activity timestamp.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

model   object   

Device model details.
id   integer   

Device model ID.

name   string   

Model name.

type   string   

Model type.

orientation   string   

Model orientation.

active   boolean   

Whether the model is active.

amputee   object   

Assigned patient (amputee) user.
id   integer   

User ID.

name   string   

User full name.

email   string   

User email address.

clinicians   object[]   

Clinicians assigned to this device.

firmwareVersion   object   

Firmware version details.
id   integer   

Firmware version ID.

name   string   

Version name.

file_firmware   string   

Firmware file URL.

file_firmware_v2   string   

Firmware v2 file URL.

file_firmware_v3   string   

Firmware v3 file URL.

file_firmware_v4   string   

Firmware v4 file URL.

file_firmware_v5   string   

Firmware v5 file URL.

file_firmware_new_pcb   string   

New PCB firmware file URL.

file_bootloader   string   

Bootloader file URL.

file_bootloader_v2   string   

Bootloader v2 file URL.

file_bootloader_v3   string   

Bootloader v3 file URL.

file_bootloader_v4   string   

Bootloader v4 file URL.

changelog   string   

Changelog file URL.

pcbVersion   object   

PCB version details.
id   integer   

PCB version ID.

name   string   

Version name.

hardware_id   string   

Hardware identifier.

joinedDevices   object[]   

Joined hand devices.

joinedElectrodes   object[]   

Joined electrode devices.

Detach joined devices

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/unjoin/1/2" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/unjoin/1/2"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "message": "Devices unjoined",
    "code": "DEVICES:UNJOIN:UNJOINED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to join devices",
    "code": "DEVICES:UNJOIN:INSUFFICIENT_PERMISSION"
}

Example response (403, OK):


{
    "message": "Devices are not joined",
    "code": "DEVICES:UNJOIN:NOT_JOINED"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:UNJOIN:DEVICE_NOT_FOUND"
}

Request   

POST api/device/unjoin/{deviceId}/{electrodeId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

electrodeId   integer   

Electrode ID. Example: 2

Create demo patient

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/dummy-patient" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/dummy-patient"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (201, OK):


{
    "email": "SERIAL@gmail.com",
    "password": "Demo@123"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create dummy patient",
    "code": "DEVICES:DUMMY_PATIENT:INSUFFICIENT_PERMISSION"
}

Example response (403, Device already has a patient):


{
    "message": "Device already has a patient",
    "code": "DEVICES:DUMMY_PATIENT:PATIENT_EXISTS"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:DUMMY_PATIENT:DEVICE_NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error: dummy patient not created",
    "code": "DEVICES:DUMMY_PATIENT:SERVER_ERROR"
}

Request   

POST api/device/{id}/dummy-patient

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Get device internal note

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/15/internal-note" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/15/internal-note"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "device_id": 20,
    "note": "Magni ipsa qui quia id ut ut similique unde. Voluptas sed saepe aut. Ullam dolore explicabo sint ipsa rem et.",
    "created_at": "2026-10-26T11:53:32.000000Z",
    "updated_at": "2026-10-26T11:53:32.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access internal notes",
    "code": "INTERNAL_NOTE:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "INTERNAL_NOTE:GET:DEVICE_NOT_FOUND"
}

Request   

GET api/device/{id}/internal-note

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

The ID of the device. Example: 15

deviceId   integer   

Device ID. Example: 1

Update device internal note

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/device/1/internal-note" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"note\": \"Device returned from clinic for inspection.\"
}"

const url = new URL(
    "http://localhost:8000/api/device/1/internal-note"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "note": "Device returned from clinic for inspection."
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 2,
    "device_id": 21,
    "note": "Sunt molestiae id tempore. Nihil aliquid omnis quia necessitatibus dolor delectus. Voluptates quo iste dolore qui ut eum.",
    "created_at": "2026-10-26T11:53:32.000000Z",
    "updated_at": "2026-10-26T11:53:32.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access internal notes",
    "code": "INTERNAL_NOTE:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "INTERNAL_NOTE:UPDATE:DEVICE_NOT_FOUND"
}

Request   

PUT api/device/{id}/internal-note

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Body Parameters

note   string  optional  

Super Admin only: Internal note for this device. Maximum length: 50 000 characters. MAXIMUM:STRING_LENGTH:50000. Example: Device returned from clinic for inspection.

Documents

API endpoints for documents management

List documents

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/documents?type=web" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/documents"
);

const params = {
    "type": "web",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "name": "Stationary Engineer OR Boiler Operator",
            "type": "mobile",
            "created_at": "2026-10-26T11:55:27.000000Z",
            "updated_at": "2026-10-26T11:55:27.000000Z"
        },
        {
            "id": 2,
            "name": "Environmental Scientist",
            "type": "mobile",
            "created_at": "2026-10-26T11:55:27.000000Z",
            "updated_at": "2026-10-26T11:55:27.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage documents",
    "code": "DOCUMENTS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/documents

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

type   string  optional  

Filter documents by type. Example: web

Must be one of:
  • web
  • mobile
perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Response

Response Fields

items   object   
id   integer   

Document ID.

name   string   

Document name.

type   string   

Document target platform.

Must be one of:
  • web
  • mobile
created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

versions   object[]   

Document versions.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Create document

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/documents" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Privacy Policy\",
    \"type\": \"web\"
}"

const url = new URL(
    "http://localhost:8000/api/documents"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Privacy Policy",
    "type": "web"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "name": "Project Manager",
    "type": "web",
    "created_at": "2026-10-26T11:55:27.000000Z",
    "updated_at": "2026-10-26T11:55:27.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage documents",
    "code": "DOCUMENTS:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/documents

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Document name. Example: Privacy Policy

type   string   

Document destination. Example: web

Must be one of:
  • web
  • mobile

Response

Response Fields

id   integer   

Document ID.

name   string   

Document name.

type   string   

Document target platform.

Must be one of:
  • web
  • mobile
created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

versions   object[]   

Document versions.

Delete document

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/documents/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/documents/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Document deleted",
    "code": "DOCUMENTS:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage documents",
    "code": "DOCUMENTS:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (403, Document has existing versions):


{
    "message": "Cannot delete: document has existing versions (1)",
    "code": "DOCUMENTS:DELETE:HAS_VERSIONS"
}

Example response (404, Document not found):


{
    "message": "Document not found",
    "code": "DOCUMENTS:DELETE:DOCUMENT_NOT_FOUND"
}

Request   

DELETE api/documents/{documentId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

documentId   integer   

Document ID. Example: 1

List document versions

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/documents/1/versions" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/documents/1/versions"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "document_id": null,
        "index": 161,
        "file": "https://carter.com/fugit-reiciendis-perferendis-perferendis.html",
        "created_at": "2026-10-26T11:55:27.000000Z",
        "updated_at": "2026-10-26T11:55:27.000000Z"
    },
    {
        "id": 2,
        "document_id": null,
        "index": 1917,
        "file": "https://raynor.com/perferendis-consequatur-fugit-voluptates-dolorum-cupiditate.html",
        "created_at": "2026-10-26T11:55:27.000000Z",
        "updated_at": "2026-10-26T11:55:27.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage documents",
    "code": "DOCUMENTS:LIST_VERSIONS:INSUFFICIENT_PERMISSION"
}

Example response (404, Document not found):


{
    "message": "Document not found",
    "code": "DOCUMENTS:LIST_VERSIONS:DOCUMENT_NOT_FOUND"
}

Request   

GET api/documents/{documentId}/versions

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

documentId   integer   

Document ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Response

Response Fields

id   integer   

Document version ID.

document_id   integer   

Associated document ID.

index   integer   

Version index number.

file   string   

File path or URL.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

document   object   

Parent document.

Create document version

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/documents/1/versions" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file\": \"https:\\/\\/www.aetherbiomedical.com\\/privacy-policy\"
}"

const url = new URL(
    "http://localhost:8000/api/documents/1/versions"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "file": "https:\/\/www.aetherbiomedical.com\/privacy-policy"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "document_id": null,
    "index": 6441981,
    "file": "http://www.weber.com/saepe-voluptatem-labore-enim-vel-maxime-a",
    "created_at": "2026-10-26T11:55:27.000000Z",
    "updated_at": "2026-10-26T11:55:27.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage documents",
    "code": "DOCUMENTS:CREATE_VERSION:INSUFFICIENT_PERMISSION"
}

Example response (404, Document not found):


{
    "message": "Document not found",
    "code": "DOCUMENTS:CREATE_VERSION:DOCUMENT_NOT_FOUND"
}

Request   

POST api/documents/{documentId}/versions

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

documentId   integer   

Document ID. Example: 1

Body Parameters

file   string   

URL to document file. Must be a valid URL. Example: https://www.aetherbiomedical.com/privacy-policy

Response

Response Fields

id   integer   

Document version ID.

document_id   integer   

Associated document ID.

index   integer   

Version index number.

file   string   

File path or URL.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

document   object   

Parent document.

Delete document version

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/documents/1/versions/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/documents/1/versions/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Document version deleted",
    "code": "DOCUMENTS:DELETE_VERSION:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage documents",
    "code": "DOCUMENTS:DELETE_VERSION:INSUFFICIENT_PERMISSION"
}

Example response (404, Document not found):


{
    "message": "Document not found",
    "code": "DOCUMENTS:DELETE_VERSION:DOCUMENT_NOT_FOUND"
}

Example response (404, Document version not found):


{
    "message": "Document version not found",
    "code": "DOCUMENTS:DELETE_VERSION:VERSION_NOT_FOUND"
}

Request   

DELETE api/documents/{documentId}/versions/{versionId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

documentId   integer   

Document ID. Example: 1

versionId   integer   

DocumentVersion ID. Example: 1

Get documents status

requires authentication

Any document on the list has to be accepted. Use POST /documents/accept endpoint to mark them as accepted once user agrees to that. Empty list means that user is up-to-date with all required documents and nothing has to be accepted.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/documents/status?type=web" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/documents/status"
);

const params = {
    "type": "web",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "documents": []
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view documents status",
    "code": "DOCUMENTS:STATUS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/documents/status

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

type   string  optional  

Filter documents by type. Example: web

Must be one of:
  • web
  • mobile

Accept documents

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/documents/accept" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"documents\": [
        1
    ]
}"

const url = new URL(
    "http://localhost:8000/api/documents/accept"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "documents": [
        1
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Accepted 1 document(s)",
    "code": "DOCUMENTS:ACCEPT:ACCEPTED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update documents status",
    "code": "DOCUMENTS:ACCEPT:INSUFFICIENT_PERMISSION"
}

Request   

POST api/documents/accept

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

documents   integer[]   

Document Version ID. The id of an existing record in the App\Models\DocumentVersion table.

Accept Terms of Service for patients

requires authentication

This endpoint does not save any information to the database. Its purpose is to make sure the patient will be saved in the HubSpot.

Example request:
curl --request POST \
    "http://localhost:8000/api/documents/accept/tos" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/documents/accept/tos"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Patients' \"Terms of Service\" accepted",
    "code": "DOCUMENTS:ACCEPT_PATIENT_TOS:ACCEPTED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to accept patients' \"Terms of Service\"",
    "code": "DOCUMENTS:ACCEPT_PATIENT_TOS:INSUFFICIENT_PERMISSION"
}

Request   

POST api/documents/accept/tos

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Feedback

Endpoints related to feedback collecting

Check feedback token

Example request:
curl --request POST \
    "http://localhost:8000/api/feedback/4KJ2YLM0MA64Y6D6FUY2OFY690IICO1OJ2DHR6T68IZNI528H3SKUFJMY0C5DHOA/check" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/feedback/4KJ2YLM0MA64Y6D6FUY2OFY690IICO1OJ2DHR6T68IZNI528H3SKUFJMY0C5DHOA/check"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "valid": true
}

Request   

POST api/feedback/{token}/check

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

token   string   

Authentication token Example: 4KJ2YLM0MA64Y6D6FUY2OFY690IICO1OJ2DHR6T68IZNI528H3SKUFJMY0C5DHOA

Send feedback with token

Example request:
curl --request POST \
    "http://localhost:8000/api/feedback/4KJ2YLM0MA64Y6D6FUY2OFY690IICO1OJ2DHR6T68IZNI528H3SKUFJMY0C5DHOA" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"contextual\",
    \"trigger\": \"remote_session\",
    \"rate\": 5,
    \"description\": \"That was amazing!\",
    \"skipped\": false,
    \"training_day_id\": 1
}"

const url = new URL(
    "http://localhost:8000/api/feedback/4KJ2YLM0MA64Y6D6FUY2OFY690IICO1OJ2DHR6T68IZNI528H3SKUFJMY0C5DHOA"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "contextual",
    "trigger": "remote_session",
    "rate": 5,
    "description": "That was amazing!",
    "skipped": false,
    "training_day_id": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 1,
    "user_id": 6,
    "type": "on_demand",
    "trigger": "async_session",
    "platform": "web",
    "rate": 1,
    "description": "At nisi natus eos laboriosam et possimus ratione.",
    "skipped": 1,
    "training_day_id": null,
    "created_at": "2026-10-26T11:53:12.000000Z",
    "updated_at": "2026-10-26T11:53:12.000000Z"
}

Example response (403, Invalid token):


{
    "message": "Invalid token",
    "code": "FEEDBACK:SEND_WITH_TOKEN:INVALID_TOKEN"
}

Request   

POST api/feedback/{token}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

token   string   

Authentication token Example: 4KJ2YLM0MA64Y6D6FUY2OFY690IICO1OJ2DHR6T68IZNI528H3SKUFJMY0C5DHOA

Body Parameters

type   string   

Type of feedback. Example: contextual

Must be one of:
  • contextual
  • periodic
trigger   string  optional  

Feedback trigger. This field is required when type is contextual. Example: remote_session

Must be one of:
  • remote_session
  • local_session
  • async_session
  • patient_create
  • clinician_invite
  • firmware_update
  • new_config
  • grip_change
  • training_failed
  • training_success
rate   integer  optional  

User's rating. MINIMUM:NUMBER:0 MAXIMUM:NUMBER:5. Example: 5

description   string  optional  

User's description. Example: That was amazing!

skipped   boolean  optional  

Feedback skipped by the user. Example: false

training_day_id   integer  optional  

Training day ID (for training feedback only). The id of an existing record in the App\Models\TrainingDay table. Example: 1

Response

Response Fields

id   integer   

Feedback ID.

user_id   integer   

User who submitted the feedback.

type   string   

Feedback type.

trigger   string   

What triggered the feedback.

platform   string   

Platform the feedback was submitted from.

rate   integer   

Feedback rating.

description   string   

Feedback description.

skipped   boolean   

Whether the feedback was skipped.

training_day_id   integer   

Associated training day ID.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Get feedback status

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/feedback/status" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/feedback/status"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "remote_session": true,
    "firmware_update": true,
    "local_session": true,
    "async_session": true,
    "patient_create": false,
    "clinician_invite": true
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to check feedback status",
    "code": "FEEDBACK:STATUS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/feedback/status

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Send feedback

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/feedback" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"contextual\",
    \"trigger\": \"remote_session\",
    \"platform\": \"web\",
    \"rate\": 5,
    \"description\": \"That was amazing!\",
    \"skipped\": false,
    \"training_day_id\": 1
}"

const url = new URL(
    "http://localhost:8000/api/feedback"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "contextual",
    "trigger": "remote_session",
    "platform": "web",
    "rate": 5,
    "description": "That was amazing!",
    "skipped": false,
    "training_day_id": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 2,
    "user_id": 311,
    "type": "periodic",
    "trigger": "grip_change",
    "platform": "mobile",
    "rate": 2,
    "description": "Totam aut id debitis quis eaque quia.",
    "skipped": 1,
    "training_day_id": null,
    "created_at": "2026-10-26T11:55:58.000000Z",
    "updated_at": "2026-10-26T11:55:58.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to send feedback",
    "code": "FEEDBACK:SEND:INSUFFICIENT_PERMISSION"
}

Request   

POST api/feedback

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

type   string   

Type of feedback. Example: contextual

Must be one of:
  • contextual
  • on_demand
  • periodic
  • training
trigger   string  optional  

Feedback trigger. Example: remote_session

Must be one of:
  • remote_session
  • local_session
  • async_session
  • patient_create
  • clinician_invite
  • firmware_update
  • new_config
  • grip_change
  • training_failed
  • training_success
platform   string   

Feedback platform. Example: web

Must be one of:
  • web
  • mobile
rate   integer  optional  

User's rating. MINIMUM:NUMBER:0 MAXIMUM:NUMBER:5. Example: 5

description   string  optional  

User's description. Example: That was amazing!

skipped   boolean  optional  

Feedback skipped by the user. Example: false

training_day_id   integer  optional  

Training day ID (for training feedback only). The id of an existing record in the App\Models\TrainingDay table. Example: 1

Response

Response Fields

id   integer   

Feedback ID.

user_id   integer   

User who submitted the feedback.

type   string   

Feedback type.

trigger   string   

What triggered the feedback.

platform   string   

Platform the feedback was submitted from.

rate   integer   

Feedback rating.

description   string   

Feedback description.

skipped   boolean   

Whether the feedback was skipped.

training_day_id   integer   

Associated training day ID.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Schedule feedback notification

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/feedback/schedule" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"trigger\": \"remote_session\"
}"

const url = new URL(
    "http://localhost:8000/api/feedback/schedule"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "trigger": "remote_session"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "scheduled_at": "2026-04-13 12:00:00"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to schedule feedback notification",
    "code": "FEEDBACK:SCHEDULE:INSUFFICIENT_PERMISSION"
}

Example response (403, Feedback with this trigger was already scheduled today):


{
    "message": "Feedback with this trigger was already scheduled today",
    "code": "FEEDBACK:SCHEDULE:ALREADY_SCHEDULED"
}

Request   

POST api/feedback/schedule

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

trigger   string   

Feedback trigger. Example: remote_session

Must be one of:
  • remote_session
  • local_session
  • async_session
  • patient_create
  • clinician_invite
  • firmware_update
  • new_config
  • grip_change
  • training_failed
  • training_success

List feedback

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/feedback" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/feedback"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (201):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 25,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 3,
            "user_id": 312,
            "type": "periodic",
            "trigger": "firmware_update",
            "platform": "web",
            "rate": 2,
            "description": "Aliquam ipsa quibusdam cupiditate nemo qui.",
            "skipped": 0,
            "training_day_id": null,
            "created_at": "2026-10-26T11:55:58.000000Z",
            "updated_at": "2026-10-26T11:55:58.000000Z"
        },
        {
            "id": 4,
            "user_id": 313,
            "type": "on_demand",
            "trigger": "grip_change",
            "platform": "web",
            "rate": 2,
            "description": "Sequi libero odit illum facilis commodi eos est.",
            "skipped": 0,
            "training_day_id": null,
            "created_at": "2026-10-26T11:55:59.000000Z",
            "updated_at": "2026-10-26T11:55:59.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list feedback",
    "code": "FEEDBACK:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/feedback

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 25).

page   integer  optional  

Page number (Default: 1).

sortby   string  optional  

Sort by field (available: date). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

Feedback ID.

user_id   integer   

User who submitted the feedback.

type   string   

Feedback type.

trigger   string   

What triggered the feedback.

platform   string   

Platform the feedback was submitted from.

rate   integer   

Feedback rating.

description   string   

Feedback description.

skipped   boolean   

Whether the feedback was skipped.

training_day_id   integer   

Associated training day ID.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Export feedback to CSV

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/feedback/csv" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/feedback/csv"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, CSV file):


{
    "file": "https://staging-us-east-2-aether-biomedical-s3-us-bucket.s3.us-east-2.amazonaws.com/feedback/feedback-1759228216.csv",
    "expires": "2025-09-30 10:40:00"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to export feedback",
    "code": "FEEDBACK:EXPORT_CSV:INSUFFICIENT_PERMISSION"
}

Request   

GET api/feedback/csv

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get feedback cooldowns

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/feedback/cooldowns" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/feedback/cooldowns"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "remote_session": 1,
    "local_session": 1,
    "async_session": 1,
    "patient_create": 1,
    "clinician_invite": 1,
    "firmware_update": 1,
    "new_config": 1,
    "grip_change": 1
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage feedback cooldowns",
    "code": "FEEDBACK:GET_COOLDOWNS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/feedback/cooldowns

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Update feedback cooldowns

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/feedback/cooldowns" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"remote_session\": 1,
    \"local_session\": 1,
    \"async_session\": 1,
    \"patient_create\": 1,
    \"clinician_invite\": 1,
    \"firmware_update\": 1,
    \"new_config\": 1,
    \"grip_change\": 1
}"

const url = new URL(
    "http://localhost:8000/api/feedback/cooldowns"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "remote_session": 1,
    "local_session": 1,
    "async_session": 1,
    "patient_create": 1,
    "clinician_invite": 1,
    "firmware_update": 1,
    "new_config": 1,
    "grip_change": 1
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "remote_session": 1,
    "local_session": 1,
    "async_session": 1,
    "patient_create": 1,
    "clinician_invite": 1,
    "firmware_update": 1,
    "new_config": 1,
    "grip_change": 1
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage feedback cooldowns",
    "code": "FEEDBACK:UPDATE_COOLDOWNS:INSUFFICIENT_PERMISSION"
}

Request   

PUT api/feedback/cooldowns

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

remote_session   integer  optional  

Cooldown for remote session trigger. MINIMUM:NUMBER:1. Example: 1

local_session   integer  optional  

Cooldown for local session trigger. MINIMUM:NUMBER:1. Example: 1

async_session   integer  optional  

Cooldown for async session trigger. MINIMUM:NUMBER:1. Example: 1

patient_create   integer  optional  

Cooldown for patient create trigger. MINIMUM:NUMBER:1. Example: 1

clinician_invite   integer  optional  

Cooldown for clinician invite trigger. MINIMUM:NUMBER:1. Example: 1

firmware_update   integer  optional  

Cooldown for firmware update trigger. MINIMUM:NUMBER:1. Example: 1

new_config   integer  optional  

Cooldown for new config trigger. MINIMUM:NUMBER:1. Example: 1

grip_change   integer  optional  

Cooldown for grip change trigger. MINIMUM:NUMBER:1. Example: 1

Get feedback enabled

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/feedback/enabled" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/feedback/enabled"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "remote_session": true,
    "local_session": true,
    "async_session": true,
    "patient_create": true,
    "clinician_invite": true,
    "firmware_update": true,
    "new_config": true,
    "grip_change": true
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage feedback cooldowns",
    "code": "FEEDBACK:GET_ENABLED:INSUFFICIENT_PERMISSION"
}

Request   

GET api/feedback/enabled

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Set feedback enabled

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/feedback/enabled" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"remote_session\": false,
    \"local_session\": false,
    \"async_session\": false,
    \"patient_create\": false,
    \"clinician_invite\": false,
    \"firmware_update\": false,
    \"new_config\": false,
    \"grip_change\": false
}"

const url = new URL(
    "http://localhost:8000/api/feedback/enabled"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "remote_session": false,
    "local_session": false,
    "async_session": false,
    "patient_create": false,
    "clinician_invite": false,
    "firmware_update": false,
    "new_config": false,
    "grip_change": false
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "remote_session": true,
    "local_session": true,
    "async_session": true,
    "patient_create": true,
    "clinician_invite": true,
    "firmware_update": true,
    "new_config": true,
    "grip_change": true
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage feedback cooldowns",
    "code": "FEEDBACK:SET_ENABLED:INSUFFICIENT_PERMISSION"
}

Request   

PUT api/feedback/enabled

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

remote_session   boolean  optional  

Enabled state for remote session trigger. Example: false

local_session   boolean  optional  

Enabled state for local session trigger. Example: false

async_session   boolean  optional  

Enabled state for async session trigger. Example: false

patient_create   boolean  optional  

Enabled state for patient create trigger. Example: false

clinician_invite   boolean  optional  

Enabled state for clinician invite trigger. Example: false

firmware_update   boolean  optional  

Enabled state for firmware update trigger. Example: false

new_config   boolean  optional  

Enabled state for new config trigger. Example: false

grip_change   boolean  optional  

Enabled state for grip change trigger. Example: false

Feedback statistics

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/feedback/statistics" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/feedback/statistics"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "submitted": 100,
    "skipped": 150,
    "total": 250,
    "average_rating": 4.76
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view feedback statistics",
    "code": "FEEDBACK:STATISTICS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/feedback/statistics

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Finger Calibrations

API endpoints for managing finger calibration results

Get finger calibration

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1/finger-calibration" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/device/1/finger-calibration"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "device_id": 14,
            "result": "eveniet",
            "created_at": "2026-10-26T11:53:32.000000Z",
            "updated_at": "2026-10-26T11:53:32.000000Z"
        },
        {
            "id": 2,
            "device_id": 15,
            "result": "culpa",
            "created_at": "2026-10-26T11:53:32.000000Z",
            "updated_at": "2026-10-26T11:53:32.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view finger calibration data",
    "code": "FINGER_CALIBRATION:VIEW:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "FINGER_CALIBRATION:VIEW:DEVICE_NOT_FOUND"
}

Request   

GET api/device/{id}/finger-calibration

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Store finger calibration

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/finger-calibration" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"result\": \"test\"
}"

const url = new URL(
    "http://localhost:8000/api/device/1/finger-calibration"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "result": "test"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "device_id": 16,
    "result": "sunt",
    "created_at": "2026-10-26T11:53:32.000000Z",
    "updated_at": "2026-10-26T11:53:32.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create finger calibration",
    "code": "FINGER_CALIBRATION:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "FINGER_CALIBRATION:CREATE:DEVICE_NOT_FOUND"
}

Request   

POST api/device/{id}/finger-calibration

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Body Parameters

result   string   

Calibration result. Example: test

GeoData

API endpoints for geodata

Get supported timezones list

Example request:
curl --request GET \
    --get "http://localhost:8000/api/timezones" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/timezones"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


[
    "Africa/Abidjan",
    "Africa/Accra",
    "Africa/Addis_Ababa",
    "Africa/Algiers",
    "Africa/Asmara",
    "Africa/Bamako",
    "Africa/Bangui",
    "Africa/Banjul",
    "Africa/Bissau",
    "Africa/Blantyre",
    "Africa/Brazzaville",
    "Africa/Bujumbura",
    "Africa/Cairo",
    "Africa/Casablanca",
    "Africa/Ceuta",
    "Africa/Conakry",
    "Africa/Dakar",
    "Africa/Dar_es_Salaam",
    "Africa/Djibouti",
    "Africa/Douala",
    "Africa/El_Aaiun",
    "Africa/Freetown",
    "Africa/Gaborone",
    "Africa/Harare",
    "Africa/Johannesburg",
    "Africa/Juba",
    "Africa/Kampala",
    "Africa/Khartoum",
    "Africa/Kigali",
    "Africa/Kinshasa",
    "Africa/Lagos",
    "Africa/Libreville",
    "Africa/Lome",
    "Africa/Luanda",
    "Africa/Lubumbashi",
    "Africa/Lusaka",
    "Africa/Malabo",
    "Africa/Maputo",
    "Africa/Maseru",
    "Africa/Mbabane",
    "Africa/Mogadishu",
    "Africa/Monrovia",
    "Africa/Nairobi",
    "Africa/Ndjamena",
    "Africa/Niamey",
    "Africa/Nouakchott",
    "Africa/Ouagadougou",
    "Africa/Porto-Novo",
    "Africa/Sao_Tome",
    "Africa/Tripoli",
    "Africa/Tunis",
    "Africa/Windhoek",
    "America/Adak",
    "America/Anchorage",
    "America/Anguilla",
    "America/Antigua",
    "America/Araguaina",
    "America/Argentina/Buenos_Aires",
    "America/Argentina/Catamarca",
    "America/Argentina/Cordoba",
    "America/Argentina/Jujuy",
    "America/Argentina/La_Rioja",
    "America/Argentina/Mendoza",
    "America/Argentina/Rio_Gallegos",
    "America/Argentina/Salta",
    "America/Argentina/San_Juan",
    "America/Argentina/San_Luis",
    "America/Argentina/Tucuman",
    "America/Argentina/Ushuaia",
    "America/Aruba",
    "America/Asuncion",
    "America/Atikokan",
    "America/Bahia",
    "America/Bahia_Banderas",
    "America/Barbados",
    "America/Belem",
    "America/Belize",
    "America/Blanc-Sablon",
    "America/Boa_Vista",
    "America/Bogota",
    "America/Boise",
    "America/Cambridge_Bay",
    "America/Campo_Grande",
    "America/Cancun",
    "America/Caracas",
    "America/Cayenne",
    "America/Cayman",
    "America/Chicago",
    "America/Chihuahua",
    "America/Costa_Rica",
    "America/Creston",
    "America/Cuiaba",
    "America/Curacao",
    "America/Danmarkshavn",
    "America/Dawson",
    "America/Dawson_Creek",
    "America/Denver",
    "America/Detroit",
    "America/Dominica",
    "America/Edmonton",
    "America/Eirunepe",
    "America/El_Salvador",
    "America/Fort_Nelson",
    "America/Fortaleza",
    "America/Glace_Bay",
    "America/Goose_Bay",
    "America/Grand_Turk",
    "America/Grenada",
    "America/Guadeloupe",
    "America/Guatemala",
    "America/Guayaquil",
    "America/Guyana",
    "America/Halifax",
    "America/Havana",
    "America/Hermosillo",
    "America/Indiana/Indianapolis",
    "America/Indiana/Knox",
    "America/Indiana/Marengo",
    "America/Indiana/Petersburg",
    "America/Indiana/Tell_City",
    "America/Indiana/Vevay",
    "America/Indiana/Vincennes",
    "America/Indiana/Winamac",
    "America/Inuvik",
    "America/Iqaluit",
    "America/Jamaica",
    "America/Juneau",
    "America/Kentucky/Louisville",
    "America/Kentucky/Monticello",
    "America/Kralendijk",
    "America/La_Paz",
    "America/Lima",
    "America/Los_Angeles",
    "America/Lower_Princes",
    "America/Maceio",
    "America/Managua",
    "America/Manaus",
    "America/Marigot",
    "America/Martinique",
    "America/Matamoros",
    "America/Mazatlan",
    "America/Menominee",
    "America/Merida",
    "America/Metlakatla",
    "America/Mexico_City",
    "America/Miquelon",
    "America/Moncton",
    "America/Monterrey",
    "America/Montevideo",
    "America/Montserrat",
    "America/Nassau",
    "America/New_York",
    "America/Nipigon",
    "America/Nome",
    "America/Noronha",
    "America/North_Dakota/Beulah",
    "America/North_Dakota/Center",
    "America/North_Dakota/New_Salem",
    "America/Nuuk",
    "America/Ojinaga",
    "America/Panama",
    "America/Pangnirtung",
    "America/Paramaribo",
    "America/Phoenix",
    "America/Port-au-Prince",
    "America/Port_of_Spain",
    "America/Porto_Velho",
    "America/Puerto_Rico",
    "America/Punta_Arenas",
    "America/Rainy_River",
    "America/Rankin_Inlet",
    "America/Recife",
    "America/Regina",
    "America/Resolute",
    "America/Rio_Branco",
    "America/Santarem",
    "America/Santiago",
    "America/Santo_Domingo",
    "America/Sao_Paulo",
    "America/Scoresbysund",
    "America/Sitka",
    "America/St_Barthelemy",
    "America/St_Johns",
    "America/St_Kitts",
    "America/St_Lucia",
    "America/St_Thomas",
    "America/St_Vincent",
    "America/Swift_Current",
    "America/Tegucigalpa",
    "America/Thule",
    "America/Thunder_Bay",
    "America/Tijuana",
    "America/Toronto",
    "America/Tortola",
    "America/Vancouver",
    "America/Whitehorse",
    "America/Winnipeg",
    "America/Yakutat",
    "America/Yellowknife",
    "Antarctica/Casey",
    "Antarctica/Davis",
    "Antarctica/DumontDUrville",
    "Antarctica/Macquarie",
    "Antarctica/Mawson",
    "Antarctica/McMurdo",
    "Antarctica/Palmer",
    "Antarctica/Rothera",
    "Antarctica/Syowa",
    "Antarctica/Troll",
    "Antarctica/Vostok",
    "Arctic/Longyearbyen",
    "Asia/Aden",
    "Asia/Almaty",
    "Asia/Amman",
    "Asia/Anadyr",
    "Asia/Aqtau",
    "Asia/Aqtobe",
    "Asia/Ashgabat",
    "Asia/Atyrau",
    "Asia/Baghdad",
    "Asia/Bahrain",
    "Asia/Baku",
    "Asia/Bangkok",
    "Asia/Barnaul",
    "Asia/Beirut",
    "Asia/Bishkek",
    "Asia/Brunei",
    "Asia/Chita",
    "Asia/Choibalsan",
    "Asia/Colombo",
    "Asia/Damascus",
    "Asia/Dhaka",
    "Asia/Dili",
    "Asia/Dubai",
    "Asia/Dushanbe",
    "Asia/Famagusta",
    "Asia/Gaza",
    "Asia/Hebron",
    "Asia/Ho_Chi_Minh",
    "Asia/Hong_Kong",
    "Asia/Hovd",
    "Asia/Irkutsk",
    "Asia/Jakarta",
    "Asia/Jayapura",
    "Asia/Jerusalem",
    "Asia/Kabul",
    "Asia/Kamchatka",
    "Asia/Karachi",
    "Asia/Kathmandu",
    "Asia/Khandyga",
    "Asia/Kolkata",
    "Asia/Krasnoyarsk",
    "Asia/Kuala_Lumpur",
    "Asia/Kuching",
    "Asia/Kuwait",
    "Asia/Macau",
    "Asia/Magadan",
    "Asia/Makassar",
    "Asia/Manila",
    "Asia/Muscat",
    "Asia/Nicosia",
    "Asia/Novokuznetsk",
    "Asia/Novosibirsk",
    "Asia/Omsk",
    "Asia/Oral",
    "Asia/Phnom_Penh",
    "Asia/Pontianak",
    "Asia/Pyongyang",
    "Asia/Qatar",
    "Asia/Qostanay",
    "Asia/Qyzylorda",
    "Asia/Riyadh",
    "Asia/Sakhalin",
    "Asia/Samarkand",
    "Asia/Seoul",
    "Asia/Shanghai",
    "Asia/Singapore",
    "Asia/Srednekolymsk",
    "Asia/Taipei",
    "Asia/Tashkent",
    "Asia/Tbilisi",
    "Asia/Tehran",
    "Asia/Thimphu",
    "Asia/Tokyo",
    "Asia/Tomsk",
    "Asia/Ulaanbaatar",
    "Asia/Urumqi",
    "Asia/Ust-Nera",
    "Asia/Vientiane",
    "Asia/Vladivostok",
    "Asia/Yakutsk",
    "Asia/Yangon",
    "Asia/Yekaterinburg",
    "Asia/Yerevan",
    "Atlantic/Azores",
    "Atlantic/Bermuda",
    "Atlantic/Canary",
    "Atlantic/Cape_Verde",
    "Atlantic/Faroe",
    "Atlantic/Madeira",
    "Atlantic/Reykjavik",
    "Atlantic/South_Georgia",
    "Atlantic/St_Helena",
    "Atlantic/Stanley",
    "Australia/Adelaide",
    "Australia/Brisbane",
    "Australia/Broken_Hill",
    "Australia/Darwin",
    "Australia/Eucla",
    "Australia/Hobart",
    "Australia/Lindeman",
    "Australia/Lord_Howe",
    "Australia/Melbourne",
    "Australia/Perth",
    "Australia/Sydney",
    "Europe/Amsterdam",
    "Europe/Andorra",
    "Europe/Astrakhan",
    "Europe/Athens",
    "Europe/Belgrade",
    "Europe/Berlin",
    "Europe/Bratislava",
    "Europe/Brussels",
    "Europe/Bucharest",
    "Europe/Budapest",
    "Europe/Busingen",
    "Europe/Chisinau",
    "Europe/Copenhagen",
    "Europe/Dublin",
    "Europe/Gibraltar",
    "Europe/Guernsey",
    "Europe/Helsinki",
    "Europe/Isle_of_Man",
    "Europe/Istanbul",
    "Europe/Jersey",
    "Europe/Kaliningrad",
    "Europe/Kiev",
    "Europe/Kirov",
    "Europe/Lisbon",
    "Europe/Ljubljana",
    "Europe/London",
    "Europe/Luxembourg",
    "Europe/Madrid",
    "Europe/Malta",
    "Europe/Mariehamn",
    "Europe/Minsk",
    "Europe/Monaco",
    "Europe/Moscow",
    "Europe/Oslo",
    "Europe/Paris",
    "Europe/Podgorica",
    "Europe/Prague",
    "Europe/Riga",
    "Europe/Rome",
    "Europe/Samara",
    "Europe/San_Marino",
    "Europe/Sarajevo",
    "Europe/Saratov",
    "Europe/Simferopol",
    "Europe/Skopje",
    "Europe/Sofia",
    "Europe/Stockholm",
    "Europe/Tallinn",
    "Europe/Tirane",
    "Europe/Ulyanovsk",
    "Europe/Uzhgorod",
    "Europe/Vaduz",
    "Europe/Vatican",
    "Europe/Vienna",
    "Europe/Vilnius",
    "Europe/Volgograd",
    "Europe/Warsaw",
    "Europe/Zagreb",
    "Europe/Zaporozhye",
    "Europe/Zurich",
    "Indian/Antananarivo",
    "Indian/Chagos",
    "Indian/Christmas",
    "Indian/Cocos",
    "Indian/Comoro",
    "Indian/Kerguelen",
    "Indian/Mahe",
    "Indian/Maldives",
    "Indian/Mauritius",
    "Indian/Mayotte",
    "Indian/Reunion",
    "Pacific/Apia",
    "Pacific/Auckland",
    "Pacific/Bougainville",
    "Pacific/Chatham",
    "Pacific/Chuuk",
    "Pacific/Easter",
    "Pacific/Efate",
    "Pacific/Fakaofo",
    "Pacific/Fiji",
    "Pacific/Funafuti",
    "Pacific/Galapagos",
    "Pacific/Gambier",
    "Pacific/Guadalcanal",
    "Pacific/Guam",
    "Pacific/Honolulu",
    "Pacific/Kanton",
    "Pacific/Kiritimati",
    "Pacific/Kosrae",
    "Pacific/Kwajalein",
    "Pacific/Majuro",
    "Pacific/Marquesas",
    "Pacific/Midway",
    "Pacific/Nauru",
    "Pacific/Niue",
    "Pacific/Norfolk",
    "Pacific/Noumea",
    "Pacific/Pago_Pago",
    "Pacific/Palau",
    "Pacific/Pitcairn",
    "Pacific/Pohnpei",
    "Pacific/Port_Moresby",
    "Pacific/Rarotonga",
    "Pacific/Saipan",
    "Pacific/Tahiti",
    "Pacific/Tarawa",
    "Pacific/Tongatapu",
    "Pacific/Wake",
    "Pacific/Wallis",
    "UTC"
]

Request   

GET api/timezones

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Goals

API endpoints for goals

The goals module consists of:

List grips

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/grips?model=1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/grips"
);

const params = {
    "model": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "number": 9639,
        "name": "delectus grip",
        "description": null,
        "opposed": 0,
        "created_at": "2026-10-26T11:55:27.000000Z",
        "updated_at": "2026-10-26T11:55:27.000000Z"
    },
    {
        "id": 2,
        "number": 3209,
        "name": "amet grip",
        "description": null,
        "opposed": 0,
        "created_at": "2026-10-26T11:55:27.000000Z",
        "updated_at": "2026-10-26T11:55:27.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view grips",
    "code": "GOALS:LIST_GRIPS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/grips

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

model   integer  optional  

Device Model ID. Use this parameter to receive the correct grip images in the image field. When not present, all images will be listed in images array. Example: 1

Response

Response Fields

id   integer   

Grip ID.

number   integer   

Grip number identifier.

name   string   

Grip name.

description   string   

Grip description.

opposed   boolean   

Whether the grip is opposed.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

List exercises

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/exercises" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/exercises"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "name": "exercises.Katelyn Court",
            "description": "exercises.Voluptas sint cumque voluptates aut.",
            "icon": "😣",
            "created_at": "2026-10-26T11:55:29.000000Z",
            "updated_at": "2026-10-26T11:55:29.000000Z"
        },
        {
            "id": 2,
            "name": "exercises.Fritsch Neck",
            "description": "exercises.Qui qui ut et aut quidem non perspiciatis.",
            "icon": "😢",
            "created_at": "2026-10-26T11:55:29.000000Z",
            "updated_at": "2026-10-26T11:55:29.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view exercises",
    "code": "GOALS:LIST_EXERCISES:INSUFFICIENT_PERMISSION"
}

Request   

GET api/exercises

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Response

Response Fields

items   object   
id   integer   

Exercise ID.

name   string   

Exercise name.

description   string   

Exercise description.

icon   string   

Exercise icon identifier.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Create exercise

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/exercises" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Water plants\",
    \"description\": \"Use Tripod Close Grip and water your plants\",
    \"icon\": \"🪴\"
}"

const url = new URL(
    "http://localhost:8000/api/exercises"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Water plants",
    "description": "Use Tripod Close Grip and water your plants",
    "icon": "🪴"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "name": "exercises.Ernser Camp",
    "description": "exercises.Voluptatibus aut nihil iure commodi perspiciatis laudantium.",
    "icon": "😫",
    "created_at": "2026-10-26T11:55:29.000000Z",
    "updated_at": "2026-10-26T11:55:29.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage exercises",
    "code": "GOALS:CREATE_EXERCISE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/exercises

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Exercise name. Example: Water plants

description   string   

Exercise description. Example: Use Tripod Close Grip and water your plants

icon   string   

Emoji icon. Example: 🪴

Response

Response Fields

id   integer   

Exercise ID.

name   string   

Exercise name.

description   string   

Exercise description.

icon   string   

Exercise icon identifier.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Update exercise

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/exercises/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Water plants\",
    \"description\": \"Use Tripod Close Grip and water your plants\",
    \"icon\": \"🪴\"
}"

const url = new URL(
    "http://localhost:8000/api/exercises/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Water plants",
    "description": "Use Tripod Close Grip and water your plants",
    "icon": "🪴"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 4,
    "name": "exercises.Mallie Overpass",
    "description": "exercises.Quis voluptas quis nesciunt voluptas repellendus.",
    "icon": "😠",
    "created_at": "2026-10-26T11:55:29.000000Z",
    "updated_at": "2026-10-26T11:55:29.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage exercises",
    "code": "GOALS:UPDATE_EXERCISE:INSUFFICIENT_PERMISSION"
}

Example response (404, Exercise not found):


{
    "message": "Exercise not found",
    "code": "GOALS:UPDATE_EXERCISE:EXERCISE_NOT_FOUND"
}

Request   

PUT api/exercises/{exerciseId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

exerciseId   integer   

Exercise ID. Example: 1

Body Parameters

name   string  optional  

Exercise name. Example: Water plants

description   string  optional  

Exercise description. Example: Use Tripod Close Grip and water your plants

icon   string  optional  

Emoji icon. Example: 🪴

Response

Response Fields

id   integer   

Exercise ID.

name   string   

Exercise name.

description   string   

Exercise description.

icon   string   

Exercise icon identifier.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Delete exercise

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/exercises/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/exercises/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Exercise deleted",
    "code": "GOALS:DELETE_EXERCISE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage exercises",
    "code": "GOALS:DELETE_EXERCISE:INSUFFICIENT_PERMISSION"
}

Example response (403, Exercise is used in goals):


{
    "message": "Cannot delete: exercise is used in goals (1)",
    "code": "GOALS:DELETE_EXERCISE:HAS_GOALS"
}

Example response (404, Exercise not found):


{
    "message": "Exercise not found",
    "code": "GOALS:DELETE_EXERCISE:EXERCISE_NOT_FOUND"
}

Request   

DELETE api/exercises/{exerciseId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

exerciseId   integer   

Exercise ID. Example: 1

List user goals

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/user/1/goals?active=1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/user/1/goals"
);

const params = {
    "active": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "amputee_id": 263,
            "clinician_id": 264,
            "start_date": "1979-04-17",
            "end_date": "2005-02-16",
            "active": 0,
            "created_at": "2026-10-26T11:55:30.000000Z",
            "updated_at": "2026-10-26T11:55:30.000000Z"
        },
        {
            "id": 2,
            "amputee_id": 265,
            "clinician_id": 266,
            "start_date": "1988-09-18",
            "end_date": "1999-03-19",
            "active": 0,
            "created_at": "2026-10-26T11:55:31.000000Z",
            "updated_at": "2026-10-26T11:55:31.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view user goals",
    "code": "GOALS:LIST_GOALS:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "GOALS:LIST_GOALS:USER_NOT_FOUND"
}

Request   

GET api/user/{userId}/goals

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Query Parameters

active   boolean  optional  

Goal active status. Example: 1

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

sortby   string  optional  

Sort by field (available: start_date). Default: start_date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

Goal ID.

amputee_id   integer   

Patient (amputee) user ID.

clinician_id   integer   

Clinician user ID.

start_date   string   

Goal start date.

end_date   string   

Goal end date.

active   boolean   

Whether the goal is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Create user goal

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/user/1/goals" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2023-05-12\",
    \"end_date\": \"2023-05-15\",
    \"active\": true
}"

const url = new URL(
    "http://localhost:8000/api/user/1/goals"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "start_date": "2023-05-12",
    "end_date": "2023-05-15",
    "active": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "amputee_id": 267,
    "clinician_id": 268,
    "start_date": "1982-06-23",
    "end_date": "1992-03-14",
    "active": 0,
    "created_at": "2026-10-26T11:55:32.000000Z",
    "updated_at": "2026-10-26T11:55:32.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user goals",
    "code": "GOALS:CREATE_GOAL:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "GOALS:CREATE_GOAL:USER_NOT_FOUND"
}

Request   

POST api/user/{userId}/goals

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Body Parameters

start_date   string   

Start date of the goal tracking. MUST_BE_DATE Must be a valid date in the format Y-m-d. MUST_BE_AFTER_OR_EQUAL:today. Example: 2023-05-12

end_date   string   

End date of goal tracking. MUST_BE_DATE Must be a valid date in the format Y-m-d. MUST_BE_AFTER:start_date. Example: 2023-05-15

active   boolean  optional  

Status of goal activity. Example: true

Response

Response Fields

id   integer   

Goal ID.

amputee_id   integer   

Patient (amputee) user ID.

clinician_id   integer   

Clinician user ID.

start_date   string   

Goal start date.

end_date   string   

Goal end date.

active   boolean   

Whether the goal is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Update user goal

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/user/1/goals/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start_date\": \"2023-05-12\",
    \"end_date\": \"2023-05-15\",
    \"active\": true
}"

const url = new URL(
    "http://localhost:8000/api/user/1/goals/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "start_date": "2023-05-12",
    "end_date": "2023-05-15",
    "active": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 4,
    "amputee_id": 269,
    "clinician_id": 270,
    "start_date": "1984-02-22",
    "end_date": "2023-05-14",
    "active": 0,
    "created_at": "2026-10-26T11:55:33.000000Z",
    "updated_at": "2026-10-26T11:55:33.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user goals",
    "code": "GOALS:UPDATE_GOAL:INSUFFICIENT_PERMISSION"
}

Example response (403, Cannot activate ongoing goal):


{
    "message": "Cannot activate ongoing goal",
    "code": "GOALS:UPDATE_GOAL:GOAL_IS_ONGOING"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "GOALS:UPDATE_GOAL:USER_NOT_FOUND"
}

Example response (404, Goal not found):


{
    "message": "Goal not found",
    "code": "GOALS:UPDATE_GOAL:GOAL_NOT_FOUND"
}

Request   

PUT api/user/{userId}/goals/{goalId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

goalId   integer   

Goal ID. Example: 1

Body Parameters

start_date   string  optional  

Start date of the goal tracking. MUST_BE_DATE Must be a valid date in the format Y-m-d. MUST_BE_AFTER_OR_EQUAL:today. Example: 2023-05-12

end_date   string  optional  

End date of goal tracking. MUST_BE_DATE Must be a valid date in the format Y-m-d. MUST_BE_AFTER:start_date. Example: 2023-05-15

active   boolean  optional  

Status of goal activity. Example: true

Response

Response Fields

id   integer   

Goal ID.

amputee_id   integer   

Patient (amputee) user ID.

clinician_id   integer   

Clinician user ID.

start_date   string   

Goal start date.

end_date   string   

Goal end date.

active   boolean   

Whether the goal is active.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Delete user goal

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/user/1/goals/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/user/1/goals/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Goal deleted",
    "code": "GOALS:DELETE_GOAL:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user goals",
    "code": "GOALS:DELETE_GOAL:INSUFFICIENT_PERMISSION"
}

Example response (403, Cannot delete ongoing goal):


{
    "message": "Cannot delete active ongoing goal",
    "code": "GOALS:DELETE_GOAL:GOAL_IS_ONGOING"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "GOALS:DELETE_GOAL:USER_NOT_FOUND"
}

Example response (404, Goal not found):


{
    "message": "Goal not found",
    "code": "GOALS:DELETE_GOAL:GOAL_NOT_FOUND"
}

Request   

DELETE api/user/{userId}/goals/{goalId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

goalId   integer   

Goal ID. Example: 1

List user goal conditions

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/user/1/goals/1/conditions" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/user/1/goals/1/conditions"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "goal_id": 5,
            "type": "switch",
            "grip_id": 3,
            "grips_frequency": "d",
            "grips_count": 25,
            "switches_frequency": "w",
            "switches_count": 490,
            "exercise_id": 5,
            "exercise_frequency": "w",
            "exercise_count": 6,
            "created_at": "2026-10-26T11:55:34.000000Z",
            "updated_at": "2026-10-26T11:55:34.000000Z"
        },
        {
            "id": 2,
            "goal_id": 6,
            "type": "exercise",
            "grip_id": 4,
            "grips_frequency": "w",
            "grips_count": 364,
            "switches_frequency": "d",
            "switches_count": 410,
            "exercise_id": 6,
            "exercise_frequency": "m",
            "exercise_count": 2,
            "created_at": "2026-10-26T11:55:35.000000Z",
            "updated_at": "2026-10-26T11:55:35.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view user goals",
    "code": "GOALS:LIST_CONDITIONS:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "GOALS:LIST_CONDITIONS:USER_NOT_FOUND"
}

Example response (404, Goal not found):


{
    "message": "Goal not found",
    "code": "GOALS:LIST_CONDITIONS:GOAL_NOT_FOUND"
}

Request   

GET api/user/{userId}/goals/{goalId}/conditions

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

goalId   integer   

Goal ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Response

Response Fields

items   object   
id   integer   

Goal condition ID.

goal_id   integer   

Associated goal ID.

type   string   

Condition type.

Must be one of:
  • grip
  • switch
  • exercise
grip_id   integer   

Target grip ID.

grips_frequency   string   

Grip frequency period.

Must be one of:
  • d
  • w
  • m
  • a
grips_count   integer   

Required grip count.

switches_frequency   string   

Switch frequency period.

Must be one of:
  • d
  • w
  • m
  • a
switches_count   integer   

Required switch count.

exercise_id   integer   

Target exercise ID.

exercise_frequency   string   

Exercise frequency period.

Must be one of:
  • d
  • w
  • m
exercise_count   integer   

Required exercise count.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Create user goal condition

requires authentication

Each goal condition could be one of type: grip, switch or exercise.

If goal condition is type of grip, fill only grip_id (optional), grips_frequency and grips_count.
If grip_id is null or missing, patient can perform any grip to fulfill objective.

If goal condition is type of switch, fill only switches_frequency and switches_count.

If goal condition is type of exercise, fill only exercise_id, exercise_frequency and exercise_count.


Restrictions:

  • you can add one grip-any condition (grip_id=null, any grip is counted) and many grip-specific conditions (for example: grip 1 - 100 times and grip 2 - 50 times),
  • all grips conditions must have same frequency (grips_frequency field),
  • sum of grip-specific conditions (grips_count field) cannot be greater than grip-any condition for same goal
  • you can add only one switch condition for same goal,
  • you can add multiple exercise conditions, but each exercise can be used only once.
Example request:
curl --request POST \
    "http://localhost:8000/api/user/1/goals/1/conditions" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"grip\",
    \"grip_id\": 1,
    \"grips_frequency\": \"d\",
    \"grips_count\": 100,
    \"switches_frequency\": \"d\",
    \"switches_count\": 100,
    \"exercise_id\": 1,
    \"exercise_frequency\": \"d\",
    \"exercise_count\": 5
}"

const url = new URL(
    "http://localhost:8000/api/user/1/goals/1/conditions"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "grip",
    "grip_id": 1,
    "grips_frequency": "d",
    "grips_count": 100,
    "switches_frequency": "d",
    "switches_count": 100,
    "exercise_id": 1,
    "exercise_frequency": "d",
    "exercise_count": 5
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "goal_id": 7,
    "type": "exercise",
    "grip_id": 5,
    "grips_frequency": "d",
    "grips_count": 390,
    "switches_frequency": "d",
    "switches_count": 790,
    "exercise_id": 7,
    "exercise_frequency": "m",
    "exercise_count": 5,
    "created_at": "2026-10-26T11:55:37.000000Z",
    "updated_at": "2026-10-26T11:55:37.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user goals",
    "code": "GOALS:CREATE_CONDITION:INSUFFICIENT_PERMISSION"
}

Example response (403, Cannot create condition: all grip conditions have to be same frequency):


{
    "message": "Cannot create condition: all grip conditions have to be same frequency",
    "code": "GOALS:CREATE_CONDITION:INVALID_FREQUENCY"
}

Example response (403, Cannot create condition: grip-any condition for this goal already exist):


{
    "message": "Cannot create condition: grip-any condition for this goal already exist",
    "code": "GOALS:CREATE_CONDITION:GRIP_ANY_ALREADY_EXISTS"
}

Example response (403, Cannot create condition: condition with this grip already exist):


{
    "message": "Cannot create condition: condition with this grip already exist",
    "code": "GOALS:CREATE_CONDITION:GRIP_CONDITION_ALREADY_EXISTS"
}

Example response (403, Cannot create condition: grip-any value cannot be lower than sum of grip-specific conditions):


{
    "message": "Cannot create condition: grip-any value cannot be lower than sum of grip-specific conditions",
    "code": "GOALS:CREATE_CONDITION:GRIP_ANY_LOWER_THAN_GRIPS_SUM"
}

Example response (403, Cannot create condition: sum of grip-specific conditions cannot be greater than value of grip-any condition):


{
    "message": "Cannot create condition: sum of grip-specific conditions cannot be greater than value of grip-any condition",
    "code": "GOALS:CREATE_CONDITION:GRIPS_SUM_GREATER_THAN_GRIP_ANY"
}

Example response (403, Cannot create condition: switch condition for this goal already exist):


{
    "message": "Cannot create condition: switch condition for this goal already exist",
    "code": "GOALS:CREATE_CONDITION:SWITCH_CONDITION_ALREADY_EXISTS"
}

Example response (403, Cannot create condition: condition with this exercise already exist):


{
    "message": "Cannot create condition: condition with this exercise already exist",
    "code": "GOALS:CREATE_CONDITION:EXERCISE_CONDITION_ALREADY_EXISTS"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "GOALS:CREATE_CONDITION:USER_NOT_FOUND"
}

Example response (404, Goal not found):


{
    "message": "Goal not found",
    "code": "GOALS:CREATE_CONDITION:GOAL_NOT_FOUND"
}

Request   

POST api/user/{userId}/goals/{goalId}/conditions

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

goalId   integer   

Goal ID. Example: 1

Body Parameters

type   string   

Goal condition type. Example: grip

Must be one of:
  • grip
  • switch
  • exercise
grip_id   integer  optional  

Grip number required for condition. Pass null to allow any grip. The id of an existing record in the App\Models\Grip table. Example: 1

grips_frequency   string  optional  

Grips frequency unit. d - daily, w - weekly, m - monthly, a - all time (within goal). This field is required when type is grip. Example: d

Must be one of:
  • d
  • w
  • m
  • a
grips_count   integer  optional  

Required number of grips per frequency unit. This field is required when type is grip. MINIMUM:NUMBER:1. Example: 100

switches_frequency   string  optional  

Switches frequency unit. d - daily, w - weekly, m - monthly, a - all time (within goal). This field is required when type is switch. Example: d

Must be one of:
  • d
  • w
  • m
  • a
switches_count   integer  optional  

Required number of switches per frequency unit. This field is required when type is switch. MINIMUM:NUMBER:1. Example: 100

exercise_id   integer  optional  

Exercise ID. This field is required when type is exercise. The id of an existing record in the App\Models\Exercise table. Example: 1

exercise_frequency   string  optional  

Exercise frequency unit. d - daily, w - weekly, m - monthly. This field is required when type is exercise. Example: d

Must be one of:
  • d
  • w
  • m
exercise_count   integer  optional  

Required number of performed exercises per frequency unit. This field is required when type is exercise. MINIMUM:NUMBER:1. Example: 5

Response

Response Fields

id   integer   

Goal condition ID.

goal_id   integer   

Associated goal ID.

type   string   

Condition type.

Must be one of:
  • grip
  • switch
  • exercise
grip_id   integer   

Target grip ID.

grips_frequency   string   

Grip frequency period.

Must be one of:
  • d
  • w
  • m
  • a
grips_count   integer   

Required grip count.

switches_frequency   string   

Switch frequency period.

Must be one of:
  • d
  • w
  • m
  • a
switches_count   integer   

Required switch count.

exercise_id   integer   

Target exercise ID.

exercise_frequency   string   

Exercise frequency period.

Must be one of:
  • d
  • w
  • m
exercise_count   integer   

Required exercise count.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Delete user goal condition

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/user/1/goals/1/conditions/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/user/1/goals/1/conditions/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Goal condition deleted",
    "code": "GOALS:DELETE_CONDITION:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user goals",
    "code": "GOALS:DELETE_CONDITION:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "GOALS:DELETE_CONDITION:USER_NOT_FOUND"
}

Example response (404, Goal not found):


{
    "message": "Goal not found",
    "code": "GOALS:DELETE_CONDITION:GOAL_NOT_FOUND"
}

Request   

DELETE api/user/{userId}/goals/{goalId}/conditions/{conditionId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

goalId   integer   

Goal ID. Example: 1

conditionId   integer   

Goal condition ID. Example: 1

Get user goal progress

requires authentication

Data is grouped into three parts:
  • grips - data about grips progress,
  • switches - data about switches progress,
  • exercises - data about exercises progress and attempts made.
For grips and switches there is summary, which is divided into 4 parts:
  • overall - summary of whole goal time-frame,
  • period - summary of given period, according to frequency (for example: if frequency of conditions is "weekly", these data is summary of current's week).
  • today - summary of today's, used mainly to send daily summary notifications,
  • conditions - goal conditions with progress for each one.
There are also extra fields inside the summary parts:
  • type for grips overall summary, which points which conditions were used to calculate the summary. If grip-any condition exists, it has priority over grip-specific conditions, otherwise summary contains sum of all grip-specific conditions,
  • frequency, frequency_from and frequency_to for period summary for both grips and switches, which describe time-frame of frequency and period,
  • done for today's summary for both grips and switches, indicates if today's goal is reached (it's calculated only for conditions of frequency "daily").
Example request:
curl --request GET \
    --get "http://localhost:8000/api/goals/1/progress" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/goals/1/progress"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "grips": {
        "meta": {
            "overall": {
                "from": "2023-09-01 00:00:00",
                "to": "2023-08-30 23:59:59"
            },
            "period": {
                "from": "2023-09-15 23:59:59",
                "to": "2023-09-21 23:59:59",
                "frequency": "w"
            }
        },
        "summary": {
            "type": "grips-specific",
            "progress": 222,
            "goal": 2535
        },
        "progress": [
            {
                "grip": {
                    "id": 1,
                    "number": 0,
                    "name": "Rest Opposition",
                    "description": null,
                    "created_at": "2023-08-30T12:20:00.000000Z",
                    "updated_at": "2023-08-30T12:20:00.000000Z"
                },
                "overall": {
                    "progress": 125,
                    "goal": 200
                },
                "period": {
                    "progress": 22,
                    "goal": 50
                }
            },
            {
                "grip": {
                    "id": 2,
                    "number": 1,
                    "name": "Power",
                    "description": null,
                    "created_at": "2023-05-18T11:24:11.000000Z",
                    "updated_at": "2023-05-18T11:24:11.000000Z"
                },
                "overall": {
                    "progress": 90,
                    "goal": 150
                },
                "period": {
                    "progress": 10,
                    "goal": 30
                }
            },
            {
                "grip": null,
                "overall": {
                    "progress": 78,
                    "goal": 1250
                },
                "period": {
                    "progress": 17,
                    "goal": 240
                }
            }
        ],
        "today": {
            "performed": 0,
            "goal": 0,
            "done": true
        }
    },
    "switches": {
        "overall": {
            "performed": 55,
            "goal": 300
        },
        "period": {
            "performed": 25,
            "goal": 30,
            "frequency": "d",
            "frequency_from": "2023-09-20 00:00:00",
            "frequency_to": "2023-09-20 23:59:59"
        },
        "today": {
            "performed": 25,
            "goal": 30,
            "done": false
        },
        "condition": {
            "type": "switch",
            "switches_frequency": "d",
            "switches_count": 30
        }
    },
    "exercises": {
        "performed": 1,
        "goal": 3,
        "done": false,
        "conditions": [
            {
                "type": "exercise",
                "exercise_id": 1,
                "exercise_frequency": "d",
                "exercise_count": 3,
                "attempts": [
                    {
                        "date_from": "2023-06-06",
                        "date_to": "2023-06-12",
                        "count_done": 1,
                        "count_not_done": 1
                    },
                    {
                        "date_from": "2023-06-13",
                        "date_to": "2023-06-19",
                        "count_done": 0,
                        "count_not_done": 0
                    },
                    {
                        "date_from": "2023-06-20",
                        "date_to": "2023-06-26",
                        "count_done": 0,
                        "count_not_done": 0
                    },
                    {
                        "date_from": "2023-06-27",
                        "date_to": "2023-07-03",
                        "count_done": 0,
                        "count_not_done": 0
                    }
                ],
                "exercise": {
                    "id": 1,
                    "name": "Water plants",
                    "description": "Use Tripod Grip and water your plants",
                    "icon": "🪴",
                    "created_at": "2023-05-19T10:25:37.000000Z",
                    "updated_at": "2023-05-19T10:25:37.000000Z"
                }
            }
        ]
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view goal progress",
    "code": "GOALS:GET_PROGRESS:INSUFFICIENT_PERMISSION"
}

Example response (404, Goal not found):


{
    "message": "Goal not found",
    "code": "GOALS:GET_PROGRESS:GOAL_NOT_FOUND"
}

Request   

GET api/goals/{goalId}/progress

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

goalId   integer   

Goal ID. Example: 1

Update user goal progress

requires authentication

Use this endpoint to update goal progress as patient. Add exercise attempts and mark them as done or not done.

Example request:
curl --request POST \
    "http://localhost:8000/api/goals/1/progress" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"exercise_id\": 1,
    \"exercise_done\": true
}"

const url = new URL(
    "http://localhost:8000/api/goals/1/progress"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "exercise_id": 1,
    "exercise_done": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 1,
    "user_id": 277,
    "goal_id": 8,
    "type": "switch",
    "grip_id": null,
    "grips": 135,
    "switches": 78,
    "exercise_id": 8,
    "exercise_done": 1,
    "created_at": "2026-10-26T11:55:38.000000Z",
    "updated_at": "2026-10-26T11:55:38.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update goal progress",
    "code": "GOALS:UPDATE_PROGRESS:INSUFFICIENT_PERMISSION"
}

Example response (404, Goal not found):


{
    "message": "Goal not found",
    "code": "GOALS:UPDATE_PROGRESS:GOAL_NOT_FOUND"
}

Example response (422, User timezone not set):


{
    "message": "User timezone not set",
    "code": "GOALS:UPDATE_PROGRESS:NO_TIMEZONE"
}

Request   

POST api/goals/{goalId}/progress

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

goalId   integer   

Goal ID. Example: 1

Body Parameters

exercise_id   integer   

Exercise ID. The id of an existing record in the App\Models\Exercise table. Example: 1

exercise_done   boolean  optional  

Status of exercise attempt. Example: true

Response

Response Fields

id   integer   

User goal ID.

user_id   integer   

Associated user ID.

goal_id   integer   

Associated goal ID.

type   string   

Goal condition type.

Must be one of:
  • grip
  • switch
  • exercise
grip_id   integer   

Target grip ID.

grips   integer   

Grip count progress.

switches   integer   

Switch count progress.

exercise_id   integer   

Target exercise ID.

exercise_done   boolean   

Whether the exercise is completed.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Invitations

Accept clinician invitation

Example request:
curl --request POST \
    "http://localhost:8000/api/invite/accept" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"ABC123DEF456GHI789JKL0\",
    \"email\": \"example@domain.com\",
    \"password\": \"Test123!\",
    \"language\": \"en\",
    \"name\": \"Tom Smith\",
    \"clinic_name\": \"My clinic Ltd\",
    \"clinic_location\": \"Example St 1\\/345 New York, NY\",
    \"address1\": \"8309 Rebekah Shoal\",
    \"address2\": \"Ivyberg, MI 57412\",
    \"mfa_enabled\": true,
    \"mfa_method\": \"email\"
}"

const url = new URL(
    "http://localhost:8000/api/invite/accept"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "token": "ABC123DEF456GHI789JKL0",
    "email": "example@domain.com",
    "password": "Test123!",
    "language": "en",
    "name": "Tom Smith",
    "clinic_name": "My clinic Ltd",
    "clinic_location": "Example St 1\/345 New York, NY",
    "address1": "8309 Rebekah Shoal",
    "address2": "Ivyberg, MI 57412",
    "mfa_enabled": true,
    "mfa_method": "email"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 4,
    "mrn": "D3GD5FCK1793015590",
    "name": "Mrs. Yessenia Wunsch IV",
    "email": "1793015590reichert.misael@example.com",
    "language": "en",
    "phone": "1-425-578-8808",
    "phone_country": "MX",
    "phone_verified_at": null,
    "address1": "3094 Hudson Roads Suite 612",
    "address2": "South Cristian, HI 50900-9440",
    "postal_code": "00239-1971",
    "city": "Brakus Ltd",
    "country": "GR",
    "clinic_name": "Layneberg",
    "clinic_location": "10420 Loren Lights\nWest Sarai, RI 45241",
    "image": null,
    "public_image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "is_ambassador": 0,
    "test_account": false,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2026-10-26T11:53:10.000000Z",
    "updated_at": "2026-10-26T11:53:10.000000Z",
    "invitation_status": "accepted",
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 3,
            "name": "ClinicAdmin"
        }
    ]
}

Example response (403, Invitation expired):


{
    "message": "Invitation expired",
    "code": "INVITATIONS:ACCEPT:INVITATION_EXPIRED"
}

Example response (404, Invitation not found):


{
    "message": "Invitation not found",
    "code": "INVITATIONS:ACCEPT:INVITATION_NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error: invitation not accepted",
    "code": "INVITATIONS:ACCEPT:SERVER_ERROR"
}

Request   

POST api/invite/accept

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

Invitation token sent by e-mail. SIZE:STRING_LENGTH:24. Example: ABC123DEF456GHI789JKL0

email   string   

User e-mail. MUST_BE_EMAIL. Example: example@domain.com

password   string   

User password. Example: Test123!

language   string   

User language. Example: en

name   string   

User name. Example: Tom Smith

clinic_name   string  optional  

Clinic name. Example: My clinic Ltd

clinic_location   string  optional  

Clinic location. Example: Example St 1/345 New York, NY

address1   string  optional  

User address line 1. Example: 8309 Rebekah Shoal

address2   string  optional  

User address line 2. Example: Ivyberg, MI 57412

mfa_enabled   boolean  optional  

MFA enabled. Example: true

mfa_method   string  optional  

MFA method. Example: email

Must be one of:
  • email
  • sms

Response

Response Fields

id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

Accept Acadle invitation

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/invite/acadle/accept" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"a1b2c3d4e5f6g7h8i9j0k1l2m3\",
    \"email\": \"user@example.com\",
    \"password\": \"securePassword123\",
    \"phone\": \"(402) 772-0305\",
    \"phone_country\": \"US\",
    \"name\": \"John Doe\",
    \"language\": \"en\"
}"

const url = new URL(
    "http://localhost:8000/api/invite/acadle/accept"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "token": "a1b2c3d4e5f6g7h8i9j0k1l2m3",
    "email": "user@example.com",
    "password": "securePassword123",
    "phone": "(402) 772-0305",
    "phone_country": "US",
    "name": "John Doe",
    "language": "en"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 5,
    "mrn": "9AGA6S6U1793015591",
    "name": "Ernie Dickens",
    "email": "1793015591janelle.green@example.net",
    "language": "en",
    "phone": "1-740-755-9366",
    "phone_country": "MM",
    "phone_verified_at": null,
    "address1": "31112 Gusikowski Spurs Apt. 047",
    "address2": "Howellview, NC 20507-2675",
    "postal_code": "51698",
    "city": "Hoppe PLC",
    "country": "NO",
    "clinic_name": "South Leolastad",
    "clinic_location": "958 Kristian Light Apt. 360\nMooreport, IL 03075-1945",
    "image": null,
    "public_image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "is_ambassador": 0,
    "test_account": false,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2026-10-26T11:53:11.000000Z",
    "updated_at": "2026-10-26T11:53:11.000000Z",
    "invitation_status": null,
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 1,
            "name": "SuperAdmin"
        }
    ]
}

Example response (403, Invitation expired):


{
    "message": "Invitation expired",
    "code": "INVITATIONS_ACADLE:ACCEPT:INVITATION_EXPIRED"
}

Example response (404, Invitation not found):


{
    "message": "Invitation not found",
    "code": "INVITATIONS_ACADLE:ACCEPT:INVITATION_NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error: invitation not accepted",
    "code": "INVITATIONS_ACADLE:ACCEPT:SERVER_ERROR"
}

Request   

POST api/invite/acadle/accept

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

Invitation token. SIZE:STRING_LENGTH:24. Example: a1b2c3d4e5f6g7h8i9j0k1l2m3

email   string   

Email address of the Acadle user. MUST_BE_EMAIL. Example: user@example.com

password   string   

User password. Example: securePassword123

phone   string   

User phone number. Example: (402) 772-0305

phone_country   string   

Phone number's country (2 characters). SIZE:STRING_LENGTH:2. Example: US

name   string   

User name. Example: John Doe

language   string   

User preferred language. Example: en

Response

Response Fields

id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

List users for invitations

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/invite/users" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/invite/users"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 15,
            "mrn": "GEP8GLP41793015597",
            "name": "Ms. Alayna Lang",
            "email": "1793015597bbreitenberg@example.com",
            "language": "en",
            "phone": "+1 (878) 565-7703",
            "phone_country": "HU",
            "phone_verified_at": null,
            "address1": "645 Lebsack Locks Apt. 070",
            "address2": "Columbusmouth, TN 14774",
            "postal_code": "16002",
            "city": "Borer PLC",
            "country": "IT",
            "clinic_name": "South Mona",
            "clinic_location": "63738 Kerluke Branch Apt. 683\nKunzeberg, AK 39839",
            "image": null,
            "public_image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "is_ambassador": 0,
            "test_account": false,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2026-10-26T11:53:18.000000Z",
            "updated_at": "2026-10-26T11:53:18.000000Z",
            "invitation_status": "accepted",
            "acadle_invitation_status": null,
            "roles": [
                {
                    "id": 5,
                    "name": "ClinicianSupport"
                }
            ]
        },
        {
            "id": 16,
            "mrn": "V9QY3A6B1793015598",
            "name": "Alexandre Dooley",
            "email": "1793015598daugherty.jedidiah@example.org",
            "language": "en",
            "phone": "951.582.3148",
            "phone_country": "DJ",
            "phone_verified_at": null,
            "address1": "113 Kaylin Turnpike Suite 330",
            "address2": "Kayliechester, AR 56191-2671",
            "postal_code": "56479",
            "city": "Ullrich PLC",
            "country": "IT",
            "clinic_name": "Noraborough",
            "clinic_location": "6812 Ewald Overpass\nReingerberg, HI 22856",
            "image": null,
            "public_image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "is_ambassador": 0,
            "test_account": false,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2026-10-26T11:53:18.000000Z",
            "updated_at": "2026-10-26T11:53:18.000000Z",
            "invitation_status": null,
            "acadle_invitation_status": null,
            "roles": [
                {
                    "id": 2,
                    "name": "CommunityAdmin"
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list users for invitations",
    "code": "INVITATIONS:USERS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/invite/users

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: clinicians, patients, devices, devicesAsClinician, roles, permissions).

Response

Response Fields

items   object   
id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Create clinician invitations

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/invite" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"patient_id\": 1,
    \"invitations\": [
        {
            \"user_id\": 1,
            \"user_email\": \"newuser@domain.com\",
            \"role\": \"Clinician\",
            \"training_confirmed\": true,
            \"permissions\": [
                \"temporibus\"
            ]
        }
    ]
}"

const url = new URL(
    "http://localhost:8000/api/invite"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "patient_id": 1,
    "invitations": [
        {
            "user_id": 1,
            "user_email": "newuser@domain.com",
            "role": "Clinician",
            "training_confirmed": true,
            "permissions": [
                "temporibus"
            ]
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 10,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 17,
            "mrn": "W3WTX6ST1793015598",
            "name": "Prof. Marlon Brekke MD",
            "email": "1793015598mazie.tillman@example.com",
            "language": "en",
            "phone": "(432) 338-1081",
            "phone_country": "ME",
            "phone_verified_at": null,
            "address1": "3654 Dorothea Locks Suite 957",
            "address2": "Hamillchester, NY 80506",
            "postal_code": "92031",
            "city": "Feil and Sons",
            "country": "SK",
            "clinic_name": "Cormierborough",
            "clinic_location": "85892 Nat Plain\nNew Germainefort, WI 21014",
            "image": null,
            "public_image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "is_ambassador": 0,
            "test_account": false,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2026-10-26T11:53:19.000000Z",
            "updated_at": "2026-10-26T11:53:19.000000Z",
            "invitation_status": "accepted",
            "acadle_invitation_status": null,
            "invitations": [
                {
                    "id": 1,
                    "user_id": 18,
                    "invited_user_id": 17,
                    "type": "clinician",
                    "training_confirmed": 0,
                    "created_at": "2026-10-26T11:53:20.000000Z",
                    "updated_at": "2026-10-26T11:53:20.000000Z"
                }
            ],
            "roles": [
                {
                    "id": 5,
                    "name": "ClinicianSupport"
                }
            ]
        },
        {
            "id": 20,
            "mrn": "FUUBST291793015600",
            "name": "Dario Kiehn",
            "email": "1793015600dominic95@example.org",
            "language": "en",
            "phone": "1-248-719-5189",
            "phone_country": "AQ",
            "phone_verified_at": null,
            "address1": "3398 Jerde Extension",
            "address2": "Boganton, MD 57238-2580",
            "postal_code": "92363",
            "city": "Walter PLC",
            "country": "RO",
            "clinic_name": "Eloisamouth",
            "clinic_location": "742 Marco Cape\nBergstromport, SD 28930",
            "image": null,
            "public_image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "is_ambassador": 0,
            "test_account": false,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2026-10-26T11:53:20.000000Z",
            "updated_at": "2026-10-26T11:53:20.000000Z",
            "invitation_status": null,
            "acadle_invitation_status": null,
            "invitations": [
                {
                    "id": 2,
                    "user_id": 21,
                    "invited_user_id": 20,
                    "type": "clinician",
                    "training_confirmed": 0,
                    "created_at": "2026-10-26T11:53:21.000000Z",
                    "updated_at": "2026-10-26T11:53:21.000000Z"
                }
            ],
            "roles": [
                {
                    "id": 1,
                    "name": "SuperAdmin"
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create invitations",
    "code": "INVITATIONS:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (403, No access to given patient):


{
    "message": "No access to given patient",
    "code": "INVITATIONS:CREATE:NO_ACCESS_TO_PATIENT"
}

Request   

POST api/invite

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

patient_id   string  optional  

Patient user ID. The id of an existing record in the App\Models\User table. Example: 1

invitations   object[]   

List of invitations (maximum entries: 10, array of objects).
user_id   integer  optional  

Invited user ID. Use only for existing users. Don't use together with user_email. This field is required when invitations.*.user_email is not present. The id of an existing record in the App\Models\User table. Example: 1

user_email   string  optional  

Invited user e-mail. Use only for non-existing users. Don't use together with user_id. This field is required when invitations.*.user_id is not present. MUST_BE_EMAIL. Example: newuser@domain.com

role   string  optional  

Invited user role. Use only for non-existing users. This field is required when invitations.*.user_id is not present. Example: Clinician

Must be one of:
  • ClinicAdmin
  • Clinician
  • ClinicianSupport
training_confirmed   boolean   

Confirmation that invited user was properly trained to use ADP. Must be accepted. Example: true

permissions   string[]  optional  

List of permissions to assign to the user (use that for ClinicianSupport role).

permissions[]   string  optional  

Permission name. Example: et

Response

Response Fields

items   object   
id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Resend invitation

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/invite/1/resend" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/invite/1/resend"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (201):


{
    "id": 23,
    "mrn": "TJTGZ2WV1793015602",
    "name": "Arjun Hermiston Sr.",
    "email": "1793015602noemie62@example.net",
    "language": "en",
    "phone": "+1-540-677-8826",
    "phone_country": "KH",
    "phone_verified_at": null,
    "address1": "50744 Carole Branch Apt. 222",
    "address2": "Franeckistad, TN 82394-9357",
    "postal_code": "69986",
    "city": "Sporer, Nicolas and O'Reilly",
    "country": "EE",
    "clinic_name": "West Ariane",
    "clinic_location": "254 Purdy Mountains\nPort Alfonsomouth, WI 22000-7973",
    "image": null,
    "public_image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "is_ambassador": 0,
    "test_account": false,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2026-10-26T11:53:22.000000Z",
    "updated_at": "2026-10-26T11:53:22.000000Z",
    "invitation_status": null,
    "acadle_invitation_status": null,
    "invitations": [
        {
            "id": 3,
            "user_id": 24,
            "invited_user_id": 23,
            "type": "clinician",
            "training_confirmed": 1,
            "created_at": "2026-10-26T11:53:23.000000Z",
            "updated_at": "2026-10-26T11:53:23.000000Z"
        }
    ],
    "roles": [
        {
            "id": 2,
            "name": "CommunityAdmin"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to resend invitations",
    "code": "INVITATIONS:RESEND:INSUFFICIENT_PERMISSION"
}

Example response (403, User not found):


{
    "message": "User not found",
    "code": "INVITATIONS:RESEND:USER_NOT_FOUND"
}

Example response (403, Invitation already accepted):


{
    "message": "Invitation already accepted",
    "code": "INVITATIONS:RESEND:INVITATION_ALREADY_ACCEPTED"
}

Request   

POST api/invite/{userId}/resend

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Response

Response Fields

id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

List all users invited to Acadle

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/invite/acadle/users?search=john" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/invite/acadle/users"
);

const params = {
    "search": "john",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 26,
            "mrn": "5WHQPHYL1793015603",
            "name": "Gregorio Hintz",
            "email": "1793015603arvilla43@example.net",
            "language": "en",
            "phone": "682-649-9032",
            "phone_country": "GG",
            "phone_verified_at": null,
            "address1": "4005 Darwin Vista Apt. 071",
            "address2": "Kayleechester, NJ 93567-1861",
            "postal_code": "31255",
            "city": "Crona-Towne",
            "country": "PT",
            "clinic_name": "New Ernesto",
            "clinic_location": "7097 Wunsch Dam\nMakennaborough, IA 34992",
            "image": null,
            "public_image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "is_ambassador": 0,
            "test_account": false,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2026-10-26T11:53:23.000000Z",
            "updated_at": "2026-10-26T11:53:23.000000Z",
            "invitation_status": null,
            "acadle_invitation_status": null,
            "roles": [
                {
                    "id": 2,
                    "name": "CommunityAdmin"
                }
            ]
        },
        {
            "id": 27,
            "mrn": "TF6NE6LQ1793015604",
            "name": "Kennedy Bergstrom V",
            "email": "1793015604gohara@example.org",
            "language": "en",
            "phone": "+13476052688",
            "phone_country": "CZ",
            "phone_verified_at": null,
            "address1": "478 Gisselle Loop Apt. 854",
            "address2": "Port Jacynthe, MN 70185-0629",
            "postal_code": "35262",
            "city": "Kertzmann, McDermott and Lakin",
            "country": "DE",
            "clinic_name": "Dorthychester",
            "clinic_location": "6826 Ada Squares Apt. 032\nAdelahaven, KS 60724",
            "image": null,
            "public_image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "is_ambassador": 0,
            "test_account": false,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2026-10-26T11:53:24.000000Z",
            "updated_at": "2026-10-26T11:53:24.000000Z",
            "invitation_status": "accepted",
            "acadle_invitation_status": null,
            "roles": [
                {
                    "id": 4,
                    "name": "Clinician"
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list users for invitations",
    "code": "INVITATIONS_ACADLE:USERS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/invite/acadle/users

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

search   string  optional  

Filter users by searching in: user name, user email, contact name, contact surname, contact email, CPO number. Example: john

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: roles, acadleSurvey, latestAcadleSurvey).

sortby   string  optional  

Sort by field (available: survey_completion_date). Default: survey_completion_date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Create Acadle invitation

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/invite/acadle" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"jschulist@example.net\"
}"

const url = new URL(
    "http://localhost:8000/api/invite/acadle"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "jschulist@example.net"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 28,
    "mrn": "5RXM3K9P1793015604",
    "name": "Andreane Gulgowski",
    "email": "1793015604pearline53@example.net",
    "language": "en",
    "phone": "+1 (623) 956-9675",
    "phone_country": "MK",
    "phone_verified_at": null,
    "address1": "5282 Rutherford Wall Suite 616",
    "address2": "Audreannemouth, FL 38421",
    "postal_code": "81373",
    "city": "Hudson Inc",
    "country": "GB",
    "clinic_name": "North Hulda",
    "clinic_location": "9312 Shields Square Suite 560\nWest Missouristad, PA 71034",
    "image": null,
    "public_image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "is_ambassador": 0,
    "test_account": false,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2026-10-26T11:53:24.000000Z",
    "updated_at": "2026-10-26T11:53:24.000000Z",
    "invitation_status": null,
    "acadle_invitation_status": "accepted",
    "invitations": [
        {
            "id": 4,
            "user_id": 29,
            "invited_user_id": 28,
            "type": "clinician",
            "training_confirmed": 0,
            "created_at": "2026-10-26T11:53:26.000000Z",
            "updated_at": "2026-10-26T11:53:26.000000Z"
        }
    ],
    "roles": [
        {
            "id": 7,
            "name": "AcadleUser"
        }
    ]
}

Example response (400, User already exists):


{
    "message": "User with this email already exists in the system",
    "code": "INVITATIONS_ACADLE:CREATE:USER_ALREADY_EXISTS"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create invitations",
    "code": "INVITATIONS_ACADLE:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/invite/acadle

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Email address of the Acadle user. Example: jschulist@example.net

Response

Response Fields

id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

Resend Acadle invitation

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/invite/acadle/1/resend" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/invite/acadle/1/resend"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (201):


{
    "id": 31,
    "mrn": "HCZVQ4RR1793015606",
    "name": "Jodie Blick",
    "email": "1793015606orville63@example.net",
    "language": "en",
    "phone": "602-289-3828",
    "phone_country": "VN",
    "phone_verified_at": null,
    "address1": "560 Hegmann Curve Suite 950",
    "address2": "Bahringermouth, ND 25881",
    "postal_code": "60669",
    "city": "Ward, Abbott and McClure",
    "country": "UA",
    "clinic_name": "Trevaton",
    "clinic_location": "11954 Raleigh Crest\nNew Melody, ME 93457-5994",
    "image": null,
    "public_image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "is_ambassador": 0,
    "test_account": false,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2026-10-26T11:53:26.000000Z",
    "updated_at": "2026-10-26T11:53:26.000000Z",
    "invitation_status": null,
    "acadle_invitation_status": null,
    "invitations": [
        {
            "id": 5,
            "user_id": 32,
            "invited_user_id": 31,
            "type": "clinician",
            "training_confirmed": 1,
            "created_at": "2026-10-26T11:53:27.000000Z",
            "updated_at": "2026-10-26T11:53:27.000000Z"
        }
    ],
    "roles": [
        {
            "id": 1,
            "name": "SuperAdmin"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to resend invitations",
    "code": "INVITATIONS_ACADLE:RESEND:INSUFFICIENT_PERMISSION"
}

Example response (403, User not found):


{
    "message": "User not found",
    "code": "INVITATIONS_ACADLE:RESEND:USER_NOT_FOUND"
}

Example response (403, Invitation already accepted):


{
    "message": "Invitation already accepted",
    "code": "INVITATIONS_ACADLE:RESEND:INVITATION_ALREADY_ACCEPTED"
}

Request   

POST api/invite/acadle/{userId}/resend

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Response

Response Fields

id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

Admin access to invitation tokens

requires authentication

Requires admin.invitations_tokens_access permission.
Fetches only non-accepted and non-expired invitations.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/invite/tokens/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/invite/tokens/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


[
    {
        "id": 1,
        "user_id": 1,
        "invited_user_id": 2,
        "token": "I0V25NUVMHC0F8RRF1YEY5BT",
        "training_confirmed": 1,
        "created_at": "2025-05-12T12:00:00.000000Z",
        "updated_at": "2025-05-12T12:00:00.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to get invitation tokens",
    "code": "INVITATIONS:ADMIN_TOKENS:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "INVITATIONS:ADMIN_TOKENS:USER_NOT_FOUND"
}

Request   

GET api/invite/tokens/{userId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Logs

API endpoints for managing event logs

Get events log

requires authentication

user - user account that performed the action
element - element model that has been affected by the action

Example request:
curl --request GET \
    --get "http://localhost:8000/api/logs?search=Test&ip=200.200.100.5&user=1&type=user&date_from=1642003200&date_to=1642003200&include_sessions=1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

const url = new URL(
    "http://localhost:8000/api/logs"
);

const params = {
    "search": "Test",
    "ip": "200.200.100.5",
    "user": "1",
    "type": "user",
    "date_from": "1642003200",
    "date_to": "1642003200",
    "include_sessions": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "user_id": 282,
            "event_name": "event_factory",
            "element_type": "App\\Models\\User",
            "element_id": 281,
            "comments": "",
            "ip_address": "208.255.202.56",
            "created_at": "2008-12-15T09:21:45.000000Z",
            "updated_at": "2026-10-26T11:55:40.000000Z",
            "username": "Cheyenne Medhurst",
            "user": {
                "id": 282,
                "mrn": "53U2PMXM1793015739",
                "name": "Cheyenne Medhurst",
                "email": "1793015739upton.hallie@example.org",
                "language": "en",
                "phone": "+14798231235",
                "phone_country": "TK",
                "phone_verified_at": null,
                "address1": "261 Martin Cove Apt. 427",
                "address2": "Runolfssonville, CO 98678-6761",
                "postal_code": "11691-8599",
                "city": "Pouros LLC",
                "country": "BE",
                "clinic_name": "Lake Ernafurt",
                "clinic_location": "63694 Tristin Landing\nKingside, NY 11600-6887",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:55:39.000000Z",
                "updated_at": "2026-10-26T11:55:39.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "element": {
                "id": 281,
                "mrn": "98RU8GEF1793015739",
                "name": "Dr. Kurtis Simonis",
                "email": "1793015739cjast@example.org",
                "language": "en",
                "phone": "520.476.0512",
                "phone_country": "UZ",
                "phone_verified_at": null,
                "address1": "45131 Pamela Mill Apt. 397",
                "address2": "Port Guiseppehaven, AK 86664",
                "postal_code": "98237",
                "city": "Wolf Inc",
                "country": "GB",
                "clinic_name": "Mertieberg",
                "clinic_location": "9072 Haylee Road Apt. 155\nLake Emiliamouth, LA 21913-2085",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:55:39.000000Z",
                "updated_at": "2026-10-26T11:55:39.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        },
        {
            "id": 2,
            "user_id": 285,
            "event_name": "event_factory",
            "element_type": "App\\Models\\User",
            "element_id": 284,
            "comments": "",
            "ip_address": "36.135.151.105",
            "created_at": "2023-06-09T15:39:52.000000Z",
            "updated_at": "2026-10-26T11:55:41.000000Z",
            "username": "Augusta Kuhic",
            "user": {
                "id": 285,
                "mrn": "USU7V65F1793015741",
                "name": "Augusta Kuhic",
                "email": "1793015741xschumm@example.net",
                "language": "en",
                "phone": "+16577028392",
                "phone_country": "GG",
                "phone_verified_at": null,
                "address1": "4694 Ova Underpass",
                "address2": "Thompsonchester, WA 04406",
                "postal_code": "54091-1433",
                "city": "Oberbrunner and Sons",
                "country": "BG",
                "clinic_name": "Gennarobury",
                "clinic_location": "29830 Bernier Mills\nPort Chelsea, KS 14122",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:55:41.000000Z",
                "updated_at": "2026-10-26T11:55:41.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "element": {
                "id": 284,
                "mrn": "72PTEKJ51793015741",
                "name": "Prof. Susana Schimmel Sr.",
                "email": "1793015741mallie94@example.com",
                "language": "en",
                "phone": "1-806-305-9140",
                "phone_country": "UZ",
                "phone_verified_at": null,
                "address1": "464 Stracke Passage",
                "address2": "Jadebury, TX 17848",
                "postal_code": "49271-0822",
                "city": "Pacocha, Welch and Larkin",
                "country": "PL",
                "clinic_name": "Rodriguezview",
                "clinic_location": "787 Mohammed Rue Apt. 447\nBogisichchester, FL 09351",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:55:41.000000Z",
                "updated_at": "2026-10-26T11:55:41.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access event logs",
    "code": "EVENT_LOGS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/logs

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

search   string  optional  

Filter logs by related element data:

  • for users: search by name or email
  • for devices: search by serial or bluetooth_id
  • for P2P sessions: search by amputee_uuid or clinician_uuid
Example: `Test`
ip   string  optional  

Filter logs by IP address. Example: 200.200.100.5

user   integer  optional  

Filter logs by user. Example: 1

type   string  optional  

Filter logs by event type (available: user, device, p2p_session. Example: user

date_from   integer  optional  

Filter logs from date (timestamp). Example: 1642003200

date_to   integer  optional  

Filter logs to date (timestamp). Example: 1642003200

include_sessions   integer  optional  

Login and logout events are filtered out by default. Set this parameter to 1 to include these events. Example: 1

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

sortby   string  optional  

Sort by field (available: type, username, ip_address, date). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Body Parameters

date_from   string  optional  
date_to   string  optional  

Response

Response Fields

items   object   
id   integer   

Event log entry ID.

user_id   integer   

ID of the user who triggered the event.

event_name   string   

Event name.

element_type   string   

Type of the related element.

element_id   integer   

ID of the related element.

comments   string   

Additional event comments.

ip_address   string   

IP address of the request.

created_at   string   

Event timestamp.

updated_at   string   

Last update timestamp.

user   object   

User who triggered the event.

element   object   

Related element.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Messages

API endpoints for message center

Get user messages list

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/messages" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"filter\": \"all\"
}"

const url = new URL(
    "http://localhost:8000/api/messages"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "filter": "all"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "user_id": null,
            "message_id": 1,
            "is_read": 0,
            "is_archived": 0,
            "is_deleted": 0,
            "message": {
                "id": 1,
                "sender_id": null,
                "title": "Non doloribus dolorem laudantium quaerat.",
                "content": "Voluptas eaque beatae veritatis amet ut.",
                "created_at": "2026-10-26T11:54:28.000000Z",
                "updated_at": "2026-10-26T11:54:28.000000Z",
                "sender": null
            }
        },
        {
            "id": 2,
            "user_id": null,
            "message_id": 2,
            "is_read": 0,
            "is_archived": 0,
            "is_deleted": 0,
            "message": {
                "id": 2,
                "sender_id": null,
                "title": "Enim optio ut velit asperiores.",
                "content": "Dolore animi autem at assumenda.",
                "created_at": "2026-10-26T11:54:28.000000Z",
                "updated_at": "2026-10-26T11:54:28.000000Z",
                "sender": null
            }
        }
    ]
}

Request   

GET api/messages

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

sortby   string  optional  

Sort by field (available: date). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Body Parameters

filter   string  optional  

Filter results by message status (available: archived, all). Defaults to non-archived only. Example: all

Response

Response Fields

items   object   
id   integer   

User message ID.

user_id   integer   

Recipient user ID.

message_id   integer   

Associated message ID.

is_read   boolean   

Whether the message has been read.

is_archived   boolean   

Whether the message is archived.

is_deleted   boolean   

Whether the message is deleted.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

message   object   

The message content.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Send message to multiple users

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/message" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Reminder about your vaccination\",
    \"content\": \"Lorem ipsum dolor sit amet\",
    \"roles\": \"Clinician,Amputee\"
}"

const url = new URL(
    "http://localhost:8000/api/message"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "Reminder about your vaccination",
    "content": "Lorem ipsum dolor sit amet",
    "roles": "Clinician,Amputee"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Messages sent",
    "count": 3,
    "code": "MESSAGES:SEND:SENT"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to send messages",
    "code": "MESSAGES:SEND:INSUFFICIENT_PERMISSION"
}

Request   

POST api/message

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Message title. MINIMUM:STRING_LENGTH:3. Example: Reminder about your vaccination

content   string  optional  

Message content text. Example: Lorem ipsum dolor sit amet

roles   string  optional  

Filter recipients with given role (comma-separated). Example: Clinician,Amputee

Mark message as read

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/message/1/read" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"state\": true
}"

const url = new URL(
    "http://localhost:8000/api/message/1/read"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "state": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 3,
    "user_id": 148,
    "message_id": 3,
    "is_read": 0,
    "is_archived": 0,
    "is_deleted": 0
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to mark this message as read",
    "code": "MESSAGES:READ:INSUFFICIENT_PERMISSION"
}

Example response (404, Message not found):


{
    "message": "Message not found",
    "code": "MESSAGES:READ:MESSAGE_NOT_FOUND"
}

Request   

POST api/message/{id}/read

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User Message ID (id from messages list; do not confuse with message_id). Example: 1

Body Parameters

state   boolean  optional  

Explicit read state. Default: 1 (true). Example: true

Response

Response Fields

id   integer   

User message ID.

user_id   integer   

Recipient user ID.

message_id   integer   

Associated message ID.

is_read   boolean   

Whether the message has been read.

is_archived   boolean   

Whether the message is archived.

is_deleted   boolean   

Whether the message is deleted.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

message   object   

The message content.

Mark message as archived

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/message/1/archive" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"state\": true
}"

const url = new URL(
    "http://localhost:8000/api/message/1/archive"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "state": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 4,
    "user_id": 149,
    "message_id": 4,
    "is_read": 0,
    "is_archived": 0,
    "is_deleted": 0
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to mark this message as archived",
    "code": "MESSAGES:ARCHIVE:INSUFFICIENT_PERMISSION"
}

Example response (404, Message not found):


{
    "message": "Message not found",
    "code": "MESSAGES:ARCHIVE:MESSAGE_NOT_FOUND"
}

Request   

POST api/message/{id}/archive

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User Message ID (id from messages list; do not confuse with message_id). Example: 1

Body Parameters

state   boolean  optional  

Explicit archived state. Default: 1 (true). Example: true

Response

Response Fields

id   integer   

User message ID.

user_id   integer   

Recipient user ID.

message_id   integer   

Associated message ID.

is_read   boolean   

Whether the message has been read.

is_archived   boolean   

Whether the message is archived.

is_deleted   boolean   

Whether the message is deleted.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

message   object   

The message content.

List of messages and tickets

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/messages-and-tickets" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/messages-and-tickets"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 2
    },
    "items": [
        {
            "type": "UserMessage",
            "date": "2024-11-02T10:00:00.000000Z",
            "item": {
                "id": 1,
                "user_id": 1,
                "message_id": 1,
                "is_read": 0,
                "is_archived": 0,
                "is_deleted": 0,
                "message": {
                    "id": 1,
                    "sender_id": 1,
                    "title": "Message title",
                    "content": "Message content",
                    "created_at": "2024-11-02T10:00:00.000000Z",
                    "updated_at": "2024-11-02T10:00:00.000000Z",
                    "sender": {
                        "id": 1,
                        "mrn": "MRN",
                        "name": "User name",
                        "email": "user@domain.com",
                        "language": "en",
                        "phone": "",
                        "phone_verified_at": null,
                        "address1": "",
                        "address2": "",
                        "postal_code": "",
                        "city": "",
                        "clinic_name": "Test Company",
                        "clinic_location": "Test Company Location",
                        "image": null,
                        "mfa_enabled": 0,
                        "mfa_method": "email",
                        "mfa_verified_to": null,
                        "created_by": null,
                        "active": 1,
                        "notifications_timezone": "Europe/Warsaw",
                        "notifications_at": "08:00:00",
                        "created_at": "2024-09-01T15:00:00.000000Z",
                        "updated_at": "2024-10-10T10:30:00.000000Z",
                        "invitation_status": "accepted",
                        "roles": [
                            {
                                "id": 3,
                                "name": "Clinician",
                                "guard_name": "web",
                                "created_at": "2024-01-01T12:00:00.000000Z",
                                "updated_at": "2024-01-01T12:00:00.000000Z",
                                "pivot": {
                                    "model_id": 1,
                                    "role_id": 3,
                                    "model_type": "App\\Models\\User"
                                }
                            }
                        ]
                    }
                }
            }
        },
        {
            "type": "SupportTicket",
            "date": "2024-11-01T15:15:00.000000Z",
            "item": {
                "id": 1,
                "sender_id": 1,
                "recipient_id": 999,
                "device_id": null,
                "meeting_date": "2024-11-10T15:00:00.000000Z",
                "meeting_type": "none",
                "contact_email": null,
                "status": "new",
                "created_at": "2024-11-01T15:15:00.000000Z",
                "updated_at": "2024-11-01T15:15:00.000000Z",
                "sender": {
                    "id": 1,
                    "mrn": "MRN",
                    "name": "User name",
                    "email": "user@domain.com",
                    "language": "en",
                    "phone": "",
                    "phone_verified_at": null,
                    "address1": "",
                    "address2": "",
                    "postal_code": "",
                    "city": "",
                    "clinic_name": "Test Company",
                    "clinic_location": "Test Company Location",
                    "image": null,
                    "mfa_enabled": 0,
                    "mfa_method": "email",
                    "mfa_verified_to": null,
                    "created_by": null,
                    "active": 1,
                    "notifications_timezone": "Europe/Warsaw",
                    "notifications_at": "08:00:00",
                    "created_at": "2024-09-01T15:00:00.000000Z",
                    "updated_at": "2024-10-10T10:30:00.000000Z",
                    "invitation_status": "accepted",
                    "roles": [
                        {
                            "id": 3,
                            "name": "Clinician",
                            "guard_name": "web",
                            "created_at": "2024-01-01T12:00:00.000000Z",
                            "updated_at": "2024-01-01T12:00:00.000000Z",
                            "pivot": {
                                "model_id": 1,
                                "role_id": 3,
                                "model_type": "App\\Models\\User"
                            }
                        }
                    ]
                },
                "recipient": {
                    "id": 2,
                    "mrn": "MRN2",
                    "name": "Patient",
                    "email": "patient4@domain.com",
                    "language": "en",
                    "phone": "",
                    "phone_verified_at": null,
                    "address1": "",
                    "address2": "",
                    "postal_code": "",
                    "city": "",
                    "clinic_name": null,
                    "clinic_location": null,
                    "image": null,
                    "mfa_enabled": 0,
                    "mfa_method": null,
                    "mfa_verified_to": null,
                    "created_by": 1,
                    "active": 1,
                    "notifications_timezone": null,
                    "notifications_at": null,
                    "created_at": "2024-10-01T15:00:00.000000Z",
                    "updated_at": "2024-10-10T10:30:00.000000Z",
                    "invitation_status": null,
                    "roles": [
                        {
                            "id": 5,
                            "name": "Amputee",
                            "guard_name": "web",
                            "created_at": "2024-01-01T12:00:00.000000Z",
                            "updated_at": "2024-01-01T12:00:00.000000Z",
                            "pivot": {
                                "model_id": 2,
                                "role_id": 5,
                                "model_type": "App\\Models\\User"
                            }
                        }
                    ]
                },
                "device": null,
                "messages": [
                    {
                        "id": 1,
                        "ticket_id": 1,
                        "sender_id": 1,
                        "title": "Communication channel",
                        "content": "Welcome to the digital platform. Please use this channel for communicating with your clinician.",
                        "is_read": false,
                        "created_at": "2024-11-01T15:15:00.000000Z",
                        "updated_at": "2024-11-01T15:15:00.000000Z",
                        "attachments": [],
                        "sender": {
                            "id": 1,
                            "mrn": "MRN",
                            "name": "User name",
                            "email": "user@domain.com",
                            "language": "en",
                            "phone": "",
                            "phone_verified_at": null,
                            "address1": "",
                            "address2": "",
                            "postal_code": "",
                            "city": "",
                            "clinic_name": "Test Company",
                            "clinic_location": "Test Company Location",
                            "image": null,
                            "mfa_enabled": 0,
                            "mfa_method": "email",
                            "mfa_verified_to": null,
                            "created_by": null,
                            "active": 1,
                            "notifications_timezone": "Europe/Warsaw",
                            "notifications_at": "08:00:00",
                            "created_at": "2024-09-01T15:00:00.000000Z",
                            "updated_at": "2024-10-10T10:30:00.000000Z",
                            "invitation_status": "accepted",
                            "roles": [
                                {
                                    "id": 3,
                                    "name": "Clinician",
                                    "guard_name": "web",
                                    "created_at": "2024-01-01T12:00:00.000000Z",
                                    "updated_at": "2024-01-01T12:00:00.000000Z",
                                    "pivot": {
                                        "model_id": 1,
                                        "role_id": 3,
                                        "model_type": "App\\Models\\User"
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ]
}

Request   

GET api/messages-and-tickets

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Status of messages and tickets

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/messages-and-tickets/status" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/messages-and-tickets/status"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "messages": 5,
    "tickets": 2
}

Request   

GET api/messages-and-tickets/status

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Mobile logs

API endpoints for managing mobile logs

Store log

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/mobile-logs" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "device_id=1"\
    --form "date_start=2018-06-12 09:15:57"\
    --form "date_end=1999-06-28 12:08:59"\
    --form "encrypt_key=dolor"\
    --form "encrypt_iv=deserunt"\
    --form "file=@/tmp/phpY15sQB" 
const url = new URL(
    "http://localhost:8000/api/mobile-logs"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('device_id', '1');
body.append('date_start', '2018-06-12 09:15:57');
body.append('date_end', '1999-06-28 12:08:59');
body.append('encrypt_key', 'dolor');
body.append('encrypt_iv', 'deserunt');
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (202):


{
    "id": 1,
    "user_id": 286,
    "device_id": 147,
    "file": "/tmp/fakero03VyI",
    "date_start": "1987-11-27 06:56:39",
    "date_end": "1991-09-02 11:00:49",
    "created_at": "2026-10-26T11:55:42.000000Z",
    "updated_at": "2026-10-26T11:55:42.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to write mobile logs",
    "code": "MOBILE_LOGS:STORE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/mobile-logs

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

device_id   string  optional  

Device ID. The id of an existing record in the App\Models\Device table. Example: 1

file   file   

Log file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpY15sQB

date_start   string   

Log start date. MUST_BE_DATE Must be a valid date in the format Y-m-d H:i:s. Example: 2018-06-12 09:15:57

date_end   string   

Log end date. MUST_BE_DATE Must be a valid date in the format Y-m-d H:i:s. MUST_BE_AFTER:date_start. Example: 1999-06-28 12:08:59

encrypt_key   string   

Encryption key. Example: dolor

encrypt_iv   string   

Encryption IV (Initialization Vector). Example: deserunt

Response

Response Fields

id   integer   

Mobile log ID.

user_id   integer   

Associated user ID.

device_id   integer   

Associated device ID.

file   string   

Log file URL.

date_start   string   

Log start date.

date_end   string   

Log end date.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Get logs

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/mobile-logs" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/mobile-logs"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 2,
            "user_id": 287,
            "device_id": 148,
            "file": "/tmp/faker6LMKwY",
            "date_start": "2008-01-20 09:56:49",
            "date_end": "1998-03-16 13:26:58",
            "created_at": "2026-10-26T11:55:43.000000Z",
            "updated_at": "2026-10-26T11:55:43.000000Z"
        },
        {
            "id": 3,
            "user_id": 288,
            "device_id": 149,
            "file": "/tmp/fakerIJiURU",
            "date_start": "2023-01-13 23:58:22",
            "date_end": "1989-08-27 01:33:52",
            "created_at": "2026-10-26T11:55:43.000000Z",
            "updated_at": "2026-10-26T11:55:43.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view mobile logs",
    "code": "MOBILE_LOGS:GET:INSUFFICIENT_PERMISSION"
}

Request   

GET api/mobile-logs

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: device).

sortby   string  optional  

Sort by field (available: date). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

Mobile log ID.

user_id   integer   

Associated user ID.

device_id   integer   

Associated device ID.

file   string   

Log file URL.

date_start   string   

Log start date.

date_end   string   

Log end date.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Get logs by user

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/mobile-logs/user/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/mobile-logs/user/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 4,
            "user_id": 289,
            "device_id": 150,
            "file": "/tmp/faker36xUj0",
            "date_start": "1986-01-27 11:17:03",
            "date_end": "2006-02-07 00:16:21",
            "created_at": "2026-10-26T11:55:44.000000Z",
            "updated_at": "2026-10-26T11:55:44.000000Z"
        },
        {
            "id": 5,
            "user_id": 290,
            "device_id": 151,
            "file": "/tmp/fakerAS4vR7",
            "date_start": "1997-03-18 02:37:33",
            "date_end": "1987-03-05 09:47:31",
            "created_at": "2026-10-26T11:55:44.000000Z",
            "updated_at": "2026-10-26T11:55:44.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view mobile logs",
    "code": "MOBILE_LOGS:GET_BY_USER:INSUFFICIENT_PERMISSION"
}

Request   

GET api/mobile-logs/user/{userId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: device).

sortby   string  optional  

Sort by field (available: date). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

Mobile log ID.

user_id   integer   

Associated user ID.

device_id   integer   

Associated device ID.

file   string   

Log file URL.

date_start   string   

Log start date.

date_end   string   

Log end date.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Get logs by device

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/mobile-logs/device/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/mobile-logs/device/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 6,
            "user_id": 291,
            "device_id": 152,
            "file": "/tmp/fakerdGfxrX",
            "date_start": "2026-08-04 00:07:22",
            "date_end": "2005-03-29 11:31:29",
            "created_at": "2026-10-26T11:55:45.000000Z",
            "updated_at": "2026-10-26T11:55:45.000000Z"
        },
        {
            "id": 7,
            "user_id": 292,
            "device_id": 153,
            "file": "/tmp/fakerTLvpCv",
            "date_start": "2012-11-21 06:25:22",
            "date_end": "2001-08-06 01:44:38",
            "created_at": "2026-10-26T11:55:45.000000Z",
            "updated_at": "2026-10-26T11:55:45.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view mobile logs",
    "code": "MOBILE_LOGS:GET_BY_DEVICE:INSUFFICIENT_PERMISSION"
}

Request   

GET api/mobile-logs/device/{deviceId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

sortby   string  optional  

Sort by field (available: date). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

Mobile log ID.

user_id   integer   

Associated user ID.

device_id   integer   

Associated device ID.

file   string   

Log file URL.

date_start   string   

Log start date.

date_end   string   

Log end date.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Old Configurator Statistics

Endpoints for old configurator statistics

Create old configurator statistic

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/old-configurator-statistics" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"entry_id\": \"aut\",
    \"comments\": \"minima\"
}"

const url = new URL(
    "http://localhost:8000/api/old-configurator-statistics"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "entry_id": "aut",
    "comments": "minima"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 1,
    "entry_id": "74244fde-b802-36c5-8569-db35d00aef40",
    "comments": "{\"key\":\"aut\",\"value\":55924}",
    "created_at": "2026-10-26T11:53:12.000000Z",
    "updated_at": "2026-10-26T11:53:12.000000Z"
}

Request   

POST api/old-configurator-statistics

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

entry_id   string   

Example: aut

comments   string  optional  

Example: minima

List old configurator statistics

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/old-configurator-statistics" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/old-configurator-statistics"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 2,
            "entry_id": "473f6e82-2d9a-342d-82b8-dffba20c3d78",
            "comments": "{\"key\":\"consequatur\",\"value\":95760}",
            "created_at": "2026-10-26T11:56:08.000000Z",
            "updated_at": "2026-10-26T11:56:08.000000Z"
        },
        {
            "id": 3,
            "entry_id": "212e998d-835d-3fb5-98fb-b5af5ca3919f",
            "comments": "{\"key\":\"et\",\"value\":84251}",
            "created_at": "2026-10-26T11:56:08.000000Z",
            "updated_at": "2026-10-26T11:56:08.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view old configurator statistics",
    "code": "OLD_CONFIGURATOR_STATISTIC:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/old-configurator-statistics

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

P2P Sessions

API endpoints for managing P2P (peer-to-peer) sessions

Get active session data

requires authentication

Returns P2P sessions with status "waiting_for_decision" or "in_progress".

Example request:
curl --request GET \
    --get "http://localhost:8000/api/p2p/user/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/p2p/user/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "amputee_id": null,
    "device_id": null,
    "clinician_id": null,
    "amputee_uuid": "436113ce-62d8-3395-b97c-d333635458e7",
    "clinician_uuid": "a8458b1d-e70f-3c3b-94d1-3095797ebb73",
    "token": "39BE3JV86TQSC459D7378KUAU7R7ZAWT9XJUD2FGVLTWWV8QQUXH4D7ZYCM4EX47",
    "status": "waiting_for_decision",
    "created_at": "2026-10-26T11:54:16.000000Z",
    "updated_at": "2026-10-26T11:54:16.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view active P2P session",
    "code": "P2P_SESSIONS:GET_ACTIVE:INSUFFICIENT_PERMISSION"
}

Example response (404, Session not found):


{
    "message": "P2P session not found",
    "code": "P2P_SESSIONS:GET_ACTIVE:SESSION_NOT_FOUND"
}

Request   

GET api/p2p/user/{userId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Response

Response Fields

id   integer   

P2P session ID.

device_id   integer   

Associated device ID.

amputee_id   integer   

Patient (amputee) user ID.

clinician_id   integer   

Clinician user ID.

amputee_uuid   string   

Amputee WebRTC UUID.

clinician_uuid   string   

Clinician WebRTC UUID.

token   string   

Session token.

status   string   

Session status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

amputee   object   

Patient user.

clinician   object   

Clinician user.

Get session data

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/p2p/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/p2p/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 2,
    "amputee_id": null,
    "device_id": null,
    "clinician_id": null,
    "amputee_uuid": "e8a903d8-d368-3f56-81d9-485433f65409",
    "clinician_uuid": "47ae125a-471a-3ee9-aef1-8e1eda0a86a9",
    "token": "MJSUYDHZF6LNE5563HDNUCUKVEUAWZPB8QA78QM9TYZTCAJQAVDNYMB4K87ZYV5Z",
    "status": "waiting_for_decision",
    "created_at": "2026-10-26T11:54:16.000000Z",
    "updated_at": "2026-10-26T11:54:16.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view P2P session",
    "code": "P2P_SESSIONS:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Session not found):


{
    "message": "P2P session not found",
    "code": "P2P_SESSIONS:GET:SESSION_NOT_FOUND"
}

Request   

GET api/p2p/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

P2P session ID. Example: 1

Response

Response Fields

id   integer   

P2P session ID.

device_id   integer   

Associated device ID.

amputee_id   integer   

Patient (amputee) user ID.

clinician_id   integer   

Clinician user ID.

amputee_uuid   string   

Amputee WebRTC UUID.

clinician_uuid   string   

Clinician WebRTC UUID.

token   string   

Session token.

status   string   

Session status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

amputee   object   

Patient user.

clinician   object   

Clinician user.

Create new P2P session

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/p2p/create" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"amputee_id\": 2,
    \"device_id\": 5,
    \"amputee_uuid\": \"a5485e7d-e0eb-3de2-8cc8-9f98339b577b\",
    \"clinician_uuid\": \"c947ea1c-e404-3006-bf89-5c07f2bfcd87\"
}"

const url = new URL(
    "http://localhost:8000/api/p2p/create"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "amputee_id": 2,
    "device_id": 5,
    "amputee_uuid": "a5485e7d-e0eb-3de2-8cc8-9f98339b577b",
    "clinician_uuid": "c947ea1c-e404-3006-bf89-5c07f2bfcd87"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "amputee_id": 123,
    "device_id": null,
    "clinician_id": 124,
    "amputee_uuid": "720648c2-a5c1-3e91-a635-460d7e06e3ae",
    "clinician_uuid": "6bc036b0-6bc4-3ad0-8b4f-40e7a1917975",
    "token": "Q5VYCH5FE2XQ6RN6A2BU2G2KNTZGWBBTSJGLURZ4B2CV6ZMUZCYCHPP3ZM25V9ST",
    "status": "waiting_for_decision",
    "created_at": "2026-10-26T11:54:17.000000Z",
    "updated_at": "2026-10-26T11:54:17.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create P2P session",
    "code": "P2P_SESSIONS:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Device not assigned to patient):


{
    "message": "Device is not assigned to the patient",
    "code": "P2P_SESSIONS:CREATE:DEVICE_NOT_ASSIGNED"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "P2P_SESSIONS:CREATE:USER_NOT_FOUND"
}

Request   

POST api/p2p/create

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

amputee_id   string   

Amputee ID. The id of an existing record in the App\Models\User table. Example: 2

device_id   string   

Device ID. The id of an existing record in the App\Models\Device table. Example: 5

amputee_uuid   string   

Amputee's UUID generated by integration platform. Example: a5485e7d-e0eb-3de2-8cc8-9f98339b577b

clinician_uuid   string   

Clinician's UUID generated by integration platform. Example: c947ea1c-e404-3006-bf89-5c07f2bfcd87

Response

Response Fields

id   integer   

P2P session ID.

device_id   integer   

Associated device ID.

amputee_id   integer   

Patient (amputee) user ID.

clinician_id   integer   

Clinician user ID.

amputee_uuid   string   

Amputee WebRTC UUID.

clinician_uuid   string   

Clinician WebRTC UUID.

token   string   

Session token.

status   string   

Session status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

amputee   object   

Patient user.

clinician   object   

Clinician user.

Update P2P session

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/p2p/1/update" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"closed\"
}"

const url = new URL(
    "http://localhost:8000/api/p2p/1/update"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": "closed"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 4,
    "amputee_id": null,
    "device_id": null,
    "clinician_id": null,
    "amputee_uuid": "0581ac26-3323-3650-af35-e3364aaea469",
    "clinician_uuid": "749e0a99-3234-3f29-ab18-e5133569f28c",
    "token": "XHKNV85ZB2A3ENBQEWLVYRFXZUDL8N2RAUT4UFP3BBQJSV7PA3QYLBWRHQ5BV67N",
    "status": "waiting_for_decision",
    "created_at": "2026-10-26T11:54:17.000000Z",
    "updated_at": "2026-10-26T11:54:17.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update P2P session",
    "code": "P2P_SESSIONS:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Session not found):


{
    "message": "P2P session not found",
    "code": "P2P_SESSIONS:UPDATE:SESSION_NOT_FOUND"
}

Request   

POST api/p2p/{id}/update

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

P2P session ID. Example: 1

Body Parameters

status   string   

Session status. Example: closed

Must be one of:
  • waiting_for_decision
  • in_progress
  • closed

Response

Response Fields

id   integer   

P2P session ID.

device_id   integer   

Associated device ID.

amputee_id   integer   

Patient (amputee) user ID.

clinician_id   integer   

Clinician user ID.

amputee_uuid   string   

Amputee WebRTC UUID.

clinician_uuid   string   

Clinician WebRTC UUID.

token   string   

Session token.

status   string   

Session status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

amputee   object   

Patient user.

clinician   object   

Clinician user.

Product features and toggles

API endpoints for product features and toggles management

Definitions:

List public feature toggles

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/product-features/public" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/product-features/public"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, Global state of publicly exposed feature toggles):


{
    "features": [
        {
            "slug": "matomo_analytics_web",
            "enabled": true
        }
    ]
}

Request   

GET api/product-features/public

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

List product features

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/product/features" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/product/features"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "name": "white",
        "slug": "itaque-consectetur-molestiae-asperiores-omnis",
        "created_at": "2026-10-26T11:55:23.000000Z",
        "updated_at": "2026-10-26T11:55:23.000000Z"
    },
    {
        "id": 2,
        "name": "gray",
        "slug": "aut-quae-adipisci-et-quod-sed",
        "created_at": "2026-10-26T11:55:23.000000Z",
        "updated_at": "2026-10-26T11:55:23.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view product features and toggles",
    "code": "PRODUCT_FEATURES:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/product/features

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Response

Response Fields

id   integer   

Product feature ID.

name   string   

Feature name.

slug   string   

Feature slug (unique identifier).

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Create product feature

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/product/features" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Remote config\",
    \"slug\": \"remote_config\"
}"

const url = new URL(
    "http://localhost:8000/api/product/features"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Remote config",
    "slug": "remote_config"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "name": "silver",
    "slug": "optio-iste-adipisci-libero-id-beatae-excepturi-repellendus-perferendis",
    "created_at": "2026-10-26T11:55:23.000000Z",
    "updated_at": "2026-10-26T11:55:23.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "PRODUCT_FEATURES:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/product/features

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Name of product feature. Example: Remote config

slug   string   

Simplified name of product feature without spaces (e.g. remote_config for Remote config name). Example: remote_config

Response

Response Fields

id   integer   

Product feature ID.

name   string   

Feature name.

slug   string   

Feature slug (unique identifier).

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Update product feature

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/product/features/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Remote config\",
    \"slug\": \"remote_config\"
}"

const url = new URL(
    "http://localhost:8000/api/product/features/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Remote config",
    "slug": "remote_config"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 4,
    "name": "maroon",
    "slug": "sit-vitae-consequatur-voluptatibus-ullam",
    "created_at": "2026-10-26T11:55:23.000000Z",
    "updated_at": "2026-10-26T11:55:23.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "PRODUCT_FEATURES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Product feature not found):


{
    "message": "Product feature not found",
    "code": "PRODUCT_FEATURES:UPDATE:FEATURE_NOT_FOUND"
}

Request   

PUT api/product/features/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Product Feature ID. Example: 1

Body Parameters

name   string  optional  

Name of product feature. Example: Remote config

slug   string  optional  

Simplified name of product feature without spaces (e.g. remote_config for Remote config name). Example: remote_config

Response

Response Fields

id   integer   

Product feature ID.

name   string   

Feature name.

slug   string   

Feature slug (unique identifier).

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Delete product feature

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/product/features/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/product/features/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Product feature deleted",
    "code": "PRODUCT_FEATURES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "PRODUCT_FEATURES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (403, Product feature belongs to compatibility entries):


{
    "message": "Cannot delete: product feature belongs to existing compatibility entries (1)",
    "code": "PRODUCT_FEATURES:DELETE:HAS_COMPATIBILITY_ENTRIES"
}

Example response (404, Product feature not found):


{
    "message": "Product feature not found",
    "code": "PRODUCT_FEATURES:DELETE:FEATURE_NOT_FOUND"
}

Request   

DELETE api/product/features/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Product Feature ID. Example: 1

List product toggles

requires authentication

This endpoint returns list of global toggles. For some users there could exist user toggle which overrides these settings.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/product/toggles?global=1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/product/toggles"
);

const params = {
    "global": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "name": "lime",
        "slug": "sit-voluptate-quod-tempora-earum-placeat-et-ut",
        "enabled": 0,
        "created_at": "2026-10-26T11:55:23.000000Z",
        "updated_at": "2026-10-26T11:55:23.000000Z"
    },
    {
        "id": 2,
        "name": "gray",
        "slug": "saepe-vel-fugit-repellendus-facere",
        "enabled": 1,
        "created_at": "2026-10-26T11:55:23.000000Z",
        "updated_at": "2026-10-26T11:55:23.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view product features and toggles",
    "code": "PRODUCT_TOGGLES:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/product/toggles

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

global   integer  optional  

Pass value 1 to fetch list of global toggles without user overrides Example: 1

Response

Response Fields

id   integer   

Product toggle ID.

name   string   

Toggle name.

slug   string   

Toggle slug (unique identifier).

enabled   boolean   

Whether the toggle is enabled globally.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Create product toggle

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/product/toggles" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Remote config\",
    \"slug\": \"remote_config\",
    \"enabled\": true
}"

const url = new URL(
    "http://localhost:8000/api/product/toggles"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Remote config",
    "slug": "remote_config",
    "enabled": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "name": "maroon",
    "slug": "vero-ut-dolore-molestiae-quasi-quod-perferendis",
    "enabled": 1,
    "created_at": "2026-10-26T11:55:23.000000Z",
    "updated_at": "2026-10-26T11:55:23.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "PRODUCT_TOGGLES:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/product/toggles

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Name of product toggle. Example: Remote config

slug   string   

Simplified name of product toggle without spaces (e.g. remote_config for Remote config name). Example: remote_config

enabled   boolean   

Is toggle enabled on this environment?. Example: true

Response

Response Fields

id   integer   

Product toggle ID.

name   string   

Toggle name.

slug   string   

Toggle slug (unique identifier).

enabled   boolean   

Whether the toggle is enabled globally.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Update product toggle

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/product/toggles/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Remote config\",
    \"slug\": \"remote_config\",
    \"enabled\": true
}"

const url = new URL(
    "http://localhost:8000/api/product/toggles/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Remote config",
    "slug": "remote_config",
    "enabled": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 4,
    "name": "yellow",
    "slug": "dolores-aut-quae-commodi-animi",
    "enabled": 0,
    "created_at": "2026-10-26T11:55:24.000000Z",
    "updated_at": "2026-10-26T11:55:24.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "PRODUCT_TOGGLES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Product toggle not found):


{
    "message": "Product toggle not found",
    "code": "PRODUCT_TOGGLES:UPDATE:TOGGLE_NOT_FOUND"
}

Request   

PUT api/product/toggles/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Product Toggle ID. Example: 1

Body Parameters

name   string  optional  

Name of product toggle. Example: Remote config

slug   string  optional  

Simplified name of product toggle without spaces (e.g. remote_config for Remote config name). Example: remote_config

enabled   boolean  optional  

Is toggle enabled on this environment?. Example: true

Response

Response Fields

id   integer   

Product toggle ID.

name   string   

Toggle name.

slug   string   

Toggle slug (unique identifier).

enabled   boolean   

Whether the toggle is enabled globally.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Delete product toggle

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/product/toggles/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/product/toggles/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Product toggle deleted",
    "code": "PRODUCT_TOGGLES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "PRODUCT_TOGGLES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Product toggle not found):


{
    "message": "Product toggle not found",
    "code": "PRODUCT_TOGGLES:DELETE:TOGGLE_NOT_FOUND"
}

Request   

DELETE api/product/toggles/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Product Toggle ID. Example: 1

List product FAQ

requires authentication

This endpoint returns list of product FAQ.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/product/faq" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/product/faq"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "question": "Dolor harum magni aut asperiores nisi sit et. Commodi eos ex quam et deleniti. Nemo porro quae soluta reprehenderit.",
            "answer": "Non pariatur deserunt enim ipsum quam fuga quas impedit. Molestiae dicta mollitia necessitatibus porro. Earum eos quam repellat ea eos ut doloribus. Sit officiis vel quod et.",
            "created_at": "2026-10-26T11:55:24.000000Z",
            "updated_at": "2026-10-26T11:55:24.000000Z"
        },
        {
            "id": 2,
            "question": "Repudiandae suscipit id et nobis voluptatibus id et. Nisi sapiente sunt ut reprehenderit. Quae laborum dolor omnis laboriosam iste sit repudiandae.",
            "answer": "Sed accusantium quasi officia. Explicabo quasi enim quos ut ut. Sed quae quidem ad saepe est. Nisi ullam rem culpa. Aspernatur non ut iste beatae occaecati nulla error cumque.",
            "created_at": "2026-10-26T11:55:24.000000Z",
            "updated_at": "2026-10-26T11:55:24.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view product features and toggles",
    "code": "FAQ:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/product/faq

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Response

Response Fields

items   object   
id   integer   

FAQ entry ID.

question   string   

FAQ question.

answer   string   

FAQ answer.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

List user toggles

requires authentication

This endpoint returns list of user toggles with their global toggles.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/user/1/toggles" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/user/1/toggles"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "toggle_id": 6,
        "user_id": 256,
        "enabled": 0,
        "created_at": "2026-10-26T11:55:24.000000Z",
        "updated_at": "2026-10-26T11:55:24.000000Z",
        "toggle": {
            "id": 6,
            "name": "yellow",
            "slug": "consequuntur-natus-quos-ut-adipisci-ut-aut-aliquam",
            "enabled": 1,
            "created_at": "2026-10-26T11:55:24.000000Z",
            "updated_at": "2026-10-26T11:55:24.000000Z"
        }
    },
    {
        "id": 2,
        "toggle_id": 8,
        "user_id": 257,
        "enabled": 0,
        "created_at": "2026-10-26T11:55:25.000000Z",
        "updated_at": "2026-10-26T11:55:25.000000Z",
        "toggle": {
            "id": 8,
            "name": "maroon",
            "slug": "ea-odio-rerum-omnis-inventore-neque-et",
            "enabled": 1,
            "created_at": "2026-10-26T11:55:25.000000Z",
            "updated_at": "2026-10-26T11:55:25.000000Z"
        }
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view product features and toggles",
    "code": "USER_TOGGLES:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USER_TOGGLES:LIST:USER_NOT_FOUND"
}

Request   

GET api/user/{userId}/toggles

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Response

Response Fields

id   integer   

User product toggle ID.

toggle_id   integer   

Associated product toggle ID.

user_id   integer   

Associated user ID.

enabled   boolean   

Whether the toggle is enabled for this user.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

toggle   object   

Associated product toggle.

Create user toggle

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/user/1/toggles" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"toggle_id\": 1,
    \"enabled\": true
}"

const url = new URL(
    "http://localhost:8000/api/user/1/toggles"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "toggle_id": 1,
    "enabled": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "toggle_id": 9,
    "user_id": 258,
    "enabled": 0,
    "created_at": "2026-10-26T11:55:25.000000Z",
    "updated_at": "2026-10-26T11:55:25.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "USER_TOGGLES:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Cannot create user toggles for SuperAdmin):


{
    "message": "Cannot create user toggles for SuperAdmin",
    "code": "USER_TOGGLES:CREATE:CANNOT_CREATE_FOR_SUPER_ADMIN"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USER_TOGGLES:CREATE:USER_NOT_FOUND"
}

Request   

POST api/user/{userId}/toggles

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Body Parameters

toggle_id   integer   

Product toggle ID. The id of an existing record in the App\Models\ProductToggle table. Example: 1

enabled   boolean   

Is user toggle enabled on this environment?. Example: true

Response

Response Fields

id   integer   

User product toggle ID.

toggle_id   integer   

Associated product toggle ID.

user_id   integer   

Associated user ID.

enabled   boolean   

Whether the toggle is enabled for this user.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

toggle   object   

Associated product toggle.

Update user toggle

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/user/1/toggles/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"enabled\": true
}"

const url = new URL(
    "http://localhost:8000/api/user/1/toggles/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "enabled": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 4,
    "toggle_id": 10,
    "user_id": 259,
    "enabled": 0,
    "created_at": "2026-10-26T11:55:26.000000Z",
    "updated_at": "2026-10-26T11:55:26.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "USER_TOGGLES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USER_TOGGLES:UPDATE:USER_NOT_FOUND"
}

Example response (404, User toggle not found):


{
    "message": "User toggle not found",
    "code": "USER_TOGGLES:UPDATE:TOGGLE_NOT_FOUND"
}

Request   

PUT api/user/{userId}/toggles/{toggleId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

toggleId   integer   

User Toggle ID. Example: 1

Body Parameters

enabled   boolean  optional  

Is user toggle enabled on this environment?. Example: true

Response

Response Fields

id   integer   

User product toggle ID.

toggle_id   integer   

Associated product toggle ID.

user_id   integer   

Associated user ID.

enabled   boolean   

Whether the toggle is enabled for this user.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

toggle   object   

Associated product toggle.

Delete user toggle

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/user/1/toggles/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/user/1/toggles/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "User toggle deleted",
    "code": "USER_TOGGLES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "USER_TOGGLES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USER_TOGGLES:DELETE:USER_NOT_FOUND"
}

Example response (404, User toggle not found):


{
    "message": "User toggle not found",
    "code": "USER_TOGGLES:DELETE:TOGGLE_NOT_FOUND"
}

Request   

DELETE api/user/{userId}/toggles/{toggleId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

toggleId   integer   

User Toggle ID. Example: 1

Release notes

Endpoints related to release notes

List release notes

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/release-notes" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"dolores\"
}"

const url = new URL(
    "http://localhost:8000/api/release-notes"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": "dolores"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "sync_uuid": "2373c937-b568-49a9-a1ca-376a77cc7f0c",
            "title": "Corporis libero quis perferendis.",
            "body": "<p>Corporis illo laudantium dolores temporibus pariatur. Facere sed ea harum quia modi aliquam.</p>",
            "video": null,
            "status": "draft",
            "translation_status": "STARTED",
            "activated_at": null,
            "archived_at": null,
            "created_by": null,
            "created_at": "2026-10-26T11:56:06.000000Z",
            "updated_at": "2026-10-26T11:56:06.000000Z"
        },
        {
            "id": 2,
            "sync_uuid": "49472cee-dfd4-435e-9192-3afdd6c0f82c",
            "title": "Non distinctio quis fugit.",
            "body": "<p>Ducimus distinctio amet ipsa dolores aut incidunt. Architecto fugiat deserunt provident. Illo rerum autem est molestias maxime.</p>",
            "video": null,
            "status": "draft",
            "translation_status": "STARTED",
            "activated_at": null,
            "archived_at": null,
            "created_by": null,
            "created_at": "2026-10-26T11:56:06.000000Z",
            "updated_at": "2026-10-26T11:56:06.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view release notes",
    "code": "RELEASE_NOTES:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/release-notes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Body Parameters

status   string  optional  

Example: dolores

Create release note

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/release-notes" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=New grip control available"\
    --form "body=<p>We just shipped a new grip control.</p>"\
    --form "sync_uuid=99f3e5ad-8063-378d-a089-054952e2dce6"\
    --form "video=@/tmp/phpdEkHyp" 
const url = new URL(
    "http://localhost:8000/api/release-notes"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('title', 'New grip control available');
body.append('body', '<p>We just shipped a new grip control.</p>');
body.append('sync_uuid', '99f3e5ad-8063-378d-a089-054952e2dce6');
body.append('video', document.querySelector('input[name="video"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "sync_uuid": "a388e7c2-60a4-4afe-a235-02318c46406e",
    "title": "Reprehenderit ipsa rerum dignissimos.",
    "body": "<p>Dolores et molestiae qui consequatur quia cupiditate voluptas. Culpa nemo ut dolores saepe. Et sit deserunt odio et ut dignissimos quibusdam quibusdam. Delectus eos commodi repudiandae repellat laudantium sunt.</p>",
    "video": null,
    "status": "draft",
    "translation_status": "STARTED",
    "activated_at": null,
    "archived_at": null,
    "created_by": null,
    "created_at": "2026-10-26T11:56:06.000000Z",
    "updated_at": "2026-10-26T11:56:06.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage release notes",
    "code": "RELEASE_NOTES:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (500, Server error):


{
    "message": "Server error: release note not created",
    "code": "RELEASE_NOTES:CREATE:SERVER_ERROR"
}

Request   

POST api/release-notes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

title   string   

Release note title, authored in English. Example: New grip control available

body   string   

Release note body (rich text HTML), authored in English. Example: <p>We just shipped a new grip control.</p>

video   file  optional  

Optional video attachment (mp4, max 250MB). Must be a file. MAXIMUM:FILE_KB:256000. Example: /tmp/phpdEkHyp

sync_uuid   string  optional  

MUST_BE_UUID. Example: 99f3e5ad-8063-378d-a089-054952e2dce6

Update release note

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/release-notes/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=New grip control available"\
    --form "body=<p>We just shipped a new grip control.</p>"\
    --form "video=@/tmp/phpffZPD1" 
const url = new URL(
    "http://localhost:8000/api/release-notes/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('title', 'New grip control available');
body.append('body', '<p>We just shipped a new grip control.</p>');
body.append('video', document.querySelector('input[name="video"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Example response (202):


{
    "id": 4,
    "sync_uuid": "a30e0668-1982-4fe5-8277-db755159dcdb",
    "title": "Voluptates veniam magnam eos.",
    "body": "<p>Dolores tempore cum eos at voluptatem voluptatem. Quidem dignissimos tempora ut quibusdam voluptatem unde ut. Consequuntur voluptatum esse tenetur dolore et ullam. Recusandae provident maxime nemo autem ducimus quo.</p>",
    "video": null,
    "status": "draft",
    "translation_status": "STARTED",
    "activated_at": null,
    "archived_at": null,
    "created_by": null,
    "created_at": "2026-10-26T11:56:06.000000Z",
    "updated_at": "2026-10-26T11:56:06.000000Z"
}

Example response (403, Release note is not editable):


{
    "message": "Release note is not editable",
    "code": "RELEASE_NOTES:UPDATE:NOT_EDITABLE"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage release notes",
    "code": "RELEASE_NOTES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Release note not found):


{
    "message": "Release note not found",
    "code": "RELEASE_NOTES:UPDATE:NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error: release note not updated",
    "code": "RELEASE_NOTES:UPDATE:SERVER_ERROR"
}

Request   

PUT api/release-notes/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

id   integer   

Release note ID. Example: 1

Body Parameters

title   string  optional  

Release note title, authored in English. Example: New grip control available

body   string  optional  

Release note body (rich text HTML), authored in English. Example: <p>We just shipped a new grip control.</p>

video   file  optional  

Optional video attachment (mp4, max 250MB). Must be a file. MAXIMUM:FILE_KB:256000. Example: /tmp/phpffZPD1

Delete release note

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/release-notes/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/release-notes/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "message": "Release note deleted",
    "code": "RELEASE_NOTES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage release notes",
    "code": "RELEASE_NOTES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Release note not found):


{
    "message": "Release note not found",
    "code": "RELEASE_NOTES:DELETE:NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error: release note not deleted",
    "code": "RELEASE_NOTES:DELETE:SERVER_ERROR"
}

Request   

DELETE api/release-notes/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Release note ID. Example: 1

Activate release note

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/release-notes/1/activate" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/release-notes/1/activate"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 5,
    "sync_uuid": "03b9f70c-c0df-451c-9d5c-9833cd05ddb3",
    "title": "Non suscipit.",
    "body": "<p>Quasi voluptatem est sapiente sunt. Aspernatur voluptate fuga sint odit quia impedit.</p>",
    "video": null,
    "status": "draft",
    "translation_status": "STARTED",
    "activated_at": null,
    "archived_at": null,
    "created_by": null,
    "created_at": "2026-10-26T11:56:06.000000Z",
    "updated_at": "2026-10-26T11:56:06.000000Z"
}

Example response (403, Release note is already active):


{
    "message": "Release note is already active",
    "code": "RELEASE_NOTES:ACTIVATE:ALREADY_ACTIVE"
}

Example response (403, Translation is not ready yet):


{
    "message": "Release note translation is not ready yet",
    "code": "RELEASE_NOTES:ACTIVATE:TRANSLATION_NOT_READY"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage release notes",
    "code": "RELEASE_NOTES:ACTIVATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Release note not found):


{
    "message": "Release note not found",
    "code": "RELEASE_NOTES:ACTIVATE:NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error: release note not activated",
    "code": "RELEASE_NOTES:ACTIVATE:SERVER_ERROR"
}

Request   

POST api/release-notes/{id}/activate

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Release note ID. Example: 1

Archive release note

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/release-notes/1/archive" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/release-notes/1/archive"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 6,
    "sync_uuid": "07e880f0-e08d-480b-9610-2a581c292602",
    "title": "Quaerat cupiditate dolores.",
    "body": "<p>Laboriosam similique aliquid quibusdam rerum. Vitae ut cumque omnis dolore beatae mollitia repellat. Atque sit ut corrupti.</p>",
    "video": null,
    "status": "draft",
    "translation_status": "STARTED",
    "activated_at": null,
    "archived_at": null,
    "created_by": null,
    "created_at": "2026-10-26T11:56:06.000000Z",
    "updated_at": "2026-10-26T11:56:06.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage release notes",
    "code": "RELEASE_NOTES:ARCHIVE:INSUFFICIENT_PERMISSION"
}

Example response (404, Release note not found):


{
    "message": "Release note not found",
    "code": "RELEASE_NOTES:ARCHIVE:NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error: release note not archived",
    "code": "RELEASE_NOTES:ARCHIVE:SERVER_ERROR"
}

Request   

POST api/release-notes/{id}/archive

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Release note ID. Example: 1

Get release notes status

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/release-notes/status" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/release-notes/status"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
vary: Origin
 

{
    "message": "api.responses.general.unauthenticated",
    "code": "GENERAL:UNAUTHENTICATED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view release notes",
    "code": "RELEASE_NOTES:STATUS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/release-notes/status

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Dismiss release note popup

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/release-notes/1/dismiss" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/release-notes/1/dismiss"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "message": "Release note dismissed",
    "code": "RELEASE_NOTES:DISMISS:DISMISSED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view release notes",
    "code": "RELEASE_NOTES:DISMISS:INSUFFICIENT_PERMISSION"
}

Example response (404, Release note not found):


{
    "message": "Release note not found",
    "code": "RELEASE_NOTES:DISMISS:NOT_FOUND"
}

Request   

POST api/release-notes/{id}/dismiss

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Release note ID. Example: 1

Mark release notes as seen

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/release-notes/mark-seen" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/release-notes/mark-seen"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "message": "Release notes marked as seen",
    "code": "RELEASE_NOTES:MARK_SEEN:MARKED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view release notes",
    "code": "RELEASE_NOTES:MARK_SEEN:INSUFFICIENT_PERMISSION"
}

Request   

POST api/release-notes/mark-seen

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Releases

API endpoints for releases management

List releases

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/releases" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/releases"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "version_type": "App\\Models\\SoftwareVersion",
            "version_id": 14,
            "description": "Asperiores ut sit sint laudantium. Sed sit nihil molestiae magni. Corporis eaque laudantium dolorem aut. Commodi itaque pariatur enim temporibus laudantium vitae veniam.",
            "created_at": "2026-10-26T11:55:27.000000Z",
            "updated_at": "2026-10-26T11:55:27.000000Z",
            "version": {
                "id": 14,
                "name": "8.70.79",
                "created_at": "2026-10-26T11:55:27.000000Z",
                "updated_at": "2026-10-26T11:55:27.000000Z"
            }
        },
        {
            "id": 2,
            "version_type": "App\\Models\\SoftwareVersion",
            "version_id": 15,
            "description": "Est et est aut. Voluptates quia esse non nisi est quia magni. Et minima expedita pariatur natus commodi magni voluptatem. Sed ullam qui quae beatae quam sit omnis natus.",
            "created_at": "2026-10-26T11:55:27.000000Z",
            "updated_at": "2026-10-26T11:55:27.000000Z",
            "version": {
                "id": 15,
                "name": "5.93.74",
                "created_at": "2026-10-26T11:55:27.000000Z",
                "updated_at": "2026-10-26T11:55:27.000000Z"
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list releases",
    "code": "RELEASES:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/releases

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Response

Response Fields

items   object   
id   integer   

Release ID.

version_type   string   

Version model type (morph class name).

version_id   integer   

Version model ID.

description   string   

Release notes.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

version   object   

Associated version (software, firmware or PCB).

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Get release

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/releases/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/releases/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 3,
    "version_type": "App\\Models\\SoftwareVersion",
    "version_id": 16,
    "description": "Eos libero in error quaerat a ut qui. Odio eveniet quasi qui nihil ut. Omnis veniam vel aliquid expedita porro voluptatum similique.",
    "created_at": "2026-10-26T11:55:27.000000Z",
    "updated_at": "2026-10-26T11:55:27.000000Z",
    "version": {
        "id": 16,
        "name": "5.24.34",
        "created_at": "2026-10-26T11:55:27.000000Z",
        "updated_at": "2026-10-26T11:55:27.000000Z"
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view release",
    "code": "RELEASES:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Release not found):


{
    "message": "Release not found",
    "code": "RELEASES:GET:RELEASE_NOT_FOUND"
}

Request   

GET api/releases/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Release ID. Example: 1

Response

Response Fields

id   integer   

Release ID.

version_type   string   

Version model type (morph class name).

version_id   integer   

Version model ID.

description   string   

Release notes.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

version   object   

Associated version (software, firmware or PCB).

Create release

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/releases" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"version_type\": \"SoftwareVersion\",
    \"version_id\": 1,
    \"description\": \"This version fixes minor bugs.\"
}"

const url = new URL(
    "http://localhost:8000/api/releases"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "version_type": "SoftwareVersion",
    "version_id": 1,
    "description": "This version fixes minor bugs."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 4,
    "version_type": "App\\Models\\SoftwareVersion",
    "version_id": 17,
    "description": "Dolorem perspiciatis molestiae maxime quis qui recusandae enim. Ea harum rerum voluptas aliquid aliquam. Necessitatibus sint reprehenderit pariatur tempora voluptatem. Officiis ut est unde et labore.",
    "created_at": "2026-10-26T11:55:27.000000Z",
    "updated_at": "2026-10-26T11:55:27.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create release",
    "code": "RELEASES:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/releases

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

version_type   string   

Version type. Example: SoftwareVersion

Must be one of:
  • DeviceModel
  • SoftwareVersion
  • FirmwareVersion
  • PCBVersion
version_id   integer   

Version ID. Example: 1

description   string  optional  

Release description. Example: This version fixes minor bugs.

Response

Response Fields

id   integer   

Release ID.

version_type   string   

Version model type (morph class name).

version_id   integer   

Version model ID.

description   string   

Release notes.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

version   object   

Associated version (software, firmware or PCB).

Update release

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/releases/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"version_type\": \"SoftwareVersion\",
    \"version_id\": 1,
    \"description\": \"This version fixes minor bugs.\"
}"

const url = new URL(
    "http://localhost:8000/api/releases/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "version_type": "SoftwareVersion",
    "version_id": 1,
    "description": "This version fixes minor bugs."
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 5,
    "version_type": "App\\Models\\SoftwareVersion",
    "version_id": 18,
    "description": "Vel amet repellat aut recusandae perspiciatis ad ut. In tempora blanditiis et facere eos. Tempora porro aut numquam iste. Et assumenda ut ipsam quasi.",
    "created_at": "2026-10-26T11:55:27.000000Z",
    "updated_at": "2026-10-26T11:55:27.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update release",
    "code": "RELEASES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Release not found):


{
    "message": "Release not found",
    "code": "RELEASES:UPDATE:RELEASE_NOT_FOUND"
}

Request   

PUT api/releases/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Release ID. Example: 1

Body Parameters

version_type   string  optional  

Version type. Example: SoftwareVersion

Must be one of:
  • DeviceModel
  • SoftwareVersion
  • FirmwareVersion
  • PCBVersion
version_id   integer  optional  

Version ID. Example: 1

description   string  optional  

Release description. Example: This version fixes minor bugs.

Response

Response Fields

id   integer   

Release ID.

version_type   string   

Version model type (morph class name).

version_id   integer   

Version model ID.

description   string   

Release notes.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

version   object   

Associated version (software, firmware or PCB).

Delete release

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/releases/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/releases/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Version deleted",
    "code": "RELEASES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete release",
    "code": "RELEASES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Release not found):


{
    "message": "Release not found",
    "code": "RELEASES:DELETE:RELEASE_NOT_FOUND"
}

Request   

DELETE api/releases/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Release ID. Example: 1

Search

API endpoints for search

requires authentication

Searches in:
  • users (by name and email)
  • devices (by serial number)

Returned collection contains entries of type User or Device.

If the device has a patient assigned, this patient is included in the results as an entry of type User. If the device has no patient, the device is included in the results.

Users included in the results, but not found directly have "devices" relation filled in with the devices that match the search query.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/search?query=Tom" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"ieufmwsdmemnatnxtxlvrjrgshxbbmxjlszhndmddubljlfhjpskticiu\"
}"

const url = new URL(
    "http://localhost:8000/api/search"
);

const params = {
    "query": "Tom",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "query": "ieufmwsdmemnatnxtxlvrjrgshxbbmxjlszhndmddubljlfhjpskticiu"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "type": "User",
            "item": {
                "id": 1,
                "mrn": "MRN",
                "name": "User name",
                "email": "user@domain.com",
                "language": "en",
                "phone": "",
                "phone_verified_at": null,
                "address1": "",
                "address2": "",
                "postal_code": "",
                "city": "",
                "clinic_name": "Test Company",
                "clinic_location": "Test Company Location",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": "email",
                "mfa_verified_to": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": "Europe/Warsaw",
                "notifications_at": "08:00:00",
                "created_at": "2024-09-01T15:00:00.000000Z",
                "updated_at": "2024-10-10T10:30:00.000000Z",
                "invitation_status": "accepted",
                "pivot": {
                    "assigned_user_id": 2,
                    "user_id": 1
                },
                "devices": [],
                "roles": [
                    {
                        "id": 5,
                        "name": "Amputee",
                        "guard_name": "web",
                        "created_at": "2024-01-01T12:00:00.000000Z",
                        "updated_at": "2024-01-01T12:00:00.000000Z",
                        "pivot": {
                            "model_id": 1,
                            "role_id": 5,
                            "model_type": "App\\Models\\User"
                        }
                    }
                ]
            }
        },
        {
            "type": "Device",
            "item": {
                "id": 1,
                "serial": "SERIAL-NUMBER",
                "bluetooth_id": "BLUETOOTH_ID",
                "model_id": 1,
                "amputee_id": 1,
                "firmware_version_id": 1,
                "pcb_version_id": 1,
                "active": 1,
                "last_activity_at": "2024-11-11 12:00:00",
                "created_at": "2024-08-30T15:00:00.000000Z",
                "updated_at": "2024-09-01T16:00:00.000000Z",
                "pivot": {
                    "user_id": 2,
                    "device_id": 1
                }
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to search",
    "code": "SEARCH:SEARCH:INSUFFICIENT_PERMISSION"
}

Servicing

API endpoints for servicing

List of parts

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/servicing/parts" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/servicing/parts"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "device_model": null,
            "name": "Discover Card",
            "created_at": "2026-10-26T11:54:25.000000Z",
            "updated_at": "2026-10-26T11:54:25.000000Z"
        },
        {
            "id": 2,
            "device_model": null,
            "name": "Visa",
            "created_at": "2026-10-26T11:54:25.000000Z",
            "updated_at": "2026-10-26T11:54:25.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list service parts",
    "code": "SERVICING:LIST_PARTS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/servicing/parts

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Response

Response Fields

items   object   
id   integer   

Service part ID.

device_model   integer   

Associated device model ID.

name   string   

Part name.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Report service repair

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/servicing/repair" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "user_id=1"\
    --form "device_id=1"\
    --form "parts[][part_id]=1"\
    --form "parts[][reason]=Mechanical issue"\
    --form "files[]=@/tmp/phpJEynkb" 
const url = new URL(
    "http://localhost:8000/api/servicing/repair"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('user_id', '1');
body.append('device_id', '1');
body.append('parts[][part_id]', '1');
body.append('parts[][reason]', 'Mechanical issue');
body.append('files[]', document.querySelector('input[name="files[]"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (201):


{
    "id": 1,
    "user_id": 141,
    "device_id": 128,
    "created_at": "2026-10-26T11:54:25.000000Z",
    "updated_at": "2026-10-26T11:54:25.000000Z",
    "parts": [
        {
            "id": 1,
            "repair_id": 1,
            "part_id": 3,
            "reason": "Et et ipsa consectetur dolores quae tempore et voluptas. Dignissimos dolor occaecati aperiam occaecati atque voluptas. Et ea dolorum molestiae dolore alias accusamus enim eos. Esse aut dolorem illum.",
            "created_at": "2026-10-26T11:54:26.000000Z",
            "updated_at": "2026-10-26T11:54:26.000000Z",
            "part": {
                "id": 3,
                "device_model": null,
                "name": "Visa",
                "created_at": "2026-10-26T11:54:26.000000Z",
                "updated_at": "2026-10-26T11:54:26.000000Z"
            }
        },
        {
            "id": 2,
            "repair_id": 1,
            "part_id": 4,
            "reason": "Ut odio libero consequatur quia. Adipisci quasi est consequatur et voluptatem magnam consequatur. Soluta ut eligendi saepe aut aliquam. Perferendis sit corporis sit aut ut expedita sit.",
            "created_at": "2026-10-26T11:54:27.000000Z",
            "updated_at": "2026-10-26T11:54:27.000000Z",
            "part": {
                "id": 4,
                "device_model": null,
                "name": "Visa",
                "created_at": "2026-10-26T11:54:27.000000Z",
                "updated_at": "2026-10-26T11:54:27.000000Z"
            }
        },
        {
            "id": 3,
            "repair_id": 1,
            "part_id": 5,
            "reason": "Quidem aut repellat quisquam placeat inventore nisi aut corrupti. Aperiam consectetur est odio a itaque. Autem corrupti nisi recusandae et suscipit.",
            "created_at": "2026-10-26T11:54:27.000000Z",
            "updated_at": "2026-10-26T11:54:27.000000Z",
            "part": {
                "id": 5,
                "device_model": null,
                "name": "Visa",
                "created_at": "2026-10-26T11:54:27.000000Z",
                "updated_at": "2026-10-26T11:54:27.000000Z"
            }
        }
    ],
    "attachments": [
        {
            "id": 1,
            "repair_id": 1,
            "file": "/tmp/fakerw0sBCT",
            "created_at": "2026-10-26T11:54:26.000000Z",
            "updated_at": "2026-10-26T11:54:26.000000Z"
        },
        {
            "id": 2,
            "repair_id": 1,
            "file": "/tmp/fakerrN79cu",
            "created_at": "2026-10-26T11:54:28.000000Z",
            "updated_at": "2026-10-26T11:54:28.000000Z"
        },
        {
            "id": 3,
            "repair_id": 1,
            "file": "/tmp/fakerTDBvLs",
            "created_at": "2026-10-26T11:54:28.000000Z",
            "updated_at": "2026-10-26T11:54:28.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to report service repair",
    "code": "SERVICING:REPORT_REPAIR:INSUFFICIENT_PERMISSION"
}

Request   

POST api/servicing/repair

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

user_id   integer   

User ID. Example: 1

device_id   integer   

Device ID. Example: 1

files   file[]  optional  

Array of attachment files.

parts   object[]  optional  

Array of replaced parts.
part_id   integer  optional  

Service part ID. Example: 1

reason   string  optional  

Reason of part replacement. Example: Mechanical issue

Response

Response Fields

id   integer   

Service repair ID.

user_id   integer   

Associated user ID.

device_id   integer   

Associated device ID.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

parts   object[]   

Service parts included in the repair.

attachments   object[]   

Repair attachments.

Settings

API endpoints for app settings

Get app version

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/settings/app-version" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/settings/app-version"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "version": "1.6.0"
}

Request   

GET api/settings/app-version

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get silent push timeout

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/settings/silent-push" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/settings/silent-push"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "timeout": "15"
}

Request   

GET api/settings/silent-push

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get available languages

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/settings/languages" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/settings/languages"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "languages": [
        "de",
        "en",
        "es",
        "it",
        "pl",
        "ru",
        "uk"
    ]
}

Request   

GET api/settings/languages

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get mobile stores versions

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/mobile/versions" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/mobile/versions"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "ios": "1.0",
    "android": "1.0"
}

Request   

GET api/mobile/versions

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Update app version

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/settings/app-version" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"version\": \"1.6.0\"
}"

const url = new URL(
    "http://localhost:8000/api/settings/app-version"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "version": "1.6.0"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "version": "1.6.0"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update settings",
    "code": "SETTINGS:UPDATE_APP_VERSION:INSUFFICIENT_PERMISSION"
}

Request   

POST api/settings/app-version

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

version   string  optional  

App version. Example: 1.6.0

Update silent push timeout

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/settings/silent-push" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"timeout\": 15
}"

const url = new URL(
    "http://localhost:8000/api/settings/silent-push"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "timeout": 15
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "timeout": "15"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update settings",
    "code": "SETTINGS:UPDATE_SILENT_PUSH:INSUFFICIENT_PERMISSION"
}

Request   

POST api/settings/silent-push

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

timeout   integer  optional  

Silent push timeout in minutes. Minimum value is 1 minute (15 for production environment), maximum is 60 minutes. MINIMUM:NUMBER:1 MAXIMUM:NUMBER:60. Example: 15

Update mobile stores versions

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/mobile/versions" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ios\": \"1.1\",
    \"android\": \"1.1\"
}"

const url = new URL(
    "http://localhost:8000/api/mobile/versions"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ios": "1.1",
    "android": "1.1"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "ios": "1.0",
    "android": "1.0"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update settings",
    "code": "SETTINGS:UPDATE_MOBILE_STORES_VERSION:INSUFFICIENT_PERMISSION"
}

Request   

POST api/mobile/versions

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

ios   string  optional  

Apple AppStore current version. Example: 1.1

android   string  optional  

Google Play current version. Example: 1.1

Get glove mode config

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/glove-mode-config" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/glove-mode-config"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "config": "{\"key\": \"value\"}"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view settings",
    "code": "GLOVE_MODE_CONFIG:GET:INSUFFICIENT_PERMISSION"
}

Request   

GET api/glove-mode-config

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Update glove mode config

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/glove-mode-config" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"config\": \"{\\\"key\\\": \\\"value\\\"}\"
}"

const url = new URL(
    "http://localhost:8000/api/glove-mode-config"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "config": "{\"key\": \"value\"}"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "config": "{\"key\": \"value\"}"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update settings",
    "code": "GLOVE_MODE_CONFIG:UPDATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/glove-mode-config

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

config   string   

Glove mode config as JSON string. MUST_BE_JSON. Example: {"key": "value"}

Support Ticket

API endpoints for managing support tickets

Get tickets list

requires authentication

Possible extend options:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/tickets?status=new&sender=1&recipient=1&device=1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/tickets"
);

const params = {
    "status": "new",
    "sender": "1",
    "recipient": "1",
    "device": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 27,
            "sender_id": 150,
            "recipient_id": 151,
            "device_id": 135,
            "meeting_date": "2026-10-26 11:54:30",
            "meeting_type": "online_meeting",
            "contact_email": "kunde.meghan@yahoo.com",
            "status": "new",
            "created_at": "2026-10-26T11:54:31.000000Z",
            "updated_at": "2026-10-26T11:54:31.000000Z",
            "sender": {
                "id": 150,
                "mrn": "YRZBHK4P1793015670",
                "name": "Mr. Reinhold Weimann",
                "email": "1793015670onader@example.org",
                "language": "en",
                "phone": "+1-351-827-5025",
                "phone_country": "ZW",
                "phone_verified_at": null,
                "address1": "329 Else Hollow Apt. 082",
                "address2": "Shaniyaborough, KY 15842-8524",
                "postal_code": "62828-0119",
                "city": "Ullrich LLC",
                "country": "IT",
                "clinic_name": "Haneville",
                "clinic_location": "2486 Herta Fields Suite 815\nSamsonville, ID 68247",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:54:30.000000Z",
                "updated_at": "2026-10-26T11:54:30.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "recipient": {
                "id": 151,
                "mrn": "YELK9HUQ1793015670",
                "name": "Wilmer Feil",
                "email": "1793015670myrtis.berge@example.org",
                "language": "en",
                "phone": "651-433-3007",
                "phone_country": "BY",
                "phone_verified_at": null,
                "address1": "5943 Guiseppe Ville",
                "address2": "Lake Naomieberg, CO 90246-2777",
                "postal_code": "88417-9655",
                "city": "Ruecker-Rath",
                "country": "DK",
                "clinic_name": "South Aron",
                "clinic_location": "227 Rolfson Branch\nHaleymouth, NJ 04974-4196",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:54:30.000000Z",
                "updated_at": "2026-10-26T11:54:30.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "device": {
                "id": 135,
                "serial": "4bdf4718-fdeb-35dd-986c-dc3f60dc85d3",
                "bluetooth_id": "d13ef407-8939-3339-ad9d-07234456dacc",
                "company_id": null,
                "model_id": null,
                "amputee_id": null,
                "clinician_id": null,
                "firmware_version_id": null,
                "pcb_version_id": null,
                "reverse_magnets": 0,
                "is_electrode": 0,
                "active": 1,
                "last_activity_at": "0000-00-00 00:00:00",
                "first_connected_at": null,
                "measurements": null,
                "created_at": "2026-10-26T11:54:31.000000Z",
                "updated_at": "2026-10-26T11:54:31.000000Z",
                "first_config_change_at": null
            },
            "messages": [
                {
                    "id": 15,
                    "ticket_id": 27,
                    "sender_id": 152,
                    "title": "Mr.",
                    "content": "Sit omnis et et ea similique magnam voluptatem aut.",
                    "is_read": false,
                    "created_at": "2026-10-26T11:54:32.000000Z",
                    "updated_at": "2026-10-26T11:54:32.000000Z"
                }
            ]
        },
        {
            "id": 35,
            "sender_id": 164,
            "recipient_id": 165,
            "device_id": 136,
            "meeting_date": "2026-10-26 11:54:37",
            "meeting_type": "online_meeting",
            "contact_email": "cummings.jazmin@rogahn.com",
            "status": "new",
            "created_at": "2026-10-26T11:54:38.000000Z",
            "updated_at": "2026-10-26T11:54:38.000000Z",
            "sender": {
                "id": 164,
                "mrn": "W6WQX8M61793015677",
                "name": "Aaron Kessler",
                "email": "1793015677braeden.reichert@example.com",
                "language": "en",
                "phone": "(848) 750-7162",
                "phone_country": "LC",
                "phone_verified_at": null,
                "address1": "57044 Stewart Via",
                "address2": "South Maxinebury, AK 77847-8357",
                "postal_code": "03509",
                "city": "Connelly, Lindgren and Harris",
                "country": "PL",
                "clinic_name": "East Micah",
                "clinic_location": "88160 Nikolaus Terrace\nWest Janhaven, LA 69600",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:54:37.000000Z",
                "updated_at": "2026-10-26T11:54:37.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "recipient": {
                "id": 165,
                "mrn": "J75RVNF61793015677",
                "name": "Rylee Huels",
                "email": "1793015677rempel.zackery@example.net",
                "language": "en",
                "phone": "+1.920.705.7518",
                "phone_country": "TT",
                "phone_verified_at": null,
                "address1": "33269 Schuster Mill Apt. 236",
                "address2": "Lake Lydia, MN 48128",
                "postal_code": "55158",
                "city": "Hane, Miller and Gleason",
                "country": "LV",
                "clinic_name": "Dickensfort",
                "clinic_location": "506 Forest Spur\nLake Stephany, DE 70558",
                "image": null,
                "public_image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "is_ambassador": 0,
                "test_account": false,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2026-10-26T11:54:37.000000Z",
                "updated_at": "2026-10-26T11:54:37.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "device": {
                "id": 136,
                "serial": "132c190d-c05b-392e-bed1-c3de7b1838fb",
                "bluetooth_id": "3f4da497-ae1a-3390-b61d-794c4f41c0b8",
                "company_id": null,
                "model_id": null,
                "amputee_id": null,
                "clinician_id": null,
                "firmware_version_id": null,
                "pcb_version_id": null,
                "reverse_magnets": 0,
                "is_electrode": 0,
                "active": 1,
                "last_activity_at": "0000-00-00 00:00:00",
                "first_connected_at": null,
                "measurements": null,
                "created_at": "2026-10-26T11:54:38.000000Z",
                "updated_at": "2026-10-26T11:54:38.000000Z",
                "first_config_change_at": null
            },
            "messages": [
                {
                    "id": 19,
                    "ticket_id": 35,
                    "sender_id": 166,
                    "title": "Ms.",
                    "content": "Quod nemo quibusdam ut dolore quo qui.",
                    "is_read": false,
                    "created_at": "2026-10-26T11:54:39.000000Z",
                    "updated_at": "2026-10-26T11:54:39.000000Z"
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list support tickets",
    "code": "TICKETS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/tickets

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

status   string  optional  

Filter tickets by status (available: new, in_progress, closed, reopened. Example: new

sender   integer  optional  

Filter tickets by sender. Example: 1

recipient   integer  optional  

Filter tickets by recipient. Example: 1

device   string  optional  

Filter tickets by devices. Provide single ID (device=1), array of IDs (device[]=1&device[]=2) or comma-separated list of IDs (device=1,2). Pass value 0 to get tickets without device. Note: tickets without a device are also included when filtering by specific device IDs. Example: 1

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: sender, recipient, device, messages, messages.attachments).

sortby   string  optional  

Sort by field (available: sender_name, recipient_name, date, last_message). Default: last_message, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

Support ticket ID.

sender_id   integer   

ID of the user who created the ticket.

recipient_id   integer   

ID of the recipient user.

device_id   integer   

Associated device ID.

meeting_date   string   

Scheduled meeting date.

meeting_type   string   

Meeting type.

Must be one of:
  • online
  • in-person
contact_email   string   

Contact email address.

status   string   

Ticket status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

sender   object   

User who created the ticket.

recipient   object   

Recipient user.

device   object   

Associated device.

messages   object[]   

Ticket messages.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Get tickets status

requires authentication

Counts tickets by their status

Example request:
curl --request GET \
    --get "http://localhost:8000/api/tickets/status" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/tickets/status"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "unread": 1
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list support tickets",
    "code": "TICKETS:STATUS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/tickets/status

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get support ticket

requires authentication

Returns single support ticket in the response.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/ticket/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/ticket/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 43,
    "sender_id": 178,
    "recipient_id": 179,
    "device_id": 137,
    "meeting_date": "2026-10-26 11:54:44",
    "meeting_type": "online_meeting",
    "contact_email": "einar.lubowitz@zemlak.com",
    "status": "new",
    "created_at": "2026-10-26T11:54:45.000000Z",
    "updated_at": "2026-10-26T11:54:45.000000Z",
    "sender": {
        "id": 178,
        "mrn": "SJCR6AQN1793015684",
        "name": "Soledad Hintz",
        "email": "1793015684klocko.lucinda@example.net",
        "language": "en",
        "phone": "838-688-4168",
        "phone_country": "FJ",
        "phone_verified_at": null,
        "address1": "36984 Mason Locks Apt. 404",
        "address2": "Abbottville, NH 24115-4407",
        "postal_code": "44722-7288",
        "city": "Thiel-Marquardt",
        "country": "SI",
        "clinic_name": "Sammieland",
        "clinic_location": "16765 Dario Point\nLake Shirley, NV 78971",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:54:44.000000Z",
        "updated_at": "2026-10-26T11:54:44.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 179,
        "mrn": "BY7WUYHN1793015684",
        "name": "Candice Kutch",
        "email": "1793015684arlene.kemmer@example.org",
        "language": "en",
        "phone": "+1 (650) 359-2481",
        "phone_country": "AT",
        "phone_verified_at": null,
        "address1": "406 Rogahn Tunnel Suite 030",
        "address2": "Ociefort, NM 65970-5034",
        "postal_code": "44789-4933",
        "city": "Botsford, Tromp and Dach",
        "country": "FI",
        "clinic_name": "West Magnoliaberg",
        "clinic_location": "39449 Rice Plain Suite 674\nJonesberg, TN 83852",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:54:44.000000Z",
        "updated_at": "2026-10-26T11:54:44.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": {
        "id": 137,
        "serial": "9fe78299-f27b-3f76-bc45-ed86157bca41",
        "bluetooth_id": "ad7633b2-970e-3fca-96ab-573a9b1d3420",
        "company_id": null,
        "model_id": null,
        "amputee_id": null,
        "clinician_id": null,
        "firmware_version_id": null,
        "pcb_version_id": null,
        "reverse_magnets": 0,
        "is_electrode": 0,
        "active": 1,
        "last_activity_at": "0000-00-00 00:00:00",
        "first_connected_at": null,
        "measurements": null,
        "created_at": "2026-10-26T11:54:45.000000Z",
        "updated_at": "2026-10-26T11:54:45.000000Z",
        "first_config_change_at": null
    },
    "messages": [
        {
            "id": 23,
            "ticket_id": 43,
            "sender_id": 180,
            "title": "Dr.",
            "content": "Molestias aut eius consequatur doloribus architecto maiores omnis ipsam.",
            "is_read": false,
            "created_at": "2026-10-26T11:54:47.000000Z",
            "updated_at": "2026-10-26T11:54:47.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view support ticket",
    "code": "TICKETS:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Support ticket not found):


{
    "message": "Support ticket not found",
    "code": "TICKETS:GET:TICKET_NOT_FOUND"
}

Request   

GET api/ticket/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Support ticket ID. Example: 1

Query Parameters

extend   string  optional  

Comma-separated list of relation extensions (available: sender, recipient, device, messages, messages.attachments, messages.sender).

Response

Response Fields

id   integer   

Support ticket ID.

sender_id   integer   

ID of the user who created the ticket.

recipient_id   integer   

ID of the recipient user.

device_id   integer   

Associated device ID.

meeting_date   string   

Scheduled meeting date.

meeting_type   string   

Meeting type.

Must be one of:
  • online
  • in-person
contact_email   string   

Contact email address.

status   string   

Ticket status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

sender   object   

User who created the ticket.

recipient   object   

Recipient user.

device   object   

Associated device.

messages   object[]   

Ticket messages.

Get support ticket history

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/ticket/1/history" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/ticket/1/history"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "ticket_id": 51,
            "author_id": 193,
            "action": "blanditiis",
            "reason": "Libero voluptas dolores repellendus quos placeat.",
            "created_at": "2026-10-26T11:54:52.000000Z",
            "updated_at": "2026-10-26T11:54:52.000000Z"
        },
        {
            "id": 2,
            "ticket_id": 52,
            "author_id": 195,
            "action": "rerum",
            "reason": "Est rem voluptatem et ut aut sunt sapiente dolorum.",
            "created_at": "2026-10-26T11:54:53.000000Z",
            "updated_at": "2026-10-26T11:54:53.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view support ticket",
    "code": "TICKETS:HISTORY:INSUFFICIENT_PERMISSION"
}

Example response (404, Support ticket not found):


{
    "message": "Support ticket not found",
    "code": "TICKETS:HISTORY:TICKET_NOT_FOUND"
}

Request   

GET api/ticket/{id}/history

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Support ticket ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

sortby   string  optional  

Sort by field (available: date). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

History entry ID.

ticket_id   integer   

Associated support ticket ID.

author_id   integer   

ID of the user who made this change.

action   string   

Action performed.

reason   string   

Reason for the action.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who made this change.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Get support ticket available filters

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/tickets/available-filters" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/tickets/available-filters"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "clinicians": [
        {
            "id": 95,
            "mrn": null,
            "name": "Name",
            "email": "email",
            "region": "us",
            "language": "pl",
            "phone": "+48-555555555",
            "phone_verified_at": null,
            "address1": "Address",
            "address2": "Address 2",
            "postal_code": "",
            "city": "",
            "clinic_name": "Name",
            "clinic_location": "Name",
            "image": "https://aether-dev-bucket.s3.amazonaws.com/users/LDueuv1uG218G7owaiLAaWRkpaGxjB0jEFwzZsT1.png",
            "mfa_enabled": 0,
            "mfa_method": "sms",
            "mfa_verified_to": null,
            "location_id": 2,
            "created_by": 1,
            "active": 1,
            "notifications_timezone": "America/Adak",
            "notifications_at": null,
            "created_at": "2022-07-19T14:43:37.000000Z",
            "updated_at": "2024-09-27T05:52:51.000000Z",
            "invitation_status": "expired",
            "roles": [
                {
                    "id": 2,
                    "name": "Clinician",
                    "guard_name": "web",
                    "created_at": "2022-03-21T17:15:47.000000Z",
                    "updated_at": "2022-03-21T17:15:47.000000Z",
                    "pivot": {
                        "model_id": 95,
                        "role_id": 2,
                        "model_type": "App\\Models\\User"
                    }
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create support ticket",
    "code": "TICKETS:AVAILABLE_FILTERS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/tickets/available-filters

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Create new support ticket

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/tickets" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "recipient=1"\
    --form "device=1"\
    --form "meeting_type=online_meeting"\
    --form "meeting_date=2026-10-26 11:54:53"\
    --form "contact_email=liana.reynolds@hotmail.com"\
    --form "message[content]=Iure recusandae quo vero officia."\
    --form "message[title]=Sunt hic fugit."\
    --form "message[attachments][]=@/tmp/phpENy3kT" 
const url = new URL(
    "http://localhost:8000/api/tickets"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('recipient', '1');
body.append('device', '1');
body.append('meeting_type', 'online_meeting');
body.append('meeting_date', '2026-10-26 11:54:53');
body.append('contact_email', 'liana.reynolds@hotmail.com');
body.append('message[content]', 'Iure recusandae quo vero officia.');
body.append('message[title]', 'Sunt hic fugit.');
body.append('message[attachments][]', document.querySelector('input[name="message[attachments][]"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (201):


{
    "id": 53,
    "sender_id": 196,
    "recipient_id": 197,
    "device_id": 138,
    "meeting_date": "2026-10-26 11:54:54",
    "meeting_type": "online_meeting",
    "contact_email": "evan.rowe@hotmail.com",
    "status": "new",
    "created_at": "2026-10-26T11:54:54.000000Z",
    "updated_at": "2026-10-26T11:54:54.000000Z",
    "sender": {
        "id": 196,
        "mrn": "5U4JR3QJ1793015693",
        "name": "Tessie Tremblay",
        "email": "1793015693lmayer@example.com",
        "language": "en",
        "phone": "+1 (859) 739-1016",
        "phone_country": "EH",
        "phone_verified_at": null,
        "address1": "41085 Baumbach Meadows",
        "address2": "New Fritz, NC 44096",
        "postal_code": "06107-7029",
        "city": "Rath LLC",
        "country": "FR",
        "clinic_name": "Lake Demetris",
        "clinic_location": "37831 Kertzmann Mills\nNew Deangelo, MD 86206",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:54:53.000000Z",
        "updated_at": "2026-10-26T11:54:53.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 197,
        "mrn": "BGBSH3UK1793015694",
        "name": "Dan Yost",
        "email": "1793015694naomi.wyman@example.com",
        "language": "en",
        "phone": "385.428.6608",
        "phone_country": "LV",
        "phone_verified_at": null,
        "address1": "7084 Weber Bridge",
        "address2": "Steveside, NH 22982",
        "postal_code": "43375-5219",
        "city": "Wuckert and Sons",
        "country": "AT",
        "clinic_name": "Rempelberg",
        "clinic_location": "864 Vernie Village Suite 782\nSouth Matilda, NJ 66594-3520",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:54:54.000000Z",
        "updated_at": "2026-10-26T11:54:54.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": {
        "id": 138,
        "serial": "22a37be4-1f3d-304a-a3cf-182a5ca37ef3",
        "bluetooth_id": "a52c8807-b80c-386c-b269-375d191189fc",
        "company_id": null,
        "model_id": null,
        "amputee_id": null,
        "clinician_id": null,
        "firmware_version_id": null,
        "pcb_version_id": null,
        "reverse_magnets": 0,
        "is_electrode": 0,
        "active": 1,
        "last_activity_at": "0000-00-00 00:00:00",
        "first_connected_at": null,
        "measurements": null,
        "created_at": "2026-10-26T11:54:54.000000Z",
        "updated_at": "2026-10-26T11:54:54.000000Z",
        "first_config_change_at": null
    },
    "messages": [
        {
            "id": 27,
            "ticket_id": 53,
            "sender_id": 198,
            "title": "Miss",
            "content": "Quia error soluta ratione unde.",
            "is_read": false,
            "created_at": "2026-10-26T11:54:56.000000Z",
            "updated_at": "2026-10-26T11:54:56.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create support ticket",
    "code": "TICKETS:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/tickets

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

recipient   integer   

User the support ticket is assigned to. For Amputee role main clinician will be automatically assigned instead. The id of an existing record in the App\Models\User table. Example: 1

device   integer  optional  

Device the support ticket is assigned to. The id of an existing record in the App\Models\Device table. Example: 1

meeting_type   string   

Type of support meeting. Example: online_meeting

Must be one of:
  • online_meeting
  • phone_call
  • personally
  • none
meeting_date   string   

Date of support meeting. MUST_BE_DATE. Example: 2026-10-26 11:54:53

contact_email   string  optional  

Email address for later contact. MUST_BE_EMAIL. Example: liana.reynolds@hotmail.com

message   object  optional  
content   string  optional  

Content of message. Example: Iure recusandae quo vero officia.

title   string  optional  

Message title. Example: Sunt hic fugit.

attachments   file[]  optional  

Must be a file.

Response

Response Fields

id   integer   

Support ticket ID.

sender_id   integer   

ID of the user who created the ticket.

recipient_id   integer   

ID of the recipient user.

device_id   integer   

Associated device ID.

meeting_date   string   

Scheduled meeting date.

meeting_type   string   

Meeting type.

Must be one of:
  • online
  • in-person
contact_email   string   

Contact email address.

status   string   

Ticket status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

sender   object   

User who created the ticket.

recipient   object   

Recipient user.

device   object   

Associated device.

messages   object[]   

Ticket messages.

Close support ticket

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/ticket/1/close" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/ticket/1/close"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (202):


{
    "id": 61,
    "sender_id": 210,
    "recipient_id": 211,
    "device_id": 139,
    "meeting_date": "2026-10-26 11:55:01",
    "meeting_type": "online_meeting",
    "contact_email": "isaiah.mosciski@strosin.com",
    "status": "new",
    "created_at": "2026-10-26T11:55:01.000000Z",
    "updated_at": "2026-10-26T11:55:01.000000Z",
    "sender": {
        "id": 210,
        "mrn": "UZJ55C8K1793015700",
        "name": "Kirsten Schoen",
        "email": "1793015700orn.mark@example.com",
        "language": "en",
        "phone": "+1-608-204-1688",
        "phone_country": "KZ",
        "phone_verified_at": null,
        "address1": "81975 Isadore Way Apt. 119",
        "address2": "Lake Rosanna, KS 38601-3478",
        "postal_code": "04433",
        "city": "Kirlin PLC",
        "country": "BE",
        "clinic_name": "Walterland",
        "clinic_location": "96567 Dariana Rapids Suite 076\nCadeburgh, CO 90354-8495",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:55:00.000000Z",
        "updated_at": "2026-10-26T11:55:00.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 211,
        "mrn": "8JGVL9941793015701",
        "name": "Scarlett Koelpin",
        "email": "1793015701trantow.tara@example.net",
        "language": "en",
        "phone": "216-799-0518",
        "phone_country": "MS",
        "phone_verified_at": null,
        "address1": "96257 Treutel Underpass Suite 069",
        "address2": "East Ashtyn, AR 25295",
        "postal_code": "55586",
        "city": "Ankunding, Ankunding and Hauck",
        "country": "IN",
        "clinic_name": "New Jessy",
        "clinic_location": "3221 Clarissa Road Apt. 046\nKiehnbury, TX 26940-1853",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:55:01.000000Z",
        "updated_at": "2026-10-26T11:55:01.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": {
        "id": 139,
        "serial": "ef2f4202-59ba-30bf-8d65-2f07c0b7f05d",
        "bluetooth_id": "709592ce-d636-3057-82df-098bf5ba3187",
        "company_id": null,
        "model_id": null,
        "amputee_id": null,
        "clinician_id": null,
        "firmware_version_id": null,
        "pcb_version_id": null,
        "reverse_magnets": 0,
        "is_electrode": 0,
        "active": 1,
        "last_activity_at": "0000-00-00 00:00:00",
        "first_connected_at": null,
        "measurements": null,
        "created_at": "2026-10-26T11:55:01.000000Z",
        "updated_at": "2026-10-26T11:55:01.000000Z",
        "first_config_change_at": null
    },
    "messages": []
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to close support ticket",
    "code": "TICKETS:CLOSE:INSUFFICIENT_PERMISSION"
}

Example response (404, Support ticket not found):


{
    "message": "Support ticket not found",
    "code": "TICKETS:CLOSE:TICKET_NOT_FOUND"
}

Request   

POST api/ticket/{id}/close

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Support ticket ID. Example: 1

Response

Response Fields

id   integer   

Support ticket ID.

sender_id   integer   

ID of the user who created the ticket.

recipient_id   integer   

ID of the recipient user.

device_id   integer   

Associated device ID.

meeting_date   string   

Scheduled meeting date.

meeting_type   string   

Meeting type.

Must be one of:
  • online
  • in-person
contact_email   string   

Contact email address.

status   string   

Ticket status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

sender   object   

User who created the ticket.

recipient   object   

Recipient user.

device   object   

Associated device.

messages   object[]   

Ticket messages.

Reopen support ticket

requires authentication

Patient (Amputee) role can reopen only non-config tickets. For config tickets patients will get "Insufficient permission" response. For patients role reason field is required.

Example request:
curl --request POST \
    "http://localhost:8000/api/ticket/1/reopen" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reason\": \"Something is still not working\"
}"

const url = new URL(
    "http://localhost:8000/api/ticket/1/reopen"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "reason": "Something is still not working"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 3,
    "ticket_id": 62,
    "author_id": 213,
    "action": "cum",
    "reason": "Hic iste vel reiciendis qui.",
    "created_at": "2026-10-26T11:55:02.000000Z",
    "updated_at": "2026-10-26T11:55:02.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to reopen support ticket",
    "code": "TICKETS:REOPEN:INSUFFICIENT_PERMISSION"
}

Example response (404, Support ticket not found):


{
    "message": "Support ticket not found",
    "code": "TICKETS:REOPEN:TICKET_NOT_FOUND"
}

Request   

POST api/ticket/{id}/reopen

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Support ticket ID. Example: 1

Body Parameters

reason   string  optional  

Reason for reopen action. Example: Something is still not working

Response

Response Fields

id   integer   

History entry ID.

ticket_id   integer   

Associated support ticket ID.

author_id   integer   

ID of the user who made this change.

action   string   

Action performed.

reason   string   

Reason for the action.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

author   object   

User who made this change.

Create new support ticket message

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/ticket/1/messages" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=Cupiditate aspernatur veritatis eaque."\
    --form "content=Et itaque voluptas nesciunt tenetur ut repudiandae."\
    --form "attachments[]=@/tmp/php2rbE8l" 
const url = new URL(
    "http://localhost:8000/api/ticket/1/messages"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('title', 'Cupiditate aspernatur veritatis eaque.');
body.append('content', 'Et itaque voluptas nesciunt tenetur ut repudiandae.');
body.append('attachments[]', document.querySelector('input[name="attachments[]"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (201):


{
    "id": 63,
    "sender_id": 214,
    "recipient_id": 215,
    "device_id": 140,
    "meeting_date": "2026-10-26 11:55:03",
    "meeting_type": "online_meeting",
    "contact_email": "ugoodwin@yahoo.com",
    "status": "new",
    "created_at": "2026-10-26T11:55:03.000000Z",
    "updated_at": "2026-10-26T11:55:03.000000Z",
    "sender": {
        "id": 214,
        "mrn": "5LFKABRE1793015702",
        "name": "Mariela Ullrich",
        "email": "1793015702isaiah01@example.com",
        "language": "en",
        "phone": "304.848.8957",
        "phone_country": "MX",
        "phone_verified_at": null,
        "address1": "419 Feest Heights Apt. 073",
        "address2": "North Linahaven, NV 66440-4276",
        "postal_code": "09221-0283",
        "city": "Dach-Waters",
        "country": "CY",
        "clinic_name": "West Madonna",
        "clinic_location": "70921 Justus Throughway Apt. 726\nNorth Elijah, PA 68756",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:55:03.000000Z",
        "updated_at": "2026-10-26T11:55:03.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 215,
        "mrn": "49DNR6AH1793015703",
        "name": "Chadd Cremin",
        "email": "1793015703colten.walker@example.net",
        "language": "en",
        "phone": "+17066463655",
        "phone_country": "TT",
        "phone_verified_at": null,
        "address1": "861 Fidel Course Suite 721",
        "address2": "West Kiraside, NY 99849",
        "postal_code": "92424",
        "city": "Weimann and Sons",
        "country": "SI",
        "clinic_name": "Toyton",
        "clinic_location": "93553 Bartholome Extension\nJarrettton, GA 08802",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:55:03.000000Z",
        "updated_at": "2026-10-26T11:55:03.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": {
        "id": 140,
        "serial": "be70b24a-b62d-308c-9ef5-3adf76f8a1ce",
        "bluetooth_id": "cbb5ef33-65ea-305e-9ea1-c170ade69428",
        "company_id": null,
        "model_id": null,
        "amputee_id": null,
        "clinician_id": null,
        "firmware_version_id": null,
        "pcb_version_id": null,
        "reverse_magnets": 0,
        "is_electrode": 0,
        "active": 1,
        "last_activity_at": "0000-00-00 00:00:00",
        "first_connected_at": null,
        "measurements": null,
        "created_at": "2026-10-26T11:55:03.000000Z",
        "updated_at": "2026-10-26T11:55:03.000000Z",
        "first_config_change_at": null
    },
    "messages": [
        {
            "id": 31,
            "ticket_id": 63,
            "sender_id": 216,
            "title": "Dr.",
            "content": "Quam nam cumque totam eos animi.",
            "is_read": false,
            "created_at": "2026-10-26T11:55:05.000000Z",
            "updated_at": "2026-10-26T11:55:05.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create support ticket",
    "code": "TICKETS:CREATE_MESSAGE:INSUFFICIENT_PERMISSION"
}

Example response (404, Support ticket not found):


{
    "message": "Support ticket not found",
    "code": "TICKETS:CREATE_MESSAGE:TICKET_NOT_FOUND"
}

Request   

POST api/ticket/{id}/messages

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

id   integer   

Support ticket ID. Example: 1

Body Parameters

title   string  optional  

Message title. Example: Cupiditate aspernatur veritatis eaque.

content   string  optional  

Content of message. Example: Et itaque voluptas nesciunt tenetur ut repudiandae.

attachments   file[]  optional  

Must be a file.

Response

Response Fields

id   integer   

Support ticket ID.

sender_id   integer   

ID of the user who created the ticket.

recipient_id   integer   

ID of the recipient user.

device_id   integer   

Associated device ID.

meeting_date   string   

Scheduled meeting date.

meeting_type   string   

Meeting type.

Must be one of:
  • online
  • in-person
contact_email   string   

Contact email address.

status   string   

Ticket status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

sender   object   

User who created the ticket.

recipient   object   

Recipient user.

device   object   

Associated device.

messages   object[]   

Ticket messages.

Mark all messages as read

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/ticket/1/read" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/ticket/1/read"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (202):


{
    "id": 71,
    "sender_id": 228,
    "recipient_id": 229,
    "device_id": 141,
    "meeting_date": "2026-10-26 11:55:10",
    "meeting_type": "online_meeting",
    "contact_email": "carroll.louisa@feeney.com",
    "status": "new",
    "created_at": "2026-10-26T11:55:11.000000Z",
    "updated_at": "2026-10-26T11:55:11.000000Z",
    "sender": {
        "id": 228,
        "mrn": "NADFU3K51793015710",
        "name": "Felix Rohan",
        "email": "1793015710bette45@example.net",
        "language": "en",
        "phone": "+1.970.818.4785",
        "phone_country": "MP",
        "phone_verified_at": null,
        "address1": "890 Terrance Harbors Apt. 896",
        "address2": "Charlesmouth, NH 11268",
        "postal_code": "78776-4053",
        "city": "Kohler, Fadel and O'Keefe",
        "country": "FI",
        "clinic_name": "Leannonland",
        "clinic_location": "5026 Lafayette Island Suite 845\nHalvorsonmouth, MA 27746-5799",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:55:10.000000Z",
        "updated_at": "2026-10-26T11:55:10.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 229,
        "mrn": "2V3PNKG31793015710",
        "name": "Shaniya Hills",
        "email": "1793015710ursula60@example.com",
        "language": "en",
        "phone": "+1-681-448-4906",
        "phone_country": "GG",
        "phone_verified_at": null,
        "address1": "9943 Barry Walk Apt. 471",
        "address2": "Andersonmouth, OH 62797-8816",
        "postal_code": "24308-8020",
        "city": "Hane Group",
        "country": "PL",
        "clinic_name": "Kellyshire",
        "clinic_location": "629 Rippin Light Apt. 300\nWindlerburgh, CT 84882",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:55:10.000000Z",
        "updated_at": "2026-10-26T11:55:10.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": {
        "id": 141,
        "serial": "951401dc-cc7e-324f-b609-6d7dae33cba2",
        "bluetooth_id": "b3d2bd6c-29d4-307b-9527-34e8bf59a600",
        "company_id": null,
        "model_id": null,
        "amputee_id": null,
        "clinician_id": null,
        "firmware_version_id": null,
        "pcb_version_id": null,
        "reverse_magnets": 0,
        "is_electrode": 0,
        "active": 1,
        "last_activity_at": "0000-00-00 00:00:00",
        "first_connected_at": null,
        "measurements": null,
        "created_at": "2026-10-26T11:55:11.000000Z",
        "updated_at": "2026-10-26T11:55:11.000000Z",
        "first_config_change_at": null
    },
    "messages": [
        {
            "id": 35,
            "ticket_id": 71,
            "sender_id": 230,
            "title": "Dr.",
            "content": "Qui ut distinctio nihil voluptas a.",
            "is_read": false,
            "created_at": "2026-10-26T11:55:12.000000Z",
            "updated_at": "2026-10-26T11:55:12.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to read message",
    "code": "TICKETS:READ_ALL:INSUFFICIENT_PERMISSION"
}

Example response (404, Support ticket not found):


{
    "message": "Support ticket not found",
    "code": "TICKETS:READ_ALL:TICKET_NOT_FOUND"
}

Request   

POST api/ticket/{id}/read

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Support ticket ID (id from ticket list; do not confuse with messages.id). Example: 1

Response

Response Fields

id   integer   

Support ticket ID.

sender_id   integer   

ID of the user who created the ticket.

recipient_id   integer   

ID of the recipient user.

device_id   integer   

Associated device ID.

meeting_date   string   

Scheduled meeting date.

meeting_type   string   

Meeting type.

Must be one of:
  • online
  • in-person
contact_email   string   

Contact email address.

status   string   

Ticket status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

sender   object   

User who created the ticket.

recipient   object   

Recipient user.

device   object   

Associated device.

messages   object[]   

Ticket messages.

Mark single message as read

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/ticket/1/read/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/ticket/1/read/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (202):


{
    "id": 79,
    "sender_id": 242,
    "recipient_id": 243,
    "device_id": 142,
    "meeting_date": "2026-10-26 11:55:17",
    "meeting_type": "online_meeting",
    "contact_email": "jjakubowski@cummings.com",
    "status": "new",
    "created_at": "2026-10-26T11:55:17.000000Z",
    "updated_at": "2026-10-26T11:55:17.000000Z",
    "sender": {
        "id": 242,
        "mrn": "6B5D32YB1793015716",
        "name": "Birdie Terry",
        "email": "1793015716kreiger.tyson@example.org",
        "language": "en",
        "phone": "+1-540-685-6629",
        "phone_country": "GF",
        "phone_verified_at": null,
        "address1": "58622 Shanelle Courts Apt. 918",
        "address2": "Christyfort, IL 93989",
        "postal_code": "67149-2005",
        "city": "Blanda-Graham",
        "country": "PL",
        "clinic_name": "Port Greta",
        "clinic_location": "81364 Halvorson Court Apt. 232\nPort Vallie, NJ 33998",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:55:16.000000Z",
        "updated_at": "2026-10-26T11:55:16.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 243,
        "mrn": "GFQV5UU21793015717",
        "name": "Jaida Beer",
        "email": "1793015717curt47@example.com",
        "language": "en",
        "phone": "1-458-561-6658",
        "phone_country": "IR",
        "phone_verified_at": null,
        "address1": "31335 Demarco Lock",
        "address2": "Leschborough, OR 23632-4102",
        "postal_code": "77033-3668",
        "city": "Mitchell Group",
        "country": "IE",
        "clinic_name": "Reneland",
        "clinic_location": "18599 Jarod Port\nNorth Amiyafort, IN 07711-2475",
        "image": null,
        "public_image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "is_ambassador": 0,
        "test_account": false,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2026-10-26T11:55:17.000000Z",
        "updated_at": "2026-10-26T11:55:17.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": {
        "id": 142,
        "serial": "ab174d1e-ec1b-3af7-b5d0-8aa46468478e",
        "bluetooth_id": "3bd6ee71-ce09-3275-8559-587ab91b7eef",
        "company_id": null,
        "model_id": null,
        "amputee_id": null,
        "clinician_id": null,
        "firmware_version_id": null,
        "pcb_version_id": null,
        "reverse_magnets": 0,
        "is_electrode": 0,
        "active": 1,
        "last_activity_at": "0000-00-00 00:00:00",
        "first_connected_at": null,
        "measurements": null,
        "created_at": "2026-10-26T11:55:17.000000Z",
        "updated_at": "2026-10-26T11:55:17.000000Z",
        "first_config_change_at": null
    },
    "messages": [
        {
            "id": 39,
            "ticket_id": 79,
            "sender_id": 244,
            "title": "Ms.",
            "content": "Voluptatem nemo aut asperiores blanditiis reiciendis.",
            "is_read": false,
            "created_at": "2026-10-26T11:55:19.000000Z",
            "updated_at": "2026-10-26T11:55:19.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to read message",
    "code": "TICKETS:READ_MESSAGE:INSUFFICIENT_PERMISSION"
}

Example response (404, Message not found):


{
    "message": "Message not found",
    "code": "TICKETS:READ_MESSAGE:MESSAGE_NOT_FOUND"
}

Request   

POST api/ticket/{id}/read/{messageId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Support ticket ID (id from ticket list; do not confuse with messages.id). Example: 1

messageId   integer   

Message ID. Example: 1

Response

Response Fields

id   integer   

Support ticket ID.

sender_id   integer   

ID of the user who created the ticket.

recipient_id   integer   

ID of the recipient user.

device_id   integer   

Associated device ID.

meeting_date   string   

Scheduled meeting date.

meeting_type   string   

Meeting type.

Must be one of:
  • online
  • in-person
contact_email   string   

Contact email address.

status   string   

Ticket status.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

sender   object   

User who created the ticket.

recipient   object   

Recipient user.

device   object   

Associated device.

messages   object[]   

Ticket messages.

Tooltips

API endpoints for managing tooltips

List tooltips

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/tooltips" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/tooltips"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "name": "Garth Maggio",
            "type": "video",
            "language": "no",
            "file": "/tmp/f50c44c0ef12548bc6f00a85308ed352.png",
            "created_by": 306,
            "created_at": "2026-10-26T11:55:55.000000Z",
            "updated_at": "2026-10-26T11:55:55.000000Z",
            "deleted_at": null
        },
        {
            "id": 2,
            "name": "Rickey Stracke",
            "type": "image",
            "language": "ho",
            "file": "/tmp/7b77a83d03796e34398bb1a008fa3e42.png",
            "created_by": 307,
            "created_at": "2026-10-26T11:55:56.000000Z",
            "updated_at": "2026-10-26T11:55:56.000000Z",
            "deleted_at": null
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list tooltips",
    "code": "TOOLTIPS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/tooltips

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Response

Response Fields

items   object   
id   integer   

Tooltip ID.

name   string   

Tooltip identifier name.

type   string   

Media type.

Must be one of:
  • image
  • video
language   string   

Language code (ISO 639-1).

file   string   

File path or URL.

created_by   integer   

ID of the user who created the tooltip.

deleted_at   string   

Soft delete timestamp.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

List archived tooltips

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/tooltips/archive" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/tooltips/archive"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 3,
            "name": "Dr. Armand Kreiger",
            "type": "video",
            "language": "ts",
            "file": "/tmp/7f3dd529bfef0617716d82f3e949ea88.png",
            "created_by": 308,
            "created_at": "2026-10-26T11:55:56.000000Z",
            "updated_at": "2026-10-26T11:55:56.000000Z",
            "deleted_at": null
        },
        {
            "id": 4,
            "name": "Mr. Tyson Hessel",
            "type": "image",
            "language": "kl",
            "file": "/tmp/7c5f2785aaf86cfb8f31d793220fa90a.png",
            "created_by": 309,
            "created_at": "2026-10-26T11:55:57.000000Z",
            "updated_at": "2026-10-26T11:55:57.000000Z",
            "deleted_at": null
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage tooltips",
    "code": "TOOLTIPS:LIST_ARCHIVE:INSUFFICIENT_PERMISSION"
}

Request   

GET api/tooltips/archive

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Response

Response Fields

items   object   
id   integer   

Tooltip ID.

name   string   

Tooltip identifier name.

type   string   

Media type.

Must be one of:
  • image
  • video
language   string   

Language code (ISO 639-1).

file   string   

File path or URL.

created_by   integer   

ID of the user who created the tooltip.

deleted_at   string   

Soft delete timestamp.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Create new tooltip

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/tooltips" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=Adaline Court"\
    --form "type=image"\
    --form "language=nb"\
    --form "file=@/tmp/php8209w0" 
const url = new URL(
    "http://localhost:8000/api/tooltips"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'Adaline Court');
body.append('type', 'image');
body.append('language', 'nb');
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (201):


{
    "id": 5,
    "name": "London Bahringer",
    "type": "video",
    "language": "pi",
    "file": "/tmp/647e89665d1a925d8944f274e8bc5232.png",
    "created_by": 310,
    "created_at": "2026-10-26T11:55:57.000000Z",
    "updated_at": "2026-10-26T11:55:57.000000Z",
    "deleted_at": null
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage tooltips",
    "code": "TOOLTIPS:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (500, Server error):


{
    "message": "Server error: tooltip not created",
    "code": "TOOLTIPS:CREATE:SERVER_ERROR"
}

Request   

POST api/tooltips

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

name   string   

Tooltip name. Example: Adaline Court

type   string   

Tooltip content type. Example: image

Must be one of:
  • image
  • video
language   string   

Tooltip content language. Example: nb

file   file   

Tooltip content file. Must have one of the following MIME types: webp, png, jpg, jpeg, mp4. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/php8209w0

Response

Response Fields

id   integer   

Tooltip ID.

name   string   

Tooltip identifier name.

type   string   

Media type.

Must be one of:
  • image
  • video
language   string   

Language code (ISO 639-1).

file   string   

File path or URL.

created_by   integer   

ID of the user who created the tooltip.

deleted_at   string   

Soft delete timestamp.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Archive tooltip

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/tooltips/1/archive" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/tooltips/1/archive"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Tooltip archived",
    "code": "TOOLTIPS:ARCHIVE:ARCHIVED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage tooltips",
    "code": "TOOLTIPS:ARCHIVE:INSUFFICIENT_PERMISSION"
}

Example response (404, Tooltip not found):


{
    "message": "Tooltip not found",
    "code": "TOOLTIPS:ARCHIVE:TOOLTIP_NOT_FOUND"
}

Request   

POST api/tooltips/{id}/archive

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Tooltip ID. Example: 1

Restore archived tooltip

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/tooltips/1/restore" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/tooltips/1/restore"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Tooltip restored",
    "code": "TOOLTIPS:RESTORE:RESTORED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage tooltips",
    "code": "TOOLTIPS:RESTORE:INSUFFICIENT_PERMISSION"
}

Example response (404, Tooltip not found):


{
    "message": "Tooltip not found",
    "code": "TOOLTIPS:RESTORE:TOOLTIP_NOT_FOUND"
}

Example response (404, Tooltip is not archived):


{
    "message": "Tooltip is not archived",
    "code": "TOOLTIPS:RESTORE:TOOLTIP_NOT_ARCHIVED"
}

Request   

POST api/tooltips/{id}/restore

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Tooltip ID. Example: 1

Trainings

API endpoints for trainings

Get user trainings

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/trainings" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/trainings"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "user_id": 314,
        "training_id": 2,
        "notifications_enabled": 1,
        "created_at": "2026-10-26T11:56:00.000000Z",
        "updated_at": "2026-10-26T11:56:00.000000Z",
        "training": {
            "id": 2,
            "name": "distinctio ullam",
            "created_at": "2026-10-26T11:56:00.000000Z",
            "updated_at": "2026-10-26T11:56:00.000000Z"
        }
    },
    {
        "id": 2,
        "user_id": 315,
        "training_id": 4,
        "notifications_enabled": 1,
        "created_at": "2026-10-26T11:56:00.000000Z",
        "updated_at": "2026-10-26T11:56:00.000000Z",
        "training": {
            "id": 4,
            "name": "voluptatem perspiciatis",
            "created_at": "2026-10-26T11:56:00.000000Z",
            "updated_at": "2026-10-26T11:56:00.000000Z"
        }
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user trainings",
    "code": "TRAININGS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/trainings

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Response

Response Fields

id   integer   

User training ID.

user_id   integer   

Associated user ID.

training_id   integer   

Associated training ID.

notifications_enabled   boolean   

Whether notifications are enabled for this training.

streak   integer   

Current training streak (days).

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

training   object   

Training details.

Get trainings for specific user (clinician access)

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/trainings/user/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/trainings/user/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 3,
        "user_id": 316,
        "training_id": 6,
        "notifications_enabled": 1,
        "created_at": "2026-10-26T11:56:00.000000Z",
        "updated_at": "2026-10-26T11:56:00.000000Z",
        "training": {
            "id": 6,
            "name": "atque omnis",
            "created_at": "2026-10-26T11:56:00.000000Z",
            "updated_at": "2026-10-26T11:56:00.000000Z"
        }
    },
    {
        "id": 4,
        "user_id": 317,
        "training_id": 8,
        "notifications_enabled": 1,
        "created_at": "2026-10-26T11:56:01.000000Z",
        "updated_at": "2026-10-26T11:56:01.000000Z",
        "training": {
            "id": 8,
            "name": "labore accusamus",
            "created_at": "2026-10-26T11:56:01.000000Z",
            "updated_at": "2026-10-26T11:56:01.000000Z"
        }
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access patient training",
    "code": "TRAININGS:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "TRAININGS:LIST:USER_NOT_FOUND"
}

Request   

GET api/trainings/user/{userId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID Example: 1

Response

Response Fields

id   integer   

User training ID.

user_id   integer   

Associated user ID.

training_id   integer   

Associated training ID.

notifications_enabled   boolean   

Whether notifications are enabled for this training.

streak   integer   

Current training streak (days).

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

training   object   

Training details.

Get user badges

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/trainings/1/user-badges" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/trainings/1/user-badges"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "user_id": 318,
        "badge_id": 1,
        "created_at": "2026-10-26T11:56:01.000000Z",
        "updated_at": "2026-10-26T11:56:01.000000Z"
    },
    {
        "id": 2,
        "user_id": 319,
        "badge_id": 2,
        "created_at": "2026-10-26T11:56:02.000000Z",
        "updated_at": "2026-10-26T11:56:02.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user trainings",
    "code": "TRAININGS:BADGES:INSUFFICIENT_PERMISSION"
}

Example response (403, User has no training started):


{
    "message": "User has no training started",
    "code": "TRAININGS:BADGES:NO_USER_TRAINING"
}

Example response (404, Training not found):


{
    "message": "Training not found",
    "code": "TRAININGS:BADGES:TRAINING_NOT_FOUND"
}

Request   

GET api/trainings/{trainingId}/user-badges

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

trainingId   integer   

Training ID. Example: 1

Response

Response Fields

id   integer   

User badge record ID.

user_id   integer   

Associated user ID.

badge_id   integer   

Associated badge ID.

created_at   string   

Awarded timestamp.

updated_at   string   

Last update timestamp.

Start user training

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/trainings/start/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/trainings/start/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (201):


{
    "id": 5,
    "user_id": 320,
    "training_id": 9,
    "notifications_enabled": 1,
    "created_at": "2026-10-26T11:56:02.000000Z",
    "updated_at": "2026-10-26T11:56:02.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user trainings",
    "code": "TRAININGS:START:INSUFFICIENT_PERMISSION"
}

Example response (403, User training already started):


{
    "message": "Cannot start: training already started",
    "code": "TRAININGS:START:ALREADY_STARTED"
}

Example response (404, Training not found):


{
    "message": "Training not found",
    "code": "TRAININGS:START:TRAINING_NOT_FOUND"
}

Request   

POST api/trainings/start/{trainingId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

trainingId   integer   

Training ID. Example: 1

Response

Response Fields

id   integer   

User training ID.

user_id   integer   

Associated user ID.

training_id   integer   

Associated training ID.

notifications_enabled   boolean   

Whether notifications are enabled for this training.

streak   integer   

Current training streak (days).

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

training   object   

Training details.

Update training

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/trainings/update/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"notifications_enabled\": false
}"

const url = new URL(
    "http://localhost:8000/api/trainings/update/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "notifications_enabled": false
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 6,
    "user_id": 321,
    "training_id": 10,
    "notifications_enabled": 1,
    "created_at": "2026-10-26T11:56:03.000000Z",
    "updated_at": "2026-10-26T11:56:03.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user trainings",
    "code": "TRAININGS:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (403, User has no training started):


{
    "message": "User has no training started",
    "code": "TRAININGS:UPDATE:NO_USER_TRAINING"
}

Example response (404, Training not found):


{
    "message": "Training not found",
    "code": "TRAININGS:UPDATE:TRAINING_NOT_FOUND"
}

Request   

PUT api/trainings/update/{trainingId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

trainingId   integer   

Training ID. Example: 1

Body Parameters

notifications_enabled   boolean  optional  

Notifications (reminders) status. Example: false

Response

Response Fields

id   integer   

User training ID.

user_id   integer   

Associated user ID.

training_id   integer   

Associated training ID.

notifications_enabled   boolean   

Whether notifications are enabled for this training.

streak   integer   

Current training streak (days).

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

training   object   

Training details.

Get training progress

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/trainings/progress/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/trainings/progress/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 7,
    "user_id": 322,
    "training_id": 11,
    "notifications_enabled": 1,
    "created_at": "2026-10-26T11:56:03.000000Z",
    "updated_at": "2026-10-26T11:56:03.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user trainings",
    "code": "TRAININGS:PROGRESS:INSUFFICIENT_PERMISSION"
}

Example response (403, User has no training started):


{
    "message": "User has no training started",
    "code": "TRAININGS:PROGRESS:NO_USER_TRAINING"
}

Example response (404, Training not found):


{
    "message": "Training not found",
    "code": "TRAININGS:PROGRESS:TRAINING_NOT_FOUND"
}

Request   

GET api/trainings/progress/{trainingId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

trainingId   integer   

Training ID. Example: 1

Response

Response Fields

id   integer   

User training ID.

user_id   integer   

Associated user ID.

training_id   integer   

Associated training ID.

notifications_enabled   boolean   

Whether notifications are enabled for this training.

streak   integer   

Current training streak (days).

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

training   object   

Training details.

Mark training task done

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/trainings/1/day/2/task/3" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/trainings/1/day/2/task/3"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 8,
    "user_id": 323,
    "training_id": 12,
    "notifications_enabled": 1,
    "created_at": "2026-10-26T11:56:04.000000Z",
    "updated_at": "2026-10-26T11:56:04.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user trainings",
    "code": "TRAININGS:MARK_DONE:INSUFFICIENT_PERMISSION"
}

Example response (403, User has no training started):


{
    "message": "User has no training started",
    "code": "TRAININGS:MARK_DONE:NO_USER_TRAINING"
}

Example response (404, Training not found):


{
    "message": "Training not found",
    "code": "TRAININGS:MARK_DONE:TRAINING_NOT_FOUND"
}

Example response (404, Training day not found):


{
    "message": "Training day not found",
    "code": "TRAININGS:MARK_DONE:TRAINING_DAY_NOT_FOUND"
}

Example response (404, Training task not found):


{
    "message": "Training task not found",
    "code": "TRAININGS:MARK_DONE:TRAINING_TASK_NOT_FOUND"
}

Request   

POST api/trainings/{trainingId}/day/{trainingDayId}/task/{trainingTaskId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

trainingId   integer   

Training ID. Example: 1

trainingDayId   integer   

Training Day ID. Example: 2

trainingTaskId   integer   

Training Task ID. Example: 3

Response

Response Fields

id   integer   

User training ID.

user_id   integer   

Associated user ID.

training_id   integer   

Associated training ID.

notifications_enabled   boolean   

Whether notifications are enabled for this training.

streak   integer   

Current training streak (days).

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

training   object   

Training details.

Save training exercises attempts

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/trainings/1/day/2/task/3/attempts" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "exercises[][date_start]=1986-03-02 16:28:06"\
    --form "exercises[][date_end]=1977-03-13 13:45:27"\
    --form "exercises[][end_reason]=success"\
    --form "exercises[][config][common][fingerStrength][]=1"\
    --form "exercises[][config][common][gripPositions][_]=0"\
    --form "exercises[][config][common][gripPositions][0][initial][]=55"\
    --form "exercises[][config][common][gripPositions][0][limit][]=87"\
    --form "exercises[][config][common][gripPositions][1][initial][]=28"\
    --form "exercises[][config][common][gripPositions][1][limit][]=53"\
    --form "exercises[][config][common][gripPositions][2][initial][]=18"\
    --form "exercises[][config][common][gripPositions][2][limit][]=92"\
    --form "exercises[][config][common][gripPositions][3][initial][]=37"\
    --form "exercises[][config][common][gripPositions][3][limit][]=58"\
    --form "exercises[][config][common][gripPositions][4][initial][]=18"\
    --form "exercises[][config][common][gripPositions][4][limit][]=43"\
    --form "exercises[][config][common][gripPositions][5][initial][]=18"\
    --form "exercises[][config][common][gripPositions][5][limit][]=23"\
    --form "exercises[][config][common][gripPositions][6][initial][]=16"\
    --form "exercises[][config][common][gripPositions][6][limit][]=89"\
    --form "exercises[][config][common][gripPositions][7][initial][]=4"\
    --form "exercises[][config][common][gripPositions][7][limit][]=18"\
    --form "exercises[][config][common][gripPositions][8][initial][]=29"\
    --form "exercises[][config][common][gripPositions][8][limit][]=87"\
    --form "exercises[][config][common][gripPositions][9][initial][]=40"\
    --form "exercises[][config][common][gripPositions][9][limit][]=41"\
    --form "exercises[][config][common][gripPositions][10][initial][]=4"\
    --form "exercises[][config][common][gripPositions][10][limit][]=47"\
    --form "exercises[][config][common][gripPositions][11][initial][]=14"\
    --form "exercises[][config][common][gripPositions][11][limit][]=19"\
    --form "exercises[][config][common][gripPositions][12][initial][]=46"\
    --form "exercises[][config][common][gripPositions][12][limit][]=75"\
    --form "exercises[][config][common][gripPositions][13][initial][]=5"\
    --form "exercises[][config][common][gripPositions][13][limit][]=13"\
    --form "exercises[][config][common][inputSite][]=1"\
    --form "exercises[][config][modes][][id]=83"\
    --form "exercises[][config][modes][][name]=Quidem eveniet perspiciatis ut nam."\
    --form "exercises[][config][modes][][slot]=0"\
    --form "exercises[][config][modes][][config][autoGrasp][]=1"\
    --form "exercises[][config][modes][][config][coContractionTimings][]=400"\
    --form "exercises[][config][modes][][config][controlMode][]=0"\
    --form "exercises[][config][modes][][config][emgGains][]=100"\
    --form "exercises[][config][modes][][config][emgSpike][]=1"\
    --form "exercises[][config][modes][][config][emgThresholds][]=40"\
    --form "exercises[][config][modes][][config][gripPairsConfig][]=10"\
    --form "exercises[][config][modes][][config][gripSequentialConfig][]=3"\
    --form "exercises[][config][modes][][config][gripSwitchingMode][]=3"\
    --form "exercises[][config][modes][][config][holdOpen][]=1500"\
    --form "exercises[][config][modes][][config][pulseTimings][]=560"\
    --form "exercises[][config][modes][][config][softGrip][]=0"\
    --form "exercises[][config][modes][][config][speedControlStrategy][]=0"\
    --form "exercises[][firmware_id]=9573"\
    --form "exercises[][app_version]=4.82.12"\
    --form "exercises[][attempts][][date_start]=1978-05-26 17:17:27"\
    --form "exercises[][attempts][][date_end]=1990-10-18 14:27:49"\
    --form "exercises[][attempts][][result]=failure"\
    --form "exercises[][emg_file]=@/tmp/phpznaEgi" 
const url = new URL(
    "http://localhost:8000/api/trainings/1/day/2/task/3/attempts"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('exercises[][date_start]', '1986-03-02 16:28:06');
body.append('exercises[][date_end]', '1977-03-13 13:45:27');
body.append('exercises[][end_reason]', 'success');
body.append('exercises[][config][common][fingerStrength][]', '1');
body.append('exercises[][config][common][gripPositions][_]', '0');
body.append('exercises[][config][common][gripPositions][0][initial][]', '55');
body.append('exercises[][config][common][gripPositions][0][limit][]', '87');
body.append('exercises[][config][common][gripPositions][1][initial][]', '28');
body.append('exercises[][config][common][gripPositions][1][limit][]', '53');
body.append('exercises[][config][common][gripPositions][2][initial][]', '18');
body.append('exercises[][config][common][gripPositions][2][limit][]', '92');
body.append('exercises[][config][common][gripPositions][3][initial][]', '37');
body.append('exercises[][config][common][gripPositions][3][limit][]', '58');
body.append('exercises[][config][common][gripPositions][4][initial][]', '18');
body.append('exercises[][config][common][gripPositions][4][limit][]', '43');
body.append('exercises[][config][common][gripPositions][5][initial][]', '18');
body.append('exercises[][config][common][gripPositions][5][limit][]', '23');
body.append('exercises[][config][common][gripPositions][6][initial][]', '16');
body.append('exercises[][config][common][gripPositions][6][limit][]', '89');
body.append('exercises[][config][common][gripPositions][7][initial][]', '4');
body.append('exercises[][config][common][gripPositions][7][limit][]', '18');
body.append('exercises[][config][common][gripPositions][8][initial][]', '29');
body.append('exercises[][config][common][gripPositions][8][limit][]', '87');
body.append('exercises[][config][common][gripPositions][9][initial][]', '40');
body.append('exercises[][config][common][gripPositions][9][limit][]', '41');
body.append('exercises[][config][common][gripPositions][10][initial][]', '4');
body.append('exercises[][config][common][gripPositions][10][limit][]', '47');
body.append('exercises[][config][common][gripPositions][11][initial][]', '14');
body.append('exercises[][config][common][gripPositions][11][limit][]', '19');
body.append('exercises[][config][common][gripPositions][12][initial][]', '46');
body.append('exercises[][config][common][gripPositions][12][limit][]', '75');
body.append('exercises[][config][common][gripPositions][13][initial][]', '5');
body.append('exercises[][config][common][gripPositions][13][limit][]', '13');
body.append('exercises[][config][common][inputSite][]', '1');
body.append('exercises[][config][modes][][id]', '83');
body.append('exercises[][config][modes][][name]', 'Quidem eveniet perspiciatis ut nam.');
body.append('exercises[][config][modes][][slot]', '0');
body.append('exercises[][config][modes][][config][autoGrasp][]', '1');
body.append('exercises[][config][modes][][config][coContractionTimings][]', '400');
body.append('exercises[][config][modes][][config][controlMode][]', '0');
body.append('exercises[][config][modes][][config][emgGains][]', '100');
body.append('exercises[][config][modes][][config][emgSpike][]', '1');
body.append('exercises[][config][modes][][config][emgThresholds][]', '40');
body.append('exercises[][config][modes][][config][gripPairsConfig][]', '10');
body.append('exercises[][config][modes][][config][gripSequentialConfig][]', '3');
body.append('exercises[][config][modes][][config][gripSwitchingMode][]', '3');
body.append('exercises[][config][modes][][config][holdOpen][]', '1500');
body.append('exercises[][config][modes][][config][pulseTimings][]', '560');
body.append('exercises[][config][modes][][config][softGrip][]', '0');
body.append('exercises[][config][modes][][config][speedControlStrategy][]', '0');
body.append('exercises[][firmware_id]', '9573');
body.append('exercises[][app_version]', '4.82.12');
body.append('exercises[][attempts][][date_start]', '1978-05-26 17:17:27');
body.append('exercises[][attempts][][date_end]', '1990-10-18 14:27:49');
body.append('exercises[][attempts][][result]', 'failure');
body.append('exercises[][emg_file]', document.querySelector('input[name="exercises[][emg_file]"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "user_id": 324,
        "training_task_id": 1,
        "date_start": "2006-01-09 04:15:41",
        "date_end": "2007-04-28 06:56:13",
        "end_reason": "ticketCreated",
        "config": "{\"common\":{\"fingerStrength\":[1,500],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[42,1,85,6,31],\"limit\":[51,35,90,61,63]},\"1\":{\"initial\":[13,18,15,12,15],\"limit\":[24,80,47,92,19]},\"2\":{\"initial\":[44,62,16,41,8],\"limit\":[83,77,77,92,81]},\"3\":{\"initial\":[3,8,66,45,8],\"limit\":[76,25,70,64,38]},\"4\":{\"initial\":[4,6,35,59,33],\"limit\":[29,82,71,92,77]},\"5\":{\"initial\":[38,7,37,78,3],\"limit\":[81,10,74,92,75]},\"6\":{\"initial\":[16,78,4,23,7],\"limit\":[78,90,55,88,11]},\"7\":{\"initial\":[11,46,59,87,14],\"limit\":[83,48,65,95,33]},\"8\":{\"initial\":[26,34,72,50,65],\"limit\":[51,69,93,83,74]},\"9\":{\"initial\":[15,19,47,27,67],\"limit\":[65,61,91,42,93]},\"10\":{\"initial\":[38,8,50,3,31],\"limit\":[44,56,77,36,39]},\"11\":{\"initial\":[77,72,63,67,37],\"limit\":[95,94,84,68,51]},\"12\":{\"initial\":[60,26,49,21,25],\"limit\":[73,67,70,26,54]},\"13\":{\"initial\":[35,4,12,45,70],\"limit\":[90,52,17,95,91]}},\"inputSite\":[0]},\"modes\":[{\"id\":86,\"name\":\"Rerum tenetur quasi ut eos officiis.\",\"slot\":0,\"config\":{\"autoGrasp\":[1,100],\"coContractionTimings\":[200,100],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[0,20,10,0,100,100,10,20,100,60],\"gripPairsConfig\":[6,9,2,10,5,3,4,12],\"gripSequentialConfig\":[1,3,255,4,6,255,13,10,12,255,255,2],\"gripSwitchingMode\":[1],\"holdOpen\":[2000,2000],\"pulseTimings\":[920,960,650,700],\"softGrip\":[0],\"speedControlStrategy\":[1]}},{\"id\":87,\"name\":\"Excepturi distinctio saepe hic officia iure sed voluptatibus.\",\"slot\":1,\"config\":{\"autoGrasp\":[0,0],\"coContractionTimings\":[200,100],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[70,80,70,90,40,0,80,90,80,50],\"gripPairsConfig\":[8,1,4,12,10,6,2,13],\"gripSequentialConfig\":[6,11,3,8,12,255,1,5,2,9,255,13],\"gripSwitchingMode\":[2],\"holdOpen\":[2000,2500],\"pulseTimings\":[650,270,720,350],\"softGrip\":[0],\"speedControlStrategy\":[1]}},{\"id\":88,\"name\":\"Magnam et ullam harum non.\",\"slot\":2,\"config\":{\"autoGrasp\":[1,100],\"coContractionTimings\":[500,100],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[100,0,100,0,20,30,30,40,30,80],\"gripPairsConfig\":[12,10,2,1,4,13,6,3],\"gripSequentialConfig\":[9,10,4,255,8,1,255,2,11,5,7,12],\"gripSwitchingMode\":[2],\"holdOpen\":[2000,2500],\"pulseTimings\":[620,1000,980,450],\"softGrip\":[1],\"speedControlStrategy\":[0]}}]}",
        "firmware_id": 24,
        "app_version": "7.60.1",
        "emg_file": "/tmp/fakerWLiqaJ",
        "created_at": "2026-10-26T11:56:04.000000Z",
        "updated_at": "2026-10-26T11:56:04.000000Z",
        "attempts": [
            {
                "id": 1,
                "training_log_id": 1,
                "date_start": "2024-09-06 04:24:38",
                "date_end": "1973-01-27 12:11:45",
                "result": "failure",
                "created_at": "2026-10-26T11:56:05.000000Z",
                "updated_at": "2026-10-26T11:56:05.000000Z"
            }
        ]
    },
    {
        "id": 3,
        "user_id": 326,
        "training_task_id": 3,
        "date_start": "2014-11-28 20:22:37",
        "date_end": "2025-11-29 09:25:19",
        "end_reason": "ticketCreated",
        "config": "{\"common\":{\"fingerStrength\":[1,100],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[28,57,42,75,81],\"limit\":[42,58,76,84,86]},\"1\":{\"initial\":[82,24,27,70,7],\"limit\":[94,83,83,93,67]},\"2\":{\"initial\":[45,65,35,34,26],\"limit\":[66,75,41,57,41]},\"3\":{\"initial\":[23,63,23,69,19],\"limit\":[63,75,53,80,29]},\"4\":{\"initial\":[2,3,79,6,54],\"limit\":[31,18,92,49,58]},\"5\":{\"initial\":[1,11,50,58,25],\"limit\":[14,45,56,70,63]},\"6\":{\"initial\":[21,9,16,41,57],\"limit\":[92,34,69,73,87]},\"7\":{\"initial\":[46,13,19,26,69],\"limit\":[88,82,32,61,90]},\"8\":{\"initial\":[6,34,61,40,8],\"limit\":[7,34,84,66,27]},\"9\":{\"initial\":[16,18,59,17,40],\"limit\":[42,56,94,24,85]},\"10\":{\"initial\":[39,17,36,32,6],\"limit\":[63,90,88,59,27]},\"11\":{\"initial\":[11,48,28,21,5],\"limit\":[89,90,95,51,47]},\"12\":{\"initial\":[11,40,60,8,47],\"limit\":[28,61,86,57,56]},\"13\":{\"initial\":[30,66,3,3,55],\"limit\":[35,91,9,58,82]}},\"inputSite\":[0]},\"modes\":[{\"id\":92,\"name\":\"Minima facilis et nam aut deserunt dolorem.\",\"slot\":0,\"config\":{\"autoGrasp\":[0,0],\"coContractionTimings\":[300,100],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[50,70,70,100,20,20,60,10,10,0],\"gripPairsConfig\":[13,6,4,8,1,10,11,2],\"gripSequentialConfig\":[255,9,255,5,10,8,1,3,4,12,13,7],\"gripSwitchingMode\":[1],\"holdOpen\":[1500,1500],\"pulseTimings\":[460,90,670,780],\"softGrip\":[0],\"speedControlStrategy\":[1]}},{\"id\":93,\"name\":\"A error sit unde vero.\",\"slot\":1,\"config\":{\"autoGrasp\":[0,100],\"coContractionTimings\":[400,100],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[20,30,30,40,40,40,0,70,90,30],\"gripPairsConfig\":[8,1,11,7,3,10,9,2],\"gripSequentialConfig\":[11,2,4,255,6,10,12,255,255,255,5,255],\"gripSwitchingMode\":[3],\"holdOpen\":[1500,2000],\"pulseTimings\":[40,880,210,230],\"softGrip\":[1],\"speedControlStrategy\":[1]}},{\"id\":94,\"name\":\"Explicabo cumque ipsa aliquam et ut.\",\"slot\":2,\"config\":{\"autoGrasp\":[1,100],\"coContractionTimings\":[200,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[60,90,20,80,50,20,10,40,80,30],\"gripPairsConfig\":[3,10,6,11,4,7,12,8],\"gripSequentialConfig\":[4,1,255,255,13,5,255,10,12,8,255,255],\"gripSwitchingMode\":[3],\"holdOpen\":[1500,2500],\"pulseTimings\":[600,360,460,430],\"softGrip\":[1],\"speedControlStrategy\":[0]}}]}",
        "firmware_id": 26,
        "app_version": "8.83.33",
        "emg_file": "/tmp/fakerMlPZfz",
        "created_at": "2026-10-26T11:56:05.000000Z",
        "updated_at": "2026-10-26T11:56:05.000000Z",
        "attempts": [
            {
                "id": 2,
                "training_log_id": 3,
                "date_start": "2005-01-25 05:54:12",
                "date_end": "2003-08-30 00:23:10",
                "result": "success",
                "created_at": "2026-10-26T11:56:06.000000Z",
                "updated_at": "2026-10-26T11:56:06.000000Z"
            }
        ]
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user trainings",
    "code": "TRAININGS:SAVE_ATTEMPTS:INSUFFICIENT_PERMISSION"
}

Example response (403, User has no training started):


{
    "message": "User has no training started",
    "code": "TRAININGS:SAVE_ATTEMPTS:NO_USER_TRAINING"
}

Example response (404, Training not found):


{
    "message": "Training not found",
    "code": "TRAININGS:SAVE_ATTEMPTS:TRAINING_NOT_FOUND"
}

Example response (404, Training day not found):


{
    "message": "Training day not found",
    "code": "TRAININGS:SAVE_ATTEMPTS:TRAINING_DAY_NOT_FOUND"
}

Example response (404, Training task not found):


{
    "message": "Training task not found",
    "code": "TRAININGS:SAVE_ATTEMPTS:TRAINING_TASK_NOT_FOUND"
}

Request   

POST api/trainings/{trainingId}/day/{trainingDayId}/task/{trainingTaskId}/attempts

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

trainingId   integer   

Training ID. Example: 1

trainingDayId   integer   

Training Day ID. Example: 2

trainingTaskId   integer   

Training Task ID. Example: 3

Body Parameters

exercises   object[]  optional  
date_start   string   

Exercise start date. MUST_BE_DATE. Example: 1986-03-02 16:28:06

date_end   string  optional  

Exercise end date. MUST_BE_DATE. Example: 1977-03-13 13:45:27

end_reason   string  optional  

Exercise end reason. Example: success

Must be one of:
  • success
  • back
  • ticketCreated
  • fail
  • null
config   string   

Device config during exercise.

firmware_id   integer   

Device Firmware Version ID during exercise. The id of an existing record in the App\Models\FirmwareVersion table. Example: 9573

app_version   string   

Mobile app version during exercise. Example: 4.82.12

emg_file   file  optional  

EMG file created during exercise. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpznaEgi

attempts   object[]  optional  
date_start   string   

Exercise attempt start date. MUST_BE_DATE. Example: 1978-05-26 17:17:27

date_end   string   

Exercise attempt end date. MUST_BE_DATE. Example: 1990-10-18 14:27:49

result   string   

Exercise attempt result. Example: failure

Must be one of:
  • success
  • failure

Response

Response Fields

id   integer   

Training log entry ID.

user_id   integer   

Associated user ID.

training_task_id   integer   

Associated training task ID.

date_start   string   

Session start datetime.

date_end   string   

Session end datetime.

end_reason   string   

Reason the session ended.

config   string   

Device config snapshot at time of session.

firmware_id   integer   

Firmware version ID used during session.

app_version   string   

App version used during session.

emg_file   string   

EMG data file URL.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

attempts   object[]   

Training log attempts.

Get reward status

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/trainings/1/reward" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/trainings/1/reward"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, Reward status):


{
    "status": true
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user trainings",
    "code": "TRAININGS:REWARD_STATUS:INSUFFICIENT_PERMISSION"
}

Example response (404, Training not found):


{
    "message": "Training not found",
    "code": "TRAININGS:REWARD_STATUS:TRAINING_NOT_FOUND"
}

Request   

GET api/trainings/{trainingId}/reward

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

trainingId   integer   

Training ID. Example: 1

Save reward details

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/trainings/1/reward" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"digital\",
    \"country\": \"CY\",
    \"delivery\": \"home_delivery\",
    \"email\": \"eryn08@rowe.com\",
    \"phone\": \"+1-726-525-9429\",
    \"full_name\": \"Amaya Ward\",
    \"address1\": \"22831 Keebler Stream\",
    \"address2\": \"Apt. 526\",
    \"city\": \"Luettgenport\",
    \"postal_code\": \"75063-5139\",
    \"state\": \"ET\",
    \"parcel_locker_code\": \"YGX9XHPS\",
    \"pin_code\": \"890490\"
}"

const url = new URL(
    "http://localhost:8000/api/trainings/1/reward"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "digital",
    "country": "CY",
    "delivery": "home_delivery",
    "email": "eryn08@rowe.com",
    "phone": "+1-726-525-9429",
    "full_name": "Amaya Ward",
    "address1": "22831 Keebler Stream",
    "address2": "Apt. 526",
    "city": "Luettgenport",
    "postal_code": "75063-5139",
    "state": "ET",
    "parcel_locker_code": "YGX9XHPS",
    "pin_code": "890490"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "user_id": 328,
    "training_id": 21,
    "type": "digital",
    "country": "LT",
    "delivery": "home_delivery",
    "email": "kendra.hyatt@koelpin.com",
    "phone": "+1.520.672.4628",
    "full_name": "Lucie Eichmann",
    "address1": "19775 Huels Pine Apt. 098",
    "address2": "18333 Pierre Grove Apt. 875\nToytown, OR 02065-2985",
    "city": "Vincetown",
    "postal_code": "68786-8641",
    "state": "QUISQUAM",
    "parcel_locker_code": "7S8J9Q9A",
    "pin_code": "685910",
    "created_at": "2026-10-26T11:56:06.000000Z",
    "updated_at": "2026-10-26T11:56:06.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user trainings",
    "code": "TRAININGS:REWARD_SAVE:INSUFFICIENT_PERMISSION"
}

Example response (403, Reward details already exists):


{
    "message": "Reward details already exists",
    "code": "TRAININGS:REWARD_SAVE:ALREADY_EXISTS"
}

Example response (404, Training not found):


{
    "message": "Training not found",
    "code": "TRAININGS:REWARD_SAVE:TRAINING_NOT_FOUND"
}

Request   

POST api/trainings/{trainingId}/reward

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

trainingId   integer   

Training ID. Example: 1

Body Parameters

type   string   

Reward type. Example: digital

Must be one of:
  • digital
  • physical
country   string   

Country code. SIZE:STRING_LENGTH:2. Example: CY

Must be one of:
  • AF
  • AX
  • AL
  • DZ
  • AS
  • AD
  • AO
  • AI
  • AQ
  • AG
  • AR
  • AM
  • AW
  • AU
  • AT
  • AZ
  • BS
  • BH
  • BD
  • BB
  • BY
  • BE
  • BZ
  • BJ
  • BM
  • BT
  • BO
  • BQ
  • BA
  • BW
  • BV
  • BR
  • IO
  • BN
  • BG
  • BF
  • BI
  • CV
  • KH
  • CM
  • CA
  • KY
  • CF
  • TD
  • CL
  • CN
  • CX
  • CC
  • CO
  • KM
  • CD
  • CG
  • CK
  • CR
  • CI
  • HR
  • CU
  • CW
  • CY
  • CZ
  • DK
  • DJ
  • DM
  • DO
  • EC
  • EG
  • SV
  • GQ
  • ER
  • EE
  • SZ
  • ET
  • FK
  • FO
  • FJ
  • FI
  • FR
  • GF
  • PF
  • TF
  • GA
  • GM
  • GE
  • DE
  • GH
  • GI
  • GR
  • GL
  • GD
  • GP
  • GU
  • GT
  • GG
  • GN
  • GW
  • GY
  • HT
  • HM
  • VA
  • HN
  • HK
  • HU
  • IS
  • IN
  • ID
  • IR
  • IQ
  • IE
  • IM
  • IL
  • IT
  • JM
  • JP
  • JE
  • JO
  • KZ
  • KE
  • KI
  • KP
  • KR
  • KW
  • KG
  • LA
  • LV
  • LB
  • LS
  • LR
  • LY
  • LI
  • LT
  • LU
  • MO
  • MG
  • MW
  • MY
  • MV
  • ML
  • MT
  • MH
  • MQ
  • MR
  • MU
  • YT
  • MX
  • FM
  • MD
  • MC
  • MN
  • ME
  • MS
  • MA
  • MZ
  • MM
  • NA
  • NR
  • NP
  • NL
  • NC
  • NZ
  • NI
  • NE
  • NG
  • NU
  • NF
  • MK
  • MP
  • NO
  • OM
  • PK
  • PW
  • PS
  • PA
  • PG
  • PY
  • PE
  • PH
  • PN
  • PL
  • PT
  • PR
  • QA
  • RE
  • RO
  • RU
  • RW
  • BL
  • SH
  • KN
  • LC
  • MF
  • PM
  • VC
  • WS
  • SM
  • ST
  • SA
  • SN
  • RS
  • SC
  • SL
  • SG
  • SX
  • SK
  • SI
  • SB
  • SO
  • ZA
  • GS
  • SS
  • ES
  • LK
  • SD
  • SR
  • SJ
  • SE
  • CH
  • SY
  • TW
  • TJ
  • TZ
  • TH
  • TL
  • TG
  • TK
  • TO
  • TT
  • TN
  • TR
  • TM
  • TC
  • TV
  • UG
  • UA
  • AE
  • GB
  • UM
  • US
  • UY
  • UZ
  • VU
  • VE
  • VN
  • VG
  • VI
  • WF
  • EH
  • YE
  • ZM
  • ZW
delivery   string  optional  

Delivery method. Default: home_delivery. Example: home_delivery

Must be one of:
  • home_delivery
  • pl_inpost_parcel_locker
  • ua_nova_poshta_branch_pickup
  • ua_nova_poshta_parcel_locker
email   string   

Contact email. MUST_BE_EMAIL. Example: eryn08@rowe.com

phone   string   

Contact phone. Example: +1-726-525-9429

full_name   string   

Full name. Example: Amaya Ward

address1   string  optional  

Address line 1. Example: 22831 Keebler Stream

address2   string  optional  

Address line 2. Example: Apt. 526

city   string  optional  

City. Example: Luettgenport

postal_code   string  optional  

Postal code/ZIP code/Postcode. Example: 75063-5139

state   string  optional  

State/Province. Example: ET

parcel_locker_code   string  optional  

Parcel locker code/Branch pickup number (for: InPost parcel locker, Nova Poshta branch pickup, Nova Poshta parcel locker). Example: YGX9XHPS

pin_code   string  optional  

PIN code (India delivery). Example: 890490

Response

Response Fields

id   integer   

User reward ID.

user_id   integer   

Associated user ID.

training_id   integer   

Associated training ID.

type   string   

Reward type.

Must be one of:
  • digital
  • physical
country   string   

Delivery country code.

delivery   string   

Delivery method.

Must be one of:
  • home_delivery
  • parcel_locker
email   string   

Recipient email.

phone   string   

Recipient phone.

full_name   string   

Recipient full name.

address1   string   

Delivery address line 1.

address2   string   

Delivery address line 2.

city   string   

Delivery city.

postal_code   string   

Delivery postal code.

state   string   

Delivery state.

parcel_locker_code   string   

Parcel locker code.

pin_code   string   

PIN code for delivery.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Get user progress (clinician view)

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/trainings/progress/repellat/user/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/trainings/progress/repellat/user/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


[
    {
        "number": 1,
        "key": "openClose",
        "status": "completed",
        "status_updated_at": "2026-02-04 11:00:00"
    },
    {
        "number": 2,
        "key": "holdOpen",
        "status": "in_progress",
        "status_updated_at": "2026-02-05 09:00:00"
    },
    {
        "number": 3,
        "key": "changeSignal",
        "status": "not_started",
        "status_updated_at": null
    },
    {
        "number": 4,
        "key": "thumbPositioning",
        "status": "not_started",
        "status_updated_at": null
    },
    {
        "number": 5,
        "key": "sequentialAndPairingMode",
        "status": "not_started",
        "status_updated_at": null
    },
    {
        "number": 6,
        "key": "fingerSpeedTraining",
        "status": "not_started",
        "status_updated_at": null
    },
    {
        "number": 7,
        "key": "freezeMode",
        "status": "not_started",
        "status_updated_at": null
    },
    {
        "number": 8,
        "key": "coreSkillsTest",
        "status": "not_started",
        "status_updated_at": null
    },
    {
        "number": 9,
        "key": "powerSoftGrip",
        "status": "not_started",
        "status_updated_at": null
    },
    {
        "number": 10,
        "key": "precisionGrip",
        "status": "not_started",
        "status_updated_at": null
    },
    {
        "number": 11,
        "key": "tripodGrip",
        "status": "not_started",
        "status_updated_at": null
    },
    {
        "number": 12,
        "key": "keyGrip",
        "status": "not_started",
        "status_updated_at": null
    },
    {
        "number": 13,
        "key": "gripSelection",
        "status": "not_started",
        "status_updated_at": null
    },
    {
        "number": 14,
        "key": "finalGripAndControlTest",
        "status": "not_started",
        "status_updated_at": null
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access patient training",
    "code": "TRAININGS:PROGRESS_CLINICIAN:INSUFFICIENT_PERMISSION"
}

Example response (404, Training not found):


{
    "message": "Training not found",
    "code": "TRAININGS:PROGRESS_CLINICIAN:TRAINING_NOT_FOUND"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "TRAININGS:PROGRESS_CLINICIAN:USER_NOT_FOUND"
}

Request   

GET api/trainings/progress/{trainingId}/user/{userId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

trainingId   string   

Example: repellat

userId   integer   

User ID. Example: 1

User preferences

API endpoints for user preferences

List user preferences

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/preferences" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/preferences"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


{
    "preference1": "value1",
    "preference2": null,
    "preference3": 1
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user preferences",
    "code": "USERS_PREFERENCES:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/preferences

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get user preference

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/preferences/sidebar_enabled" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/preferences/sidebar_enabled"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "user_id": 329,
    "name": "SandyBrown",
    "value": "1",
    "created_at": "2026-10-26T11:56:07.000000Z",
    "updated_at": "2026-10-26T11:56:07.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user preferences",
    "code": "USERS_PREFERENCES:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, User preference not found):


{
    "message": "User preference not found",
    "code": "USERS_PREFERENCES:GET:NOT_FOUND"
}

Request   

GET api/preferences/{name}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

name   string   

Preference name. Example: sidebar_enabled

Set user preference

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/preferences" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"sidebar_enabled\",
    \"value\": \"1\"
}"

const url = new URL(
    "http://localhost:8000/api/preferences"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "sidebar_enabled",
    "value": "1"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 2,
    "user_id": 330,
    "name": "Violet",
    "value": "0",
    "created_at": "2026-10-26T11:56:08.000000Z",
    "updated_at": "2026-10-26T11:56:08.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user preferences",
    "code": "USERS_PREFERENCES:SET:INSUFFICIENT_PERMISSION"
}

Request   

POST api/preferences

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Preference name. Example: sidebar_enabled

value   string   

Preference value. Example: 1

Users

API endpoints for user management

Get users list

requires authentication

Possible extend options:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/users?search=Tom&active=-1&clinician[]=2&roles=Clinician%2CAmputee&has_devices=1&user_toggles=goals%2Ctrainings" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/users"
);

const params = {
    "search": "Tom",
    "active": "-1",
    "clinician[0]": "2",
    "roles": "Clinician,Amputee",
    "has_devices": "1",
    "user_toggles": "goals,trainings",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 7,
            "mrn": "KNAL7TRB1793015593",
            "name": "Ms. Willa Krajcik Jr.",
            "email": "1793015593robbie45@example.net",
            "language": "en",
            "phone": "+1-636-201-7916",
            "phone_country": "SZ",
            "phone_verified_at": null,
            "address1": "29509 Fadel Inlet",
            "address2": "Lake Else, ND 28391-8555",
            "postal_code": "95860-0134",
            "city": "Dicki, Russel and Schumm",
            "country": "EE",
            "clinic_name": "New Kelsifurt",
            "clinic_location": "342 Hammes Fords Suite 592\nNorth Margaretborough, TN 83028",
            "image": null,
            "public_image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "is_ambassador": 0,
            "test_account": false,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2026-10-26T11:53:13.000000Z",
            "updated_at": "2026-10-26T11:53:13.000000Z",
            "invitation_status": null,
            "acadle_invitation_status": null,
            "clinicians": [
                {
                    "id": 8,
                    "mrn": "LXHGLQTE1793015593",
                    "name": "Adell Schmitt Jr.",
                    "email": "1793015593kennith.leannon@example.org",
                    "language": "en",
                    "phone": "(941) 401-0972",
                    "phone_country": "MN",
                    "phone_verified_at": null,
                    "address1": "35415 Unique Overpass Apt. 338",
                    "address2": "Port Elody, KS 06952-8146",
                    "postal_code": "84525-9107",
                    "city": "Oberbrunner Ltd",
                    "country": "FI",
                    "clinic_name": "Deckowshire",
                    "clinic_location": "49630 Williamson Centers\nWest Rhett, CT 18310-4000",
                    "image": null,
                    "public_image": null,
                    "mfa_enabled": 0,
                    "mfa_method": null,
                    "mfa_verified_to": null,
                    "location_id": null,
                    "created_by": null,
                    "active": 1,
                    "is_ambassador": 0,
                    "test_account": false,
                    "notifications_timezone": null,
                    "notifications_at": null,
                    "created_at": "2026-10-26T11:53:13.000000Z",
                    "updated_at": "2026-10-26T11:53:13.000000Z",
                    "invitation_status": null,
                    "acadle_invitation_status": null,
                    "pivot": {
                        "user_id": 7,
                        "assigned_user_id": 8
                    },
                    "roles": []
                }
            ],
            "devices": [
                {
                    "id": 1,
                    "serial": "a7e37b9d-4e8a-3577-a947-40936714a5e6",
                    "bluetooth_id": "e73bcaec-0a70-31d2-9b10-a350a5f3290f",
                    "company_id": null,
                    "model_id": null,
                    "amputee_id": 7,
                    "clinician_id": null,
                    "firmware_version_id": null,
                    "pcb_version_id": null,
                    "reverse_magnets": 0,
                    "is_electrode": 0,
                    "active": 1,
                    "last_activity_at": "0000-00-00 00:00:00",
                    "first_connected_at": null,
                    "measurements": null,
                    "created_at": "2026-10-26T11:53:14.000000Z",
                    "updated_at": "2026-10-26T11:53:14.000000Z",
                    "first_config_change_at": null
                }
            ],
            "roles": [
                {
                    "id": 6,
                    "name": "Amputee"
                }
            ]
        },
        {
            "id": 9,
            "mrn": "SK786BP81793015594",
            "name": "Dr. Ken Hayes",
            "email": "1793015594harber.godfrey@example.org",
            "language": "en",
            "phone": "+19042612811",
            "phone_country": "MR",
            "phone_verified_at": null,
            "address1": "44257 Jackson Prairie",
            "address2": "Greenholtside, MS 07119",
            "postal_code": "39915-0251",
            "city": "Waelchi-Pagac",
            "country": "SK",
            "clinic_name": "Oceanemouth",
            "clinic_location": "3735 Gillian Neck Suite 783\nQuitzonmouth, VA 15831",
            "image": null,
            "public_image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "is_ambassador": 0,
            "test_account": false,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2026-10-26T11:53:14.000000Z",
            "updated_at": "2026-10-26T11:53:14.000000Z",
            "invitation_status": "accepted",
            "acadle_invitation_status": null,
            "clinicians": [
                {
                    "id": 10,
                    "mrn": "6C9Z72M41793015594",
                    "name": "Bertrand Bins DVM",
                    "email": "1793015594itzel18@example.org",
                    "language": "en",
                    "phone": "+1-847-695-4972",
                    "phone_country": "VE",
                    "phone_verified_at": null,
                    "address1": "132 Jo Mountain Suite 976",
                    "address2": "South Kevinchester, NH 27370",
                    "postal_code": "39937",
                    "city": "Will, Boyer and Jast",
                    "country": "LV",
                    "clinic_name": "West Skyeberg",
                    "clinic_location": "371 Carter Pine Apt. 458\nPort Damienville, VT 64028",
                    "image": null,
                    "public_image": null,
                    "mfa_enabled": 0,
                    "mfa_method": null,
                    "mfa_verified_to": null,
                    "location_id": null,
                    "created_by": null,
                    "active": 1,
                    "is_ambassador": 0,
                    "test_account": false,
                    "notifications_timezone": null,
                    "notifications_at": null,
                    "created_at": "2026-10-26T11:53:15.000000Z",
                    "updated_at": "2026-10-26T11:53:15.000000Z",
                    "invitation_status": null,
                    "acadle_invitation_status": null,
                    "pivot": {
                        "user_id": 9,
                        "assigned_user_id": 10
                    },
                    "roles": []
                }
            ],
            "devices": [
                {
                    "id": 2,
                    "serial": "91429498-b88b-3caa-ba83-76b418914258",
                    "bluetooth_id": "a3e7233c-88f3-3715-9076-0974d7206d76",
                    "company_id": null,
                    "model_id": null,
                    "amputee_id": 9,
                    "clinician_id": null,
                    "firmware_version_id": null,
                    "pcb_version_id": null,
                    "reverse_magnets": 0,
                    "is_electrode": 0,
                    "active": 1,
                    "last_activity_at": "0000-00-00 00:00:00",
                    "first_connected_at": null,
                    "measurements": null,
                    "created_at": "2026-10-26T11:53:15.000000Z",
                    "updated_at": "2026-10-26T11:53:15.000000Z",
                    "first_config_change_at": null
                }
            ],
            "roles": [
                {
                    "id": 4,
                    "name": "Clinician"
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view user list",
    "code": "USERS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/users

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

search   string  optional  

Filter users by name. For SuperAdmin role it filters by UUID. Example: Tom

active   integer  optional  

Filter users by active status (available: 0 - only inactive, 1 - only active, -1 - all users). Default: 1. Example: -1

clinician   integer[]  optional  

Filter users by clinician. Provide single ID (clinician=1), array of IDs (clinician[]=1&clinician[]=2) or comma-separated list of IDs (clinician=1,2).

roles   string  optional  

Filter users by roles (comma-separated). Example: Clinician,Amputee

has_devices   integer  optional  

Filter users who has at least one device assigned. Example: 1

user_toggles   string  optional  

Filter users by their user-specific product toggles (comma-separated). Example: goals,trainings

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: clinicians, patients, devices, devices.model, devicesAsClinician, devicesAsClinician.model, roles, permissions, userToggles).

sortby   string  optional  

Sort by field (available: user_mrn, user_name, role_name, date). Default: date, desc.

sortdir   string  optional  

Sort direction (available: asc, desc).

Response

Response Fields

items   object   
id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Get current user data

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/me" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/me"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 11,
    "mrn": "84TPDHTF1793015595",
    "name": "Jess Russel",
    "email": "1793015595qyost@example.net",
    "language": "en",
    "phone": "+1 (219) 386-4587",
    "phone_country": "MZ",
    "phone_verified_at": null,
    "address1": "7532 Edwina Flat Apt. 326",
    "address2": "Wiegandport, OH 05295",
    "postal_code": "21567-8198",
    "city": "Walsh Ltd",
    "country": "CY",
    "clinic_name": "Sydnishire",
    "clinic_location": "4442 Parker Oval\nSouth Zechariahberg, WI 92740-7465",
    "image": null,
    "public_image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "is_ambassador": 0,
    "test_account": false,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2026-10-26T11:53:15.000000Z",
    "updated_at": "2026-10-26T11:53:15.000000Z",
    "invitation_status": "accepted",
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 5,
            "name": "ClinicianSupport"
        }
    ]
}

Request   

GET api/me

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

extend   string  optional  

Comma-separated list of relation extensions (available: clinicians, patients, devices, devicesAsClinician, roles, permissions).

Response

Response Fields

id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

Get other user data

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/user/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/user/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 12,
    "mrn": "BUDC8V3H1793015596",
    "name": "Hilario Bogisich",
    "email": "1793015596robel.olga@example.net",
    "language": "en",
    "phone": "1-331-222-5354",
    "phone_country": "ZM",
    "phone_verified_at": null,
    "address1": "5288 Miller Mill Suite 186",
    "address2": "Sylvanfurt, AK 10368",
    "postal_code": "71387",
    "city": "Ratke and Sons",
    "country": "BE",
    "clinic_name": "Vonmouth",
    "clinic_location": "9798 Hadley Trace\nNorth Eltamouth, OH 03238",
    "image": null,
    "public_image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "is_ambassador": 0,
    "test_account": false,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2026-10-26T11:53:16.000000Z",
    "updated_at": "2026-10-26T11:53:16.000000Z",
    "invitation_status": null,
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 6,
            "name": "Amputee"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view user data",
    "code": "USERS:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:GET:USER_NOT_FOUND"
}

Request   

GET api/user/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Query Parameters

extend   string  optional  

Comma-separated list of relation extensions (available: clinicians, patients, devices, devicesAsClinician, roles, permissions).

Response

Response Fields

id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

Create new user account

requires authentication

Predefined permissions:

Example request:
curl --request POST \
    "http://localhost:8000/api/user" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "mrn=MRN12345678"\
    --form "name=Tom Smith"\
    --form "email=test@example.com"\
    --form "language=en"\
    --form "address1=530 Maureen Estate"\
    --form "address2=East Rosella, UT 75735-0225"\
    --form "postal_code=95839"\
    --form "city=Gutkowskiburgh"\
    --form "country=DK"\
    --form "clinic_name=Aether"\
    --form "clinic_location=530 Maureen Estate"\
    --form "mfa_enabled=1"\
    --form "mfa_method=email"\
    --form "is_internal="\
    --form "is_ambassador="\
    --form "test_account=1"\
    --form "clinicians[]=2"\
    --form "notifications_timezone=Europe/Warsaw"\
    --form "notifications_at=8:00"\
    --form "role=Amputee"\
    --form "image=@/tmp/phpGOdSzH" \
    --form "public_image=@/tmp/phpWIwWLJ" 
const url = new URL(
    "http://localhost:8000/api/user"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('mrn', 'MRN12345678');
body.append('name', 'Tom Smith');
body.append('email', 'test@example.com');
body.append('language', 'en');
body.append('address1', '530 Maureen Estate');
body.append('address2', 'East Rosella, UT 75735-0225');
body.append('postal_code', '95839');
body.append('city', 'Gutkowskiburgh');
body.append('country', 'DK');
body.append('clinic_name', 'Aether');
body.append('clinic_location', '530 Maureen Estate');
body.append('mfa_enabled', '1');
body.append('mfa_method', 'email');
body.append('is_internal', '');
body.append('is_ambassador', '');
body.append('test_account', '1');
body.append('clinicians[]', '2');
body.append('notifications_timezone', 'Europe/Warsaw');
body.append('notifications_at', '8:00');
body.append('role', 'Amputee');
body.append('image', document.querySelector('input[name="image"]').files[0]);
body.append('public_image', document.querySelector('input[name="public_image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (201):


{
    "id": 13,
    "mrn": "E5PBZBNL1793015596",
    "name": "Leda Mann",
    "email": "1793015596wcasper@example.org",
    "language": "en",
    "phone": "925.593.2157",
    "phone_country": "KG",
    "phone_verified_at": null,
    "address1": "3566 Schmeler Ridge",
    "address2": "North Roderickhaven, NJ 36786-0041",
    "postal_code": "59513",
    "city": "Hansen Ltd",
    "country": "HU",
    "clinic_name": "North Sheldon",
    "clinic_location": "52079 Ethan Forge Suite 020\nWatsicamouth, AR 91645",
    "image": null,
    "public_image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "is_ambassador": 0,
    "test_account": false,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2026-10-26T11:53:16.000000Z",
    "updated_at": "2026-10-26T11:53:16.000000Z",
    "invitation_status": "accepted",
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 4,
            "name": "Clinician"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create user with given role",
    "code": "USERS:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (403, E-mail in use (in another region)):


{
    "message": "E-mail address already in use (in another region)",
    "code": "USERS:CREATE:EMAIL_IN_USE"
}

Request   

POST api/user

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

mrn   string  optional  

Medical Record Number. Example: MRN12345678

name   string  optional  

User full name. Example: Tom Smith

email   string   

User email. MUST_BE_EMAIL. Example: test@example.com

language   string  optional  

User language. Example: en

address1   string  optional  

Address line 1. MAXIMUM:STRING_LENGTH:100. Example: 530 Maureen Estate

address2   string  optional  

Address line 2. MAXIMUM:STRING_LENGTH:100. Example: East Rosella, UT 75735-0225

postal_code   string  optional  

Postal code. MAXIMUM:STRING_LENGTH:100. Example: 95839

city   string  optional  

City. MAXIMUM:STRING_LENGTH:100. Example: Gutkowskiburgh

country   string  optional  

Country. MAXIMUM:STRING_LENGTH:2. Example: DK

clinic_name   string  optional  

Clinic name. MAXIMUM:STRING_LENGTH:100. Example: Aether

clinic_location   string  optional  

Clinic location. MAXIMUM:STRING_LENGTH:100. Example: 530 Maureen Estate

image   file  optional  

Attached user image. MUST_BE_IMAGE MAXIMUM:FILE_KB:5120. Example: /tmp/phpGOdSzH

public_image   file  optional  

MUST_BE_IMAGE MAXIMUM:FILE_KB:5120. Example: /tmp/phpWIwWLJ

mfa_enabled   boolean  optional  

Super Admin only: MFA enabled. Example: true

mfa_method   string  optional  

Super Admin only: MFA method. Example: email

Must be one of:
  • email
  • sms
is_internal   boolean  optional  

Super Admin only: Mark user as internal (QA/ADP team). Example: false

is_ambassador   boolean  optional  

Mark user as a Community ambassador. Example: false

test_account   boolean  optional  

Example: true

clinicians   string[]  optional  

Clinician ID. The id of an existing record in the App\Models\User table.

notifications_timezone   string  optional  

User notifications timezone. Example: Europe/Warsaw

notifications_at   string  optional  

Time when notifications and reminders should be sent. Format: HH:MM. Set null to notify at default time. Must be a valid date in the format H:i. Example: 8:00

role   string   

Role name. One of: SuperAdmin, CommunityAdmin, ClinicAdmin, Clinician, ClinicianSupport, Amputee. Example: Amputee

Must be one of:
  • Amputee
  • ClinicianSupport
  • Clinician
  • ClinicAdmin
  • CommunityAdmin
  • SuperAdmin
  • AcadleUser
permissions   object  optional  

List of permissions given to this user. For now, it is used for ClinicianSupport role to give access to specific actions (for example user.update means that user can update users). You can assign both predefined permissions (already checked by some endpoints) and custom permissions (check them on your own). You can also use wildcards like user.* to give access to all actions for given scope.

Response

Response Fields

id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

Update user account

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/user/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "mrn=MRN12345678"\
    --form "name=Tom Smith"\
    --form "email=test@example.com"\
    --form "language=en"\
    --form "address1=56652 Jeramie Haven"\
    --form "address2=East Celine, AL 80105-0787"\
    --form "postal_code=49261"\
    --form "city=Hettingermouth"\
    --form "country=SK"\
    --form "clinic_name=Aether"\
    --form "clinic_location=56652 Jeramie Haven"\
    --form "image_delete=1"\
    --form "mfa_enabled=1"\
    --form "mfa_method=email"\
    --form "active=1"\
    --form "is_internal="\
    --form "is_ambassador="\
    --form "test_account="\
    --form "clinicians[]=2"\
    --form "notifications_timezone=Europe/Warsaw"\
    --form "notifications_at=8:00"\
    --form "role=Amputee"\
    --form "image=@/tmp/phpadXqhd" \
    --form "public_image=@/tmp/phpIQ2ZeU" 
const url = new URL(
    "http://localhost:8000/api/user/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('mrn', 'MRN12345678');
body.append('name', 'Tom Smith');
body.append('email', 'test@example.com');
body.append('language', 'en');
body.append('address1', '56652 Jeramie Haven');
body.append('address2', 'East Celine, AL 80105-0787');
body.append('postal_code', '49261');
body.append('city', 'Hettingermouth');
body.append('country', 'SK');
body.append('clinic_name', 'Aether');
body.append('clinic_location', '56652 Jeramie Haven');
body.append('image_delete', '1');
body.append('mfa_enabled', '1');
body.append('mfa_method', 'email');
body.append('active', '1');
body.append('is_internal', '');
body.append('is_ambassador', '');
body.append('test_account', '');
body.append('clinicians[]', '2');
body.append('notifications_timezone', 'Europe/Warsaw');
body.append('notifications_at', '8:00');
body.append('role', 'Amputee');
body.append('image', document.querySelector('input[name="image"]').files[0]);
body.append('public_image', document.querySelector('input[name="public_image"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Example response (202):


{
    "id": 14,
    "mrn": "9L9HRTHW1793015597",
    "name": "Prof. Jamel Conn II",
    "email": "1793015597hermina.kutch@example.com",
    "language": "en",
    "phone": "940.924.5338",
    "phone_country": "NF",
    "phone_verified_at": null,
    "address1": "771 Oberbrunner Island Apt. 503",
    "address2": "Medhurstfurt, MN 23893",
    "postal_code": "08035-2249",
    "city": "Cummings Group",
    "country": "NL",
    "clinic_name": "Westview",
    "clinic_location": "94919 Frederic Knoll\nRosaleeport, GA 50110-0311",
    "image": null,
    "public_image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "is_ambassador": 0,
    "test_account": false,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2026-10-26T11:53:17.000000Z",
    "updated_at": "2026-10-26T11:53:17.000000Z",
    "invitation_status": "accepted",
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 3,
            "name": "ClinicAdmin"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update user data",
    "code": "USERS:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Insufficient permission to assign role):


{
    "message": "Insufficient permission to assign this role as ClinicAdmin",
    "code": "USERS:UPDATE:INSUFFICIENT_PERMISSION_ASSIGN_ROLE"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:UPDATE:USER_NOT_FOUND"
}

Request   

PUT api/user/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Body Parameters

mrn   string  optional  

Medical Record Number. Example: MRN12345678

name   string  optional  

User full name. Example: Tom Smith

email   string  optional  

User email. MUST_BE_EMAIL. Example: test@example.com

language   string  optional  

User language. Example: en

address1   string  optional  

Address line 1. MAXIMUM:STRING_LENGTH:100. Example: 56652 Jeramie Haven

address2   string  optional  

Address line 2. MAXIMUM:STRING_LENGTH:100. Example: East Celine, AL 80105-0787

postal_code   string  optional  

Postal code. MAXIMUM:STRING_LENGTH:100. Example: 49261

city   string  optional  

City. MAXIMUM:STRING_LENGTH:100. Example: Hettingermouth

country   string  optional  

Country. MAXIMUM:STRING_LENGTH:2. Example: SK

clinic_name   string  optional  

Clinic name. MAXIMUM:STRING_LENGTH:100. Example: Aether

clinic_location   string  optional  

Clinic location. MAXIMUM:STRING_LENGTH:100. Example: 56652 Jeramie Haven

image   file  optional  

Attached user image. MUST_BE_IMAGE MAXIMUM:FILE_KB:5120. Example: /tmp/phpadXqhd

image_delete   boolean  optional  

Send this parameter instead of image to remove previously added image. Example: true

public_image   file  optional  

MUST_BE_IMAGE MAXIMUM:FILE_KB:5120. Example: /tmp/phpIQ2ZeU

mfa_enabled   boolean  optional  

Super Admin only: MFA enabled. Example: true

mfa_method   string  optional  

Super Admin only: MFA method. Example: email

Must be one of:
  • email
  • sms
active   boolean  optional  

User active status (0 - inactive, 1 - active). Example: true

is_internal   boolean  optional  

Super Admin only: Mark user as internal (QA/ADP team). Example: false

is_ambassador   boolean  optional  

Mark user as a Community ambassador. Example: false

test_account   boolean  optional  

Example: false

clinicians   string[]  optional  

Clinician ID. The id of an existing record in the App\Models\User table.

notifications_timezone   string  optional  

User notifications timezone. Example: Europe/Warsaw

notifications_at   string  optional  

Time when notifications and reminders should be sent. Format: HH:MM. Set null to notify at default time. Must be a valid date in the format H:i. Example: 8:00

role   string  optional  

Role name. One of: SuperAdmin, CommunityAdmin, ClinicAdmin, Clinician, ClinicianSupport, Amputee. Example: Amputee

Must be one of:
  • Amputee
  • ClinicianSupport
  • Clinician
  • ClinicAdmin
  • CommunityAdmin
  • SuperAdmin
  • AcadleUser
permissions   object  optional  

List of permissions given to this user. For now, it is used for ClinicianSupport role to give access to specific actions (for example user.update means that user can update users). You can assign both predefined permissions (already checked by some endpoints) and custom permissions (check them on your own). You can also use wildcards like user.* to give access to all actions for given scope.

Response

Response Fields

id   integer   

User ID.

mrn   string   

Medical Record Number.

name   string   

User full name.

email   string   

User email address.

language   string   

User preferred language.

phone   string   

User phone number.

phone_country   string   

Phone country code.

phone_verified_at   string   

Phone verification date.

address1   string   

Address line 1.

address2   string   

Address line 2.

postal_code   string   

Postal code.

city   string   

City.

country   string   

Country code (ISO 3166 Alpha-2).

clinic_name   string   

Clinic name.

clinic_location   string   

Clinic location.

image   string   

User profile image URL.

mfa_enabled   boolean   

Whether MFA is enabled.

mfa_method   string   

Preferred MFA method.

mfa_verified_to   string   

MFA session verified until.

location_id   integer   

Location ID.

created_by   integer   

ID of the user who created this account.

active   boolean   

Whether the user account is active.

is_internal   boolean   

Super Admin only: Whether the user is an internal user (QA/ADP team).

notifications_timezone   string   

Timezone for notifications.

notifications_at   string   

Preferred notification time.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

invitation_status   string   

User invitation status.

acadle_invitation_status   string   

Acadle invitation status.

roles   object[]   

User roles.
id   integer   

Role ID.

name   string   

Role name.

permissions   object[]   

User permissions.

clinicians   object[]   

Assigned clinicians.

devices   object[]   

Assigned devices.

patients   object[]   

Assigned patients.

invitations   object[]   

User invitations.

Update user phone number

requires authentication

Phone number has to be verified after update. Call /api/mfa/phone/verify with user-filled code after performing this operation. If value is "0" phone number will be removed without any verification.

Example request:
curl --request POST \
    "http://localhost:8000/api/user/1/phone" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"phone\": \"+1 (208) 892-0242\",
    \"phone_country\": \"US\"
}"

const url = new URL(
    "http://localhost:8000/api/user/1/phone"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "phone": "+1 (208) 892-0242",
    "phone_country": "US"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, Phone number removed):


{
    "message": "Phone number removed",
    "code": "USERS:SET_PHONE:REMOVED"
}

Example response (200, Phone number updated):


{
    "message": "Verification code sent. Call /api/mfa/phone/verify to verify phone number.",
    "code": "USERS:SET_PHONE:UPDATED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update user data",
    "code": "USERS:SET_PHONE:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:SET_PHONE:USER_NOT_FOUND"
}

Example response (500, Code send failed):


{
    "message": "Verification code sending failed",
    "code": "USERS:SET_PHONE:SEND_FAILED"
}

Request   

POST api/user/{id}/phone

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Body Parameters

phone   string  optional  

User phone number. Pass "0" to remove current one. Example: +1 (208) 892-0242

phone_country   string  optional  

Phone number's country (2 characters). SIZE:STRING_LENGTH:2. Example: US

Delete user account

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/user/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/user/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "User deleted",
    "code": "USERS:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete user",
    "code": "USERS:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (403, User has existing patients or chat rooms):


{
    "message": "Cannot delete: user has existing patients or chat rooms (patients: 1, chat rooms: 0)",
    "code": "USERS:DELETE:HAS_PATIENTS"
}

Example response (403, User has existing devices):


{
    "message": "Cannot delete: user has existing devices (as patient: 1, as clinician: 0)",
    "code": "USERS:DELETE:HAS_DEVICES"
}

Example response (403, User has open P2P sessions):


{
    "message": "Cannot delete: user has open P2P sessions (as patient: 0, as clinician: 1)",
    "code": "USERS:DELETE:HAS_P2P_SESSIONS"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:DELETE:USER_NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error: user not deleted",
    "code": "USERS:DELETE:SERVER_ERROR"
}

Request   

DELETE api/user/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Delete own user account

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/user" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"password\"
}"

const url = new URL(
    "http://localhost:8000/api/user"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "password": "password"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202, OK):


{
    "message": "User deleted",
    "code": "USERS:SELF_DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete user",
    "code": "USERS:SELF_DELETE:INSUFFICIENT_PERMISSION"
}

Example response (422, Invalid password):


{
    "message": "Invalid password",
    "code": "USERS:SELF_DELETE:INVALID_PASSWORD"
}

Example response (500, Server error):


{
    "message": "Server error: user not deleted",
    "code": "USERS:SELF_DELETE:SERVER_ERROR"
}

Request   

DELETE api/user

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

password   string   

User account password. Example: password

Change other user password

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/user/1/password" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"recusandae\"
}"

const url = new URL(
    "http://localhost:8000/api/user/1/password"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "password": "recusandae"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202, OK):


{
    "message": "User password changed",
    "code": "USERS:PASSWORD_CHANGE:CHANGED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to change user password",
    "code": "USERS:PASSWORD_CHANGE:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:PASSWORD_CHANGE:USER_NOT_FOUND"
}

Request   

POST api/user/{id}/password

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Body Parameters

password   string   

Example: recusandae

Get user devices list

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/user/1/devices" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/user/1/devices"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 3,
            "serial": "a7752688-b4ae-3d0c-a9f5-4178d6db8f83",
            "bluetooth_id": "2f94ddc6-b024-30b0-98d5-44198b14ec8f",
            "company_id": null,
            "model_id": 1,
            "amputee_id": null,
            "clinician_id": null,
            "firmware_version_id": null,
            "pcb_version_id": null,
            "reverse_magnets": 0,
            "is_electrode": 0,
            "active": 1,
            "last_activity_at": "0000-00-00 00:00:00",
            "first_connected_at": null,
            "measurements": null,
            "created_at": "2026-10-26T11:53:17.000000Z",
            "updated_at": "2026-10-26T11:53:17.000000Z",
            "first_config_change_at": null,
            "model": {
                "id": 1,
                "name": "Zeus hand v1",
                "type": "arm",
                "orientation": "right",
                "active": 1,
                "created_at": "2026-10-26T11:53:17.000000Z",
                "updated_at": "2026-10-26T11:53:17.000000Z"
            }
        },
        {
            "id": 4,
            "serial": "2ac3bc8d-7395-3327-8d6a-9119a9adbd7d",
            "bluetooth_id": "cb6950a5-aed2-3117-997f-0e784a2f299f",
            "company_id": null,
            "model_id": 2,
            "amputee_id": null,
            "clinician_id": null,
            "firmware_version_id": null,
            "pcb_version_id": null,
            "reverse_magnets": 0,
            "is_electrode": 0,
            "active": 1,
            "last_activity_at": "0000-00-00 00:00:00",
            "first_connected_at": null,
            "measurements": null,
            "created_at": "2026-10-26T11:53:17.000000Z",
            "updated_at": "2026-10-26T11:53:17.000000Z",
            "first_config_change_at": null,
            "model": {
                "id": 2,
                "name": "Zeus hand v1",
                "type": "arm",
                "orientation": "left",
                "active": 1,
                "created_at": "2026-10-26T11:53:17.000000Z",
                "updated_at": "2026-10-26T11:53:17.000000Z"
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view user devices",
    "code": "USERS:DEVICES:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:DEVICES:USER_NOT_FOUND"
}

Request   

GET api/user/{id}/devices

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: model, firmwareVersion, pcbVersion, joinedDevices, joinedElectrodes).

Response

Response Fields

items   object   
id   integer   

Device ID.

serial   string   

Device serial number.

bluetooth_id   string   

Bluetooth identifier.

model_id   integer   

Device model ID.

amputee_id   integer   

Assigned patient (amputee) user ID.

firmware_version_id   integer   

Firmware version ID.

pcb_version_id   integer   

PCB version ID.

company_id   integer   

Company ID.

reverse_magnets   boolean   

Whether magnets are reversed.

is_electrode   boolean   

Whether this device is an electrode.

active   boolean   

Whether the device is active.

last_activity_at   string   

Last activity timestamp.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

model   object   

Device model details.
id   integer   

Device model ID.

name   string   

Model name.

type   string   

Model type.

orientation   string   

Model orientation.

active   boolean   

Whether the model is active.

amputee   object   

Assigned patient (amputee) user.
id   integer   

User ID.

name   string   

User full name.

email   string   

User email address.

clinicians   object[]   

Clinicians assigned to this device.

firmwareVersion   object   

Firmware version details.
id   integer   

Firmware version ID.

name   string   

Version name.

file_firmware   string   

Firmware file URL.

file_firmware_v2   string   

Firmware v2 file URL.

file_firmware_v3   string   

Firmware v3 file URL.

file_firmware_v4   string   

Firmware v4 file URL.

file_firmware_v5   string   

Firmware v5 file URL.

file_firmware_new_pcb   string   

New PCB firmware file URL.

file_bootloader   string   

Bootloader file URL.

file_bootloader_v2   string   

Bootloader v2 file URL.

file_bootloader_v3   string   

Bootloader v3 file URL.

file_bootloader_v4   string   

Bootloader v4 file URL.

changelog   string   

Changelog file URL.

pcbVersion   object   

PCB version details.
id   integer   

PCB version ID.

name   string   

Version name.

hardware_id   string   

Hardware identifier.

joinedDevices   object[]   

Joined hand devices.

joinedElectrodes   object[]   

Joined electrode devices.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Attach patient to clinician

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/user/attach" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"name@domain.com\"
}"

const url = new URL(
    "http://localhost:8000/api/user/attach"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "name@domain.com"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Patient attached",
    "code": "USERS:ATTACH:ATTACHED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to attach patients",
    "code": "USERS:ATTACH:INSUFFICIENT_PERMISSION"
}

Example response (403, Patient is already assigned to another clinician):


{
    "message": "Patient is already assigned to another clinician",
    "code": "USERS:ATTACH:ALREADY_ASSIGNED"
}

Example response (403, User reached the temporary limit of attached devices):


{
    "message": "Reached the limit of assigned devices",
    "code": "USERS:ATTACH:LIMIT_REACHED"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:ATTACH:USER_NOT_FOUND"
}

Request   

POST api/user/attach

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

User e-mail address. MUST_BE_EMAIL. Example: name@domain.com

Detach patient from clinician

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/user/1/detach" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/user/1/detach"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Patient detached",
    "code": "USERS:DETACH:DETACHED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to detach patient",
    "code": "USERS:DETACH:INSUFFICIENT_PERMISSION"
}

Example response (403, Cannot detach last clinician):


{
    "message": "Cannot detach patient's last clinician",
    "code": "USERS:DETACH:CANNOT_DETACH_LAST_CLINICIAN"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:DETACH:USER_NOT_FOUND"
}

Request   

POST api/user/{id}/detach

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Admin access to MFA codes

requires authentication

Requires admin.mfa_access permission.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/user/1/mfa-codes" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/user/1/mfa-codes"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, OK):


[
    {
        "id": 1,
        "user_id": 1,
        "code": "123456",
        "channel": "email",
        "expires": "2025-05-09 12:00:00"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access MFA codes",
    "code": "USERS:ADMIN_MFA_ACCESS:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:ADMIN_MFA_ACCESS:USER_NOT_FOUND"
}

Request   

GET api/user/{id}/mfa-codes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Export clinician devices

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/clinician-devices/csv" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/clinician-devices/csv"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, CSV file):


{
    "file": "https://staging-us-east-2-aether-biomedical-s3-us-bucket.s3.us-east-2.amazonaws.com/clinicians/clinicians-devices-1759228216.csv",
    "expires": "2026-07-02 10:40:00"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to export clinician devices",
    "code": "USERS:EXPORT_CLINICIAN_DEVICES:INSUFFICIENT_PERMISSION"
}

Request   

GET api/clinician-devices/csv

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get user mobile consents

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/consents" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/consents"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "user_id": 34,
        "name": "quia",
        "value": "sapiente",
        "created_at": "1976-09-18T02:54:46.000000Z",
        "updated_at": "1973-09-03T18:46:20.000000Z"
    },
    {
        "id": 2,
        "user_id": 35,
        "name": "cumque",
        "value": "harum",
        "created_at": "1992-02-29T03:25:16.000000Z",
        "updated_at": "2010-05-17T11:48:56.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to use mobile consents",
    "code": "USERS:GET_MOBILE_CONSENTS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/consents

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Response

Response Fields

id   integer   

Consent record ID.

user_id   integer   

Associated user ID.

name   string   

Consent name/key.

value   string   

Consent value.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Set user mobile consent

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/consents" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Push notifications\",
    \"value\": 1
}"

const url = new URL(
    "http://localhost:8000/api/consents"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Push notifications",
    "value": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


[
    {
        "id": 3,
        "user_id": 36,
        "name": "dicta",
        "value": "ipsum",
        "created_at": "2010-08-05T09:35:03.000000Z",
        "updated_at": "2011-07-01T05:54:06.000000Z"
    },
    {
        "id": 4,
        "user_id": 37,
        "name": "laboriosam",
        "value": "voluptatem",
        "created_at": "2020-07-04T00:35:08.000000Z",
        "updated_at": "1997-11-20T02:05:36.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to use mobile consents",
    "code": "USERS:SET_MOBILE_CONSENTS:INSUFFICIENT_PERMISSION"
}

Request   

POST api/consents

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Consent name. Example: Push notifications

value   string   

Consent value. Example: 1

Response

Response Fields

id   integer   

Consent record ID.

user_id   integer   

Associated user ID.

name   string   

Consent name/key.

value   string   

Consent value.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Clear user notifications

requires authentication

Clearing notifications allow to receive another notification on same day. This endpoint deletes notifications of type:

    This endpoint is intended for testing use only.
Example request:
curl --request DELETE \
    "http://localhost:8000/api/notifications/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/notifications/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "messages": "1 notifications deleted",
    "code": "USERS:CLEAR_NOTIFICATIONS:CLEARED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update user data",
    "code": "USERS:CLEAR_NOTIFICATIONS:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:CLEAR_NOTIFICATIONS:USER_NOT_FOUND"
}

Request   

DELETE api/notifications/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Versions

API endpoints for versions management

Get software versions

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/versions/software" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/versions/software"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "name": "8.60.59",
        "created_at": "2026-10-26T11:55:26.000000Z",
        "updated_at": "2026-10-26T11:55:26.000000Z"
    },
    {
        "id": 2,
        "name": "8.36.98",
        "created_at": "2026-10-26T11:55:26.000000Z",
        "updated_at": "2026-10-26T11:55:26.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list versions",
    "code": "SOFTWARE_VERSION:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/versions/software

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Response

Response Fields

id   integer   

Software version ID.

name   string   

Version name.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Create software version

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/versions/software" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"1.0\"
}"

const url = new URL(
    "http://localhost:8000/api/versions/software"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "1.0"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "name": "1.2.7",
    "created_at": "2026-10-26T11:55:26.000000Z",
    "updated_at": "2026-10-26T11:55:26.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create versions",
    "code": "SOFTWARE_VERSION:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/versions/software

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Name of version. Example: 1.0

Response

Response Fields

id   integer   

Software version ID.

name   string   

Version name.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Delete software version

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/versions/software/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/versions/software/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Version deleted",
    "code": "SOFTWARE_VERSION:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete versions",
    "code": "SOFTWARE_VERSION:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (403, Version in use (compatibility)):


{
    "message": "Cannot delete: version is used in compatibility entries (1)",
    "code": "SOFTWARE_VERSION:DELETE:VERSION_IN_USE_COMPATIBILITY"
}

Example response (404, Version not found):


{
    "message": "Version not found",
    "code": "SOFTWARE_VERSION:DELETE:VERSION_NOT_FOUND"
}

Request   

DELETE api/versions/software/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Software Version ID. Example: 1

Get firmware versions

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/versions/firmware" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/versions/firmware"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 2,
        "name": "4.96.99",
        "file_firmware": "/tmp/fakerdm1NdO",
        "file_firmware_v2": "/tmp/fakerD8Qvz7",
        "file_firmware_v3": "/tmp/faker2cw3a8",
        "file_firmware_v4": "/tmp/fakeroDVot2",
        "file_firmware_v5": "/tmp/fakerBvmmq3",
        "file_firmware_new_pcb": "/tmp/fakerZhTvgX",
        "file_bootloader": "/tmp/fakersS3Yof",
        "file_bootloader_v2": "/tmp/fakerwBva1P",
        "file_bootloader_v3": "/tmp/fakerYuupee",
        "file_bootloader_v4": "/tmp/fakerxrsIo8",
        "changelog": "Consequatur asperiores inventore quaerat nemo et debitis reiciendis. Amet ut voluptatum et sint. Vitae illum mollitia numquam in. Incidunt magnam illo amet vel.",
        "created_at": "2026-10-26T11:55:26.000000Z",
        "updated_at": "2026-10-26T11:55:26.000000Z"
    },
    {
        "id": 3,
        "name": "2.69.73",
        "file_firmware": "/tmp/fakerWtv1Gr",
        "file_firmware_v2": "/tmp/fakeruHP5eB",
        "file_firmware_v3": "/tmp/fakerPmBPQd",
        "file_firmware_v4": "/tmp/faker6j2jpl",
        "file_firmware_v5": "/tmp/fakeruqaSXf",
        "file_firmware_new_pcb": "/tmp/fakerdelqnn",
        "file_bootloader": "/tmp/faker8WjlCp",
        "file_bootloader_v2": "/tmp/fakerigJgld",
        "file_bootloader_v3": "/tmp/fakerRugttR",
        "file_bootloader_v4": "/tmp/faker4c7VlB",
        "changelog": "Et sapiente doloribus modi harum laborum mollitia ut. Enim accusamus omnis quis laboriosam ut qui. Ut veritatis quis doloribus velit beatae. Nemo quia libero fugit ea vel.",
        "created_at": "2026-10-26T11:55:26.000000Z",
        "updated_at": "2026-10-26T11:55:26.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list versions",
    "code": "FIRMWARE_VERSION:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/versions/firmware

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

extend   string  optional  

Comma-separated list of relation extensions (available: models).

Response

Response Fields

id   integer   

Firmware version ID.

name   string   

Version name.

file_firmware   string   

Firmware file URL.

file_firmware_v2   string   

Firmware v2 file URL.

file_firmware_v3   string   

Firmware v3 file URL.

file_firmware_v4   string   

Firmware v4 file URL.

file_firmware_v5   string   

Firmware v5 file URL.

file_firmware_new_pcb   string   

New PCB firmware file URL.

file_bootloader   string   

Bootloader file URL.

file_bootloader_v2   string   

Bootloader v2 file URL.

file_bootloader_v3   string   

Bootloader v3 file URL.

file_bootloader_v4   string   

Bootloader v4 file URL.

changelog   string   

Changelog file URL.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Create firmware version

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/versions/firmware" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=1.0"\
    --form "models[]=1"\
    --form "changelog[][language]=en"\
    --form "changelog[][changelog]=Fixed bug with the connection"\
    --form "file_firmware=@/tmp/phpJGNoPM" \
    --form "file_firmware_v2=@/tmp/php1uhbyM" \
    --form "file_firmware_v3=@/tmp/phppsEQwQ" \
    --form "file_firmware_v4=@/tmp/phpaRI2I6" \
    --form "file_firmware_v5=@/tmp/phpaqDYyG" \
    --form "file_firmware_new_pcb=@/tmp/phpPydBLK" \
    --form "file_bootloader=@/tmp/phpSGwtOS" \
    --form "file_bootloader_v2=@/tmp/phpJWsKNd" \
    --form "file_bootloader_v3=@/tmp/phpzRc7GM" \
    --form "file_bootloader_v4=@/tmp/php3DMUhe" 
const url = new URL(
    "http://localhost:8000/api/versions/firmware"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', '1.0');
body.append('models[]', '1');
body.append('changelog[][language]', 'en');
body.append('changelog[][changelog]', 'Fixed bug with the connection');
body.append('file_firmware', document.querySelector('input[name="file_firmware"]').files[0]);
body.append('file_firmware_v2', document.querySelector('input[name="file_firmware_v2"]').files[0]);
body.append('file_firmware_v3', document.querySelector('input[name="file_firmware_v3"]').files[0]);
body.append('file_firmware_v4', document.querySelector('input[name="file_firmware_v4"]').files[0]);
body.append('file_firmware_v5', document.querySelector('input[name="file_firmware_v5"]').files[0]);
body.append('file_firmware_new_pcb', document.querySelector('input[name="file_firmware_new_pcb"]').files[0]);
body.append('file_bootloader', document.querySelector('input[name="file_bootloader"]').files[0]);
body.append('file_bootloader_v2', document.querySelector('input[name="file_bootloader_v2"]').files[0]);
body.append('file_bootloader_v3', document.querySelector('input[name="file_bootloader_v3"]').files[0]);
body.append('file_bootloader_v4', document.querySelector('input[name="file_bootloader_v4"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (201):


{
    "id": 4,
    "name": "3.45.85",
    "file_firmware": "/tmp/fakerv9la0c",
    "file_firmware_v2": "/tmp/fakerGZhovA",
    "file_firmware_v3": "/tmp/fakerfbYm2O",
    "file_firmware_v4": "/tmp/fakergN3s8f",
    "file_firmware_v5": "/tmp/fakerHOtovs",
    "file_firmware_new_pcb": "/tmp/fakercO67Fc",
    "file_bootloader": "/tmp/fakerOuw6uh",
    "file_bootloader_v2": "/tmp/fakerYQk4YD",
    "file_bootloader_v3": "/tmp/faker53tjXP",
    "file_bootloader_v4": "/tmp/fakerDEDLxW",
    "changelog": "Animi dolor autem nam impedit sit est nulla. Est et enim minima et asperiores qui sint voluptatem. Sit similique atque dolore quia delectus quas.",
    "created_at": "2026-10-26T11:55:26.000000Z",
    "updated_at": "2026-10-26T11:55:26.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create versions",
    "code": "FIRMWARE_VERSION:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/versions/firmware

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

name   string   

Name of version. Example: 1.0

models   integer[]  optional  

Device Model ID. The id of an existing record in the App\Models\DeviceModel table.

file_firmware   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpJGNoPM

file_firmware_v2   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/php1uhbyM

file_firmware_v3   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phppsEQwQ

file_firmware_v4   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpaRI2I6

file_firmware_v5   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpaqDYyG

file_firmware_new_pcb   file  optional  

Attached firmware for new PCB file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpPydBLK

file_bootloader   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpSGwtOS

file_bootloader_v2   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpJWsKNd

file_bootloader_v3   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpzRc7GM

file_bootloader_v4   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/php3DMUhe

changelog   object[]  optional  

List of changelog translations.
language   string  optional  

Changelog language (2 characters code). Example: en

changelog   string  optional  

Changelog for the version. Example: Fixed bug with the connection

Response

Response Fields

id   integer   

Firmware version ID.

name   string   

Version name.

file_firmware   string   

Firmware file URL.

file_firmware_v2   string   

Firmware v2 file URL.

file_firmware_v3   string   

Firmware v3 file URL.

file_firmware_v4   string   

Firmware v4 file URL.

file_firmware_v5   string   

Firmware v5 file URL.

file_firmware_new_pcb   string   

New PCB firmware file URL.

file_bootloader   string   

Bootloader file URL.

file_bootloader_v2   string   

Bootloader v2 file URL.

file_bootloader_v3   string   

Bootloader v3 file URL.

file_bootloader_v4   string   

Bootloader v4 file URL.

changelog   string   

Changelog file URL.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Update firmware version

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/versions/firmware/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=1.0"\
    --form "models[]=1"\
    --form "file_firmware_delete=1"\
    --form "file_firmware_v2_delete=1"\
    --form "file_firmware_v3_delete=1"\
    --form "file_firmware_v4_delete=1"\
    --form "file_firmware_v5_delete=1"\
    --form "file_firmware_new_pcb_delete=1"\
    --form "file_bootloader_delete=1"\
    --form "file_bootloader_v2_delete=1"\
    --form "file_bootloader_v3_delete=1"\
    --form "file_bootloader_v4_delete=1"\
    --form "changelog[][language]=en"\
    --form "changelog[][changelog]=Fixed bug with the connection"\
    --form "file_firmware=@/tmp/phpUxwStS" \
    --form "file_firmware_v2=@/tmp/php4Xqi6H" \
    --form "file_firmware_v3=@/tmp/phpFPSGRg" \
    --form "file_firmware_v4=@/tmp/phpWojDS2" \
    --form "file_firmware_v5=@/tmp/phpYnSQq6" \
    --form "file_firmware_new_pcb=@/tmp/phpxzqfrb" \
    --form "file_bootloader=@/tmp/php70NNeH" \
    --form "file_bootloader_v2=@/tmp/phpyRNZVO" \
    --form "file_bootloader_v3=@/tmp/phpQ9rDto" \
    --form "file_bootloader_v4=@/tmp/phptmOQfT" 
const url = new URL(
    "http://localhost:8000/api/versions/firmware/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', '1.0');
body.append('models[]', '1');
body.append('file_firmware_delete', '1');
body.append('file_firmware_v2_delete', '1');
body.append('file_firmware_v3_delete', '1');
body.append('file_firmware_v4_delete', '1');
body.append('file_firmware_v5_delete', '1');
body.append('file_firmware_new_pcb_delete', '1');
body.append('file_bootloader_delete', '1');
body.append('file_bootloader_v2_delete', '1');
body.append('file_bootloader_v3_delete', '1');
body.append('file_bootloader_v4_delete', '1');
body.append('changelog[][language]', 'en');
body.append('changelog[][changelog]', 'Fixed bug with the connection');
body.append('file_firmware', document.querySelector('input[name="file_firmware"]').files[0]);
body.append('file_firmware_v2', document.querySelector('input[name="file_firmware_v2"]').files[0]);
body.append('file_firmware_v3', document.querySelector('input[name="file_firmware_v3"]').files[0]);
body.append('file_firmware_v4', document.querySelector('input[name="file_firmware_v4"]').files[0]);
body.append('file_firmware_v5', document.querySelector('input[name="file_firmware_v5"]').files[0]);
body.append('file_firmware_new_pcb', document.querySelector('input[name="file_firmware_new_pcb"]').files[0]);
body.append('file_bootloader', document.querySelector('input[name="file_bootloader"]').files[0]);
body.append('file_bootloader_v2', document.querySelector('input[name="file_bootloader_v2"]').files[0]);
body.append('file_bootloader_v3', document.querySelector('input[name="file_bootloader_v3"]').files[0]);
body.append('file_bootloader_v4', document.querySelector('input[name="file_bootloader_v4"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Example response (201):


{
    "id": 5,
    "name": "6.15.43",
    "file_firmware": "/tmp/fakerrntrKB",
    "file_firmware_v2": "/tmp/faker2Dnqjq",
    "file_firmware_v3": "/tmp/fakerbVnpW3",
    "file_firmware_v4": "/tmp/fakeraZYVdX",
    "file_firmware_v5": "/tmp/fakerBufeTP",
    "file_firmware_new_pcb": "/tmp/faker1P4gOi",
    "file_bootloader": "/tmp/fakerbjLaqq",
    "file_bootloader_v2": "/tmp/fakerN1gSfx",
    "file_bootloader_v3": "/tmp/faker0WMqHP",
    "file_bootloader_v4": "/tmp/faker4sj0LA",
    "changelog": "Labore et ut modi iure numquam. Pariatur magnam ducimus ullam ea corrupti et. Omnis quia quod eius corrupti magni officiis laboriosam sit.",
    "created_at": "2026-10-26T11:55:26.000000Z",
    "updated_at": "2026-10-26T11:55:26.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update versions",
    "code": "FIRMWARE_VERSION:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Version not found):


{
    "message": "Version not found",
    "code": "FIRMWARE_VERSION:UPDATE:VERSION_NOT_FOUND"
}

Request   

PUT api/versions/firmware/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

id   integer   

Firmware Version ID. Example: 1

Body Parameters

name   string  optional  

Name of version. Example: 1.0

models   integer[]  optional  

Device Model ID. The id of an existing record in the App\Models\DeviceModel table.

file_firmware   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpUxwStS

file_firmware_v2   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/php4Xqi6H

file_firmware_v3   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpFPSGRg

file_firmware_v4   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpWojDS2

file_firmware_v5   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpYnSQq6

file_firmware_new_pcb   file  optional  

Attached firmware for new PCB file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpxzqfrb

file_bootloader   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/php70NNeH

file_bootloader_v2   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpyRNZVO

file_bootloader_v3   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpQ9rDto

file_bootloader_v4   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phptmOQfT

changelog   object[]  optional  

List of changelog translations.
language   string  optional  

Changelog language (2 characters code). Example: en

changelog   string  optional  

Changelog for the version. Pass "NULL" string to remove the entry for given language. Example: Fixed bug with the connection

file_firmware_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_firmware. Example: 1

file_firmware_v2_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_firmware_v2. Example: 1

file_firmware_v3_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_firmware_v3. Example: 1

file_firmware_v4_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_firmware_v4. Example: 1

file_firmware_v5_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_firmware_v5. Example: 1

file_firmware_new_pcb_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_firmware_new_pcb. Example: 1

file_bootloader_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_bootloader. Example: 1

file_bootloader_v2_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_bootloader_v2. Example: 1

file_bootloader_v3_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_bootloader_v3. Example: 1

file_bootloader_v4_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_bootloader_v4. Example: 1

Response

Response Fields

id   integer   

Firmware version ID.

name   string   

Version name.

file_firmware   string   

Firmware file URL.

file_firmware_v2   string   

Firmware v2 file URL.

file_firmware_v3   string   

Firmware v3 file URL.

file_firmware_v4   string   

Firmware v4 file URL.

file_firmware_v5   string   

Firmware v5 file URL.

file_firmware_new_pcb   string   

New PCB firmware file URL.

file_bootloader   string   

Bootloader file URL.

file_bootloader_v2   string   

Bootloader v2 file URL.

file_bootloader_v3   string   

Bootloader v3 file URL.

file_bootloader_v4   string   

Bootloader v4 file URL.

changelog   string   

Changelog file URL.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Delete firmware version

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/versions/firmware/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/versions/firmware/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Version deleted",
    "code": "FIRMWARE_VERSION:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete versions",
    "code": "FIRMWARE_VERSION:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (403, Version in use (compatibility)):


{
    "message": "Cannot delete: version is used in compatibility entries (1)",
    "code": "FIRMWARE_VERSION:DELETE:VERSION_IN_USE_COMPATIBILITY"
}

Example response (403, Version in use (device)):


{
    "message": "Cannot delete: version is assigned to devices (1)",
    "code": "FIRMWARE_VERSION:DELETE:VERSION_IN_USE_DEVICE"
}

Example response (404, Version not found):


{
    "message": "Version not found",
    "code": "FIRMWARE_VERSION:DELETE:VERSION_NOT_FOUND"
}

Request   

DELETE api/versions/firmware/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Firmware Version ID. Example: 1

Get PCB versions

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/versions/pcb" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/versions/pcb"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 2,
        "name": "0.25.50",
        "hardware_id": "",
        "created_at": "2026-10-26T11:55:26.000000Z",
        "updated_at": "2026-10-26T11:55:26.000000Z"
    },
    {
        "id": 3,
        "name": "9.78.71",
        "hardware_id": "",
        "created_at": "2026-10-26T11:55:26.000000Z",
        "updated_at": "2026-10-26T11:55:26.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list versions",
    "code": "PCB_VERSION:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/versions/pcb

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

extend   string  optional  

Comma-separated list of relation extensions (available: models).

Response

Response Fields

id   integer   

PCB version ID.

name   string   

Version name.

hardware_id   string   

Hardware identifier.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Create PCB version

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/versions/pcb" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"1.0\",
    \"models\": [
        1
    ],
    \"hardware_id\": \"1\"
}"

const url = new URL(
    "http://localhost:8000/api/versions/pcb"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "1.0",
    "models": [
        1
    ],
    "hardware_id": "1"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 4,
    "name": "4.79.73",
    "hardware_id": "",
    "created_at": "2026-10-26T11:55:26.000000Z",
    "updated_at": "2026-10-26T11:55:26.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create versions",
    "code": "PCB_VERSION:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/versions/pcb

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Name of version. Example: 1.0

models   integer[]  optional  

Device Model ID. The id of an existing record in the App\Models\DeviceModel table.

hardware_id   string   

Hardware ID name. Example: 1

Response

Response Fields

id   integer   

PCB version ID.

name   string   

Version name.

hardware_id   string   

Hardware identifier.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Update PCB version

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/versions/pcb/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"1.0\",
    \"models\": [
        1
    ],
    \"hardware_id\": \"1\"
}"

const url = new URL(
    "http://localhost:8000/api/versions/pcb/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "1.0",
    "models": [
        1
    ],
    "hardware_id": "1"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 5,
    "name": "6.40.46",
    "hardware_id": "",
    "created_at": "2026-10-26T11:55:26.000000Z",
    "updated_at": "2026-10-26T11:55:26.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update versions",
    "code": "PCB_VERSION:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Version not found):


{
    "message": "Version not found",
    "code": "PCB_VERSION:UPDATE:VERSION_NOT_FOUND"
}

Request   

PUT api/versions/pcb/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

PCB Version ID. Example: 1

Body Parameters

name   string  optional  

Name of version. Example: 1.0

models   integer[]  optional  

Device Model ID. The id of an existing record in the App\Models\DeviceModel table.

hardware_id   string  optional  

Hardware ID name. Example: 1

Response

Response Fields

id   integer   

PCB version ID.

name   string   

Version name.

hardware_id   string   

Hardware identifier.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

Delete PCB version

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/versions/pcb/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/versions/pcb/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Version deleted",
    "code": "PCB_VERSION:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete versions",
    "code": "PCB_VERSION:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (403, Version in use (compatibility)):


{
    "message": "Cannot delete: version is used in compatibility entries (1)",
    "code": "PCB_VERSION:DELETE:VERSION_IN_USE_COMPATIBILITY"
}

Example response (403, Version in use (device)):


{
    "message": "Cannot delete: version is assigned to devices (1)",
    "code": "PCB_VERSION:DELETE:VERSION_IN_USE_DEVICE"
}

Example response (404, Version not found):


{
    "message": "Version not found",
    "code": "PCB_VERSION:DELETE:VERSION_NOT_FOUND"
}

Request   

DELETE api/versions/pcb/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

PCB Version ID. Example: 1

List compatibilities

requires authentication

Most typical scenarios to use compatibility matrix:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/versions/compatibility?model=1&software=1.2&firmware=1.5&pcb=1.0&summary=" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/versions/compatibility"
);

const params = {
    "model": "1",
    "software": "1.2",
    "firmware": "1.5",
    "pcb": "1.0",
    "summary": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "device_model_id": 10,
            "software_version_id": 4,
            "firmware_version_id": 14,
            "pcb_version_id": 6,
            "is_fully_compatible": 0,
            "created_at": "2026-10-26T11:55:26.000000Z",
            "updated_at": "2026-10-26T11:55:26.000000Z",
            "features": [
                {
                    "id": 1,
                    "compatibility_id": 1,
                    "feature_id": 5,
                    "is_compatible": 0,
                    "reason": "Perferendis et est nisi harum qui. Voluptatibus vitae natus voluptatum architecto sequi iusto nihil. Eos non ut sit impedit.",
                    "created_at": "2026-10-26T11:55:26.000000Z",
                    "updated_at": "2026-10-26T11:55:26.000000Z",
                    "feature": {
                        "id": 5,
                        "name": "yellow",
                        "slug": "necessitatibus-adipisci-perferendis-qui-et-qui-voluptatem",
                        "created_at": "2026-10-26T11:55:26.000000Z",
                        "updated_at": "2026-10-26T11:55:26.000000Z"
                    }
                },
                {
                    "id": 2,
                    "compatibility_id": 1,
                    "feature_id": 7,
                    "is_compatible": 0,
                    "reason": "Laudantium natus adipisci magni enim ratione. Nostrum et qui eos doloremque nesciunt. Repudiandae consequatur est consequatur molestiae provident ut nemo.",
                    "created_at": "2026-10-26T11:55:26.000000Z",
                    "updated_at": "2026-10-26T11:55:26.000000Z",
                    "feature": {
                        "id": 7,
                        "name": "lime",
                        "slug": "et-recusandae-cupiditate-illo-sapiente-labore-magni-aut",
                        "created_at": "2026-10-26T11:55:26.000000Z",
                        "updated_at": "2026-10-26T11:55:26.000000Z"
                    }
                },
                {
                    "id": 3,
                    "compatibility_id": 1,
                    "feature_id": 9,
                    "is_compatible": 1,
                    "reason": "Unde veritatis illo suscipit ut. Consectetur voluptatum est autem voluptates dolor porro quas. Distinctio animi labore non.",
                    "created_at": "2026-10-26T11:55:26.000000Z",
                    "updated_at": "2026-10-26T11:55:26.000000Z",
                    "feature": {
                        "id": 9,
                        "name": "teal",
                        "slug": "numquam-sit-quo-porro-consequatur",
                        "created_at": "2026-10-26T11:55:26.000000Z",
                        "updated_at": "2026-10-26T11:55:26.000000Z"
                    }
                }
            ]
        },
        {
            "id": 5,
            "device_model_id": 14,
            "software_version_id": 8,
            "firmware_version_id": 18,
            "pcb_version_id": 10,
            "is_fully_compatible": 0,
            "created_at": "2026-10-26T11:55:26.000000Z",
            "updated_at": "2026-10-26T11:55:26.000000Z",
            "features": [
                {
                    "id": 4,
                    "compatibility_id": 5,
                    "feature_id": 10,
                    "is_compatible": 1,
                    "reason": "Deserunt dolorum accusantium repellendus quasi. Omnis voluptatem quasi voluptatem nihil dolores autem. Optio et neque enim doloribus non nihil sunt quae. Quasi saepe labore eaque repudiandae harum.",
                    "created_at": "2026-10-26T11:55:26.000000Z",
                    "updated_at": "2026-10-26T11:55:26.000000Z",
                    "feature": {
                        "id": 10,
                        "name": "teal",
                        "slug": "inventore-tenetur-modi-autem-modi-expedita-ab",
                        "created_at": "2026-10-26T11:55:26.000000Z",
                        "updated_at": "2026-10-26T11:55:26.000000Z"
                    }
                },
                {
                    "id": 5,
                    "compatibility_id": 5,
                    "feature_id": 12,
                    "is_compatible": 1,
                    "reason": "Quas tenetur qui sit dolorem. Repudiandae tempora autem eaque incidunt similique laborum dolores. Modi vitae nihil expedita voluptatem omnis. Nostrum reiciendis aut dolorum et cum voluptates esse.",
                    "created_at": "2026-10-26T11:55:26.000000Z",
                    "updated_at": "2026-10-26T11:55:26.000000Z",
                    "feature": {
                        "id": 12,
                        "name": "olive",
                        "slug": "ratione-eum-ipsam-autem-doloremque-est-omnis",
                        "created_at": "2026-10-26T11:55:26.000000Z",
                        "updated_at": "2026-10-26T11:55:26.000000Z"
                    }
                },
                {
                    "id": 6,
                    "compatibility_id": 5,
                    "feature_id": 14,
                    "is_compatible": 0,
                    "reason": "Non sed recusandae deleniti nostrum est ullam quibusdam repellendus. Possimus rerum incidunt quia ipsum deleniti est. Animi porro iusto sequi nihil alias sit atque.",
                    "created_at": "2026-10-26T11:55:26.000000Z",
                    "updated_at": "2026-10-26T11:55:26.000000Z",
                    "feature": {
                        "id": 14,
                        "name": "white",
                        "slug": "officiis-excepturi-non-distinctio-consequatur-optio-laudantium-neque",
                        "created_at": "2026-10-26T11:55:26.000000Z",
                        "updated_at": "2026-10-26T11:55:26.000000Z"
                    }
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list versions compatibilities",
    "code": "COMPATIBILITY:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, Device model not found):


{
    "message": "Device model not found",
    "code": "COMPATIBILITY:LIST:DEVICE_MODEL_NOT_FOUND"
}

Example response (404, Software version not found):


{
    "message": "Software version not found",
    "code": "COMPATIBILITY:LIST:SOFTWARE_VERSION_NOT_FOUND"
}

Example response (404, Firmware version not found):


{
    "message": "Firmware version not found",
    "code": "COMPATIBILITY:LIST:FIRMWARE_VERSION_NOT_FOUND"
}

Example response (404, PCB version not found):


{
    "message": "PCB version not found",
    "code": "COMPATIBILITY:LIST:PCB_VERSION_NOT_FOUND"
}

Request   

GET api/versions/compatibility

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

model   integer  optional  

Filter compatibility matrix by device model ID. Example: 1

software   string  optional  

Filter compatibility matrix by software version name (not ID!). Example: 1.2

firmware   string  optional  

Filter compatibility matrix by firmware version name (not ID!). Example: 1.5

pcb   string  optional  

Filter compatibility matrix by PCB version name (not ID!). Example: 1.0

summary   boolean  optional  

Add to response the device model, software, firmware and PCB entries used to filter the list. Example: false

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: features, features.feature, deviceModel, softwareVersion, firmwareVersion, pcbVersion).

Response

Response Fields

items   object   
id   integer   

Compatibility entry ID.

device_model_id   integer   

Associated device model ID.

software_version_id   integer   

Associated software version ID.

firmware_version_id   integer   

Associated firmware version ID.

pcb_version_id   integer   

Associated PCB version ID.

is_fully_compatible   boolean   

Whether all versions are fully compatible.

note   string   

Compatibility note.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

features   object[]   

Associated compatibility features.

paginator   object   
total   integer   

Total number of items.

count   integer   

Number of items on current page.

perpage   integer   

Items per page.

current_page   integer   

Current page number.

last_page   integer   

Last page number.

Add compatibility

requires authentication

Adds or updates compatibility matrix with assigned features. You can specify many versions for each list.

Example request:
curl --request POST \
    "http://localhost:8000/api/versions/compatibility" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"device_models\": [
        1
    ],
    \"software_versions\": [
        1
    ],
    \"firmware_versions\": [
        1
    ],
    \"pcb_versions\": [
        1
    ],
    \"is_fully_compatible\": true,
    \"features\": [
        {
            \"feature_id\": 1,
            \"compatible\": true,
            \"reason\": \"Firmware does not support...\"
        }
    ]
}"

const url = new URL(
    "http://localhost:8000/api/versions/compatibility"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "device_models": [
        1
    ],
    "software_versions": [
        1
    ],
    "firmware_versions": [
        1
    ],
    "pcb_versions": [
        1
    ],
    "is_fully_compatible": true,
    "features": [
        {
            "feature_id": 1,
            "compatible": true,
            "reason": "Firmware does not support..."
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202, OK):


{
    "added": 1,
    "updated": 0,
    "not_changed": 0
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to add versions compatibility",
    "code": "COMPATIBILITY:ADD:INSUFFICIENT_PERMISSION"
}

Request   

POST api/versions/compatibility

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

device_models   integer[]  optional  

Array of Device Model IDs. The id of an existing record in the App\Models\DeviceModel table.

software_versions   integer[]  optional  

Array of Software Version IDs. The id of an existing record in the App\Models\SoftwareVersion table.

firmware_versions   integer[]  optional  

Array of Firmware Version IDs. The id of an existing record in the App\Models\FirmwareVersion table.

pcb_versions   integer[]  optional  

Array of PCB Version IDs. The id of an existing record in the App\Models\PCBVersion table.

is_fully_compatible   boolean  optional  

Is this set of versions fully compatible?. Example: true

features   object[]  optional  

Array of features to be assigned to this set of versions.
feature_id   string  optional  

Product feature ID. The id of an existing record in the App\Models\ProductFeature table. Example: 1

compatible   boolean  optional  

Is this feature compatible?. Example: true

reason   string  optional  

Reason of incompatibility. Example: Firmware does not support...

Update compatibility

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/versions/compatibility/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"device_model_id\": 18,
    \"software_version_id\": 11,
    \"firmware_version_id\": 17,
    \"pcb_version_id\": 11,
    \"is_fully_compatible\": true,
    \"features\": [
        {
            \"id\": 1,
            \"feature_id\": 1,
            \"compatible\": true,
            \"reason\": \"Firmware does not support...\",
            \"delete\": true
        }
    ]
}"

const url = new URL(
    "http://localhost:8000/api/versions/compatibility/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "device_model_id": 18,
    "software_version_id": 11,
    "firmware_version_id": 17,
    "pcb_version_id": 11,
    "is_fully_compatible": true,
    "features": [
        {
            "id": 1,
            "feature_id": 1,
            "compatible": true,
            "reason": "Firmware does not support...",
            "delete": true
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (202):


{
    "id": 9,
    "device_model_id": 18,
    "software_version_id": 12,
    "firmware_version_id": 22,
    "pcb_version_id": 14,
    "is_fully_compatible": 0,
    "created_at": "2026-10-26T11:55:27.000000Z",
    "updated_at": "2026-10-26T11:55:27.000000Z",
    "features": [
        {
            "id": 7,
            "compatibility_id": 9,
            "feature_id": 15,
            "is_compatible": 1,
            "reason": "Quidem quam incidunt et quisquam voluptatem. Similique placeat illum vel voluptas. Expedita animi fuga enim itaque necessitatibus fuga accusamus. Est qui tempora soluta veniam inventore odit dicta.",
            "created_at": "2026-10-26T11:55:27.000000Z",
            "updated_at": "2026-10-26T11:55:27.000000Z",
            "feature": {
                "id": 15,
                "name": "navy",
                "slug": "quia-quos-itaque-recusandae-aut-quo",
                "created_at": "2026-10-26T11:55:27.000000Z",
                "updated_at": "2026-10-26T11:55:27.000000Z"
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update versions compatibility",
    "code": "COMPATIBILITY:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Versions Compatibility not found):


{
    "message": "Versions compatibility not found",
    "code": "COMPATIBILITY:UPDATE:COMPATIBILITY_NOT_FOUND"
}

Request   

PUT api/versions/compatibility/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Versions Compatibility ID. Example: 1

Body Parameters

device_model_id   integer  optional  

Device Model ID. The id of an existing record in the App\Models\DeviceModel table. Example: 18

software_version_id   integer  optional  

Software Version ID. The id of an existing record in the App\Models\SoftwareVersion table. Example: 11

firmware_version_id   integer  optional  

Firmware Version ID. The id of an existing record in the App\Models\FirmwareVersion table. Example: 17

pcb_version_id   integer  optional  

PCB Version ID. The id of an existing record in the App\Models\PCBVersion table. Example: 11

is_fully_compatible   boolean  optional  

Is this set of versions fully compatible?. Example: true

features   object[]  optional  

Array of features to be assigned to this set of versions.
id   string  optional  

Versions compatibility feature ID. Use with delete parameter to delete specific entry. Do not confuse with feature_id, this field refers to ID of relation between versions compatibility and product feature. The id of an existing record in the App\Models\VersionsCompatibilityFeature table. Example: 1

feature_id   string  optional  

Product feature ID. The id of an existing record in the App\Models\ProductFeature table. Example: 1

compatible   boolean  optional  

Is this feature compatible?. Example: true

reason   string  optional  

Reason of incompatibility. Example: Firmware does not support...

delete   boolean  optional  

Pass 1 to detach feature from this set of versions, skip otherwise. Example: true

Response

Response Fields

id   integer   

Compatibility entry ID.

device_model_id   integer   

Associated device model ID.

software_version_id   integer   

Associated software version ID.

firmware_version_id   integer   

Associated firmware version ID.

pcb_version_id   integer   

Associated PCB version ID.

is_fully_compatible   boolean   

Whether all versions are fully compatible.

note   string   

Compatibility note.

created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

features   object[]   

Associated compatibility features.

Delete compatibility

requires authentication

Example request:
curl --request DELETE \
    "http://localhost:8000/api/versions/compatibility/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/versions/compatibility/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Versions compatibility deleted",
    "code": "COMPATIBILITY:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete versions compatibility",
    "code": "COMPATIBILITY:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Versions compatibility not found):


{
    "message": "Versions compatibility not found",
    "code": "COMPATIBILITY:DELETE:COMPATIBILITY_NOT_FOUND"
}

Request   

DELETE api/versions/compatibility/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Versions Compatibility ID. Example: 1

Video sessions

API endpoints for managing video sessions

List video sessions

requires authentication

Returns list of open video sessions. For most cases there should be exactly one entry (open/active session) or exactly zero entries (empty array, no open sessions).

Example request:
curl --request GET \
    --get "http://localhost:8000/api/sessions/video/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/sessions/video/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "moderator_id": 127,
        "guest_id": 128,
        "jwt_moderator": "fe7a34c814a0f602c6180927dfc4c193bc7f163f1aeecc8f0c7a721bca9499de",
        "jwt_guest": "760176194068f3029466de5c06f1faa6471a566c66eda866e984f0ca6674d96f",
        "room_name": "room_abf84c332f17ebcce53ca023a2fc4d50",
        "expires": 1793016558,
        "status": "open",
        "created_at": "2026-10-26T11:54:19.000000Z",
        "updated_at": "2026-10-26T11:54:19.000000Z"
    },
    {
        "id": 2,
        "moderator_id": 131,
        "guest_id": 132,
        "jwt_moderator": "6c7931aeb78aebe13b0d2000645e14113d2bcd6a949624b940c3de3fdd51830b",
        "jwt_guest": "6402c51c6f5a3e7d37a4e55e355f5032a0b68872843882cc1fc41ebaef087377",
        "room_name": "room_db7cb4a0d04e7d1d00c78a343c312676",
        "expires": 1793016560,
        "status": "open",
        "created_at": "2026-10-26T11:54:21.000000Z",
        "updated_at": "2026-10-26T11:54:21.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access video session",
    "code": "VIDEO_SESSIONS:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "VIDEO_SESSIONS:LIST:USER_NOT_FOUND"
}

Request   

GET api/sessions/video/{guestId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

guestId   integer   

User ID (guest of the meeting). Example: 1

Response

Response Fields

id   integer   

Video session ID.

moderator_id   integer   

Moderator user ID.

guest_id   integer   

Guest user ID.

jwt_moderator   string   

JWT token for the moderator.

jwt_guest   string   

JWT token for the guest.

room_name   string   

Video room name.

expires   integer   

Session expiry as Unix timestamp.

status   string   

Session status.

Must be one of:
  • open
  • expired
  • closed
created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

moderator   object   

Moderator user.

guest   object   

Guest user.

Initialize video session

requires authentication

Creates JWT (JSON Web Token) and room name for Jitsi session. Logged-in user is a moderator of the session. JWT lifetime is 15 minutes.

Example request:
curl --request POST \
    "http://localhost:8000/api/sessions/video/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/sessions/video/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (201):


{
    "id": 3,
    "moderator_id": 135,
    "guest_id": 136,
    "jwt_moderator": "85756a474e257033f25556671875139001822d37a1b9cfb9cf6c4a3b2acb0eaa",
    "jwt_guest": "469cc643a19fb75901e5d331b8dc14befa8b98810b246c2fb22fff0c382dc39e",
    "room_name": "room_66f9b0a9ac89118e0a7f6ee78044b4aa",
    "expires": 1793016562,
    "status": "open",
    "created_at": "2026-10-26T11:54:23.000000Z",
    "updated_at": "2026-10-26T11:54:23.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to initialize video session",
    "code": "VIDEO_SESSIONS:INIT:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "VIDEO_SESSIONS:INIT:USER_NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error",
    "code": "VIDEO_SESSIONS:INIT:SERVER_ERROR"
}

Request   

POST api/sessions/video/{guestId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

guestId   integer   

User ID (guest of the meeting). Example: 1

Response

Response Fields

id   integer   

Video session ID.

moderator_id   integer   

Moderator user ID.

guest_id   integer   

Guest user ID.

jwt_moderator   string   

JWT token for the moderator.

jwt_guest   string   

JWT token for the guest.

room_name   string   

Video room name.

expires   integer   

Session expiry as Unix timestamp.

status   string   

Session status.

Must be one of:
  • open
  • expired
  • closed
created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

moderator   object   

Moderator user.

guest   object   

Guest user.

Refresh video session

requires authentication

Refreshes video session JWT tokens to extend session lifetime.

Example request:
curl --request POST \
    "http://localhost:8000/api/sessions/video/1/refresh" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/sessions/video/1/refresh"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (202):


{
    "id": 4,
    "moderator_id": 139,
    "guest_id": 140,
    "jwt_moderator": "73396f3affd1e0c4246d01e46a40fc16c57c102f0da11b34e58ac4a018a75354",
    "jwt_guest": "8fed8061e1e33d96169b9026605172a8fe21eb1ce51756187195be0330536fb7",
    "room_name": "room_db9b26bcba845b88bb95d4d5618f3146",
    "expires": 1793016564,
    "status": "open",
    "created_at": "2026-10-26T11:54:25.000000Z",
    "updated_at": "2026-10-26T11:54:25.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to refresh video session",
    "code": "VIDEO_SESSIONS:REFRESH:INSUFFICIENT_PERMISSION"
}

Example response (404, Session not found):


{
    "message": "Video session not found",
    "code": "VIDEO_SESSIONS:REFRESH:SESSION_NOT_FOUND"
}

Request   

POST api/sessions/video/{sessionId}/refresh

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

sessionId   integer   

Video Session ID. Example: 1

Response

Response Fields

id   integer   

Video session ID.

moderator_id   integer   

Moderator user ID.

guest_id   integer   

Guest user ID.

jwt_moderator   string   

JWT token for the moderator.

jwt_guest   string   

JWT token for the guest.

room_name   string   

Video room name.

expires   integer   

Session expiry as Unix timestamp.

status   string   

Session status.

Must be one of:
  • open
  • expired
  • closed
created_at   string   

Creation timestamp.

updated_at   string   

Last update timestamp.

moderator   object   

Moderator user.

guest   object   

Guest user.

Close video session

requires authentication

Marks video session (database entry) as closed. Does not close session on Jitsi side.

Example request:
curl --request DELETE \
    "http://localhost:8000/api/sessions/video/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/sessions/video/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (202, OK):


{
    "message": "Video session closed",
    "code": "VIDEO_SESSIONS:CLOSE:CLOSED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to close video session",
    "code": "VIDEO_SESSIONS:CLOSE:INSUFFICIENT_PERMISSION"
}

Example response (404, Session not found):


{
    "message": "Video session not found",
    "code": "VIDEO_SESSIONS:CLOSE:SESSION_NOT_FOUND"
}

Request   

DELETE api/sessions/video/{sessionId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

sessionId   integer   

Video Session ID. Example: 1

Invite technical support

requires authentication

Sends notification to Slack channel. Link to meeting is valid for 10 minutes.

Example request:
curl --request POST \
    "http://localhost:8000/api/sessions/video/invite-support/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"room\": \"room_1081c785cf1464e4d6ebc3976561d490\",
    \"description\": \"Grip switching is not working, please join.\"
}"

const url = new URL(
    "http://localhost:8000/api/sessions/video/invite-support/1"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "room": "room_1081c785cf1464e4d6ebc3976561d490",
    "description": "Grip switching is not working, please join."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200, OK):


{
    "response": "success",
    "code": "VIDEO_SESSIONS:INVITE_TECH_SUPPORT:SUCCESS"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to invite tech support",
    "code": "VIDEO_SESSIONS:INVITE_TECH_SUPPORT:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "VIDEO_SESSIONS:INVITE_TECH_SUPPORT:DEVICE_NOT_FOUND"
}

Example response (500, Request failed):


{
    "response": "invalid_payload",
    "code": "VIDEO_SESSIONS:INVITE_TECH_SUPPORT:FAILED"
}

Request   

POST api/sessions/video/invite-support/{deviceId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID (current device of the session). Example: 1

Body Parameters

room   string   

Name of Jitsi room to connect. Example: room_1081c785cf1464e4d6ebc3976561d490

description   string  optional  

Description of problem provided by clinician. Example: Grip switching is not working, please join.

Wizard

Endpoints related to the device setup wizard prompt (Guide vs Configurator choice)

Save wizard prompt choice

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/wizard-prompt" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"choice\": \"guide\",
    \"dont_ask_again\": false
}"

const url = new URL(
    "http://localhost:8000/api/device/1/wizard-prompt"
);

const headers = {
    "Authorization": "Bearer {ACCESS_TOKEN}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "choice": "guide",
    "dont_ask_again": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (201):


{
    "id": 1,
    "user_id": 79,
    "device_id": 68,
    "choice": "dismissed",
    "dont_ask_again": 0,
    "created_at": "2026-10-26T11:53:53.000000Z",
    "updated_at": "2026-10-26T11:53:53.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update device config",
    "code": "WIZARD:SAVE_PROMPT:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "WIZARD:SAVE_PROMPT:DEVICE_NOT_FOUND"
}

Request   

POST api/device/{deviceId}/wizard-prompt

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Body Parameters

choice   string   

What the clinician chose in the wizard prompt. Example: guide

Must be one of:
  • guide
  • configurator
  • dismissed
dont_ask_again   boolean  optional  

Whether user checked the "don't ask again" checkbox. Example: false