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.
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.
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:
maxChecks 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_sizeChecks 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
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:
RULES:URL_EXISTS_RULE:NOT_FOUND
content_typeRULES:URL_EXISTS_RULE:NOT_FOUND
Checks whether the specified URL exists and returns an HTTP 200 response.
If
Otherwise, it only checks the status code and returns
Fails if HTTP code is not 200 or the Content-Type doesn't match the expected value (if specified).
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.
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "3505",
"country": "Congo",
"medical_training": "physician",
"myo_exp_zeus": "0",
"has_demo_hand_access": 0,
"wants_demo_hand": 1,
"myo_exp_covvi": 0,
"myo_exp_fillauer": 0,
"myo_exp_ossur": 0,
"myo_exp_ottobock": 1,
"myo_exp_steeper": 1,
"myo_exp_taska": 0,
"myo_exp_vincent": 0,
"myo_exp_pattern_recognition": 0,
"myo_exp_other": "Omnis consequatur sint ut recusandae et nesciunt.",
"partial_hand_protheses": "2",
"below_elbow_protheses_single_action": "2",
"below_elbow_protheses_multi_action": "1",
"above_elbow_protheses": "2",
"shoulder_protheses": "4",
"zeus_components_description": "Eum sit modi dolores fugit quod voluptatem.",
"contact_name": "Shanelle",
"contact_surname": "Von",
"company_name": "Gleason, Cremin and Olson",
"street": "20912 Waelchi Canyon Apt. 781",
"city": "Gaychester",
"postal_code": "66309",
"email": "elsie41@roberts.com",
"phone": "+1 (405) 978-5173",
"phone_country": "td",
"device_side": "R",
"created_at": "2026-09-17T09:24:07.000000Z",
"updated_at": "2026-09-17T09:24:07.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:LR
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": "36",
"country": "Finland",
"medical_training": "biomedical_engineer",
"myo_exp_zeus": "0",
"has_demo_hand_access": 1,
"wants_demo_hand": 1,
"myo_exp_covvi": 1,
"myo_exp_fillauer": 1,
"myo_exp_ossur": 0,
"myo_exp_ottobock": 1,
"myo_exp_steeper": 0,
"myo_exp_taska": 1,
"myo_exp_vincent": 1,
"myo_exp_pattern_recognition": 1,
"myo_exp_other": "Dolores quia maxime facilis voluptatibus possimus tempore.",
"partial_hand_protheses": "1",
"below_elbow_protheses_single_action": "0",
"below_elbow_protheses_multi_action": "4",
"above_elbow_protheses": "0",
"shoulder_protheses": "1",
"zeus_components_description": "Et neque consequatur dolorem nam nemo eos.",
"contact_name": "Rashad",
"contact_surname": "Toy",
"company_name": "Moen LLC",
"street": "644 Kilback Key Apt. 212",
"city": "Jacobifurt",
"postal_code": "01770",
"email": "dfeest@prohaska.com",
"phone": "(838) 544-3839",
"phone_country": "ir",
"device_side": "R",
"created_at": "2026-09-17T09:24:09.000000Z",
"updated_at": "2026-09-17T09:24:09.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:LR
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": "482803",
"country": "Luxembourg",
"medical_training": "physiotherapist",
"myo_exp_zeus": "1",
"has_demo_hand_access": 1,
"wants_demo_hand": 0,
"myo_exp_covvi": 0,
"myo_exp_fillauer": 1,
"myo_exp_ossur": 0,
"myo_exp_ottobock": 1,
"myo_exp_steeper": 0,
"myo_exp_taska": 0,
"myo_exp_vincent": 1,
"myo_exp_pattern_recognition": 1,
"myo_exp_other": "Quos voluptatibus non molestias ea.",
"partial_hand_protheses": "4",
"below_elbow_protheses_single_action": "0",
"below_elbow_protheses_multi_action": "2",
"above_elbow_protheses": "1",
"shoulder_protheses": "0",
"zeus_components_description": "Et itaque molestias dolores ut.",
"contact_name": "Anjali",
"contact_surname": "Beatty",
"company_name": "Kiehn-Wilderman",
"street": "95344 Hirthe Alley",
"city": "North Marina",
"postal_code": "97234",
"email": "demard@jaskolski.com",
"phone": "(602) 715-3382",
"phone_country": "sm",
"device_side": "R",
"created_at": "2026-09-17T09:24:09.000000Z",
"updated_at": "2026-09-17T09:24:09.000000Z"
},
{
"id": 4,
"user_id": 304,
"cpo_number": "646402514",
"country": "Namibia",
"medical_training": "biomedical_engineer",
"myo_exp_zeus": "1",
"has_demo_hand_access": 0,
"wants_demo_hand": 1,
"myo_exp_covvi": 0,
"myo_exp_fillauer": 1,
"myo_exp_ossur": 1,
"myo_exp_ottobock": 1,
"myo_exp_steeper": 1,
"myo_exp_taska": 1,
"myo_exp_vincent": 1,
"myo_exp_pattern_recognition": 1,
"myo_exp_other": "A alias error voluptatum ab.",
"partial_hand_protheses": "5",
"below_elbow_protheses_single_action": "3",
"below_elbow_protheses_multi_action": "4",
"above_elbow_protheses": "2",
"shoulder_protheses": "3",
"zeus_components_description": "Assumenda commodi dolor ut natus.",
"contact_name": "Wellington",
"contact_surname": "Schultz",
"company_name": "Medhurst, Carroll and Bogisich",
"street": "8172 Margaretta Mountains",
"city": "Denesikfort",
"postal_code": "14192",
"email": "brionna.altenwerth@oberbrunner.info",
"phone": "+1 (470) 538-6573",
"phone_country": "tc",
"device_side": "R",
"created_at": "2026-09-17T09:24:10.000000Z",
"updated_at": "2026-09-17T09:24:10.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to use Acadle",
"code": "ACADLE:SURVEYS:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:LR
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\": 47,
\"country\": \"Armenia\",
\"medical_training\": \"clinician\",
\"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\": \"Excepturi adipisci consectetur assumenda aut.\",
\"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\": \"Accusantium repellat culpa sunt excepturi quod.\",
\"contact_name\": \"Jakayla\",
\"company_name\": \"Cartwright, Yundt and Hickle\",
\"street\": \"3334 Norbert Roads\",
\"city\": \"Kianafurt\",
\"postal_code\": \"77965-5292\",
\"email\": \"bernadette56@abshire.net\",
\"phone\": \"+1-219-977-2214\",
\"phone_country\": \"JE\",
\"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": 47,
"country": "Armenia",
"medical_training": "clinician",
"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": "Excepturi adipisci consectetur assumenda aut.",
"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": "Accusantium repellat culpa sunt excepturi quod.",
"contact_name": "Jakayla",
"company_name": "Cartwright, Yundt and Hickle",
"street": "3334 Norbert Roads",
"city": "Kianafurt",
"postal_code": "77965-5292",
"email": "bernadette56@abshire.net",
"phone": "+1-219-977-2214",
"phone_country": "JE",
"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": "664939",
"country": "Myanmar",
"medical_training": "biomedical_engineer",
"myo_exp_zeus": "1",
"has_demo_hand_access": 0,
"wants_demo_hand": 0,
"myo_exp_covvi": 0,
"myo_exp_fillauer": 0,
"myo_exp_ossur": 0,
"myo_exp_ottobock": 0,
"myo_exp_steeper": 0,
"myo_exp_taska": 0,
"myo_exp_vincent": 1,
"myo_exp_pattern_recognition": 0,
"myo_exp_other": "Illum ullam deleniti ea harum quo autem ea.",
"partial_hand_protheses": "5",
"below_elbow_protheses_single_action": "0",
"below_elbow_protheses_multi_action": "3",
"above_elbow_protheses": "2",
"shoulder_protheses": "4",
"zeus_components_description": "Quisquam qui at dolore ut voluptas molestiae.",
"contact_name": "Efrain",
"contact_surname": "Spinka",
"company_name": "Herzog-Feil",
"street": "43306 O'Hara Burgs Suite 340",
"city": "Angelofurt",
"postal_code": "59778-3733",
"email": "damore.janessa@marquardt.com",
"phone": "(240) 918-5396",
"phone_country": "ma",
"device_side": "L",
"created_at": "2026-09-17T09:24:11.000000Z",
"updated_at": "2026-09-17T09:24:11.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:LR
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": "7PA2T9",
"created_by": 41,
"used_by": 42,
"used_at": null,
"active": 1,
"created_at": "2026-09-17T09:21:28.000000Z",
"updated_at": "2026-09-17T09:21:28.000000Z"
},
{
"id": 2,
"code": "EAPKUG",
"created_by": 43,
"used_by": 44,
"used_at": null,
"active": 1,
"created_at": "2026-09-17T09:21:28.000000Z",
"updated_at": "2026-09-17T09:21:28.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to manage activation codes",
"code": "ACTIVATION_CODE:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "HTYK55",
"created_by": 45,
"used_by": 46,
"used_at": null,
"active": 0,
"created_at": "2026-09-17T09:21:30.000000Z",
"updated_at": "2026-09-17T09:21:30.000000Z"
},
{
"id": 4,
"code": "CJQLBA",
"created_by": 47,
"used_by": 48,
"used_at": null,
"active": 1,
"created_at": "2026-09-17T09:21:31.000000Z",
"updated_at": "2026-09-17T09:21:31.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to manage activation codes",
"code": "ACTIVATION_CODE:ACTIVE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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/vel" \
--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/vel"
);
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": "3KKZ6M",
"created_by": null,
"used_by": null,
"used_at": null,
"active": 0,
"created_at": "2026-09-17T09:21:31.000000Z",
"updated_at": "2026-09-17T09:21:31.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "JV9T76",
"created_by": null,
"used_by": null,
"used_at": null,
"active": 0,
"created_at": "2026-09-17T09:21:31.000000Z",
"updated_at": "2026-09-17T09:21:31.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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/3" \
--header "Authorization: Bearer {ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/activation-codes/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 (201):
{
"id": 7,
"code": "766UDH",
"created_by": null,
"used_by": null,
"used_at": null,
"active": 0,
"created_at": "2026-09-17T09:21:31.000000Z",
"updated_at": "2026-09-17T09:21:31.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to manage activation codes",
"code": "ACTIVATION_CODE:CREATE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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/18" \
--header "Authorization: Bearer {ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/activation-codes/18"
);
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": "6T4CRC",
"created_by": null,
"used_by": null,
"used_at": null,
"active": 0,
"created_at": "2026-09-17T09:21:31.000000Z",
"updated_at": "2026-09-17T09:21:31.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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.
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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\": \"(904) 596-3560\",
\"phone_country\": \"US\",
\"language\": \"en\",
\"clinic_name\": \"Blick, Anderson and Roberts\",
\"clinic_location\": \"Ricardoshire\",
\"address1\": \"177 Hills Junctions Apt. 871\",
\"address2\": \"East Judahborough, TN 53253\",
\"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": "(904) 596-3560",
"phone_country": "US",
"language": "en",
"clinic_name": "Blick, Anderson and Roberts",
"clinic_location": "Ricardoshire",
"address1": "177 Hills Junctions Apt. 871",
"address2": "East Judahborough, TN 53253",
"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": "XZA5ZTZB1789636859",
"name": "Murphy Jenkins",
"email": "1789636859maximus52@example.com",
"language": "en",
"phone": "+1.872.368.4373",
"phone_country": "GF",
"phone_verified_at": null,
"address1": "25796 Wisoky Manor Apt. 353",
"address2": "Braxtonbury, NM 81478",
"postal_code": "43950-0873",
"city": "Mayer, Sipes and Heller",
"country": "IE",
"clinic_name": "North Frank",
"clinic_location": "3994 Ratke Summit Apt. 534\nSouth Golda, ID 18141",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:20:59.000000Z",
"updated_at": "2026-09-17T09:20:59.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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": "47JC7VZW1789636860",
"name": "Mr. Lance Reilly DDS",
"email": "1789636860jadyn.douglas@example.com",
"language": "en",
"phone": "+18607941255",
"phone_country": "AE",
"phone_verified_at": null,
"address1": "3108 Elwyn Points Suite 583",
"address2": "New Cathryn, NE 03464-7842",
"postal_code": "04908",
"city": "Kovacek-Bashirian",
"country": "HR",
"clinic_name": "New Geraldchester",
"clinic_location": "67795 Schultz Crossing Apt. 411\nWest Rosieside, NY 63763-0137",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:00.000000Z",
"updated_at": "2026-09-17T09:21:00.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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):
[]
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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):
[]
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "4WNMP4EA1789637075",
"name": "Arlene Block",
"email": "1789637075llegros@example.net",
"language": "en",
"phone": "+1.480.955.7799",
"phone_country": "YT",
"phone_verified_at": null,
"address1": "46857 Kirstin Roads",
"address2": "Helgahaven, NC 70523-8318",
"postal_code": "85131-8015",
"city": "Nolan-Kihn",
"country": "IT",
"clinic_name": "Lake Nataliaburgh",
"clinic_location": "526 Medhurst Tunnel Apt. 429\nEast Leanneside, FL 17907-8301",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:24:35.000000Z",
"updated_at": "2026-09-17T09:24:35.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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
List all chat rooms
requires authentication
This method retrieves all chat rooms. Possible extend options:
- participants - user assigned to chat room
- participants.roles - roles assigned to chat participants
- owner - the clinician assigned to patient
- patient - the patient for whom the chat was created
- messages - the messages related to chat room
- messages.author - the author of message/li>
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": 20,
"current_page": 1,
"last_page": 1
},
"items": [
{
"id": 1,
"owner": null,
"patient_id": null,
"encryption_key": "xDHptrH/euU225tf4p1WrkD33TV2dCcAE12f82TbAWY=",
"name": "autem",
"friendly_name": "autem",
"created_at": "2026-09-17T09:24:02.000000Z",
"deleted_at": null,
"updated_at": "2026-09-17T09:24:02.000000Z"
},
{
"id": 2,
"owner": null,
"patient_id": null,
"encryption_key": "/YpQEFOpo1Hu0Iu1uC8He7rJBvTMjpWL9cY8na/vb1I=",
"name": "magnam",
"friendly_name": "magnam",
"created_at": "2026-09-17T09:24:02.000000Z",
"deleted_at": null,
"updated_at": "2026-09-17T09:24:02.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to list chat room",
"code": "CHAT:LIST_ROOMS:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:
- participants - user assigned to chat room
- owner - the clinician assigned to patient
- patient - the patient for whom the chat was created
- messages - the messages related to chat room
- messages.author - the author of message/li>
Example request:
curl --request GET \
--get "http://localhost:8000/api/chat/room/suscipit" \
--header "Authorization: Bearer {ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/chat/room/suscipit"
);
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": "j2MaCzEEpzo7OY9fj5jY/VZxm9ERImY26zSoS6vBj8w=",
"name": "officiis",
"friendly_name": "officiis",
"created_at": "2026-09-17T09:24:02.000000Z",
"deleted_at": null,
"updated_at": "2026-09-17T09:24:02.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "kEkl17pg5PBDWylLm5seMT8QB547fWLAfpFpG14sG+0=",
"name": "culpa",
"friendly_name": "culpa",
"created_at": "2026-09-17T09:24:02.000000Z",
"deleted_at": null,
"updated_at": "2026-09-17T09:24:02.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to view chat room",
"code": "CHAT:CREATE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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/tempore" \
--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/tempore"
);
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": "UmS+4So8QAxiSJKu4lW0IJLyJJaubrbQ41VINxNr9B4=",
"name": "dolorem",
"friendly_name": "dolorem",
"created_at": "2026-09-17T09:24:02.000000Z",
"deleted_at": null,
"updated_at": "2026-09-17T09:24:02.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:
- author - this field represent user who send message
Example request:
curl --request GET \
--get "http://localhost:8000/api/chat/room/molestiae/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/molestiae/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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Unread messages
requires authentication
Get unread messaged for chat room. Possible extend options:
- author - this field represent user who send message
Example request:
curl --request GET \
--get "http://localhost:8000/api/chat/messages/unread?room=9" \
--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": "9",
};
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete chat message
requires authentication
Example request:
curl --request DELETE \
"http://localhost:8000/api/chat/messages/8?msgId=sed" \
--header "Authorization: Bearer {ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/chat/messages/8"
);
const params = {
"msgId": "sed",
};
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get tickets list for chat room
requires authentication
Possible extend options:
- sender - the user who created ticket
- recipient - the user who was ticket recipient
- messages - message allocated to ticket
- messages.attachments - list of attachments assigned to message and ticket
- messages.sender - the user who wrote the message
Example request:
curl --request GET \
--get "http://localhost:8000/api/chat/tickets/aliquam?status=deserunt&sender=6&recipient=4" \
--header "Authorization: Bearer {ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"http://localhost:8000/api/chat/tickets/aliquam"
);
const params = {
"status": "deserunt",
"sender": "6",
"recipient": "4",
};
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-09-17 09:24:03",
"meeting_type": "online_meeting",
"contact_email": "andrew.marvin@heathcote.biz",
"status": "new",
"created_at": "2026-09-17T09:24:03.000000Z",
"updated_at": "2026-09-17T09:24:03.000000Z",
"sender": {
"id": 293,
"mrn": "VYMBY3N51789637042",
"name": "Dr. Elwyn Stiedemann",
"email": "1789637042stoltenberg.josefina@example.com",
"language": "en",
"phone": "+19522496732",
"phone_country": "AQ",
"phone_verified_at": null,
"address1": "9431 Koss Falls Apt. 855",
"address2": "Savionbury, VT 47872",
"postal_code": "31155-3702",
"city": "Lueilwitz Group",
"country": "CY",
"clinic_name": "Katlynnhaven",
"clinic_location": "314 Rice Point Suite 776\nWest Bereniceburgh, CA 95626",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:24:02.000000Z",
"updated_at": "2026-09-17T09:24:02.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"recipient": {
"id": 294,
"mrn": "8L4BEWE21789637043",
"name": "Mathilde Heidenreich",
"email": "1789637043okozey@example.com",
"language": "en",
"phone": "+1-463-379-9819",
"phone_country": "PF",
"phone_verified_at": null,
"address1": "399 Erwin Junctions Suite 435",
"address2": "Port Nicole, NC 20000-7076",
"postal_code": "32161-2428",
"city": "McClure, Kunze and Cormier",
"country": "GR",
"clinic_name": "North Hermina",
"clinic_location": "6062 Alyson Corner Suite 233\nSouth Vidalborough, KY 65774-1311",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:24:03.000000Z",
"updated_at": "2026-09-17T09:24:03.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-09-17 09:24:03",
"meeting_type": "online_meeting",
"contact_email": "gulgowski.kara@hotmail.com",
"status": "new",
"created_at": "2026-09-17T09:24:04.000000Z",
"updated_at": "2026-09-17T09:24:04.000000Z",
"sender": {
"id": 295,
"mrn": "73DG49GN1789637043",
"name": "Mr. Royal Williamson I",
"email": "1789637043norris.block@example.com",
"language": "en",
"phone": "1-760-898-3083",
"phone_country": "TF",
"phone_verified_at": null,
"address1": "406 Flossie Wells Suite 202",
"address2": "Haagburgh, VT 80886-1430",
"postal_code": "72227",
"city": "Schowalter LLC",
"country": "LV",
"clinic_name": "Port Jacynthe",
"clinic_location": "6076 Joelle Turnpike\nNew Kellietown, NE 22779-8265",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:24:03.000000Z",
"updated_at": "2026-09-17T09:24:03.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"recipient": {
"id": 296,
"mrn": "BDEWXFCF1789637043",
"name": "Giovani Maggio",
"email": "1789637043carroll.asa@example.com",
"language": "en",
"phone": "862-509-3194",
"phone_country": "KR",
"phone_verified_at": null,
"address1": "6311 Flatley Passage",
"address2": "Port Sister, CA 07938-0800",
"postal_code": "02779",
"city": "Ankunding-Nitzsche",
"country": "BG",
"clinic_name": "South Alexzandermouth",
"clinic_location": "611 Stehr Creek Apt. 856\nKimland, WI 06501",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:24:03.000000Z",
"updated_at": "2026-09-17T09:24:03.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:onlinein-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:
- clinician - clinician assigned to this user
- devices - products assigned to user
- roles - user roles
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": "Z5ZD7K7Z1789637044",
"name": "Mr. Colt Streich",
"email": "1789637044tyler.konopelski@example.org",
"language": "en",
"phone": "1-540-330-5722",
"phone_country": "EE",
"phone_verified_at": null,
"address1": "1648 Darion Crossroad Suite 232",
"address2": "Lake Vivianeborough, ME 09671-8835",
"postal_code": "98722-2910",
"city": "Hudson and Sons",
"country": "FR",
"clinic_name": "New Craigburgh",
"clinic_location": "53600 Streich Row\nLake Wilhelmineside, NC 98727-0725",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:24:04.000000Z",
"updated_at": "2026-09-17T09:24:04.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"devices": [
{
"id": 150,
"serial": "b5752ce8-db39-3f17-b6d1-69d7eb8a8039",
"bluetooth_id": "2098d5f1-d642-36aa-aefa-b9516d47cf73",
"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-09-17T09:24:04.000000Z",
"updated_at": "2026-09-17T09:24:04.000000Z",
"first_config_change_at": null
}
],
"roles": [
{
"id": 6,
"name": "Amputee"
}
]
},
{
"id": 298,
"mrn": "U5LFV9C21789637044",
"name": "Hayley Tillman",
"email": "1789637044oswald16@example.org",
"language": "en",
"phone": "+1.573.262.5928",
"phone_country": "IQ",
"phone_verified_at": null,
"address1": "11903 Bosco Cliffs",
"address2": "Romaguerafurt, IA 23358",
"postal_code": "06693",
"city": "McKenzie PLC",
"country": "CY",
"clinic_name": "East Cruzchester",
"clinic_location": "2490 Chase Summit Suite 330\nPort Josianeberg, WV 83248-0237",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:24:04.000000Z",
"updated_at": "2026-09-17T09:24:04.000000Z",
"invitation_status": "accepted",
"acadle_invitation_status": null,
"devices": [
{
"id": 151,
"serial": "dba842f9-e944-373f-a030-df76139872dc",
"bluetooth_id": "176f68ad-0db8-3c64-838a-39aefb750fff",
"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-09-17T09:24:04.000000Z",
"updated_at": "2026-09-17T09:24:04.000000Z",
"first_config_change_at": null
}
],
"roles": [
{
"id": 5,
"name": "ClinicianSupport"
}
]
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to list available patients",
"code": "CHAT:LIST_PATIENTS:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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:
- roles - user roles
- permissions - user permissions
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": "ZL7N8AV81789637045",
"name": "Rachael Crooks",
"email": "1789637045jbartell@example.com",
"language": "en",
"phone": "562-620-6676",
"phone_country": "MU",
"phone_verified_at": null,
"address1": "7743 Bergstrom Stravenue Apt. 941",
"address2": "Okeystad, CT 99298-3482",
"postal_code": "06512-2176",
"city": "Weissnat-Wiza",
"country": "LU",
"clinic_name": "Troybury",
"clinic_location": "11403 Reba Mall\nWest Nona, VA 92640-7520",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:24:05.000000Z",
"updated_at": "2026-09-17T09:24:05.000000Z",
"invitation_status": "accepted",
"acadle_invitation_status": null,
"roles": [
{
"id": 4,
"name": "Clinician"
}
]
},
{
"id": 300,
"mrn": "XL4MESBY1789637045",
"name": "Prof. Myrtice Stracke I",
"email": "1789637045wilkinson.tomasa@example.net",
"language": "en",
"phone": "+1-641-383-9052",
"phone_country": "CL",
"phone_verified_at": null,
"address1": "40901 DuBuque Cliffs",
"address2": "Hellenberg, VT 34931",
"postal_code": "40531-4244",
"city": "Beier, Schinner and Fay",
"country": "SI",
"clinic_name": "Lake Stephonstad",
"clinic_location": "68481 Reynold Keys Suite 912\nWest Jamieshire, DE 46889",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:24:05.000000Z",
"updated_at": "2026-09-17T09:24:05.000000Z",
"invitation_status": "accepted",
"acadle_invitation_status": null,
"roles": [
{
"id": 4,
"name": "Clinician"
}
]
}
]
}
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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/php7L3INw" 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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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/phpF3qeoa" 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": "Vickie Shanahan",
"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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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:
- config - current config entries
- config history entry - set of changes in config, updated during the session
- config history change - single change made to config (part of config history entry)
Example request:
curl --request GET \
--get "http://localhost:8000/api/device/1/config?_format=ut" \
--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": "ut",
};
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": "earum",
"value": "non",
"created_at": "2026-09-17T09:21:31.000000Z",
"updated_at": "2026-09-17T09:21:31.000000Z",
"mode": {
"id": 1,
"device_id": 23,
"slot": null,
"name": "Labore et non explicabo et est.",
"active": 1,
"created_at": "2026-09-17T09:21:31.000000Z",
"updated_at": "2026-09-17T09:21:31.000000Z"
}
},
{
"id": 2,
"device_id": 24,
"mode_id": 2,
"key": "tempora",
"value": "quia",
"created_at": "2026-09-17T09:21:31.000000Z",
"updated_at": "2026-09-17T09:21:31.000000Z",
"mode": {
"id": 2,
"device_id": 25,
"slot": null,
"name": "Sapiente sunt voluptatibus ea vero cum quis.",
"active": 0,
"created_at": "2026-09-17T09:21:31.000000Z",
"updated_at": "2026-09-17T09:21:31.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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\": false
}"
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": false
};
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": "Similique dolorum laboriosam perspiciatis voluptatem et esse.",
"config": "{\"common\":{\"fingerStrength\":[1,400],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[48,7,60,24,16],\"limit\":[71,40,92,68,66]},\"1\":{\"initial\":[63,14,44,70,39],\"limit\":[74,36,88,77,59]},\"2\":{\"initial\":[9,62,34,57,23],\"limit\":[17,71,52,57,40]},\"3\":{\"initial\":[8,3,61,18,7],\"limit\":[44,28,84,24,67]},\"4\":{\"initial\":[5,46,40,5,16],\"limit\":[33,49,64,54,82]},\"5\":{\"initial\":[2,29,29,18,22],\"limit\":[52,43,50,27,46]},\"6\":{\"initial\":[11,66,48,32,24],\"limit\":[39,71,82,74,42]},\"7\":{\"initial\":[87,5,20,48,68],\"limit\":[91,32,46,88,89]},\"8\":{\"initial\":[43,75,60,5,31],\"limit\":[66,93,63,34,53]},\"9\":{\"initial\":[30,8,28,10,30],\"limit\":[69,53,50,18,67]},\"10\":{\"initial\":[10,23,18,14,6],\"limit\":[19,33,28,92,27]},\"11\":{\"initial\":[2,26,40,1,55],\"limit\":[88,58,81,76,86]},\"12\":{\"initial\":[57,15,11,22,39],\"limit\":[59,63,15,48,87]},\"13\":{\"initial\":[20,13,3,40,62],\"limit\":[91,49,28,58,86]}},\"inputSite\":[1]},\"modes\":[{\"id\":3,\"name\":\"Est voluptatum autem ea et mollitia molestiae.\",\"slot\":0,\"config\":{\"autoGrasp\":[1,0],\"coContractionTimings\":[500,500],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[10,100,10,40,40,60,60,100,60,100],\"gripPairsConfig\":[1,7,3,12,11,6,13,4],\"gripSequentialConfig\":[12,255,255,13,11,255,1,5,6,255,10,3],\"gripSwitchingMode\":[3],\"holdOpen\":[2000,2500],\"pulseTimings\":[770,150,630,150],\"softGrip\":[1],\"speedControlStrategy\":[0]}},{\"id\":4,\"name\":\"In ad numquam veniam architecto.\",\"slot\":1,\"config\":{\"autoGrasp\":[1,100],\"coContractionTimings\":[100,100],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[0,100,0,100,30,50,50,30,40,90],\"gripPairsConfig\":[1,5,8,11,4,6,3,9],\"gripSequentialConfig\":[4,11,10,255,13,12,255,7,6,255,255,255],\"gripSwitchingMode\":[3],\"holdOpen\":[2500,2500],\"pulseTimings\":[40,30,210,590],\"softGrip\":[0],\"speedControlStrategy\":[1]}},{\"id\":5,\"name\":\"Vero voluptatem libero molestiae expedita voluptatem voluptatem et.\",\"slot\":2,\"config\":{\"autoGrasp\":[1,100],\"coContractionTimings\":[500,400],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[90,90,90,10,90,20,50,10,30,0],\"gripPairsConfig\":[5,11,12,9,13,10,2,1],\"gripSequentialConfig\":[255,2,8,5,3,255,7,11,12,255,4,255],\"gripSwitchingMode\":[2],\"holdOpen\":[1500,2500],\"pulseTimings\":[260,900,270,940],\"softGrip\":[0],\"speedControlStrategy\":[1]}}]}",
"restore_point": 0,
"factory_reset_point": 0,
"source": "configurator",
"changed_by": 50,
"firmware_version_id": null,
"created_at": "2026-09-17T09:21:32.000000Z",
"updated_at": "2026-09-17T09:21:32.000000Z",
"author": {
"id": 50,
"mrn": "5VK7Y6PH1789636892",
"name": "Axel Hane",
"email": "1789636892leopold36@example.org",
"language": "en",
"phone": "458-370-2066",
"phone_country": "IS",
"phone_verified_at": null,
"address1": "506 Jaydon Lakes",
"address2": "West Ebonyshire, DE 86102-5669",
"postal_code": "66115",
"city": "Cummings-Muller",
"country": "MT",
"clinic_name": "Strackestad",
"clinic_location": "467 Elisa Dale Apt. 671\nLake Parkerstad, WY 84639-9107",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:32.000000Z",
"updated_at": "2026-09-17T09:21:32.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"entries": [
{
"id": 1,
"config_history_id": 1,
"config_id": 3,
"old_value": "et",
"new_value": "quia",
"created_at": "2026-09-17T09:21:33.000000Z",
"updated_at": "2026-09-17T09:21:33.000000Z",
"config_entry": {
"id": 3,
"device_id": 34,
"mode_id": null,
"key": "modi",
"value": "unde",
"created_at": "2026-09-17T09:21:33.000000Z",
"updated_at": "2026-09-17T09:21:33.000000Z"
}
}
]
},
{
"id": 3,
"user_id": null,
"device_id": 35,
"index": null,
"name": "Hic vitae dolorem sunt mollitia.",
"config": "{\"common\":{\"fingerStrength\":[1,100],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[63,5,1,1,34],\"limit\":[66,42,93,83,46]},\"1\":{\"initial\":[21,5,31,18,7],\"limit\":[69,29,73,83,59]},\"2\":{\"initial\":[39,78,53,81,2],\"limit\":[56,80,85,86,73]},\"3\":{\"initial\":[64,28,11,12,71],\"limit\":[78,68,47,88,95]},\"4\":{\"initial\":[51,30,32,33,47],\"limit\":[58,43,59,49,59]},\"5\":{\"initial\":[67,45,20,72,2],\"limit\":[87,81,35,93,10]},\"6\":{\"initial\":[72,68,27,37,44],\"limit\":[95,80,40,65,67]},\"7\":{\"initial\":[33,31,19,61,15],\"limit\":[66,76,41,65,37]},\"8\":{\"initial\":[32,4,14,20,1],\"limit\":[35,85,18,31,14]},\"9\":{\"initial\":[16,6,42,7,27],\"limit\":[44,58,54,84,88]},\"10\":{\"initial\":[10,24,1,19,40],\"limit\":[77,49,38,25,42]},\"11\":{\"initial\":[30,66,66,29,14],\"limit\":[82,77,72,47,82]},\"12\":{\"initial\":[16,39,60,50,16],\"limit\":[64,56,61,89,38]},\"13\":{\"initial\":[50,47,34,42,2],\"limit\":[95,51,83,69,83]}},\"inputSite\":[1]},\"modes\":[{\"id\":9,\"name\":\"Accusantium rem ipsa nobis cupiditate consequatur.\",\"slot\":0,\"config\":{\"autoGrasp\":[0,0],\"coContractionTimings\":[400,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[0,30,20,90,10,30,10,50,50,90],\"gripPairsConfig\":[7,8,5,9,11,10,13,3],\"gripSequentialConfig\":[11,10,13,5,4,255,3,9,8,1,255,2],\"gripSwitchingMode\":[3],\"holdOpen\":[2500,2500],\"pulseTimings\":[70,40,310,960],\"softGrip\":[1],\"speedControlStrategy\":[1]}},{\"id\":10,\"name\":\"Et reprehenderit expedita dignissimos rerum ea hic.\",\"slot\":1,\"config\":{\"autoGrasp\":[1,100],\"coContractionTimings\":[200,200],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[0,10,10,40,20,80,20,80,40,30],\"gripPairsConfig\":[11,3,1,12,9,6,7,2],\"gripSequentialConfig\":[255,255,10,2,255,7,9,4,11,1,6,13],\"gripSwitchingMode\":[3],\"holdOpen\":[1500,2500],\"pulseTimings\":[750,380,100,200],\"softGrip\":[0],\"speedControlStrategy\":[0]}},{\"id\":11,\"name\":\"Tenetur eius sint dolor id.\",\"slot\":2,\"config\":{\"autoGrasp\":[0,0],\"coContractionTimings\":[500,100],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[30,20,30,40,70,10,60,40,10,90],\"gripPairsConfig\":[12,11,3,6,13,9,8,7],\"gripSequentialConfig\":[1,12,13,11,5,3,6,255,255,8,255,4],\"gripSwitchingMode\":[2],\"holdOpen\":[1500,2500],\"pulseTimings\":[740,880,410,420],\"softGrip\":[0],\"speedControlStrategy\":[1]}}]}",
"restore_point": 1,
"factory_reset_point": 0,
"source": "configurator",
"changed_by": 53,
"firmware_version_id": null,
"created_at": "2026-09-17T09:21:34.000000Z",
"updated_at": "2026-09-17T09:21:34.000000Z",
"author": {
"id": 53,
"mrn": "T62YHWJ61789636893",
"name": "Kailee Wehner",
"email": "1789636893philip12@example.net",
"language": "en",
"phone": "(320) 419-9856",
"phone_country": "BG",
"phone_verified_at": null,
"address1": "45373 Darwin Walk Apt. 693",
"address2": "South Assuntaville, OK 16572",
"postal_code": "80767-1619",
"city": "Schneider, Marquardt and Turner",
"country": "BE",
"clinic_name": "West Loiston",
"clinic_location": "3143 Haag Falls\nSouth Dimitristad, FL 88218",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:33.000000Z",
"updated_at": "2026-09-17T09:21:33.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"entries": [
{
"id": 2,
"config_history_id": 3,
"config_id": 4,
"old_value": "ut",
"new_value": "ut",
"created_at": "2026-09-17T09:21:34.000000Z",
"updated_at": "2026-09-17T09:21:34.000000Z",
"config_entry": {
"id": 4,
"device_id": 43,
"mode_id": null,
"key": "esse",
"value": "non",
"created_at": "2026-09-17T09:21:34.000000Z",
"updated_at": "2026-09-17T09:21:34.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Sint itaque repellendus ullam ut quae.",
"config": "{\"common\":{\"fingerStrength\":[1,100],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[13,4,32,29,33],\"limit\":[59,8,36,38,52]},\"1\":{\"initial\":[59,20,39,48,65],\"limit\":[71,73,92,79,73]},\"2\":{\"initial\":[39,53,3,11,5],\"limit\":[64,80,65,95,48]},\"3\":{\"initial\":[32,20,11,1,21],\"limit\":[74,39,85,15,60]},\"4\":{\"initial\":[45,20,46,14,4],\"limit\":[83,93,52,84,12]},\"5\":{\"initial\":[12,27,7,32,16],\"limit\":[79,36,90,60,95]},\"6\":{\"initial\":[38,28,7,47,9],\"limit\":[64,48,66,50,9]},\"7\":{\"initial\":[38,18,69,1,27],\"limit\":[59,94,78,56,67]},\"8\":{\"initial\":[8,27,35,4,17],\"limit\":[43,74,93,48,24]},\"9\":{\"initial\":[37,26,47,21,3],\"limit\":[42,88,79,86,26]},\"10\":{\"initial\":[59,8,10,87,28],\"limit\":[60,78,66,93,84]},\"11\":{\"initial\":[42,48,45,76,32],\"limit\":[52,63,95,93,60]},\"12\":{\"initial\":[6,36,31,11,14],\"limit\":[52,37,41,61,79]},\"13\":{\"initial\":[36,21,21,6,4],\"limit\":[64,31,23,32,77]}},\"inputSite\":[1]},\"modes\":[{\"id\":15,\"name\":\"Consequatur dolor incidunt eligendi dolor aut.\",\"slot\":0,\"config\":{\"autoGrasp\":[1,100],\"coContractionTimings\":[400,200],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[70,50,10,60,30,60,80,50,50,10],\"gripPairsConfig\":[12,8,3,11,5,1,2,13],\"gripSequentialConfig\":[3,12,10,255,13,4,1,5,255,255,6,7],\"gripSwitchingMode\":[3],\"holdOpen\":[2000,2000],\"pulseTimings\":[660,470,800,30],\"softGrip\":[1],\"speedControlStrategy\":[0]}},{\"id\":16,\"name\":\"Voluptatum cupiditate odit et fugiat ut voluptates.\",\"slot\":1,\"config\":{\"autoGrasp\":[0,100],\"coContractionTimings\":[200,100],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[60,70,60,10,10,50,40,0,70,20],\"gripPairsConfig\":[6,4,11,12,5,1,3,2],\"gripSequentialConfig\":[3,12,11,10,255,1,255,255,13,6,255,8],\"gripSwitchingMode\":[2],\"holdOpen\":[1500,2500],\"pulseTimings\":[850,700,830,940],\"softGrip\":[0],\"speedControlStrategy\":[0]}},{\"id\":17,\"name\":\"Velit sint deserunt consectetur quaerat sint eum neque quia.\",\"slot\":2,\"config\":{\"autoGrasp\":[1,100],\"coContractionTimings\":[400,200],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[70,30,40,70,80,10,40,50,10,20],\"gripPairsConfig\":[5,7,2,9,3,4,12,11],\"gripSequentialConfig\":[2,255,8,255,255,6,12,7,255,255,9,5],\"gripSwitchingMode\":[2],\"holdOpen\":[1500,2000],\"pulseTimings\":[900,770,250,680],\"softGrip\":[0],\"speedControlStrategy\":[1]}}]}",
"restore_point": 1,
"factory_reset_point": 0,
"source": "configurator",
"changed_by": 55,
"firmware_version_id": null,
"created_at": "2026-09-17T09:21:35.000000Z",
"updated_at": "2026-09-17T09:21:35.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Fugiat nisi temporibus beatae voluptas laborum.",
"config": "{\"common\":{\"fingerStrength\":[1,100],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[24,67,27,19,8],\"limit\":[62,84,74,46,20]},\"1\":{\"initial\":[25,60,31,39,35],\"limit\":[54,66,87,53,71]},\"2\":{\"initial\":[32,13,13,3,45],\"limit\":[39,89,45,86,71]},\"3\":{\"initial\":[57,8,20,71,18],\"limit\":[60,89,46,90,22]},\"4\":{\"initial\":[26,84,53,65,51],\"limit\":[65,85,63,88,74]},\"5\":{\"initial\":[15,24,44,30,29],\"limit\":[55,63,94,77,79]},\"6\":{\"initial\":[10,47,38,67,62],\"limit\":[33,57,57,79,89]},\"7\":{\"initial\":[12,63,68,53,22],\"limit\":[79,87,82,78,39]},\"8\":{\"initial\":[56,2,38,3,11],\"limit\":[72,45,50,60,86]},\"9\":{\"initial\":[26,16,21,21,37],\"limit\":[35,27,72,56,86]},\"10\":{\"initial\":[31,22,80,10,68],\"limit\":[40,25,94,79,83]},\"11\":{\"initial\":[31,38,20,45,3],\"limit\":[72,88,44,63,55]},\"12\":{\"initial\":[49,9,70,21,66],\"limit\":[72,34,88,67,69]},\"13\":{\"initial\":[66,43,22,42,4],\"limit\":[89,86,91,49,64]}},\"inputSite\":[1]},\"modes\":[{\"id\":18,\"name\":\"Et eum nemo a est.\",\"slot\":0,\"config\":{\"autoGrasp\":[0,0],\"coContractionTimings\":[400,300],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[70,50,30,0,10,70,30,90,90,50],\"gripPairsConfig\":[7,9,10,8,3,6,11,1],\"gripSequentialConfig\":[3,255,2,10,9,255,255,13,1,5,7,4],\"gripSwitchingMode\":[3],\"holdOpen\":[2000,2500],\"pulseTimings\":[170,530,270,860],\"softGrip\":[0],\"speedControlStrategy\":[1]}},{\"id\":19,\"name\":\"Id enim dolor cum.\",\"slot\":1,\"config\":{\"autoGrasp\":[1,100],\"coContractionTimings\":[500,300],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[80,50,30,50,30,80,90,60,50,30],\"gripPairsConfig\":[12,7,6,13,4,8,11,9],\"gripSequentialConfig\":[4,255,5,255,6,10,1,12,255,8,7,11],\"gripSwitchingMode\":[3],\"holdOpen\":[1500,2000],\"pulseTimings\":[650,30,680,180],\"softGrip\":[1],\"speedControlStrategy\":[1]}},{\"id\":20,\"name\":\"Sed quo nam perferendis.\",\"slot\":2,\"config\":{\"autoGrasp\":[1,0],\"coContractionTimings\":[500,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[10,80,70,60,60,80,50,30,100,20],\"gripPairsConfig\":[13,9,6,8,12,1,5,7],\"gripSequentialConfig\":[4,2,9,255,255,6,12,255,5,11,255,1],\"gripSwitchingMode\":[2],\"holdOpen\":[1500,2000],\"pulseTimings\":[410,50,360,880],\"softGrip\":[0],\"speedControlStrategy\":[0]}}]}",
"restore_point": 0,
"factory_reset_point": 0,
"source": "configurator",
"changed_by": 56,
"firmware_version_id": null,
"created_at": "2026-09-17T09:21:35.000000Z",
"updated_at": "2026-09-17T09:21:35.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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-09-17 09:21:36",
"meeting_type": "online_meeting",
"contact_email": "gardner99@hotmail.com",
"status": "new",
"created_at": "2026-09-17T09:21:36.000000Z",
"updated_at": "2026-09-17T09:21:36.000000Z",
"sender": {
"id": 57,
"mrn": "G4CNMTYK1789636895",
"name": "Robbie Kassulke",
"email": "1789636895kkozey@example.org",
"language": "en",
"phone": "(260) 560-6722",
"phone_country": "JE",
"phone_verified_at": null,
"address1": "885 Turner Street Suite 707",
"address2": "Croninview, HI 05229-3018",
"postal_code": "91252",
"city": "Effertz, Rowe and Wolff",
"country": "AT",
"clinic_name": "Huelchester",
"clinic_location": "1096 Regan Walks\nWest Brauliotown, CA 09265-9553",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:35.000000Z",
"updated_at": "2026-09-17T09:21:35.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"recipient": {
"id": 58,
"mrn": "2XMH448U1789636896",
"name": "Mrs. Maude Baumbach III",
"email": "1789636896cooper48@example.net",
"language": "en",
"phone": "(248) 366-6622",
"phone_country": "CM",
"phone_verified_at": null,
"address1": "15110 Raynor Avenue",
"address2": "Guyside, DE 72125-1376",
"postal_code": "95237",
"city": "Eichmann-Hilpert",
"country": "MT",
"clinic_name": "Port Sheamouth",
"clinic_location": "7922 Collins Trail Apt. 512\nLake Maceyborough, OK 61563-5325",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:36.000000Z",
"updated_at": "2026-09-17T09:21:36.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"device": null,
"messages": [
{
"id": 1,
"ticket_id": 1,
"sender_id": 59,
"title": "Mr.",
"content": "Impedit maxime voluptas voluptas et iusto autem consequatur id.",
"is_read": false,
"created_at": "2026-09-17T09:21:37.000000Z",
"updated_at": "2026-09-17T09:21:37.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:onlinein-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:
config- The factory reset config. It might be updated with current config entries when the restored config does not contain a key or its value is false, but the key is available in the current config, has a non-false value, and is required by the config schema.not_modified- The part of the current config that contains keys which were ignored (because they’re on the ignore list, such as custom grips settings), or were not updated with values from the factory reset config (because the values are the same in both configs, or missing in the factory reset config but present and non-false in the current config). These are included in theconfigto ensure their values remain unchanged and are not replaced with defaults.ticket- Support ticket entity, if patient is assigned, null otherwise.
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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-09-17 09:21:40",
"meeting_type": "online_meeting",
"contact_email": "esperanza.streich@runolfsson.com",
"status": "new",
"created_at": "2026-09-17T09:21:41.000000Z",
"updated_at": "2026-09-17T09:21:41.000000Z",
"sender": {
"id": 68,
"mrn": "QYJTDF721789636900",
"name": "Dr. Savion Rolfson MD",
"email": "1789636900pollich.dillan@example.net",
"language": "en",
"phone": "+1-743-468-5236",
"phone_country": "ES",
"phone_verified_at": null,
"address1": "90024 Hahn Highway Apt. 277",
"address2": "New Diana, AK 51396-9392",
"postal_code": "28675",
"city": "Bashirian, Bailey and Wilderman",
"country": "US",
"clinic_name": "South Elinore",
"clinic_location": "111 Dahlia Turnpike Apt. 353\nEast Frederique, NH 42880",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:40.000000Z",
"updated_at": "2026-09-17T09:21:40.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"recipient": {
"id": 69,
"mrn": "HLCC9E5P1789636900",
"name": "Krystina Hills",
"email": "1789636900hegmann.marcelle@example.org",
"language": "en",
"phone": "520.270.6533",
"phone_country": "SI",
"phone_verified_at": null,
"address1": "507 Cecilia Prairie Suite 204",
"address2": "New Evalynchester, IA 27105-6342",
"postal_code": "47986-9283",
"city": "Haag-Herman",
"country": "UA",
"clinic_name": "Joshshire",
"clinic_location": "7277 Medhurst Club\nAbbotthaven, LA 40852-3946",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:40.000000Z",
"updated_at": "2026-09-17T09:21:40.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"device": null,
"messages": [
{
"id": 4,
"ticket_id": 7,
"sender_id": 70,
"title": "Prof.",
"content": "Dolores cupiditate enim vero ullam consectetur consectetur.",
"is_read": false,
"created_at": "2026-09-17T09:21:42.000000Z",
"updated_at": "2026-09-17T09:21:42.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:onlinein-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\": \"[\\\"unde\\\",\\\"qui\\\"]\",
\"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": "[\"unde\",\"qui\"]",
"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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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=2" \
--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": "2",
};
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": 81,
"message_id": 8,
"config": "Maxime officiis est eum animi porro consectetur suscipit.",
"is_accepted": 0,
"notes": "Quas qui provident sequi.",
"created_at": "2026-09-17T09:21:55.000000Z",
"updated_at": "2026-09-17T09:21:55.000000Z",
"message": {
"id": 8,
"ticket_id": 15,
"sender_id": 92,
"title": "Mr.",
"content": "Aut et asperiores incidunt sint iure maiores hic.",
"is_read": false,
"created_at": "2026-09-17T09:21:55.000000Z",
"updated_at": "2026-09-17T09:21:55.000000Z"
}
},
{
"id": 2,
"user_id": null,
"device_id": 82,
"message_id": 10,
"config": "Velit dolores sed earum enim.",
"is_accepted": 1,
"notes": "Consectetur sit minima molestiae omnis ipsam similique possimus.",
"created_at": "2026-09-17T09:21:56.000000Z",
"updated_at": "2026-09-17T09:21:56.000000Z",
"message": {
"id": 10,
"ticket_id": 18,
"sender_id": 97,
"title": "Ms.",
"content": "Quia et dolores eum minima.",
"is_read": false,
"created_at": "2026-09-17T09:21:56.000000Z",
"updated_at": "2026-09-17T09:21:56.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 83,
"message_id": 11,
"config": "Voluptatem eligendi quis sit.",
"is_accepted": 1,
"notes": "Corporis quaerat vel id.",
"created_at": "2026-09-17T09:21:58.000000Z",
"updated_at": "2026-09-17T09:21:58.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 112,
"slot": null,
"name": "Ipsum repellendus quia est eligendi.",
"active": 0,
"created_at": "2026-09-17T09:22:08.000000Z",
"updated_at": "2026-09-17T09:22:08.000000Z",
"device": {
"id": 112,
"serial": "ac4cd494-8292-32e0-b674-e3881f280385",
"bluetooth_id": "60ba794d-4c23-3c4e-a02f-40e0794f6612",
"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-09-17T09:22:08.000000Z",
"updated_at": "2026-09-17T09:22:08.000000Z",
"first_config_change_at": null,
"amputee": {
"id": 110,
"mrn": "RMASBJ7T1789636928",
"name": "Miss Lilian Mosciski IV",
"email": "1789636928kpaucek@example.com",
"language": "en",
"phone": "503.935.4649",
"phone_country": "ZW",
"phone_verified_at": null,
"address1": "2218 Johns Crossroad Apt. 364",
"address2": "Daishafort, DE 18212",
"postal_code": "03874-0871",
"city": "Fritsch-Cruickshank",
"country": "UA",
"clinic_name": "Hodkiewiczbury",
"clinic_location": "6405 Lueilwitz Manor\nWestchester, IN 65976",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:08.000000Z",
"updated_at": "2026-09-17T09:22:08.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
}
}
},
{
"id": 73,
"device_id": 114,
"slot": null,
"name": "Illo beatae nesciunt vero autem vel.",
"active": 0,
"created_at": "2026-09-17T09:22:09.000000Z",
"updated_at": "2026-09-17T09:22:09.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 115,
"slot": null,
"name": "Porro ut non vero molestiae est.",
"active": 1,
"created_at": "2026-09-17T09:22:09.000000Z",
"updated_at": "2026-09-17T09:22:09.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 116,
"slot": null,
"name": "Dolores illo sapiente rerum velit quo.",
"active": 0,
"created_at": "2026-09-17T09:22:09.000000Z",
"updated_at": "2026-09-17T09:22:09.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 117,
"slot": null,
"name": "Maiores sit quia veniam modi.",
"active": 1,
"created_at": "2026-09-17T09:22:09.000000Z",
"updated_at": "2026-09-17T09:22:09.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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-09-17 09:22:09",
"meeting_type": "online_meeting",
"contact_email": "letitia.schmidt@schamberger.com",
"status": "new",
"created_at": "2026-09-17T09:22:11.000000Z",
"updated_at": "2026-09-17T09:22:11.000000Z",
"sender": {
"id": 112,
"mrn": "XGSTUFSP1789636929",
"name": "Johnnie Kreiger",
"email": "1789636929mhessel@example.org",
"language": "en",
"phone": "+1-715-786-3870",
"phone_country": "PA",
"phone_verified_at": null,
"address1": "8277 Brant Ford",
"address2": "Port Johan, FL 47705",
"postal_code": "63215",
"city": "Heaney, Labadie and Klein",
"country": "IN",
"clinic_name": "West Fionaberg",
"clinic_location": "70015 Thompson Trail\nEast Jordane, ME 98784",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:09.000000Z",
"updated_at": "2026-09-17T09:22:09.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"recipient": {
"id": 113,
"mrn": "ZDS5PY7M1789636929",
"name": "Dion Gleason",
"email": "1789636929harris.agustin@example.com",
"language": "en",
"phone": "1-484-219-3888",
"phone_country": "LU",
"phone_verified_at": null,
"address1": "7415 Chase Corner",
"address2": "East Jereltown, WA 12177",
"postal_code": "23238-4759",
"city": "Mosciski, Lebsack and Wuckert",
"country": "IE",
"clinic_name": "Port Cordell",
"clinic_location": "20480 Larissa Plaza Apt. 995\nAbbigailmouth, AK 22992",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:09.000000Z",
"updated_at": "2026-09-17T09:22:09.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"device": null,
"messages": [
{
"id": 12,
"ticket_id": 21,
"sender_id": 114,
"title": "Miss",
"content": "Eum et voluptas omnis excepturi.",
"is_read": false,
"created_at": "2026-09-17T09:22:12.000000Z",
"updated_at": "2026-09-17T09:22:12.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:onlinein-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": "Repellendus aperiam alias deleniti nesciunt itaque qui eos.",
"type": "public",
"created_at": "2026-09-17T09:21:50.000000Z",
"updated_at": "2026-09-17T09:21:50.000000Z",
"author": {
"id": 81,
"mrn": "THEUAZH71789636909",
"name": "Mrs. Jalyn Batz",
"email": "1789636909deven19@example.com",
"language": "en",
"phone": "1-726-580-9001",
"phone_country": "NI",
"phone_verified_at": null,
"address1": "12041 Monahan Inlet",
"address2": "West Deondremouth, MT 56159-4380",
"postal_code": "80929",
"city": "Schumm-Wintheiser",
"country": "CZ",
"clinic_name": "Port Olgaburgh",
"clinic_location": "79593 Greenfelder Roads\nFlatleyfurt, PA 56321",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:49.000000Z",
"updated_at": "2026-09-17T09:21:49.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
}
},
{
"id": 2,
"config_history_id": 8,
"user_id": 83,
"note": "Quia cupiditate molestias fuga minima rerum corporis.",
"type": "public",
"created_at": "2026-09-17T09:21:51.000000Z",
"updated_at": "2026-09-17T09:21:51.000000Z",
"author": {
"id": 83,
"mrn": "QGW4H5BW1789636910",
"name": "Lilyan Bergstrom Sr.",
"email": "1789636910nrobel@example.com",
"language": "en",
"phone": "+1 (385) 515-4289",
"phone_country": "MH",
"phone_verified_at": null,
"address1": "84664 Donnelly Viaduct Suite 179",
"address2": "Strosinton, MO 55389",
"postal_code": "19461",
"city": "Streich LLC",
"country": "IT",
"clinic_name": "Jacobsonmouth",
"clinic_location": "46426 Yadira Fords Apt. 729\nEast Brad, AK 24004-8566",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:50.000000Z",
"updated_at": "2026-09-17T09:21:50.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:publicprivate
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": "Qui dolorem velit exercitationem temporibus sed.",
"type": "public",
"created_at": "2026-09-17T09:21:52.000000Z",
"updated_at": "2026-09-17T09:21:52.000000Z",
"author": {
"id": 85,
"mrn": "2H6PGQ6J1789636911",
"name": "Berenice Schamberger",
"email": "1789636911twolf@example.net",
"language": "en",
"phone": "559-857-8165",
"phone_country": "VE",
"phone_verified_at": null,
"address1": "467 Wiegand Mountain",
"address2": "Stromanview, ND 70797",
"postal_code": "72214-5411",
"city": "Homenick-Oberbrunner",
"country": "FR",
"clinic_name": "Deborahfurt",
"clinic_location": "16393 Tristian Port\nWadechester, DE 80572-6485",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:51.000000Z",
"updated_at": "2026-09-17T09:21:51.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:publicprivate
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\": \"Adipisci voluptates nam autem atque unde quidem mollitia temporibus.\",
\"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": "Adipisci voluptates nam autem atque unde quidem mollitia temporibus.",
"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": "Blanditiis est praesentium eum cupiditate incidunt.",
"type": "public",
"created_at": "2026-09-17T09:21:53.000000Z",
"updated_at": "2026-09-17T09:21:53.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:publicprivate
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "dolore",
"is_common": 0,
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z"
},
{
"id": 2,
"firmware_id": 9,
"key": "minus",
"is_common": 1,
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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/vero/schema" \
--header "Authorization: Bearer {ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "[
{
\"key\": \"gripsPosition.0.initial\",
\"is_common\": 1
}
]"
const url = new URL(
"http://localhost:8000/api/versions/firmware/vero/schema"
);
const headers = {
"Authorization": "Bearer {ACCESS_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = [
{
"key": "gripsPosition.0.initial",
"is_common": 1
}
];
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (200):
[
{
"id": 3,
"firmware_id": 11,
"key": "voluptatem",
"is_common": 0,
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z"
},
{
"id": 4,
"firmware_id": 13,
"key": "itaque",
"is_common": 0,
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Aperiam temporibus iure vitae rerum qui distinctio.",
"description": "Blanditiis nihil nam voluptatem repudiandae rem animi consequatur.",
"author_id": 101,
"company_id": null,
"config": "{\"autoGrasp\":[0,100],\"coContractionTimings\":[500,100],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[30,0,80,40,30,30,40,10,70,50],\"gripPairsConfig\":[3,9,6,5,13,10,8,1],\"gripSequentialConfig\":[13,1,3,7,255,255,4,12,255,10,255,11],\"gripSwitchingMode\":[2],\"holdOpen\":[1500,2500],\"pulseTimings\":[860,640,70,890],\"softGrip\":[0],\"speedControlStrategy\":[0]}",
"created_at": "2026-09-17T09:21:58.000000Z",
"updated_at": "2026-09-17T09:21:58.000000Z",
"author": {
"id": 101,
"mrn": "UAL5N5GZ1789636918",
"name": "Garrison Johnson Sr.",
"email": "1789636918jazmin07@example.org",
"language": "en",
"phone": "562.594.8994",
"phone_country": "SA",
"phone_verified_at": null,
"address1": "95984 Cleveland River Apt. 005",
"address2": "Port Emiliamouth, OH 09050-6239",
"postal_code": "40831-3415",
"city": "Welch-Koepp",
"country": "IE",
"clinic_name": "South Daphnehaven",
"clinic_location": "369 Patricia Inlet\nEast Destinfurt, DE 47023",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:58.000000Z",
"updated_at": "2026-09-17T09:21:58.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
}
},
{
"id": 2,
"name": "Sit rerum earum exercitationem ea.",
"description": "Nisi illum alias voluptatem aut iste et quam.",
"author_id": 102,
"company_id": null,
"config": "{\"autoGrasp\":[1,0],\"coContractionTimings\":[500,300],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[90,30,0,20,50,40,60,90,80,30],\"gripPairsConfig\":[3,5,8,12,7,6,4,13],\"gripSequentialConfig\":[13,3,255,255,4,9,2,255,10,255,255,12],\"gripSwitchingMode\":[3],\"holdOpen\":[2500,2500],\"pulseTimings\":[550,460,470,850],\"softGrip\":[0],\"speedControlStrategy\":[0]}",
"created_at": "2026-09-17T09:21:59.000000Z",
"updated_at": "2026-09-17T09:21:59.000000Z",
"author": {
"id": 102,
"mrn": "JFWC4SMD1789636918",
"name": "Marge Runte",
"email": "1789636918emiliano63@example.com",
"language": "en",
"phone": "(724) 910-3299",
"phone_country": "AQ",
"phone_verified_at": null,
"address1": "466 Walter Views Suite 451",
"address2": "East Kenna, WI 58002-4559",
"postal_code": "62966-4793",
"city": "Sipes-Schneider",
"country": "FR",
"clinic_name": "North Estrellatown",
"clinic_location": "648 Altenwerth Isle Suite 676\nPort Alene, IA 92130-2681",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:58.000000Z",
"updated_at": "2026-09-17T09:21:58.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Consectetur sequi laudantium doloribus.",
"description": "Officia enim repellat voluptatem voluptates autem ut natus non.",
"author_id": 103,
"company_id": null,
"config": "{\"autoGrasp\":[0,0],\"coContractionTimings\":[300,100],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[10,40,0,60,80,0,20,70,20,20],\"gripPairsConfig\":[10,12,7,13,8,9,6,1],\"gripSequentialConfig\":[255,12,6,7,8,255,3,1,255,2,255,9],\"gripSwitchingMode\":[3],\"holdOpen\":[1500,2000],\"pulseTimings\":[400,700,940,820],\"softGrip\":[0],\"speedControlStrategy\":[0]}",
"created_at": "2026-09-17T09:22:00.000000Z",
"updated_at": "2026-09-17T09:22:00.000000Z",
"author": {
"id": 103,
"mrn": "BN6GE6BG1789636920",
"name": "Fatima Roberts",
"email": "1789636920heathcote.gerardo@example.net",
"language": "en",
"phone": "239-494-7829",
"phone_country": "CI",
"phone_verified_at": null,
"address1": "76609 Deckow Lake Suite 506",
"address2": "South Omarifort, UT 67598-9807",
"postal_code": "96406-3872",
"city": "Ward PLC",
"country": "IE",
"clinic_name": "East Guy",
"clinic_location": "50394 Stark Fork\nEast Cathytown, KS 37400-9286",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:00.000000Z",
"updated_at": "2026-09-17T09:22:00.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Cum ex sapiente exercitationem et labore.",
"description": "Quo voluptatem velit explicabo voluptatibus a quas placeat.",
"author_id": 104,
"company_id": null,
"config": "{\"autoGrasp\":[1,0],\"coContractionTimings\":[500,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[0,30,90,100,0,0,0,30,20,10],\"gripPairsConfig\":[11,9,5,2,1,7,6,8],\"gripSequentialConfig\":[8,255,13,2,6,5,3,7,9,4,10,11],\"gripSwitchingMode\":[2],\"holdOpen\":[2500,2500],\"pulseTimings\":[390,830,510,690],\"softGrip\":[1],\"speedControlStrategy\":[1]}",
"created_at": "2026-09-17T09:22:00.000000Z",
"updated_at": "2026-09-17T09:22:00.000000Z",
"author": {
"id": 104,
"mrn": "WD5BUWUT1789636920",
"name": "Ms. Madge Lesch Sr.",
"email": "1789636920philpert@example.org",
"language": "en",
"phone": "(979) 724-7401",
"phone_country": "CF",
"phone_verified_at": null,
"address1": "678 Daija Tunnel Apt. 994",
"address2": "Keeblerberg, WY 23834-6978",
"postal_code": "18107-0925",
"city": "Mante Group",
"country": "ES",
"clinic_name": "Port Dewitt",
"clinic_location": "138 Hansen Courts\nYesseniachester, IN 53510-5149",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:00.000000Z",
"updated_at": "2026-09-17T09:22:00.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Et ducimus ut voluptatem iure sit libero facilis.",
"description": "Delectus tempora cum harum nobis esse facilis in.",
"author_id": 105,
"company_id": null,
"config": "{\"autoGrasp\":[1,100],\"coContractionTimings\":[500,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[0,0,90,50,90,20,90,80,50,30],\"gripPairsConfig\":[12,3,2,4,13,5,6,1],\"gripSequentialConfig\":[255,255,8,1,5,6,3,2,255,255,7,10],\"gripSwitchingMode\":[3],\"holdOpen\":[1500,2000],\"pulseTimings\":[980,420,790,350],\"softGrip\":[0],\"speedControlStrategy\":[1]}",
"created_at": "2026-09-17T09:22:05.000000Z",
"updated_at": "2026-09-17T09:22:05.000000Z",
"author": {
"id": 105,
"mrn": "8YXMGJ2R1789636924",
"name": "Elinor Berge",
"email": "1789636924godfrey98@example.org",
"language": "en",
"phone": "980-696-2014",
"phone_country": "GR",
"phone_verified_at": null,
"address1": "92092 Donnelly Valley",
"address2": "Faustinoton, AZ 31699",
"postal_code": "00026-7126",
"city": "Emmerich PLC",
"country": "HU",
"clinic_name": "Jaleelland",
"clinic_location": "84025 Heidi Drive\nQuigleyhaven, MN 75218-9419",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:05.000000Z",
"updated_at": "2026-09-17T09:22:05.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Cum atque nihil molestiae sit.",
"created_at": "2026-09-17T09:22:06.000000Z",
"updated_at": "2026-09-17T09:22:06.000000Z",
"author": {
"id": 106,
"mrn": "72XMY9QV1789636926",
"name": "Dr. Monica Schmidt Sr.",
"email": "1789636926vita87@example.org",
"language": "en",
"phone": "+1 (830) 586-7993",
"phone_country": "FJ",
"phone_verified_at": null,
"address1": "7908 Fred Grove",
"address2": "East Una, MA 79025-9765",
"postal_code": "33750",
"city": "Kuvalis, Hirthe and Reynolds",
"country": "SK",
"clinic_name": "Collinville",
"clinic_location": "8310 Hermann Station Suite 169\nLessieberg, SD 65540-5936",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:06.000000Z",
"updated_at": "2026-09-17T09:22:06.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
}
},
{
"id": 2,
"template_id": 7,
"user_id": 107,
"note": "Aut provident voluptas soluta et est.",
"created_at": "2026-09-17T09:22:06.000000Z",
"updated_at": "2026-09-17T09:22:06.000000Z",
"author": {
"id": 107,
"mrn": "FDQ2US5Q1789636926",
"name": "Lavinia Hayes",
"email": "1789636926feest.amya@example.net",
"language": "en",
"phone": "(913) 581-3919",
"phone_country": "CI",
"phone_verified_at": null,
"address1": "4638 Myah Tunnel Apt. 355",
"address2": "Tedhaven, WY 45352-7360",
"postal_code": "73316",
"city": "Wilkinson, Hamill and Yost",
"country": "NO",
"clinic_name": "South Rogelio",
"clinic_location": "28621 Holden Ridges Suite 072\nNew Caleton, HI 15380-9044",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:06.000000Z",
"updated_at": "2026-09-17T09:22:06.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Impedit et eum impedit hic modi repudiandae aliquid.",
"created_at": "2026-09-17T09:22:07.000000Z",
"updated_at": "2026-09-17T09:22:07.000000Z",
"author": {
"id": 108,
"mrn": "YMSWMVKK1789636927",
"name": "Jacklyn Beatty",
"email": "1789636927dratke@example.org",
"language": "en",
"phone": "+1.929.766.7590",
"phone_country": "CK",
"phone_verified_at": null,
"address1": "66508 Jerry Vista",
"address2": "Robertsberg, AZ 67601-0432",
"postal_code": "55341",
"city": "Gorczany, Purdy and Friesen",
"country": "SI",
"clinic_name": "Hegmannmouth",
"clinic_location": "3068 Markus Spring\nNorth Kennithshire, AR 79764-0620",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:07.000000Z",
"updated_at": "2026-09-17T09:22: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: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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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\": \"Ullam sed eius nisi mollitia ab culpa occaecati magni.\"
}"
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": "Ullam sed eius nisi mollitia ab culpa occaecati magni."
};
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": "Harum est alias velit pariatur.",
"created_at": "2026-09-17T09:22:08.000000Z",
"updated_at": "2026-09-17T09:22:08.000000Z",
"author": {
"id": 109,
"mrn": "6ZUEDH3E1789636927",
"name": "Alta Reichert DDS",
"email": "1789636927haley26@example.net",
"language": "en",
"phone": "+1.820.295.1851",
"phone_country": "SJ",
"phone_verified_at": null,
"address1": "1217 Kulas Knoll Suite 859",
"address2": "South Alene, MD 44720",
"postal_code": "61380",
"city": "Willms Inc",
"country": "PT",
"clinic_name": "Rogahnmouth",
"clinic_location": "34838 Estefania Port Suite 719\nPort Kayliebury, HI 56021",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:07.000000Z",
"updated_at": "2026-09-17T09:22:07.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "toy.yundt",
"initial_position": "[50, 50, 50, 50, 50]",
"limit_position": "[900, 900, 900, 900, 900]",
"active_fingers": "[0, 1, 1, 1, 1]",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.000000Z"
},
{
"id": 2,
"user_id": 261,
"name": "vickie57",
"initial_position": "[50, 50, 50, 50, 50]",
"limit_position": "[900, 900, 900, 900, 900]",
"active_fingers": "[0, 1, 1, 1, 1]",
"created_at": "2026-09-17T09:23:39.000000Z",
"updated_at": "2026-09-17T09:23:39.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to manage custom grips templates",
"code": "CUSTOM_GRIPS_TEMPLATES:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "lharris",
"initial_position": "[50, 50, 50, 50, 50]",
"limit_position": "[900, 900, 900, 900, 900]",
"active_fingers": "[0, 1, 1, 1, 1]",
"created_at": "2026-09-17T09:23:39.000000Z",
"updated_at": "2026-09-17T09:23:39.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 139,
"name": "tillman.francesco",
"opposed": 1,
"grip_number": 0,
"created_at": "2026-09-17T09:23:40.000000Z",
"updated_at": "2026-09-17T09:23:40.000000Z"
},
{
"id": 2,
"device_id": 140,
"name": "tremaine98",
"opposed": 1,
"grip_number": 0,
"created_at": "2026-09-17T09:23:40.000000Z",
"updated_at": "2026-09-17T09:23:40.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 141,
"name": "amelia.wilkinson",
"opposed": 1,
"grip_number": 0,
"created_at": "2026-09-17T09:23:41.000000Z",
"updated_at": "2026-09-17T09:23:41.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 142,
"name": "kkulas",
"opposed": 1,
"grip_number": 0,
"created_at": "2026-09-17T09:23:41.000000Z",
"updated_at": "2026-09-17T09:23:41.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 28.9
},
"created_at": "2026-09-17T09:21:27.000000Z"
},
{
"id": 2,
"device_id": 18,
"data": {
"unit": "cm",
"length": 12.58
},
"created_at": "2026-09-17T09:21:27.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 41.56
},
"created_at": "2026-09-17T09:21:27.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "right",
"active": 1,
"created_at": "2026-09-17T09:21:25.000000Z",
"updated_at": "2026-09-17T09:21:25.000000Z"
},
{
"id": 4,
"name": "Zeus hand v1",
"type": "leg",
"orientation": "left",
"active": 1,
"created_at": "2026-09-17T09:21:25.000000Z",
"updated_at": "2026-09-17T09:21:25.000000Z"
}
]
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to list device models",
"code": "DEVICE_MODELS:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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-09-17T09:21:25.000000Z",
"updated_at": "2026-09-17T09:21:25.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to create device model",
"code": "DEVICE_MODELS:CREATE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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\": \"right\",
\"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": "right",
"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": "right",
"active": 1,
"created_at": "2026-09-17T09:21:25.000000Z",
"updated_at": "2026-09-17T09:21:25.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "magni",
"company": "Morissette Inc",
"internal_id": "9e81ec6e-4c47-3ec4-a196-9d80fc8e7f51",
"type": "quos",
"created_at": "2026-09-17T09:21:25.000000Z",
"updated_at": "2026-09-17T09:21:25.000000Z"
},
{
"id": 2,
"name": "assumenda",
"company": "Walker-Mohr",
"internal_id": "16fde0cd-9aeb-3249-b4bd-5fb677b07d67",
"type": "accusantium",
"created_at": "2026-09-17T09:21:25.000000Z",
"updated_at": "2026-09-17T09:21:25.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to view device peripherals",
"code": "DEVICE_PERIPHERALS:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "nemo",
"company": "Gaylord LLC",
"internal_id": "10d291d6-0061-3b83-b1b0-7d2e6f06e080",
"type": "rem",
"created_at": "2026-09-17T09:21:25.000000Z",
"updated_at": "2026-09-17T09:21:25.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to manage device peripherals",
"code": "DEVICE_PERIPHERALS:CREATE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "aut",
"company": "Fadel, Bashirian and Rutherford",
"internal_id": "bc48369c-0eca-31cd-8f19-1996cdc27b01",
"type": "veniam",
"created_at": "2026-09-17T09:21:25.000000Z",
"updated_at": "2026-09-17T09:21:25.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get devices list
requires authentication
Possible extend options:
- model - device model details
- amputee - end-user assigned to device
- clinicians - list of clinicians assigned to the device
- firmwareVersion - device firmware version
- pcbVersion - PCB version
Example request:
curl --request GET \
--get "http://localhost:8000/api/devices?search=S3R1AL-NUM83R&active=-1&utee=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": "46752292-8ba1-3277-8850-7e8ad7b40f94",
"bluetooth_id": "95a20b5a-e4b1-38b0-9a84-f62811441e4c",
"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-09-17T09:21:25.000000Z",
"updated_at": "2026-09-17T09:21:25.000000Z",
"first_config_change_at": null,
"model": {
"id": 7,
"name": "Zeus hand v1",
"type": "arm",
"orientation": "right",
"active": 1,
"created_at": "2026-09-17T09:21:25.000000Z",
"updated_at": "2026-09-17T09:21:25.000000Z"
},
"amputee": {
"id": 38,
"mrn": "SVB7MTPM1789636885",
"name": "Rodrick Stiedemann",
"email": "1789636885kshlerin.brendan@example.org",
"language": "en",
"phone": "+1-541-802-0080",
"phone_country": "ES",
"phone_verified_at": null,
"address1": "9565 Ward Square Suite 063",
"address2": "South Pedro, MI 19718-0270",
"postal_code": "21448-2994",
"city": "Vandervort LLC",
"country": "LU",
"clinic_name": "Andreanneside",
"clinic_location": "1793 Ashley Trail Suite 322\nDavistown, TN 24060-2211",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:25.000000Z",
"updated_at": "2026-09-17T09:21:25.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
}
},
{
"id": 6,
"serial": "2cf5a93a-d8fd-371f-8d4a-bf6a08cbbde1",
"bluetooth_id": "db8764c4-1301-38b1-af28-ee3c23d58d7f",
"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-09-17T09:21:26.000000Z",
"updated_at": "2026-09-17T09:21:26.000000Z",
"first_config_change_at": null,
"model": {
"id": 8,
"name": "Zeus hand v1",
"type": "arm",
"orientation": "left",
"active": 1,
"created_at": "2026-09-17T09:21:25.000000Z",
"updated_at": "2026-09-17T09:21:25.000000Z"
},
"amputee": {
"id": 39,
"mrn": "J33ND35V1789636885",
"name": "Prof. Rowan Greenfelder II",
"email": "1789636885lmante@example.com",
"language": "en",
"phone": "+1.657.825.4756",
"phone_country": "TH",
"phone_verified_at": null,
"address1": "35049 Doris Plaza Suite 626",
"address2": "Winstonview, NH 24044",
"postal_code": "60915",
"city": "Quitzon, Jenkins and Schoen",
"country": "SK",
"clinic_name": "Leopoldoberg",
"clinic_location": "8966 Abraham Fall\nNorth Agustin, SD 79759",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:25.000000Z",
"updated_at": "2026-09-17T09:21:25.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "fdf98d0a-e532-33ce-b1cc-fc1a29ade86d",
"bluetooth_id": "48eb875d-855f-3883-a57f-db06ca273595",
"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-09-17T09:21:26.000000Z",
"updated_at": "2026-09-17T09:21:26.000000Z",
"first_config_change_at": null,
"model": {
"id": 9,
"name": "Zeus hand v1",
"type": "arm",
"orientation": "left",
"active": 1,
"created_at": "2026-09-17T09:21:26.000000Z",
"updated_at": "2026-09-17T09:21:26.000000Z"
},
"amputee": {
"id": 40,
"mrn": "TTAE7TTR1789636886",
"name": "Christina Zemlak",
"email": "1789636886graham.marlin@example.org",
"language": "en",
"phone": "+16782964355",
"phone_country": "AQ",
"phone_verified_at": null,
"address1": "6693 Okuneva Village",
"address2": "Elwintown, PA 71652-0622",
"postal_code": "26381",
"city": "Dooley LLC",
"country": "GB",
"clinic_name": "New Jevon",
"clinic_location": "6205 Mauricio Falls Apt. 952\nNew Elvera, ME 59893-7455",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:26.000000Z",
"updated_at": "2026-09-17T09:21:26.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"pcb_version": {
"id": 1,
"name": "7.82.39",
"hardware_id": "",
"created_at": "2026-09-17T09:21:26.000000Z",
"updated_at": "2026-09-17T09:21:26.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "430e1e7b-0f3e-3546-9de7-2283e10edabc",
"bluetooth_id": "78325951-25ee-3edc-8980-f54a93787518",
"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-09-17T09:21:26.000000Z",
"updated_at": "2026-09-17T09:21:26.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "ff59b6cc-3e5e-374b-a8d2-a306609b87a1",
"bluetooth_id": "4c5f1f9e-76b6-3bed-8951-3de608e731fd",
"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-09-17T09:21:26.000000Z",
"updated_at": "2026-09-17T09:21:26.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "e748d3fd-8ac5-3cbe-9ac6-036122f64628",
"bluetooth_id": "5618b67f-aaa6-32a1-a7ff-4dc458a13504",
"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-09-17T09:21:27.000000Z",
"updated_at": "2026-09-17T09:21:27.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "7b22a278-ec6e-361d-b5e4-ef42b4b53e87",
"bluetooth_id": "d54b7e9d-a6f7-313c-9563-c0383f4509cf",
"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-09-17T09:21:27.000000Z",
"updated_at": "2026-09-17T09:21:27.000000Z",
"first_config_change_at": null,
"joined_devices": [
{
"id": 12,
"serial": "5a6fa691-40b8-3a90-b9b0-b6026b76de1c",
"bluetooth_id": "a5bdd9bc-862d-3fcf-af73-c430528d980c",
"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-09-17T09:21:27.000000Z",
"updated_at": "2026-09-17T09:21:27.000000Z",
"first_config_change_at": null,
"pivot": {
"electrode_id": 11,
"device_id": 12,
"created_at": "2026-09-17T09:21:27.000000Z",
"updated_at": "2026-09-17T09:21:27.000000Z"
}
}
],
"joined_electrodes": [
{
"id": 13,
"serial": "52d7811b-24ae-3b77-a2df-5faa89a40756",
"bluetooth_id": "c8292e9a-fcd3-34df-a6d7-3bf70a97b5b9",
"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-09-17T09:21:27.000000Z",
"updated_at": "2026-09-17T09:21:27.000000Z",
"first_config_change_at": null,
"pivot": {
"device_id": 11,
"electrode_id": 13,
"created_at": "2026-09-17T09:21:27.000000Z",
"updated_at": "2026-09-17T09:21:27.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get device internal note
requires authentication
Example request:
curl --request GET \
--get "http://localhost:8000/api/device/16/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/16/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": "Corporis explicabo enim ut nihil natus qui a cupiditate. Ut dolorem et facilis modi qui quia. Nam in eos voluptatum reiciendis omnis.",
"created_at": "2026-09-17T09:21:27.000000Z",
"updated_at": "2026-09-17T09:21:27.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Harum et qui omnis aperiam. Unde rerum illo pariatur sunt et. Reiciendis accusamus quae aliquam ab nihil. Repellendus ipsa exercitationem quaerat minima.",
"created_at": "2026-09-17T09:21:27.000000Z",
"updated_at": "2026-09-17T09:21:27.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Courier",
"type": "web",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.000000Z"
},
{
"id": 2,
"name": "Food Science Technician",
"type": "web",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to manage documents",
"code": "DOCUMENTS:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Response
Response Fields
items
object
id
integer
Document ID.
name
string
Document name.
type
string
Document target platform.
Must be one of:webmobile
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": "Forming Machine Operator",
"type": "web",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to manage documents",
"code": "DOCUMENTS:CREATE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Response
Response Fields
id
integer
Document ID.
name
string
Document name.
type
string
Document target platform.
Must be one of:webmobile
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 862760,
"file": "http://williamson.org/",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.000000Z"
},
{
"id": 2,
"document_id": null,
"index": 3633,
"file": "http://www.cormier.org/neque-numquam-fugiat-vitae-velit",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 682754,
"file": "http://www.kautzer.info/laborum-et-quasi-eligendi-quam-consectetur-et",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "periodic",
"trigger": "grip_change",
"platform": "mobile",
"rate": 3,
"description": "Porro magnam praesentium officiis consequatur veniam.",
"skipped": 0,
"training_day_id": null,
"created_at": "2026-09-17T09:21:03.000000Z",
"updated_at": "2026-09-17T09:21:03.000000Z"
}
Example response (403, Invalid token):
{
"message": "Invalid token",
"code": "FEEDBACK:SEND_WITH_TOKEN:INVALID_TOKEN"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "contextual",
"trigger": "async_session",
"platform": "mobile",
"rate": 5,
"description": "Temporibus delectus ut consectetur.",
"skipped": 1,
"training_day_id": null,
"created_at": "2026-09-17T09:24:14.000000Z",
"updated_at": "2026-09-17T09:24:14.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to send feedback",
"code": "FEEDBACK:SEND:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "on_demand",
"trigger": "patient_create",
"platform": "mobile",
"rate": 3,
"description": "Debitis occaecati qui et.",
"skipped": 1,
"training_day_id": null,
"created_at": "2026-09-17T09:24:15.000000Z",
"updated_at": "2026-09-17T09:24:15.000000Z"
},
{
"id": 4,
"user_id": 313,
"type": "contextual",
"trigger": "remote_session",
"platform": "mobile",
"rate": 4,
"description": "Perferendis quaerat vitae natus atque sunt.",
"skipped": 1,
"training_day_id": null,
"created_at": "2026-09-17T09:24:16.000000Z",
"updated_at": "2026-09-17T09:24:16.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to list feedback",
"code": "FEEDBACK:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "tempore",
"created_at": "2026-09-17T09:21:27.000000Z",
"updated_at": "2026-09-17T09:21:27.000000Z"
},
{
"id": 2,
"device_id": 15,
"result": "totam",
"created_at": "2026-09-17T09:21:27.000000Z",
"updated_at": "2026-09-17T09:21:27.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "voluptates",
"created_at": "2026-09-17T09:21:27.000000Z",
"updated_at": "2026-09-17T09:21:27.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
]
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Goals
API endpoints for goals
The goals module consists of:
- exercises - predefined actions which should be performed by patient. Exercises can be managed only by SuperAdmin,
- goals - objectives defined for each patient which could consists of exercises, grips and grip switches,
- goal conditions - parts of the goal, single condition of type exercise, grips goal or switches goal.
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": 2393,
"name": "veritatis grip",
"description": null,
"opposed": 0,
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.000000Z"
},
{
"id": 2,
"number": 6815,
"name": "voluptatem grip",
"description": null,
"opposed": 0,
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.000000Z"
}
]
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to view grips",
"code": "GOALS:LIST_GRIPS:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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.Talon Hollow",
"description": "exercises.Ut alias harum nostrum totam.",
"icon": "😜",
"created_at": "2026-09-17T09:23:41.000000Z",
"updated_at": "2026-09-17T09:23:41.000000Z"
},
{
"id": 2,
"name": "exercises.Braxton Pass",
"description": "exercises.Ullam magnam saepe porro cupiditate architecto minus.",
"icon": "😞",
"created_at": "2026-09-17T09:23:41.000000Z",
"updated_at": "2026-09-17T09:23:41.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to view exercises",
"code": "GOALS:LIST_EXERCISES:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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.Rosalia Expressway",
"description": "exercises.Ea blanditiis reprehenderit dolorem veniam.",
"icon": "😐",
"created_at": "2026-09-17T09:23:41.000000Z",
"updated_at": "2026-09-17T09:23:41.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to manage exercises",
"code": "GOALS:CREATE_EXERCISE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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.Walker Squares",
"description": "exercises.Quia occaecati dolorum sed consectetur.",
"icon": "😜",
"created_at": "2026-09-17T09:23:41.000000Z",
"updated_at": "2026-09-17T09:23:41.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "2017-03-01",
"end_date": "1982-12-15",
"active": 0,
"created_at": "2026-09-17T09:23:42.000000Z",
"updated_at": "2026-09-17T09:23:42.000000Z"
},
{
"id": 2,
"amputee_id": 265,
"clinician_id": 266,
"start_date": "2023-04-13",
"end_date": "2014-03-04",
"active": 1,
"created_at": "2026-09-17T09:23:43.000000Z",
"updated_at": "2026-09-17T09:23:43.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "1999-05-11",
"end_date": "1994-05-11",
"active": 1,
"created_at": "2026-09-17T09:23:45.000000Z",
"updated_at": "2026-09-17T09:23:45.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "2018-08-07",
"end_date": "1982-11-27",
"active": 0,
"created_at": "2026-09-17T09:23:46.000000Z",
"updated_at": "2026-09-17T09:23:46.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "a",
"grips_count": 280,
"switches_frequency": "d",
"switches_count": 876,
"exercise_id": 5,
"exercise_frequency": "w",
"exercise_count": 2,
"created_at": "2026-09-17T09:23:47.000000Z",
"updated_at": "2026-09-17T09:23:47.000000Z"
},
{
"id": 2,
"goal_id": 6,
"type": "switch",
"grip_id": 4,
"grips_frequency": "m",
"grips_count": 453,
"switches_frequency": "m",
"switches_count": 988,
"exercise_id": 6,
"exercise_frequency": "m",
"exercise_count": 6,
"created_at": "2026-09-17T09:23:48.000000Z",
"updated_at": "2026-09-17T09:23:48.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Response
Response Fields
items
object
id
integer
Goal condition ID.
goal_id
integer
Associated goal ID.
type
string
Condition type.
Must be one of:gripswitchexercise
grip_id
integer
Target grip ID.
grips_frequency
string
Grip frequency period.
Must be one of:dwma
grips_count
integer
Required grip count.
switches_frequency
string
Switch frequency period.
Must be one of:dwma
switches_count
integer
Required switch count.
exercise_id
integer
Target exercise ID.
exercise_frequency
string
Exercise frequency period.
Must be one of:dwm
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_frequencyfield), - sum of grip-specific conditions (
grips_countfield) 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": "grip",
"grip_id": 5,
"grips_frequency": "d",
"grips_count": 751,
"switches_frequency": "a",
"switches_count": 947,
"exercise_id": 7,
"exercise_frequency": "d",
"exercise_count": 2,
"created_at": "2026-09-17T09:23:49.000000Z",
"updated_at": "2026-09-17T09:23:49.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Response
Response Fields
id
integer
Goal condition ID.
goal_id
integer
Associated goal ID.
type
string
Condition type.
Must be one of:gripswitchexercise
grip_id
integer
Target grip ID.
grips_frequency
string
Grip frequency period.
Must be one of:dwma
grips_count
integer
Required grip count.
switches_frequency
string
Switch frequency period.
Must be one of:dwma
switches_count
integer
Required switch count.
exercise_id
integer
Target exercise ID.
exercise_frequency
string
Exercise frequency period.
Must be one of:dwm
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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.
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.
typefor 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_fromandfrequency_tofor period summary for both grips and switches, which describe time-frame of frequency and period,donefor 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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "exercise",
"grip_id": null,
"grips": 31,
"switches": 963,
"exercise_id": 8,
"exercise_done": 1,
"created_at": "2026-09-17T09:23:50.000000Z",
"updated_at": "2026-09-17T09:23:50.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:gripswitchexercise
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\": \"61542 Ralph Ports\",
\"address2\": \"North Consueloville, VT 36923-5426\",
\"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": "61542 Ralph Ports",
"address2": "North Consueloville, VT 36923-5426",
"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": "65MG67GP1789636860",
"name": "Della Wuckert",
"email": "1789636860justus79@example.com",
"language": "en",
"phone": "(820) 753-9084",
"phone_country": "YT",
"phone_verified_at": null,
"address1": "12536 Kautzer Ways",
"address2": "West Kamronfort, TX 15187-9344",
"postal_code": "21518",
"city": "Corkery Ltd",
"country": "RO",
"clinic_name": "Binsland",
"clinic_location": "93013 Torp Mission\nWillisville, MS 94689-6726",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:00.000000Z",
"updated_at": "2026-09-17T09:21:00.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": [
{
"id": 2,
"name": "CommunityAdmin"
}
]
}
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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\": \"+1.786.501.3374\",
\"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": "+1.786.501.3374",
"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": "GCDAFS3G1789636861",
"name": "Jessy Carroll",
"email": "1789636861dee.zemlak@example.com",
"language": "en",
"phone": "+18436975327",
"phone_country": "US",
"phone_verified_at": null,
"address1": "6386 Kuhn Gardens Apt. 380",
"address2": "North Dionborough, NJ 87155",
"postal_code": "47558-7786",
"city": "Collier-Moen",
"country": "DE",
"clinic_name": "Collierburgh",
"clinic_location": "98029 Peter Glen Apt. 512\nKeeblerport, TN 61255",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:01.000000Z",
"updated_at": "2026-09-17T09:21:01.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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": "M82GKGFM1789636870",
"name": "Ms. Shannon Kozey Jr.",
"email": "1789636870kobe23@example.org",
"language": "en",
"phone": "202-556-9178",
"phone_country": "LK",
"phone_verified_at": null,
"address1": "340 Lemke Extension",
"address2": "South Raoul, ND 74586",
"postal_code": "06567",
"city": "Lesch-Mills",
"country": "FR",
"clinic_name": "Bogisichmouth",
"clinic_location": "928 Stokes Roads Apt. 009\nEast Rubye, MD 27175-4199",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:10.000000Z",
"updated_at": "2026-09-17T09:21:10.000000Z",
"invitation_status": "accepted",
"acadle_invitation_status": null,
"roles": [
{
"id": 4,
"name": "Clinician"
}
]
},
{
"id": 16,
"mrn": "54YY3FEZ1789636870",
"name": "Jimmy Farrell",
"email": "1789636870reid34@example.org",
"language": "en",
"phone": "+1 (260) 925-2905",
"phone_country": "CL",
"phone_verified_at": null,
"address1": "97796 Harvey Overpass Apt. 262",
"address2": "Junemouth, MD 89604",
"postal_code": "67202",
"city": "Johns, Hagenes and Bergstrom",
"country": "UA",
"clinic_name": "South Carliemouth",
"clinic_location": "339 Wilderman Turnpike Suite 962\nWest Meghan, SC 41702-3696",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:10.000000Z",
"updated_at": "2026-09-17T09:21:10.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:USERS:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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\": [
\"qui\"
]
}
]
}"
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": [
"qui"
]
}
]
};
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": "WXFDC55X1789636871",
"name": "Prof. Christ Zulauf IV",
"email": "1789636871dnader@example.net",
"language": "en",
"phone": "(248) 245-5309",
"phone_country": "IE",
"phone_verified_at": null,
"address1": "85869 Kertzmann Gateway Apt. 919",
"address2": "New Kallieburgh, MI 12943",
"postal_code": "16186",
"city": "Bayer-Mayer",
"country": "IN",
"clinic_name": "Kesslermouth",
"clinic_location": "7602 DuBuque Track Apt. 419\nPort Retha, GA 30127",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:11.000000Z",
"updated_at": "2026-09-17T09:21:11.000000Z",
"invitation_status": "accepted",
"acadle_invitation_status": null,
"invitations": [
{
"id": 1,
"user_id": 18,
"invited_user_id": 17,
"type": "clinician",
"training_confirmed": 1,
"created_at": "2026-09-17T09:21:12.000000Z",
"updated_at": "2026-09-17T09:21:12.000000Z"
}
],
"roles": [
{
"id": 5,
"name": "ClinicianSupport"
}
]
},
{
"id": 20,
"mrn": "EXM82XH41789636872",
"name": "Dr. Jamal Koch DVM",
"email": "1789636872rath.assunta@example.net",
"language": "en",
"phone": "+1 (351) 209-9442",
"phone_country": "AI",
"phone_verified_at": null,
"address1": "9704 Beer Extension Suite 122",
"address2": "Pascaleland, FL 44736-1448",
"postal_code": "56264-4513",
"city": "Wintheiser-Miller",
"country": "DE",
"clinic_name": "Pinkieport",
"clinic_location": "41821 Flatley Spurs\nKellyland, VT 98166-2264",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:12.000000Z",
"updated_at": "2026-09-17T09:21:12.000000Z",
"invitation_status": "accepted",
"acadle_invitation_status": null,
"invitations": [
{
"id": 2,
"user_id": 21,
"invited_user_id": 20,
"type": "clinician",
"training_confirmed": 1,
"created_at": "2026-09-17T09:21:13.000000Z",
"updated_at": "2026-09-17T09:21:13.000000Z"
}
],
"roles": [
{
"id": 5,
"name": "ClinicianSupport"
}
]
}
]
}
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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": "KWUA8PCU1789636873",
"name": "Lesly Gusikowski",
"email": "1789636873labadie.dedric@example.com",
"language": "en",
"phone": "351-615-9034",
"phone_country": "NP",
"phone_verified_at": null,
"address1": "41186 Vivienne Trafficway Apt. 898",
"address2": "Lloydville, VA 75820",
"postal_code": "62749",
"city": "Streich-Wehner",
"country": "SK",
"clinic_name": "East Caleb",
"clinic_location": "167 Jordy Pike\nPort Sydnihaven, NM 90106",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:13.000000Z",
"updated_at": "2026-09-17T09:21:13.000000Z",
"invitation_status": "accepted",
"acadle_invitation_status": null,
"invitations": [
{
"id": 3,
"user_id": 24,
"invited_user_id": 23,
"type": "clinician",
"training_confirmed": 1,
"created_at": "2026-09-17T09:21:14.000000Z",
"updated_at": "2026-09-17T09:21:14.000000Z"
}
],
"roles": [
{
"id": 5,
"name": "ClinicianSupport"
}
]
}
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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": "WBVYJHNB1789636877",
"name": "Maurine Nikolaus",
"email": "1789636877rosie25@example.org",
"language": "en",
"phone": "+1-727-681-2181",
"phone_country": "LR",
"phone_verified_at": null,
"address1": "32294 Judy Isle Apt. 101",
"address2": "Feilville, ND 34218",
"postal_code": "75022-7180",
"city": "Cassin PLC",
"country": "DK",
"clinic_name": "Lake Luciano",
"clinic_location": "6727 Hoeger Mews Suite 990\nMeaghanshire, NC 58090-4311",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:17.000000Z",
"updated_at": "2026-09-17T09:21:17.000000Z",
"invitation_status": "accepted",
"acadle_invitation_status": null,
"roles": [
{
"id": 3,
"name": "ClinicAdmin"
}
]
},
{
"id": 27,
"mrn": "XJD24NSY1789636877",
"name": "Mr. Melvin Herman IV",
"email": "1789636877giovanny27@example.com",
"language": "en",
"phone": "+1.843.367.9951",
"phone_country": "VC",
"phone_verified_at": null,
"address1": "95008 Conner Street Apt. 616",
"address2": "Beerside, NJ 98343-8180",
"postal_code": "60226-1263",
"city": "Nitzsche, Waelchi and Raynor",
"country": "PT",
"clinic_name": "Cruickshankshire",
"clinic_location": "661 Hintz Terrace\nPaucekhaven, AK 75764",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:17.000000Z",
"updated_at": "2026-09-17T09:21:17.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_ACADLE:USERS:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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\": \"ykulas@example.org\"
}"
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": "ykulas@example.org"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (201):
{
"id": 28,
"mrn": "697BHHS81789636878",
"name": "Dr. Gregorio Ondricka",
"email": "1789636878plarson@example.net",
"language": "en",
"phone": "1-651-232-4972",
"phone_country": "MG",
"phone_verified_at": null,
"address1": "20080 Stokes Locks Suite 822",
"address2": "South Annabel, KY 14795",
"postal_code": "37116-6949",
"city": "Powlowski LLC",
"country": "RO",
"clinic_name": "Velvahaven",
"clinic_location": "8552 Monahan Extensions Apt. 706\nKellenview, CT 00285-8057",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:18.000000Z",
"updated_at": "2026-09-17T09:21:18.000000Z",
"invitation_status": "accepted",
"acadle_invitation_status": null,
"invitations": [
{
"id": 4,
"user_id": 29,
"invited_user_id": 28,
"type": "clinician",
"training_confirmed": 1,
"created_at": "2026-09-17T09:21:19.000000Z",
"updated_at": "2026-09-17T09:21:19.000000Z"
}
],
"roles": [
{
"id": 3,
"name": "ClinicAdmin"
}
]
}
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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": "BBBP4X921789636879",
"name": "Mylene Gutmann IV",
"email": "1789636879drenner@example.org",
"language": "en",
"phone": "(810) 371-9962",
"phone_country": "LY",
"phone_verified_at": null,
"address1": "7114 Ofelia Mountain",
"address2": "Laurettaburgh, TN 87896",
"postal_code": "50650-9312",
"city": "Rau, Feest and Swift",
"country": "US",
"clinic_name": "Rafaelmouth",
"clinic_location": "598 Fritsch Freeway\nDurganbury, WA 30352",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:19.000000Z",
"updated_at": "2026-09-17T09:21:19.000000Z",
"invitation_status": "accepted",
"acadle_invitation_status": null,
"invitations": [
{
"id": 5,
"user_id": 32,
"invited_user_id": 31,
"type": "clinician",
"training_confirmed": 0,
"created_at": "2026-09-17T09:21:20.000000Z",
"updated_at": "2026-09-17T09:21:20.000000Z"
}
],
"roles": [
{
"id": 3,
"name": "ClinicAdmin"
}
]
}
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "127.189.65.91",
"created_at": "1996-10-29T02:41:46.000000Z",
"updated_at": "2026-09-17T09:23:52.000000Z",
"username": "Javier Gleichner PhD",
"user": {
"id": 282,
"mrn": "VKXLQ77C1789637031",
"name": "Javier Gleichner PhD",
"email": "1789637031conrad.carroll@example.org",
"language": "en",
"phone": "341-587-9545",
"phone_country": "TD",
"phone_verified_at": null,
"address1": "53782 Herbert Junctions",
"address2": "East Vergiebury, OH 85439",
"postal_code": "39813",
"city": "Hirthe-Ebert",
"country": "NO",
"clinic_name": "Alizamouth",
"clinic_location": "35557 Keven Drives Suite 710\nNorth Dorothy, CO 78263",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:23:52.000000Z",
"updated_at": "2026-09-17T09:23:52.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"element": {
"id": 281,
"mrn": "A9AK2T351789637031",
"name": "Molly Purdy",
"email": "1789637031nmayer@example.com",
"language": "en",
"phone": "1-617-694-7525",
"phone_country": "ZA",
"phone_verified_at": null,
"address1": "6776 Elfrieda Court Apt. 550",
"address2": "Sawaynton, WA 75728",
"postal_code": "08685",
"city": "Schoen, Nikolaus and Gaylord",
"country": "FI",
"clinic_name": "East Annamarie",
"clinic_location": "993 Dooley Mews Suite 129\nNew May, MD 88476-4255",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:23:51.000000Z",
"updated_at": "2026-09-17T09:23:51.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": "213.160.188.46",
"created_at": "1985-02-27T18:29:57.000000Z",
"updated_at": "2026-09-17T09:23:53.000000Z",
"username": "Katherine Kunde",
"user": {
"id": 285,
"mrn": "J6AXZSMA1789637032",
"name": "Katherine Kunde",
"email": "1789637032christine.kuphal@example.net",
"language": "en",
"phone": "574-633-7175",
"phone_country": "IE",
"phone_verified_at": null,
"address1": "7631 Huel Estate Suite 793",
"address2": "Thielhaven, AR 58484-7875",
"postal_code": "65570",
"city": "Swaniawski, Lynch and Ledner",
"country": "IN",
"clinic_name": "Hartmannfurt",
"clinic_location": "7521 Langosh Vista\nKingmouth, GA 09412",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:23:53.000000Z",
"updated_at": "2026-09-17T09:23:53.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"element": {
"id": 284,
"mrn": "Q7SLGEVM1789637032",
"name": "Muriel Tillman",
"email": "1789637032buster.weissnat@example.org",
"language": "en",
"phone": "726.682.9342",
"phone_country": "AD",
"phone_verified_at": null,
"address1": "46304 Ashlynn Pine Suite 217",
"address2": "East Wilber, OK 83432",
"postal_code": "49343-7166",
"city": "Rodriguez Ltd",
"country": "IN",
"clinic_name": "Port Rebeccaburgh",
"clinic_location": "27123 Eusebio Lodge Apt. 382\nChamplinville, MO 76225-5334",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:23:52.000000Z",
"updated_at": "2026-09-17T09:23:52.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Sit aperiam sapiente eos.",
"content": "Ratione provident et aut neque.",
"created_at": "2026-09-17T09:22:33.000000Z",
"updated_at": "2026-09-17T09:22:33.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": "Quia laboriosam nam reprehenderit.",
"content": "Itaque rem qui ab consequatur neque temporibus dolor possimus.",
"created_at": "2026-09-17T09:22:33.000000Z",
"updated_at": "2026-09-17T09:22:33.000000Z",
"sender": null
}
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
}
]
}
}
]
}
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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=2021-07-23 09:07:49"\
--form "date_end=1972-03-11 16:14:53"\
--form "encrypt_key=ea"\
--form "encrypt_iv=impedit"\
--form "file=@/tmp/phpV4H0aL" 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', '2021-07-23 09:07:49');
body.append('date_end', '1972-03-11 16:14:53');
body.append('encrypt_key', 'ea');
body.append('encrypt_iv', 'impedit');
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": 143,
"file": "/tmp/fakerVTRUQ0",
"date_start": "1995-02-12 07:14:48",
"date_end": "2005-02-16 00:40:28",
"created_at": "2026-09-17T09:23:54.000000Z",
"updated_at": "2026-09-17T09:23:54.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to write mobile logs",
"code": "MOBILE_LOGS:STORE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 144,
"file": "/tmp/fakeraaZOOU",
"date_start": "2005-04-29 17:29:00",
"date_end": "1974-02-04 02:09:28",
"created_at": "2026-09-17T09:23:55.000000Z",
"updated_at": "2026-09-17T09:23:55.000000Z"
},
{
"id": 3,
"user_id": 288,
"device_id": 145,
"file": "/tmp/fakerxbCsem",
"date_start": "2022-09-18 13:51:58",
"date_end": "1989-11-21 04:16:55",
"created_at": "2026-09-17T09:23:56.000000Z",
"updated_at": "2026-09-17T09:23:56.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to view mobile logs",
"code": "MOBILE_LOGS:GET:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 146,
"file": "/tmp/fakerDKRRIG",
"date_start": "1982-12-06 01:20:19",
"date_end": "1995-08-27 08:54:57",
"created_at": "2026-09-17T09:23:58.000000Z",
"updated_at": "2026-09-17T09:23:58.000000Z"
},
{
"id": 5,
"user_id": 290,
"device_id": 147,
"file": "/tmp/fakeraYF1es",
"date_start": "2025-06-21 05:55:46",
"date_end": "1980-03-14 05:47:28",
"created_at": "2026-09-17T09:23:58.000000Z",
"updated_at": "2026-09-17T09:23:58.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to view mobile logs",
"code": "MOBILE_LOGS:GET_BY_USER:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 148,
"file": "/tmp/fakerKCARQ5",
"date_start": "1972-05-14 15:58:14",
"date_end": "1992-05-03 01:42:59",
"created_at": "2026-09-17T09:24:01.000000Z",
"updated_at": "2026-09-17T09:24:01.000000Z"
},
{
"id": 7,
"user_id": 292,
"device_id": 149,
"file": "/tmp/fakerxFdPHd",
"date_start": "1989-12-26 00:07:28",
"date_end": "1971-02-26 23:47:19",
"created_at": "2026-09-17T09:24:01.000000Z",
"updated_at": "2026-09-17T09:24:01.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to view mobile logs",
"code": "MOBILE_LOGS:GET_BY_DEVICE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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\": \"excepturi\",
\"comments\": \"officiis\"
}"
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": "excepturi",
"comments": "officiis"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Example response (201):
{
"id": 1,
"entry_id": "d0429838-4586-359c-8863-85382affbcec",
"comments": "{\"key\":\"nihil\",\"value\":1526605}",
"created_at": "2026-09-17T09:21:03.000000Z",
"updated_at": "2026-09-17T09:21:03.000000Z"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "69f6fadc-5d3a-34c5-bb87-fb23845f8a90",
"comments": "{\"key\":\"accusantium\",\"value\":35841}",
"created_at": "2026-09-17T09:24:34.000000Z",
"updated_at": "2026-09-17T09:24:34.000000Z"
},
{
"id": 3,
"entry_id": "8751c35c-9231-32bb-a509-1fed54750ca8",
"comments": "{\"key\":\"omnis\",\"value\":773}",
"created_at": "2026-09-17T09:24:34.000000Z",
"updated_at": "2026-09-17T09:24:34.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to view old configurator statistics",
"code": "OLD_CONFIGURATOR_STATISTIC:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "849090cf-97b9-3f9c-bdf4-bfba8ea37204",
"clinician_uuid": "a730c161-3a31-300e-987a-25cec7103c0c",
"token": "AQCRBHGN66K96FDEV7FHUREENJMB5YMT7VR7LEC5QUSBG3YPYEQ4BBQ3T7TARD2X",
"status": "waiting_for_decision",
"created_at": "2026-09-17T09:22:17.000000Z",
"updated_at": "2026-09-17T09:22:17.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "2f8225e8-a981-3e93-9bf9-137d7af1e3e2",
"clinician_uuid": "04450c4c-620b-3b89-9bf6-e2ac9dbb3fbb",
"token": "4PUMJ3JE6AMDAJTQ4BXEQBH88PYVL2AY4HRQ9Q3TJ55L2YR6QE3M75ZT94VS8NHM",
"status": "waiting_for_decision",
"created_at": "2026-09-17T09:22:17.000000Z",
"updated_at": "2026-09-17T09:22:17.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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\": \"33b23464-b184-35f8-9b37-a717ccef50f6\",
\"clinician_uuid\": \"a4448767-7dc2-3a4d-b221-22a3cf40edd6\"
}"
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": "33b23464-b184-35f8-9b37-a717ccef50f6",
"clinician_uuid": "a4448767-7dc2-3a4d-b221-22a3cf40edd6"
};
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": "460a26a1-cc7c-3b46-a590-e5811be8217f",
"clinician_uuid": "2b9d9836-c46f-3922-b5bd-b4bb5e683fdd",
"token": "FPJ4Z8F72FLJDVLRDRUVVJD2NUNNTTV2QR4XA7CSHJPZF27W29TC6N6XMEVDTVFC",
"status": "waiting_for_decision",
"created_at": "2026-09-17T09:22:17.000000Z",
"updated_at": "2026-09-17T09:22: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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "ca028ca1-8e24-3414-95de-bc2b51e3668e",
"clinician_uuid": "3bee1650-4e23-320b-842d-a2d70125374b",
"token": "N9PZUCKQXZDHD2H9E92YRMCW9CXLU522ARTAWFSKE59L3B2ZB8RH8YTE9TPV7TLV",
"status": "waiting_for_decision",
"created_at": "2026-09-17T09:22:18.000000Z",
"updated_at": "2026-09-17T09:22:18.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:
- Product feature - part of application which can be considered as hardware compatible (with for example specific PCB version) or software compatible (with for example specific firmware version). Product features are used in versions compatibility matrix.
- Product toggle - part of application which can be enabled and disabled for current environment.
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": "lime",
"slug": "eum-quos-expedita-aut-molestias-nostrum-numquam",
"created_at": "2026-09-17T09:23:32.000000Z",
"updated_at": "2026-09-17T09:23:32.000000Z"
},
{
"id": 2,
"name": "white",
"slug": "maxime-modi-voluptatem-adipisci-unde",
"created_at": "2026-09-17T09:23:32.000000Z",
"updated_at": "2026-09-17T09:23:32.000000Z"
}
]
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to view product features and toggles",
"code": "PRODUCT_FEATURES:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "lime",
"slug": "dolor-dolor-unde-fugiat-itaque",
"created_at": "2026-09-17T09:23:32.000000Z",
"updated_at": "2026-09-17T09:23:32.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to manage product features and toggles",
"code": "PRODUCT_FEATURES:CREATE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "white",
"slug": "molestias-corrupti-magni-nulla-voluptates-quidem-natus",
"created_at": "2026-09-17T09:23:32.000000Z",
"updated_at": "2026-09-17T09:23:32.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "teal",
"slug": "adipisci-quia-et-dignissimos-aut-in",
"enabled": 1,
"created_at": "2026-09-17T09:23:32.000000Z",
"updated_at": "2026-09-17T09:23:32.000000Z"
},
{
"id": 2,
"name": "black",
"slug": "omnis-qui-voluptatum-ut-ipsam-id-quae-illo",
"enabled": 0,
"created_at": "2026-09-17T09:23:32.000000Z",
"updated_at": "2026-09-17T09:23:32.000000Z"
}
]
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to view product features and toggles",
"code": "PRODUCT_TOGGLES:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "aqua",
"slug": "fuga-ad-et-et-voluptas",
"enabled": 0,
"created_at": "2026-09-17T09:23:32.000000Z",
"updated_at": "2026-09-17T09:23:32.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to manage product features and toggles",
"code": "PRODUCT_TOGGLES:CREATE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "blue",
"slug": "qui-accusamus-possimus-dolores-in",
"enabled": 1,
"created_at": "2026-09-17T09:23:32.000000Z",
"updated_at": "2026-09-17T09:23:32.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Minus pariatur cupiditate fuga fugiat sit sint. Molestiae quis temporibus minus ducimus dolor nihil est. Porro velit ut illum et assumenda est. Aut voluptatem rem ex velit dolorum.",
"answer": "Vero et adipisci quasi ullam qui nam. Dolorem sed nihil quo dolor. Consequatur ratione expedita vitae quasi voluptas.",
"created_at": "2026-09-17T09:23:33.000000Z",
"updated_at": "2026-09-17T09:23:33.000000Z"
},
{
"id": 2,
"question": "Dolorem dolorem mollitia explicabo repellat. Ut vitae voluptatem quia et. Hic voluptas odit officiis quia porro.",
"answer": "Sed praesentium deleniti quas rerum excepturi. Consequatur sunt iure placeat ut itaque atque unde. Quas qui molestias corporis beatae tenetur hic placeat eos. Eos aut labore velit porro.",
"created_at": "2026-09-17T09:23:33.000000Z",
"updated_at": "2026-09-17T09:23:33.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to view product features and toggles",
"code": "FAQ:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 1,
"created_at": "2026-09-17T09:23:33.000000Z",
"updated_at": "2026-09-17T09:23:33.000000Z",
"toggle": {
"id": 6,
"name": "teal",
"slug": "hic-voluptate-sed-provident-officiis",
"enabled": 1,
"created_at": "2026-09-17T09:23:33.000000Z",
"updated_at": "2026-09-17T09:23:33.000000Z"
}
},
{
"id": 2,
"toggle_id": 8,
"user_id": 257,
"enabled": 0,
"created_at": "2026-09-17T09:23:33.000000Z",
"updated_at": "2026-09-17T09:23:33.000000Z",
"toggle": {
"id": 8,
"name": "white",
"slug": "vel-delectus-optio-excepturi-voluptas-maxime-omnis-voluptatem",
"enabled": 0,
"created_at": "2026-09-17T09:23:33.000000Z",
"updated_at": "2026-09-17T09:23:33.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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-09-17T09:23:34.000000Z",
"updated_at": "2026-09-17T09:23:34.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 1,
"created_at": "2026-09-17T09:23:34.000000Z",
"updated_at": "2026-09-17T09:23:34.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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\": \"deleniti\"
}"
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": "deleniti"
};
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": "3c0f2342-81f2-462b-993f-e514b3004094",
"title": "Rem hic nesciunt.",
"body": "<p>Autem rem rem nulla et amet occaecati at. Dolorum veniam ipsam et sapiente. Enim explicabo autem tempora ipsam.</p>",
"video": null,
"status": "draft",
"translation_status": "STARTED",
"activated_at": null,
"archived_at": null,
"created_by": null,
"created_at": "2026-09-17T09:24:32.000000Z",
"updated_at": "2026-09-17T09:24:32.000000Z"
},
{
"id": 2,
"sync_uuid": "3d2badec-8620-40fa-afbb-4dbdac782a2f",
"title": "Maiores neque in quidem consequuntur.",
"body": "<p>Dolor repellat ullam vel quia neque sint. Provident dolorem nulla nulla cum eum. Cum ea eius quae explicabo accusantium.</p>",
"video": null,
"status": "draft",
"translation_status": "STARTED",
"activated_at": null,
"archived_at": null,
"created_by": null,
"created_at": "2026-09-17T09:24:32.000000Z",
"updated_at": "2026-09-17T09:24:32.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to view release notes",
"code": "RELEASE_NOTES:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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=c881e418-d308-3ff4-96e2-783786893061"\
--form "video=@/tmp/phpd4X5kk" 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', 'c881e418-d308-3ff4-96e2-783786893061');
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": "5876fa00-a54b-4d6d-9468-c140118a834a",
"title": "Nisi libero hic.",
"body": "<p>Illo recusandae voluptatibus dolorem et provident ut aut. Ut at reprehenderit porro. Blanditiis esse ea inventore sit perferendis reprehenderit.</p>",
"video": null,
"status": "draft",
"translation_status": "STARTED",
"activated_at": null,
"archived_at": null,
"created_by": null,
"created_at": "2026-09-17T09:24:33.000000Z",
"updated_at": "2026-09-17T09:24:33.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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/phpB1Moo0" 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": "8fa02894-0611-4e7c-9456-e74606752ef4",
"title": "Temporibus eveniet aut.",
"body": "<p>Facere voluptas nostrum repudiandae quibusdam. Rerum et rerum officia voluptatum est velit. Dolor doloribus perferendis beatae ut aut dolorem.</p>",
"video": null,
"status": "draft",
"translation_status": "STARTED",
"activated_at": null,
"archived_at": null,
"created_by": null,
"created_at": "2026-09-17T09:24:33.000000Z",
"updated_at": "2026-09-17T09:24:33.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "e94b1ed7-f662-4ce3-8490-c63ecb9aa2a9",
"title": "Rem tempore praesentium.",
"body": "<p>Rerum sit ipsa sapiente et vero. Deleniti sequi iusto explicabo ut. Minus sunt nobis omnis maxime. Sint et optio soluta rem totam est aspernatur et.</p>",
"video": null,
"status": "draft",
"translation_status": "STARTED",
"activated_at": null,
"archived_at": null,
"created_by": null,
"created_at": "2026-09-17T09:24:33.000000Z",
"updated_at": "2026-09-17T09:24:33.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "f5934465-e1c3-423f-b46c-1606b99d5786",
"title": "Fugit dolores maxime.",
"body": "<p>Quae rem quia cumque nemo similique voluptatem omnis. Odit ab provident illum beatae possimus ea impedit. Est cupiditate accusamus id alias laborum consequatur nisi. In sequi eos quia. Ipsa rem asperiores voluptatem voluptas.</p>",
"video": null,
"status": "draft",
"translation_status": "STARTED",
"activated_at": null,
"archived_at": null,
"created_by": null,
"created_at": "2026-09-17T09:24:33.000000Z",
"updated_at": "2026-09-17T09:24:33.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Cumque quasi et dolores eos ut molestiae accusamus. Dolor aut et assumenda voluptate odit quam iusto.",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.000000Z",
"version": {
"id": 14,
"name": "0.23.86",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.000000Z"
}
},
{
"id": 2,
"version_type": "App\\Models\\SoftwareVersion",
"version_id": 15,
"description": "Temporibus qui ut cumque sint ut necessitatibus beatae. Exercitationem ut distinctio occaecati quidem deleniti. Neque quod ut iste quo praesentium eos.",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.000000Z",
"version": {
"id": 15,
"name": "4.27.54",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.000000Z"
}
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to list releases",
"code": "RELEASES:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Sequi labore qui repellat omnis quae veniam. Possimus ut rerum neque officiis exercitationem ad non laudantium. Dolorem enim sint mollitia ipsum.",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.000000Z",
"version": {
"id": 16,
"name": "2.99.89",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Ab eos consectetur dolor in quia. Magni atque quibusdam consequatur ut sunt eum. Nemo sunt repudiandae velit cupiditate rerum exercitationem. Voluptatem nisi rerum ea dolores voluptate aut.",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to create release",
"code": "RELEASES:CREATE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Tempore hic dignissimos nihil. Veritatis vitae tempora voluptatem numquam. Numquam possimus qui et provident. Non voluptas repellendus dolores.",
"created_at": "2026-09-17T09:23:38.000000Z",
"updated_at": "2026-09-17T09:23:38.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Search
API endpoints for search
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\": \"hfcitxmhopwdqxclcfsliabpmcosauulwzhfmugqwlotiexdmsdtcdanwhqkduullozshwakifgn\"
}"
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": "hfcitxmhopwdqxclcfsliabpmcosauulwzhfmugqwlotiexdmsdtcdanwhqkduullozshwakifgn"
};
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Visa",
"created_at": "2026-09-17T09:22:29.000000Z",
"updated_at": "2026-09-17T09:22:29.000000Z"
},
{
"id": 2,
"device_model": null,
"name": "MasterCard",
"created_at": "2026-09-17T09:22:29.000000Z",
"updated_at": "2026-09-17T09:22:29.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to list service parts",
"code": "SERVICING:LIST_PARTS:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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/phppTaLYJ" 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": 124,
"created_at": "2026-09-17T09:22:29.000000Z",
"updated_at": "2026-09-17T09:22:29.000000Z",
"parts": [
{
"id": 1,
"repair_id": 1,
"part_id": 3,
"reason": "Dolore et quasi ut aut natus sit. Deserunt quia quod qui enim maiores veniam. Cum ad laudantium ut aspernatur non quidem illum ad.",
"created_at": "2026-09-17T09:22:30.000000Z",
"updated_at": "2026-09-17T09:22:30.000000Z",
"part": {
"id": 3,
"device_model": null,
"name": "Visa",
"created_at": "2026-09-17T09:22:30.000000Z",
"updated_at": "2026-09-17T09:22:30.000000Z"
}
},
{
"id": 2,
"repair_id": 1,
"part_id": 4,
"reason": "Ad exercitationem ut ut voluptatum vel. Dolorum iusto in rerum id aliquam. Debitis hic debitis incidunt vel. Doloremque rerum numquam enim enim provident sed quae. Laudantium error libero voluptatem.",
"created_at": "2026-09-17T09:22:31.000000Z",
"updated_at": "2026-09-17T09:22:31.000000Z",
"part": {
"id": 4,
"device_model": null,
"name": "Visa",
"created_at": "2026-09-17T09:22:31.000000Z",
"updated_at": "2026-09-17T09:22:31.000000Z"
}
},
{
"id": 3,
"repair_id": 1,
"part_id": 5,
"reason": "Possimus omnis in et molestias cum autem doloremque. Molestiae nihil velit et voluptas qui. Minus autem quos quia odit dolores quis.",
"created_at": "2026-09-17T09:22:31.000000Z",
"updated_at": "2026-09-17T09:22:31.000000Z",
"part": {
"id": 5,
"device_model": null,
"name": "Visa",
"created_at": "2026-09-17T09:22:31.000000Z",
"updated_at": "2026-09-17T09:22:31.000000Z"
}
}
],
"attachments": [
{
"id": 1,
"repair_id": 1,
"file": "/tmp/fakeruT1Sxl",
"created_at": "2026-09-17T09:22:30.000000Z",
"updated_at": "2026-09-17T09:22:30.000000Z"
},
{
"id": 2,
"repair_id": 1,
"file": "/tmp/faker8JOqG0",
"created_at": "2026-09-17T09:22:32.000000Z",
"updated_at": "2026-09-17T09:22:32.000000Z"
},
{
"id": 3,
"repair_id": 1,
"file": "/tmp/fakerrOLBKw",
"created_at": "2026-09-17T09:22:32.000000Z",
"updated_at": "2026-09-17T09:22:32.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to report service repair",
"code": "SERVICING:REPORT_REPAIR:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Support Ticket
API endpoints for managing support tickets
Get tickets list
requires authentication
Possible extend options:
- sender - the user who created ticket
- recipient - the user who was ticket recipient
- device - the device assigned to ticket
- messages - message allocated to ticket
- messages.attachments - list of attachments assigned to message and ticket
- messages.sender - the user who wrote the message
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": 131,
"meeting_date": "2026-09-17 09:22:39",
"meeting_type": "online_meeting",
"contact_email": "rgerlach@koelpin.com",
"status": "new",
"created_at": "2026-09-17T09:22:39.000000Z",
"updated_at": "2026-09-17T09:22:39.000000Z",
"sender": {
"id": 150,
"mrn": "WECFQJ4H1789636958",
"name": "Elda Luettgen",
"email": "1789636958louvenia92@example.org",
"language": "en",
"phone": "(231) 393-7278",
"phone_country": "BE",
"phone_verified_at": null,
"address1": "634 Cruickshank Plains",
"address2": "Pagacside, DE 26941",
"postal_code": "19572-5039",
"city": "Kub, Dickens and Simonis",
"country": "BE",
"clinic_name": "Mylenemouth",
"clinic_location": "33462 Harvey Gateway\nDonaldhaven, CA 86122-0296",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:38.000000Z",
"updated_at": "2026-09-17T09:22:38.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"recipient": {
"id": 151,
"mrn": "HTG5KTF51789636959",
"name": "Remington Grady III",
"email": "1789636959pamela95@example.org",
"language": "en",
"phone": "1-385-515-6209",
"phone_country": "AE",
"phone_verified_at": null,
"address1": "4659 Upton Pike Apt. 197",
"address2": "Ritchiemouth, MN 23081-5612",
"postal_code": "97294-4353",
"city": "Halvorson, Satterfield and Lynch",
"country": "CY",
"clinic_name": "Janiceshire",
"clinic_location": "29384 Batz Mission\nKrajcikberg, PA 38664",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:39.000000Z",
"updated_at": "2026-09-17T09:22:39.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"device": {
"id": 131,
"serial": "ca20c741-afb9-3654-bd16-0137dded00e3",
"bluetooth_id": "d0b6a1f9-1e1f-3c54-acf4-466f1a721a1f",
"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-09-17T09:22:39.000000Z",
"updated_at": "2026-09-17T09:22:39.000000Z",
"first_config_change_at": null
},
"messages": [
{
"id": 15,
"ticket_id": 27,
"sender_id": 152,
"title": "Dr.",
"content": "Fugiat vel ut qui.",
"is_read": false,
"created_at": "2026-09-17T09:22:40.000000Z",
"updated_at": "2026-09-17T09:22:40.000000Z"
}
]
},
{
"id": 35,
"sender_id": 164,
"recipient_id": 165,
"device_id": 132,
"meeting_date": "2026-09-17 09:22:44",
"meeting_type": "online_meeting",
"contact_email": "tristin68@hotmail.com",
"status": "new",
"created_at": "2026-09-17T09:22:44.000000Z",
"updated_at": "2026-09-17T09:22:44.000000Z",
"sender": {
"id": 164,
"mrn": "3BEV87HT1789636963",
"name": "Gordon Schimmel",
"email": "1789636963zieme.thora@example.org",
"language": "en",
"phone": "(240) 323-0706",
"phone_country": "QA",
"phone_verified_at": null,
"address1": "531 Jairo Key",
"address2": "Schimmelville, WA 22601",
"postal_code": "77428",
"city": "Dach, Kilback and Gleason",
"country": "IN",
"clinic_name": "North Rosinaview",
"clinic_location": "12716 Martin Summit\nWest Selina, AZ 39548",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:43.000000Z",
"updated_at": "2026-09-17T09:22:43.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"recipient": {
"id": 165,
"mrn": "GYKYLXYC1789636964",
"name": "Quentin Strosin",
"email": "1789636964verna67@example.org",
"language": "en",
"phone": "+1 (240) 372-1118",
"phone_country": "RO",
"phone_verified_at": null,
"address1": "642 Reinger Knoll Apt. 154",
"address2": "North Jimmy, KS 01103",
"postal_code": "11807-5924",
"city": "Gerhold-Rath",
"country": "IE",
"clinic_name": "North Emmanuel",
"clinic_location": "6968 Martine Forges\nMoriahmouth, SC 46112",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:44.000000Z",
"updated_at": "2026-09-17T09:22:44.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"device": {
"id": 132,
"serial": "444441e2-fd15-37cf-b0ca-f739d2746a70",
"bluetooth_id": "beb3ce20-4084-392e-bdf3-28e179f7c553",
"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-09-17T09:22:44.000000Z",
"updated_at": "2026-09-17T09:22:44.000000Z",
"first_config_change_at": null
},
"messages": [
{
"id": 19,
"ticket_id": 35,
"sender_id": 166,
"title": "Dr.",
"content": "Sit repellat voluptas vero praesentium fugiat animi.",
"is_read": false,
"created_at": "2026-09-17T09:22:47.000000Z",
"updated_at": "2026-09-17T09:22:47.000000Z"
}
]
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to list support tickets",
"code": "TICKETS:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:onlinein-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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 133,
"meeting_date": "2026-09-17 09:22:52",
"meeting_type": "online_meeting",
"contact_email": "vada39@gmail.com",
"status": "new",
"created_at": "2026-09-17T09:22:53.000000Z",
"updated_at": "2026-09-17T09:22:53.000000Z",
"sender": {
"id": 178,
"mrn": "W3HJ3NRW1789636972",
"name": "Otha Greenholt",
"email": "1789636972zgottlieb@example.com",
"language": "en",
"phone": "551-223-9715",
"phone_country": "PN",
"phone_verified_at": null,
"address1": "7751 Abshire Cliffs",
"address2": "Vinceton, MS 90665",
"postal_code": "05899",
"city": "Cremin Ltd",
"country": "LU",
"clinic_name": "Johnstonchester",
"clinic_location": "62900 Berge Common Suite 644\nPort Osborne, VT 90204-5065",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:52.000000Z",
"updated_at": "2026-09-17T09:22:52.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"recipient": {
"id": 179,
"mrn": "BM5TM8FA1789636972",
"name": "Wilbert Koelpin III",
"email": "1789636972cummerata.elbert@example.org",
"language": "en",
"phone": "+1.760.766.8799",
"phone_country": "LR",
"phone_verified_at": null,
"address1": "1440 Ebert Radial",
"address2": "North Jordychester, AZ 49910-3407",
"postal_code": "35309",
"city": "Rodriguez, Kunde and Wilkinson",
"country": "HU",
"clinic_name": "West Annabell",
"clinic_location": "1323 O'Conner Dam\nBodebury, SC 76336-9010",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:22:53.000000Z",
"updated_at": "2026-09-17T09:22:53.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"device": {
"id": 133,
"serial": "ee0858af-2141-34d8-abe8-834eded0753a",
"bluetooth_id": "f09ea618-7ee5-3f78-9d42-e6c83e1ce73e",
"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-09-17T09:22:53.000000Z",
"updated_at": "2026-09-17T09:22:53.000000Z",
"first_config_change_at": null
},
"messages": [
{
"id": 23,
"ticket_id": 43,
"sender_id": 180,
"title": "Ms.",
"content": "Eveniet laborum et dolores cumque et magni perferendis.",
"is_read": false,
"created_at": "2026-09-17T09:22:54.000000Z",
"updated_at": "2026-09-17T09:22:54.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:onlinein-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": "asperiores",
"reason": "Incidunt minima velit magnam.",
"created_at": "2026-09-17T09:23:00.000000Z",
"updated_at": "2026-09-17T09:23:00.000000Z"
},
{
"id": 2,
"ticket_id": 52,
"author_id": 195,
"action": "corrupti",
"reason": "Quidem nihil dicta maxime omnis molestiae.",
"created_at": "2026-09-17T09:23:01.000000Z",
"updated_at": "2026-09-17T09:23:01.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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-09-17 09:23:01"\
--form "contact_email=pfannerstill.meda@gmail.com"\
--form "message[content]=Fugiat aut voluptas natus deserunt perferendis aut deleniti."\
--form "message[title]=Pariatur fugiat cum magnam exercitationem."\
--form "message[attachments][]=@/tmp/phpEHLJWm" 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-09-17 09:23:01');
body.append('contact_email', 'pfannerstill.meda@gmail.com');
body.append('message[content]', 'Fugiat aut voluptas natus deserunt perferendis aut deleniti.');
body.append('message[title]', 'Pariatur fugiat cum magnam exercitationem.');
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": 134,
"meeting_date": "2026-09-17 09:23:02",
"meeting_type": "online_meeting",
"contact_email": "rodriguez.maximillia@block.biz",
"status": "new",
"created_at": "2026-09-17T09:23:02.000000Z",
"updated_at": "2026-09-17T09:23:02.000000Z",
"sender": {
"id": 196,
"mrn": "TYZKG2Y61789636981",
"name": "Raven Bayer",
"email": "1789636981rowena36@example.com",
"language": "en",
"phone": "1-385-207-5552",
"phone_country": "GG",
"phone_verified_at": null,
"address1": "907 Onie Island",
"address2": "Lelaborough, SC 70854",
"postal_code": "53816-6411",
"city": "Leuschke Inc",
"country": "IE",
"clinic_name": "Astridhaven",
"clinic_location": "63917 Christiansen Course\nRomanview, OK 56911",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:23:01.000000Z",
"updated_at": "2026-09-17T09:23:01.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"recipient": {
"id": 197,
"mrn": "UEC483QF1789636982",
"name": "Percival Nader",
"email": "1789636982blabadie@example.com",
"language": "en",
"phone": "(689) 406-8519",
"phone_country": "AF",
"phone_verified_at": null,
"address1": "811 Lindsey Fields",
"address2": "Lake Norberto, CO 58594-7533",
"postal_code": "06564",
"city": "Brekke-Hickle",
"country": "EE",
"clinic_name": "East Harry",
"clinic_location": "70878 Devon Path Apt. 970\nCollinschester, RI 94790",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:23:02.000000Z",
"updated_at": "2026-09-17T09:23:02.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"device": {
"id": 134,
"serial": "99dc0ed1-498c-30b9-9df5-228be6f59f83",
"bluetooth_id": "0d88a21b-dda8-3494-a632-83b01ba68384",
"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-09-17T09:23:02.000000Z",
"updated_at": "2026-09-17T09:23:02.000000Z",
"first_config_change_at": null
},
"messages": [
{
"id": 27,
"ticket_id": 53,
"sender_id": 198,
"title": "Mrs.",
"content": "Eius et enim dolores aspernatur fugiat.",
"is_read": false,
"created_at": "2026-09-17T09:23:03.000000Z",
"updated_at": "2026-09-17T09:23:03.000000Z"
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to create support ticket",
"code": "TICKETS:CREATE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:onlinein-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": 135,
"meeting_date": "2026-09-17 09:23:09",
"meeting_type": "online_meeting",
"contact_email": "gloria.kihn@gmail.com",
"status": "new",
"created_at": "2026-09-17T09:23:09.000000Z",
"updated_at": "2026-09-17T09:23:09.000000Z",
"sender": {
"id": 210,
"mrn": "UU7Y6KEQ1789636988",
"name": "Mrs. Cathy Kuhn MD",
"email": "1789636988blanche.heathcote@example.org",
"language": "en",
"phone": "+16828704721",
"phone_country": "PS",
"phone_verified_at": null,
"address1": "1528 Sipes Mill",
"address2": "Dorothychester, HI 73939",
"postal_code": "83779",
"city": "Grant, Hane and Swift",
"country": "AT",
"clinic_name": "Strosinland",
"clinic_location": "62331 Will Center\nAbbeyside, KY 94419-3475",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:23:08.000000Z",
"updated_at": "2026-09-17T09:23:08.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"recipient": {
"id": 211,
"mrn": "ZCV3YWWK1789636989",
"name": "Prof. Odie Cummerata",
"email": "1789636989schiller.mariam@example.org",
"language": "en",
"phone": "1-551-440-9542",
"phone_country": "SG",
"phone_verified_at": null,
"address1": "1112 Renner Landing Suite 852",
"address2": "East Irvingville, MS 71451-8095",
"postal_code": "98515",
"city": "Pagac-Bayer",
"country": "LV",
"clinic_name": "South Amirfurt",
"clinic_location": "45364 Little Expressway Suite 394\nNorth Adriannabury, UT 20242",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:23:09.000000Z",
"updated_at": "2026-09-17T09:23:09.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"device": {
"id": 135,
"serial": "793d7256-92c9-3ff7-bd93-4e7494c787e6",
"bluetooth_id": "e5335964-f592-34d5-8cba-f6b2abf4a150",
"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-09-17T09:23:09.000000Z",
"updated_at": "2026-09-17T09:23:09.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:onlinein-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": "quaerat",
"reason": "Ullam cum nesciunt quia accusantium voluptatem quasi.",
"created_at": "2026-09-17T09:23:10.000000Z",
"updated_at": "2026-09-17T09:23:10.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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=Molestiae odio porro modi."\
--form "content=Nemo minima ut ea neque."\
--form "attachments[]=@/tmp/phpIbWzQW" 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', 'Molestiae odio porro modi.');
body.append('content', 'Nemo minima ut ea neque.');
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": 136,
"meeting_date": "2026-09-17 09:23:10",
"meeting_type": "online_meeting",
"contact_email": "hodkiewicz.norval@yundt.org",
"status": "new",
"created_at": "2026-09-17T09:23:11.000000Z",
"updated_at": "2026-09-17T09:23:11.000000Z",
"sender": {
"id": 214,
"mrn": "UKXCU69L1789636990",
"name": "Cedrick Murazik",
"email": "1789636990zula.yost@example.net",
"language": "en",
"phone": "+1-559-827-3475",
"phone_country": "MZ",
"phone_verified_at": null,
"address1": "5647 Lubowitz Burgs",
"address2": "Darronberg, IL 89861",
"postal_code": "53879",
"city": "Langosh LLC",
"country": "NO",
"clinic_name": "Reggieburgh",
"clinic_location": "389 Stroman Drives\nGulgowskiport, CT 34671",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:23:10.000000Z",
"updated_at": "2026-09-17T09:23:10.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"recipient": {
"id": 215,
"mrn": "WWFAGBQX1789636990",
"name": "Werner Gulgowski PhD",
"email": "1789636990weber.elza@example.com",
"language": "en",
"phone": "1-240-329-5595",
"phone_country": "AU",
"phone_verified_at": null,
"address1": "24176 Rolfson Fork Apt. 398",
"address2": "West Fabian, DC 15865-6955",
"postal_code": "80337-1915",
"city": "Robel LLC",
"country": "ES",
"clinic_name": "Lake Spencer",
"clinic_location": "2797 Sean Roads Apt. 763\nBernhardside, MT 48500",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:23:10.000000Z",
"updated_at": "2026-09-17T09:23:10.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"device": {
"id": 136,
"serial": "0e47a9fe-9b41-35a1-89a9-a94a39176e44",
"bluetooth_id": "fa0405f4-732b-35ab-9ffe-715ae2640228",
"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-09-17T09:23:11.000000Z",
"updated_at": "2026-09-17T09:23:11.000000Z",
"first_config_change_at": null
},
"messages": [
{
"id": 31,
"ticket_id": 63,
"sender_id": 216,
"title": "Dr.",
"content": "Nesciunt at architecto blanditiis et laborum corrupti.",
"is_read": false,
"created_at": "2026-09-17T09:23:12.000000Z",
"updated_at": "2026-09-17T09:23:12.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:onlinein-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": 137,
"meeting_date": "2026-09-17 09:23:17",
"meeting_type": "online_meeting",
"contact_email": "kaela.brakus@reilly.info",
"status": "new",
"created_at": "2026-09-17T09:23:17.000000Z",
"updated_at": "2026-09-17T09:23:17.000000Z",
"sender": {
"id": 228,
"mrn": "WRPNUHRF1789636996",
"name": "Alana Schowalter",
"email": "1789636996bartell.neha@example.org",
"language": "en",
"phone": "+1.760.246.7035",
"phone_country": "AG",
"phone_verified_at": null,
"address1": "688 Corkery Falls Suite 451",
"address2": "Ziemeport, NM 09903-9799",
"postal_code": "97808-9120",
"city": "Roob-Walter",
"country": "CZ",
"clinic_name": "East Caroline",
"clinic_location": "79960 Toy Square Apt. 231\nLake Anastacioshire, ME 90098-0269",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:23:16.000000Z",
"updated_at": "2026-09-17T09:23:16.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"recipient": {
"id": 229,
"mrn": "NNNC4EEY1789636997",
"name": "Wanda Ruecker Jr.",
"email": "1789636997ryan.margarett@example.com",
"language": "en",
"phone": "(272) 253-7303",
"phone_country": "TJ",
"phone_verified_at": null,
"address1": "31156 Amira Tunnel Apt. 639",
"address2": "Lake Isadoreville, HI 19170-8826",
"postal_code": "66007-4133",
"city": "Paucek, Dickinson and Cassin",
"country": "US",
"clinic_name": "South Elenora",
"clinic_location": "754 Bayer Rue\nJacynthechester, HI 83070-7721",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:23:17.000000Z",
"updated_at": "2026-09-17T09:23:17.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"device": {
"id": 137,
"serial": "28f428e4-a647-3020-b87e-5d082049cb64",
"bluetooth_id": "096799b8-cf08-3f11-b4de-d3c3c64c875b",
"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-09-17T09:23:17.000000Z",
"updated_at": "2026-09-17T09:23:17.000000Z",
"first_config_change_at": null
},
"messages": [
{
"id": 35,
"ticket_id": 71,
"sender_id": 230,
"title": "Ms.",
"content": "Vel ex debitis dolores perspiciatis tenetur quis at et.",
"is_read": false,
"created_at": "2026-09-17T09:23:18.000000Z",
"updated_at": "2026-09-17T09:23:18.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:onlinein-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": 138,
"meeting_date": "2026-09-17 09:23:22",
"meeting_type": "online_meeting",
"contact_email": "gorczany.joshuah@bins.biz",
"status": "new",
"created_at": "2026-09-17T09:23:23.000000Z",
"updated_at": "2026-09-17T09:23:23.000000Z",
"sender": {
"id": 242,
"mrn": "JJSX57E71789637002",
"name": "Phyllis Nikolaus",
"email": "1789637002volkman.gloria@example.com",
"language": "en",
"phone": "+1-586-451-6459",
"phone_country": "SY",
"phone_verified_at": null,
"address1": "819 Reichel Tunnel",
"address2": "New Alanfort, DE 10437",
"postal_code": "22396-7676",
"city": "Predovic, Stamm and Bahringer",
"country": "SI",
"clinic_name": "Wardberg",
"clinic_location": "8698 Langworth Mountains Apt. 661\nNew Kennedyton, GA 08217-3997",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:23:22.000000Z",
"updated_at": "2026-09-17T09:23:22.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"recipient": {
"id": 243,
"mrn": "NAH6ADST1789637002",
"name": "Telly Wunsch MD",
"email": "1789637002morgan99@example.org",
"language": "en",
"phone": "+1-986-916-0305",
"phone_country": "ES",
"phone_verified_at": null,
"address1": "385 Jarod Glens",
"address2": "East Flossieland, CO 99578-5388",
"postal_code": "06864-5498",
"city": "Rutherford Ltd",
"country": "IT",
"clinic_name": "Clemensberg",
"clinic_location": "5092 Stiedemann Mall Apt. 760\nNew Lilly, NJ 97552",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:23:22.000000Z",
"updated_at": "2026-09-17T09:23:22.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": []
},
"device": {
"id": 138,
"serial": "8d1f9184-2ebd-38f1-a75a-ae32b4b27261",
"bluetooth_id": "a1d8bd53-f3c7-3d53-92fa-854d0b5cce1d",
"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-09-17T09:23:23.000000Z",
"updated_at": "2026-09-17T09:23:23.000000Z",
"first_config_change_at": null
},
"messages": [
{
"id": 39,
"ticket_id": 79,
"sender_id": 244,
"title": "Prof.",
"content": "Consequuntur pariatur et eum et dolores velit.",
"is_read": false,
"created_at": "2026-09-17T09:23:24.000000Z",
"updated_at": "2026-09-17T09:23:24.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:onlinein-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": "Wilson Klein",
"type": "image",
"language": "my",
"file": "0",
"created_by": 306,
"created_at": "2026-09-17T09:24:12.000000Z",
"updated_at": "2026-09-17T09:24:12.000000Z",
"deleted_at": null
},
{
"id": 2,
"name": "Winifred McClure",
"type": "image",
"language": "ff",
"file": "0",
"created_by": 307,
"created_at": "2026-09-17T09:24:12.000000Z",
"updated_at": "2026-09-17T09:24:12.000000Z",
"deleted_at": null
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to list tooltips",
"code": "TOOLTIPS:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Response
Response Fields
items
object
id
integer
Tooltip ID.
name
string
Tooltip identifier name.
type
string
Media type.
Must be one of:imagevideo
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": "Craig Mraz III",
"type": "video",
"language": "st",
"file": "0",
"created_by": 308,
"created_at": "2026-09-17T09:24:13.000000Z",
"updated_at": "2026-09-17T09:24:13.000000Z",
"deleted_at": null
},
{
"id": 4,
"name": "Sheldon Shields",
"type": "video",
"language": "so",
"file": "0",
"created_by": 309,
"created_at": "2026-09-17T09:24:13.000000Z",
"updated_at": "2026-09-17T09:24:13.000000Z",
"deleted_at": null
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to manage tooltips",
"code": "TOOLTIPS:LIST_ARCHIVE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Response
Response Fields
items
object
id
integer
Tooltip ID.
name
string
Tooltip identifier name.
type
string
Media type.
Must be one of:imagevideo
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=Gladys Grove"\
--form "type=image"\
--form "language=sa"\
--form "file=@/tmp/phpFWXj1M" 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', 'Gladys Grove');
body.append('type', 'image');
body.append('language', 'sa');
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": "Mrs. Celestine Stark",
"type": "video",
"language": "yi",
"file": "0",
"created_by": 310,
"created_at": "2026-09-17T09:24:14.000000Z",
"updated_at": "2026-09-17T09:24:14.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Response
Response Fields
id
integer
Tooltip ID.
name
string
Tooltip identifier name.
type
string
Media type.
Must be one of:imagevideo
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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-09-17T09:24:18.000000Z",
"updated_at": "2026-09-17T09:24:18.000000Z",
"training": {
"id": 2,
"name": "perspiciatis natus",
"created_at": "2026-09-17T09:24:18.000000Z",
"updated_at": "2026-09-17T09:24:18.000000Z"
}
},
{
"id": 2,
"user_id": 315,
"training_id": 4,
"notifications_enabled": 1,
"created_at": "2026-09-17T09:24:18.000000Z",
"updated_at": "2026-09-17T09:24:18.000000Z",
"training": {
"id": 4,
"name": "deleniti quod",
"created_at": "2026-09-17T09:24:18.000000Z",
"updated_at": "2026-09-17T09:24:18.000000Z"
}
}
]
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to manage user trainings",
"code": "TRAININGS:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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-09-17T09:24:19.000000Z",
"updated_at": "2026-09-17T09:24:19.000000Z",
"training": {
"id": 6,
"name": "ut molestias",
"created_at": "2026-09-17T09:24:19.000000Z",
"updated_at": "2026-09-17T09:24:19.000000Z"
}
},
{
"id": 4,
"user_id": 317,
"training_id": 8,
"notifications_enabled": 1,
"created_at": "2026-09-17T09:24:19.000000Z",
"updated_at": "2026-09-17T09:24:19.000000Z",
"training": {
"id": 8,
"name": "aut eveniet",
"created_at": "2026-09-17T09:24:19.000000Z",
"updated_at": "2026-09-17T09:24:19.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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-09-17T09:24:20.000000Z",
"updated_at": "2026-09-17T09:24:20.000000Z"
},
{
"id": 2,
"user_id": 319,
"badge_id": 2,
"created_at": "2026-09-17T09:24:20.000000Z",
"updated_at": "2026-09-17T09:24:20.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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-09-17T09:24:22.000000Z",
"updated_at": "2026-09-17T09:24:22.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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-09-17T09:24:28.000000Z",
"updated_at": "2026-09-17T09:24:28.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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-09-17T09:24:28.000000Z",
"updated_at": "2026-09-17T09:24:28.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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-09-17T09:24:29.000000Z",
"updated_at": "2026-09-17T09:24:29.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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]=2012-09-24 18:15:30"\
--form "exercises[][date_end]=1997-10-18 09:59:13"\
--form "exercises[][end_reason]=success"\
--form "exercises[][config][common][fingerStrength][]=1"\
--form "exercises[][config][common][gripPositions][_]=0"\
--form "exercises[][config][common][gripPositions][0][initial][]=42"\
--form "exercises[][config][common][gripPositions][0][limit][]=67"\
--form "exercises[][config][common][gripPositions][1][initial][]=20"\
--form "exercises[][config][common][gripPositions][1][limit][]=36"\
--form "exercises[][config][common][gripPositions][2][initial][]=19"\
--form "exercises[][config][common][gripPositions][2][limit][]=19"\
--form "exercises[][config][common][gripPositions][3][initial][]=47"\
--form "exercises[][config][common][gripPositions][3][limit][]=86"\
--form "exercises[][config][common][gripPositions][4][initial][]=9"\
--form "exercises[][config][common][gripPositions][4][limit][]=81"\
--form "exercises[][config][common][gripPositions][5][initial][]=24"\
--form "exercises[][config][common][gripPositions][5][limit][]=33"\
--form "exercises[][config][common][gripPositions][6][initial][]=40"\
--form "exercises[][config][common][gripPositions][6][limit][]=86"\
--form "exercises[][config][common][gripPositions][7][initial][]=33"\
--form "exercises[][config][common][gripPositions][7][limit][]=90"\
--form "exercises[][config][common][gripPositions][8][initial][]=26"\
--form "exercises[][config][common][gripPositions][8][limit][]=78"\
--form "exercises[][config][common][gripPositions][9][initial][]=1"\
--form "exercises[][config][common][gripPositions][9][limit][]=58"\
--form "exercises[][config][common][gripPositions][10][initial][]=4"\
--form "exercises[][config][common][gripPositions][10][limit][]=85"\
--form "exercises[][config][common][gripPositions][11][initial][]=51"\
--form "exercises[][config][common][gripPositions][11][limit][]=86"\
--form "exercises[][config][common][gripPositions][12][initial][]=24"\
--form "exercises[][config][common][gripPositions][12][limit][]=35"\
--form "exercises[][config][common][gripPositions][13][initial][]=30"\
--form "exercises[][config][common][gripPositions][13][limit][]=43"\
--form "exercises[][config][common][inputSite][]=0"\
--form "exercises[][config][modes][][id]=83"\
--form "exercises[][config][modes][][name]=Eum officiis ratione temporibus dolorem maxime voluptates quis."\
--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][]=1"\
--form "exercises[][config][modes][][config][emgGains][]=100"\
--form "exercises[][config][modes][][config][emgSpike][]=0"\
--form "exercises[][config][modes][][config][emgThresholds][]=10"\
--form "exercises[][config][modes][][config][gripPairsConfig][]=9"\
--form "exercises[][config][modes][][config][gripSequentialConfig][]=6"\
--form "exercises[][config][modes][][config][gripSwitchingMode][]=1"\
--form "exercises[][config][modes][][config][holdOpen][]=1500"\
--form "exercises[][config][modes][][config][pulseTimings][]=680"\
--form "exercises[][config][modes][][config][softGrip][]=0"\
--form "exercises[][config][modes][][config][speedControlStrategy][]=1"\
--form "exercises[][firmware_id]=4961"\
--form "exercises[][app_version]=1.12.59"\
--form "exercises[][attempts][][date_start]=1991-09-09 20:12:36"\
--form "exercises[][attempts][][date_end]=1974-12-28 04:33:39"\
--form "exercises[][attempts][][result]=success"\
--form "exercises[][emg_file]=@/tmp/phpidKU1H" 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]', '2012-09-24 18:15:30');
body.append('exercises[][date_end]', '1997-10-18 09:59:13');
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][]', '42');
body.append('exercises[][config][common][gripPositions][0][limit][]', '67');
body.append('exercises[][config][common][gripPositions][1][initial][]', '20');
body.append('exercises[][config][common][gripPositions][1][limit][]', '36');
body.append('exercises[][config][common][gripPositions][2][initial][]', '19');
body.append('exercises[][config][common][gripPositions][2][limit][]', '19');
body.append('exercises[][config][common][gripPositions][3][initial][]', '47');
body.append('exercises[][config][common][gripPositions][3][limit][]', '86');
body.append('exercises[][config][common][gripPositions][4][initial][]', '9');
body.append('exercises[][config][common][gripPositions][4][limit][]', '81');
body.append('exercises[][config][common][gripPositions][5][initial][]', '24');
body.append('exercises[][config][common][gripPositions][5][limit][]', '33');
body.append('exercises[][config][common][gripPositions][6][initial][]', '40');
body.append('exercises[][config][common][gripPositions][6][limit][]', '86');
body.append('exercises[][config][common][gripPositions][7][initial][]', '33');
body.append('exercises[][config][common][gripPositions][7][limit][]', '90');
body.append('exercises[][config][common][gripPositions][8][initial][]', '26');
body.append('exercises[][config][common][gripPositions][8][limit][]', '78');
body.append('exercises[][config][common][gripPositions][9][initial][]', '1');
body.append('exercises[][config][common][gripPositions][9][limit][]', '58');
body.append('exercises[][config][common][gripPositions][10][initial][]', '4');
body.append('exercises[][config][common][gripPositions][10][limit][]', '85');
body.append('exercises[][config][common][gripPositions][11][initial][]', '51');
body.append('exercises[][config][common][gripPositions][11][limit][]', '86');
body.append('exercises[][config][common][gripPositions][12][initial][]', '24');
body.append('exercises[][config][common][gripPositions][12][limit][]', '35');
body.append('exercises[][config][common][gripPositions][13][initial][]', '30');
body.append('exercises[][config][common][gripPositions][13][limit][]', '43');
body.append('exercises[][config][common][inputSite][]', '0');
body.append('exercises[][config][modes][][id]', '83');
body.append('exercises[][config][modes][][name]', 'Eum officiis ratione temporibus dolorem maxime voluptates quis.');
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][]', '1');
body.append('exercises[][config][modes][][config][emgGains][]', '100');
body.append('exercises[][config][modes][][config][emgSpike][]', '0');
body.append('exercises[][config][modes][][config][emgThresholds][]', '10');
body.append('exercises[][config][modes][][config][gripPairsConfig][]', '9');
body.append('exercises[][config][modes][][config][gripSequentialConfig][]', '6');
body.append('exercises[][config][modes][][config][gripSwitchingMode][]', '1');
body.append('exercises[][config][modes][][config][holdOpen][]', '1500');
body.append('exercises[][config][modes][][config][pulseTimings][]', '680');
body.append('exercises[][config][modes][][config][softGrip][]', '0');
body.append('exercises[][config][modes][][config][speedControlStrategy][]', '1');
body.append('exercises[][firmware_id]', '4961');
body.append('exercises[][app_version]', '1.12.59');
body.append('exercises[][attempts][][date_start]', '1991-09-09 20:12:36');
body.append('exercises[][attempts][][date_end]', '1974-12-28 04:33:39');
body.append('exercises[][attempts][][result]', 'success');
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": "2020-02-03 07:01:12",
"date_end": "2021-11-30 12:07:03",
"end_reason": "success",
"config": "{\"common\":{\"fingerStrength\":[1,100],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[30,48,36,30,40],\"limit\":[93,79,50,49,77]},\"1\":{\"initial\":[35,55,13,74,36],\"limit\":[59,81,37,77,76]},\"2\":{\"initial\":[41,17,80,77,9],\"limit\":[43,47,86,80,86]},\"3\":{\"initial\":[27,25,48,45,23],\"limit\":[52,92,89,53,57]},\"4\":{\"initial\":[43,10,85,13,50],\"limit\":[53,58,92,51,77]},\"5\":{\"initial\":[40,5,30,37,15],\"limit\":[87,83,94,47,89]},\"6\":{\"initial\":[22,2,33,50,31],\"limit\":[90,20,80,72,44]},\"7\":{\"initial\":[64,42,46,34,75],\"limit\":[65,95,71,76,80]},\"8\":{\"initial\":[6,66,73,52,22],\"limit\":[59,94,76,57,83]},\"9\":{\"initial\":[27,24,30,3,16],\"limit\":[39,81,61,81,89]},\"10\":{\"initial\":[20,4,54,21,6],\"limit\":[53,61,67,34,59]},\"11\":{\"initial\":[61,18,50,19,8],\"limit\":[78,27,54,68,63]},\"12\":{\"initial\":[42,25,56,51,49],\"limit\":[44,34,62,83,61]},\"13\":{\"initial\":[12,65,73,4,29],\"limit\":[30,79,92,67,43]}},\"inputSite\":[1]},\"modes\":[{\"id\":86,\"name\":\"Eveniet qui doloremque qui ea assumenda magnam.\",\"slot\":0,\"config\":{\"autoGrasp\":[0,0],\"coContractionTimings\":[500,300],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[0,90,10,10,40,40,40,0,90,20],\"gripPairsConfig\":[4,9,1,6,2,8,3,12],\"gripSequentialConfig\":[5,255,255,9,12,11,13,7,3,2,8,1],\"gripSwitchingMode\":[1],\"holdOpen\":[2000,2500],\"pulseTimings\":[900,80,880,40],\"softGrip\":[0],\"speedControlStrategy\":[1]}},{\"id\":87,\"name\":\"Aut molestiae necessitatibus asperiores voluptatem sint perferendis iusto.\",\"slot\":1,\"config\":{\"autoGrasp\":[0,0],\"coContractionTimings\":[500,100],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[0,40,90,50,20,40,20,60,20,20],\"gripPairsConfig\":[8,2,3,4,13,10,9,12],\"gripSequentialConfig\":[7,9,3,2,1,255,12,10,6,11,13,8],\"gripSwitchingMode\":[1],\"holdOpen\":[2000,2500],\"pulseTimings\":[390,920,220,840],\"softGrip\":[1],\"speedControlStrategy\":[1]}},{\"id\":88,\"name\":\"Corporis enim quis neque consequatur.\",\"slot\":2,\"config\":{\"autoGrasp\":[0,100],\"coContractionTimings\":[500,400],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[50,70,30,40,0,0,0,90,30,40],\"gripPairsConfig\":[6,13,3,7,8,1,10,2],\"gripSequentialConfig\":[255,7,8,1,255,4,2,3,255,255,255,5],\"gripSwitchingMode\":[2],\"holdOpen\":[2000,2500],\"pulseTimings\":[360,810,800,560],\"softGrip\":[0],\"speedControlStrategy\":[0]}}]}",
"firmware_id": 24,
"app_version": "7.87.83",
"emg_file": "/tmp/fakerGvkvjh",
"created_at": "2026-09-17T09:24:30.000000Z",
"updated_at": "2026-09-17T09:24:30.000000Z",
"attempts": [
{
"id": 1,
"training_log_id": 1,
"date_start": "2024-04-28 03:23:04",
"date_end": "1982-12-25 01:06:51",
"result": "failure",
"created_at": "2026-09-17T09:24:30.000000Z",
"updated_at": "2026-09-17T09:24:30.000000Z"
}
]
},
{
"id": 3,
"user_id": 326,
"training_task_id": 3,
"date_start": "2003-11-12 22:18:28",
"date_end": "2023-04-17 22:48:52",
"end_reason": "success",
"config": "{\"common\":{\"fingerStrength\":[1,500],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[50,8,29,4,34],\"limit\":[72,43,50,33,35]},\"1\":{\"initial\":[41,2,34,27,33],\"limit\":[74,76,55,81,78]},\"2\":{\"initial\":[29,45,2,74,29],\"limit\":[77,78,25,84,30]},\"3\":{\"initial\":[61,27,39,22,37],\"limit\":[94,75,40,86,82]},\"4\":{\"initial\":[35,6,59,6,8],\"limit\":[64,31,74,34,55]},\"5\":{\"initial\":[23,61,35,31,84],\"limit\":[35,81,76,64,90]},\"6\":{\"initial\":[8,1,9,18,30],\"limit\":[64,19,12,34,42]},\"7\":{\"initial\":[30,36,1,18,26],\"limit\":[52,56,29,60,31]},\"8\":{\"initial\":[2,58,26,15,58],\"limit\":[19,75,85,84,80]},\"9\":{\"initial\":[29,36,7,19,8],\"limit\":[63,65,30,57,13]},\"10\":{\"initial\":[14,57,39,23,9],\"limit\":[46,57,54,91,67]},\"11\":{\"initial\":[18,10,15,31,71],\"limit\":[81,13,89,75,90]},\"12\":{\"initial\":[13,4,62,50,13],\"limit\":[74,47,81,78,21]},\"13\":{\"initial\":[12,34,25,57,20],\"limit\":[47,35,45,63,85]}},\"inputSite\":[0]},\"modes\":[{\"id\":92,\"name\":\"Sapiente aut est aut est ut mollitia.\",\"slot\":0,\"config\":{\"autoGrasp\":[0,100],\"coContractionTimings\":[400,300],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[90,10,70,100,90,100,80,90,90,10],\"gripPairsConfig\":[6,8,1,11,7,2,12,4],\"gripSequentialConfig\":[4,5,1,8,13,6,2,10,9,255,255,3],\"gripSwitchingMode\":[3],\"holdOpen\":[2000,2000],\"pulseTimings\":[70,220,130,840],\"softGrip\":[0],\"speedControlStrategy\":[0]}},{\"id\":93,\"name\":\"Ducimus sit ut laudantium dolorum.\",\"slot\":1,\"config\":{\"autoGrasp\":[1,100],\"coContractionTimings\":[200,200],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[40,100,60,100,60,60,80,10,50,70],\"gripPairsConfig\":[10,6,12,5,2,11,8,13],\"gripSequentialConfig\":[12,255,10,13,3,255,5,2,6,255,255,8],\"gripSwitchingMode\":[1],\"holdOpen\":[2000,2000],\"pulseTimings\":[660,790,260,320],\"softGrip\":[0],\"speedControlStrategy\":[0]}},{\"id\":94,\"name\":\"Qui corrupti doloribus voluptatem voluptate.\",\"slot\":2,\"config\":{\"autoGrasp\":[0,100],\"coContractionTimings\":[500,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[20,70,40,70,30,90,50,40,80,30],\"gripPairsConfig\":[13,3,5,11,6,7,4,10],\"gripSequentialConfig\":[255,255,2,7,13,8,10,3,6,11,255,1],\"gripSwitchingMode\":[3],\"holdOpen\":[1500,2500],\"pulseTimings\":[120,680,270,1000],\"softGrip\":[1],\"speedControlStrategy\":[0]}}]}",
"firmware_id": 26,
"app_version": "8.17.39",
"emg_file": "/tmp/fakerlsDXXZ",
"created_at": "2026-09-17T09:24:31.000000Z",
"updated_at": "2026-09-17T09:24:31.000000Z",
"attempts": [
{
"id": 2,
"training_log_id": 3,
"date_start": "2011-03-16 16:19:37",
"date_end": "2009-04-25 12:33:46",
"result": "failure",
"created_at": "2026-09-17T09:24:31.000000Z",
"updated_at": "2026-09-17T09:24:31.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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\": \"physical\",
\"country\": \"ES\",
\"delivery\": \"ua_nova_poshta_branch_pickup\",
\"email\": \"brolfson@weimann.net\",
\"phone\": \"+1.380.613.3410\",
\"full_name\": \"Adah Haag\",
\"address1\": \"6992 McCullough Locks Suite 670\",
\"address2\": \"Apt. 239\",
\"city\": \"Lake Leopold\",
\"postal_code\": \"94987-3053\",
\"state\": \"MOLESTIAS\",
\"parcel_locker_code\": \"N2KHGCVR\",
\"pin_code\": \"301743\"
}"
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": "physical",
"country": "ES",
"delivery": "ua_nova_poshta_branch_pickup",
"email": "brolfson@weimann.net",
"phone": "+1.380.613.3410",
"full_name": "Adah Haag",
"address1": "6992 McCullough Locks Suite 670",
"address2": "Apt. 239",
"city": "Lake Leopold",
"postal_code": "94987-3053",
"state": "MOLESTIAS",
"parcel_locker_code": "N2KHGCVR",
"pin_code": "301743"
};
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": "NO",
"delivery": "ua_nova_poshta_parcel_locker",
"email": "runte.luigi@yahoo.com",
"phone": "+1-470-832-1731",
"full_name": "Madalyn Bailey DDS",
"address1": "4369 Violet Valley Apt. 861",
"address2": "737 Zemlak Mountain Suite 502\nShemarburgh, UT 03391",
"city": "Maggiofort",
"postal_code": "23232",
"state": "HARUM",
"parcel_locker_code": "7YUM27CA",
"pin_code": "002188",
"created_at": "2026-09-17T09:24:32.000000Z",
"updated_at": "2026-09-17T09:24:32.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:digitalphysical
country
string
Delivery country code.
delivery
string
Delivery method.
Must be one of:home_deliveryparcel_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/eos/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/eos/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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "DarkSlateBlue",
"value": "0",
"created_at": "2026-09-17T09:24:33.000000Z",
"updated_at": "2026-09-17T09:24:33.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "Orchid",
"value": "1",
"created_at": "2026-09-17T09:24:34.000000Z",
"updated_at": "2026-09-17T09:24:34.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to manage user preferences",
"code": "USERS_PREFERENCES:SET:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Users
API endpoints for user management
Get users list
requires authentication
Possible extend options:
- clinicians - users assigned to this user as clinicians (for Amputee role)
- patients - users assigned to this user as patients (for ClinicAdmin/Clinician/ClinicianSupport role)
- devices - products assigned to user (for Amputee role)
- devicesAsClinician - products assigned to user as clinician (for ClinicAdmin/Clinician/ClinicianSupport role)
- roles - user roles
- permissions - user permissions (for ClinicianSupport role)
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": "S8RFR2PE1789636863",
"name": "Miss Veronica Harvey",
"email": "1789636863wolf.mark@example.com",
"language": "en",
"phone": "+1 (458) 747-8523",
"phone_country": "GT",
"phone_verified_at": null,
"address1": "1198 Kayden Radial Apt. 384",
"address2": "Bettyeville, DE 94580-6255",
"postal_code": "12681-2465",
"city": "Cole-Weimann",
"country": "LV",
"clinic_name": "East Xzaviermouth",
"clinic_location": "7587 Alaina Crest\nNorth Ebbaville, NV 66592",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:03.000000Z",
"updated_at": "2026-09-17T09:21:03.000000Z",
"invitation_status": "accepted",
"acadle_invitation_status": null,
"clinicians": [
{
"id": 8,
"mrn": "LZXCAXUH1789636864",
"name": "Cristal Kuphal",
"email": "1789636864deckow.buck@example.com",
"language": "en",
"phone": "+1-267-919-3320",
"phone_country": "AI",
"phone_verified_at": null,
"address1": "85420 Cruickshank Glens",
"address2": "Christianbury, ND 47247",
"postal_code": "57258",
"city": "Paucek Inc",
"country": "SI",
"clinic_name": "South Zionland",
"clinic_location": "860 Emile Trail Apt. 767\nClovischester, MD 97462-8630",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:04.000000Z",
"updated_at": "2026-09-17T09:21:04.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"pivot": {
"user_id": 7,
"assigned_user_id": 8
},
"roles": []
}
],
"devices": [
{
"id": 1,
"serial": "93c608e4-12a9-363a-b0e4-d4ac2b99cc73",
"bluetooth_id": "0e8b9f38-a7e6-38e9-8e78-a17bc1c137aa",
"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-09-17T09:21:04.000000Z",
"updated_at": "2026-09-17T09:21:04.000000Z",
"first_config_change_at": null
}
],
"roles": [
{
"id": 5,
"name": "ClinicianSupport"
}
]
},
{
"id": 9,
"mrn": "AMHU3TZK1789636864",
"name": "Caroline Bruen",
"email": "1789636864jermaine55@example.com",
"language": "en",
"phone": "(561) 684-1982",
"phone_country": "AI",
"phone_verified_at": null,
"address1": "715 Gorczany Ferry Apt. 457",
"address2": "Pfannerstillhaven, CA 10653-3345",
"postal_code": "19600",
"city": "Dare LLC",
"country": "HR",
"clinic_name": "Osinskichester",
"clinic_location": "77571 Hettie Fork\nHammesland, NV 00085",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:04.000000Z",
"updated_at": "2026-09-17T09:21:04.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"clinicians": [
{
"id": 10,
"mrn": "X823D62T1789636865",
"name": "Jamie Ortiz I",
"email": "1789636865wintheiser.gregoria@example.net",
"language": "en",
"phone": "469.430.7093",
"phone_country": "KZ",
"phone_verified_at": null,
"address1": "4864 Hintz Well Suite 712",
"address2": "Lake Deltaberg, VT 22682-9933",
"postal_code": "85570",
"city": "Quigley-Bergstrom",
"country": "FI",
"clinic_name": "Theodorabury",
"clinic_location": "29706 Derrick Trafficway\nPort Janytown, UT 93784",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:05.000000Z",
"updated_at": "2026-09-17T09:21:05.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"pivot": {
"user_id": 9,
"assigned_user_id": 10
},
"roles": []
}
],
"devices": [
{
"id": 2,
"serial": "2bc499a2-74f8-3f03-a805-c6705312ce53",
"bluetooth_id": "1d6ad642-ae0b-37f1-b400-b25b259fd776",
"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-09-17T09:21:05.000000Z",
"updated_at": "2026-09-17T09:21:05.000000Z",
"first_config_change_at": null
}
],
"roles": [
{
"id": 2,
"name": "CommunityAdmin"
}
]
}
]
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to view user list",
"code": "USERS:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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": "3M3M983L1789636867",
"name": "Amelia Parker II",
"email": "1789636867verdie.hermann@example.net",
"language": "en",
"phone": "+1.539.679.5039",
"phone_country": "LA",
"phone_verified_at": null,
"address1": "5050 Lola Cape Suite 657",
"address2": "Port Josuehaven, NC 54933",
"postal_code": "12941",
"city": "Morar, O'Hara and Borer",
"country": "HU",
"clinic_name": "North Iva",
"clinic_location": "81995 Gabe Parks\nSchimmelberg, OH 57961-1302",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:08.000000Z",
"updated_at": "2026-09-17T09:21:08.000000Z",
"invitation_status": null,
"acadle_invitation_status": null,
"roles": [
{
"id": 6,
"name": "Amputee"
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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": "E7B4VRRS1789636868",
"name": "Garrett Braun",
"email": "1789636868madisen.paucek@example.com",
"language": "en",
"phone": "(848) 686-6679",
"phone_country": "JE",
"phone_verified_at": null,
"address1": "5364 Prohaska Stream",
"address2": "East Johnsonside, ME 97183-3761",
"postal_code": "07440",
"city": "Robel, Jast and Jenkins",
"country": "AT",
"clinic_name": "Nienowhaven",
"clinic_location": "304 Demetrius Common\nAndreanneland, LA 38710-4584",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:08.000000Z",
"updated_at": "2026-09-17T09:21:08.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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:
user.view- access to view users' data (GET /user/{id} endpoint)user.update- access to update users' data (PUT /user/{id} and POST /user/{id}/phone endpoints)user.passwordChange- access to change users' passwords (POST /user/{id}/password endpoint)user.devices- access to list of users' devices (GET /user/{id}/devices endpoint)user.tickets.view- access to listing and viewing ticketsuser.tickets.update- access to updating tickets (marking messages as read)user.tickets.send- access to sending messages in ticketsuser.tickets.close- access to closing ticketsuser.goals- access to view or manage users' goals
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=452 Lela Lane"\
--form "address2=East Edgar, TN 93134"\
--form "postal_code=13293"\
--form "city=Amiebury"\
--form "country=CY"\
--form "clinic_name=Aether"\
--form "clinic_location=452 Lela Lane"\
--form "mfa_enabled=1"\
--form "mfa_method=email"\
--form "is_internal="\
--form "is_ambassador="\
--form "clinicians[]=2"\
--form "notifications_timezone=Europe/Warsaw"\
--form "notifications_at=8:00"\
--form "role=Amputee"\
--form "image=@/tmp/phpgQW6QI" \
--form "public_image=@/tmp/phpn2LN5c" 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', '452 Lela Lane');
body.append('address2', 'East Edgar, TN 93134');
body.append('postal_code', '13293');
body.append('city', 'Amiebury');
body.append('country', 'CY');
body.append('clinic_name', 'Aether');
body.append('clinic_location', '452 Lela Lane');
body.append('mfa_enabled', '1');
body.append('mfa_method', 'email');
body.append('is_internal', '');
body.append('is_ambassador', '');
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": "MYZFTWL61789636868",
"name": "Joana Langworth",
"email": "1789636868xschneider@example.org",
"language": "en",
"phone": "+1 (463) 247-3738",
"phone_country": "LU",
"phone_verified_at": null,
"address1": "4260 O'Conner Park Apt. 120",
"address2": "Schmidtport, MN 70408",
"postal_code": "78441-2258",
"city": "Runolfsson and Sons",
"country": "BE",
"clinic_name": "Lake Bernicestad",
"clinic_location": "3581 Mayert Corners Suite 525\nNorth Junius, KY 80567-5089",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:09.000000Z",
"updated_at": "2026-09-17T09:21:09.000000Z",
"invitation_status": null,
"acadle_invitation_status": "accepted",
"roles": [
{
"id": 7,
"name": "AcadleUser"
}
]
}
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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=29336 Amelie Stravenue"\
--form "address2=Port Alexie, UT 26737-4780"\
--form "postal_code=28921"\
--form "city=Robertoberg"\
--form "country=GB"\
--form "clinic_name=Aether"\
--form "clinic_location=29336 Amelie Stravenue"\
--form "image_delete=1"\
--form "mfa_enabled=1"\
--form "mfa_method=email"\
--form "active=1"\
--form "is_internal="\
--form "is_ambassador="\
--form "clinicians[]=2"\
--form "notifications_timezone=Europe/Warsaw"\
--form "notifications_at=8:00"\
--form "role=Amputee"\
--form "image=@/tmp/phpd74bnm" \
--form "public_image=@/tmp/php84Uga5" 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', '29336 Amelie Stravenue');
body.append('address2', 'Port Alexie, UT 26737-4780');
body.append('postal_code', '28921');
body.append('city', 'Robertoberg');
body.append('country', 'GB');
body.append('clinic_name', 'Aether');
body.append('clinic_location', '29336 Amelie Stravenue');
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('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": "UMQSZNW51789636869",
"name": "Bradly Dare",
"email": "1789636869paula.schultz@example.com",
"language": "en",
"phone": "+14329931751",
"phone_country": "SY",
"phone_verified_at": null,
"address1": "361 Schamberger Brook Suite 908",
"address2": "New Stacey, NJ 78663",
"postal_code": "21734-5657",
"city": "Boyle, Cummerata and Eichmann",
"country": "CY",
"clinic_name": "Port Yasmin",
"clinic_location": "510 Gregorio Drive Apt. 333\nStiedemannside, OK 26161",
"image": null,
"public_image": null,
"mfa_enabled": 0,
"mfa_method": null,
"mfa_verified_to": null,
"location_id": null,
"created_by": null,
"active": 1,
"is_internal": 0,
"is_ambassador": 0,
"notifications_timezone": null,
"notifications_at": null,
"created_at": "2026-09-17T09:21:09.000000Z",
"updated_at": "2026-09-17T09:21:09.000000Z",
"invitation_status": "accepted",
"acadle_invitation_status": null,
"roles": [
{
"id": 4,
"name": "Clinician"
}
]
}
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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
Whether the user is an internal user.
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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\": \"cumque\"
}"
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": "cumque"
};
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "0dff6e9f-d271-3577-a9ee-3bec9aefe882",
"bluetooth_id": "918a0bcc-fa18-3ee0-9108-3d13e00769d6",
"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-09-17T09:21:09.000000Z",
"updated_at": "2026-09-17T09:21:09.000000Z",
"first_config_change_at": null,
"model": {
"id": 1,
"name": "Zeus hand v1",
"type": "arm",
"orientation": "left",
"active": 1,
"created_at": "2026-09-17T09:21:09.000000Z",
"updated_at": "2026-09-17T09:21:09.000000Z"
}
},
{
"id": 4,
"serial": "7bb1182a-d9a3-378e-8096-0599b15d4868",
"bluetooth_id": "9d1eb0ff-310f-3624-ba4f-1c0091643b88",
"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-09-17T09:21:09.000000Z",
"updated_at": "2026-09-17T09:21:09.000000Z",
"first_config_change_at": null,
"model": {
"id": 2,
"name": "Zeus hand v1",
"type": "arm",
"orientation": "right",
"active": 1,
"created_at": "2026-09-17T09:21:09.000000Z",
"updated_at": "2026-09-17T09:21:09.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "dolor",
"value": "nobis",
"created_at": "2002-01-27T21:13:01.000000Z",
"updated_at": "1982-06-25T07:14:54.000000Z"
},
{
"id": 2,
"user_id": 35,
"name": "cupiditate",
"value": "quam",
"created_at": "2003-06-23T06:14:13.000000Z",
"updated_at": "1986-09-26T05:07:37.000000Z"
}
]
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to use mobile consents",
"code": "USERS:GET_MOBILE_CONSENTS:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "eos",
"value": "est",
"created_at": "1970-11-13T23:33:32.000000Z",
"updated_at": "1972-06-13T06:24:07.000000Z"
},
{
"id": 4,
"user_id": 37,
"name": "a",
"value": "ipsa",
"created_at": "2018-06-30T19:05:49.000000Z",
"updated_at": "2021-09-12T15:49:26.000000Z"
}
]
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to use mobile consents",
"code": "USERS:SET_MOBILE_CONSENTS:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:
- daily activity reminders
- goals daily summary
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "2.72.83",
"created_at": "2026-09-17T09:23:34.000000Z",
"updated_at": "2026-09-17T09:23:34.000000Z"
},
{
"id": 2,
"name": "6.39.27",
"created_at": "2026-09-17T09:23:34.000000Z",
"updated_at": "2026-09-17T09:23:34.000000Z"
}
]
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to list versions",
"code": "SOFTWARE_VERSION:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "4.67.4",
"created_at": "2026-09-17T09:23:34.000000Z",
"updated_at": "2026-09-17T09:23:34.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to create versions",
"code": "SOFTWARE_VERSION:CREATE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "7.46.87",
"file_firmware": "/tmp/fakervPxCqH",
"file_firmware_v2": "/tmp/faker7hFmwr",
"file_firmware_v3": "/tmp/fakerQsBrU3",
"file_firmware_v4": "/tmp/fakerGPogmO",
"file_firmware_v5": "/tmp/fakerP4AFEJ",
"file_firmware_new_pcb": "/tmp/faker8rJuZE",
"file_bootloader": "/tmp/fakerFYkEdA",
"file_bootloader_v2": "/tmp/fakerXxUwmn",
"file_bootloader_v3": "/tmp/faker1yeSJj",
"file_bootloader_v4": "/tmp/fakerHBHWIf",
"changelog": "Nemo a officia eaque totam quos hic et. Nihil molestiae accusantium pariatur nemo sapiente possimus. Enim id dolor qui cum et velit. Sint reiciendis incidunt nostrum consequuntur non magnam.",
"created_at": "2026-09-17T09:23:34.000000Z",
"updated_at": "2026-09-17T09:23:34.000000Z"
},
{
"id": 3,
"name": "3.46.48",
"file_firmware": "/tmp/fakerYKzkBe",
"file_firmware_v2": "/tmp/fakerEEa5Fp",
"file_firmware_v3": "/tmp/fakerbK1ERI",
"file_firmware_v4": "/tmp/fakerJf1ard",
"file_firmware_v5": "/tmp/fakerr88dnM",
"file_firmware_new_pcb": "/tmp/fakerylhQ8F",
"file_bootloader": "/tmp/fakerKlRCiU",
"file_bootloader_v2": "/tmp/fakerI7fckT",
"file_bootloader_v3": "/tmp/fakerIzsTSq",
"file_bootloader_v4": "/tmp/fakerDCABPY",
"changelog": "Quibusdam doloremque eos rerum corrupti. Vel quis ut voluptates officia. Aut eligendi error sunt sunt dolorem laboriosam. In quam officiis est nam repellat voluptas.",
"created_at": "2026-09-17T09:23:34.000000Z",
"updated_at": "2026-09-17T09:23:34.000000Z"
}
]
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to list versions",
"code": "FIRMWARE_VERSION:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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/phpvZdWhB" \
--form "file_firmware_v2=@/tmp/php9iYdDA" \
--form "file_firmware_v3=@/tmp/phpiv2DeC" \
--form "file_firmware_v4=@/tmp/phpGI7Vnv" \
--form "file_firmware_v5=@/tmp/phpc1AAoL" \
--form "file_firmware_new_pcb=@/tmp/phpm4FXGF" \
--form "file_bootloader=@/tmp/phpqJcans" \
--form "file_bootloader_v2=@/tmp/phpPUUYBT" \
--form "file_bootloader_v3=@/tmp/phpqNJxUI" \
--form "file_bootloader_v4=@/tmp/phpC46Bby" 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": "7.33.29",
"file_firmware": "/tmp/fakerGrgR0y",
"file_firmware_v2": "/tmp/fakerDP9OXJ",
"file_firmware_v3": "/tmp/fakerIOgRXH",
"file_firmware_v4": "/tmp/fakerIJKJLY",
"file_firmware_v5": "/tmp/fakerkmW2xz",
"file_firmware_new_pcb": "/tmp/fakerH9MFrF",
"file_bootloader": "/tmp/fakeroOAsnJ",
"file_bootloader_v2": "/tmp/fakeraVJaDw",
"file_bootloader_v3": "/tmp/fakerrx51xN",
"file_bootloader_v4": "/tmp/faker5a9qCG",
"changelog": "Placeat mollitia quaerat quas hic. Doloremque assumenda ipsa laboriosam vitae. Assumenda aut repudiandae temporibus mollitia. Magni sint officiis natus.",
"created_at": "2026-09-17T09:23:34.000000Z",
"updated_at": "2026-09-17T09:23:34.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to create versions",
"code": "FIRMWARE_VERSION:CREATE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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/phpGNAN4x" \
--form "file_firmware_v2=@/tmp/phpeOZE2a" \
--form "file_firmware_v3=@/tmp/phpz5mf5w" \
--form "file_firmware_v4=@/tmp/phpgeXtqY" \
--form "file_firmware_v5=@/tmp/phpCyEMC9" \
--form "file_firmware_new_pcb=@/tmp/phpeNyUzU" \
--form "file_bootloader=@/tmp/phpCmw6us" \
--form "file_bootloader_v2=@/tmp/phpveh4hz" \
--form "file_bootloader_v3=@/tmp/php1ahpXH" \
--form "file_bootloader_v4=@/tmp/phpooOIB6" 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": "3.18.95",
"file_firmware": "/tmp/fakeriJC2sd",
"file_firmware_v2": "/tmp/fakerdjtgNk",
"file_firmware_v3": "/tmp/faker9UqdAo",
"file_firmware_v4": "/tmp/faker5VmcRJ",
"file_firmware_v5": "/tmp/fakerx5vfII",
"file_firmware_new_pcb": "/tmp/fakerwkWyf7",
"file_bootloader": "/tmp/faker6TCAJK",
"file_bootloader_v2": "/tmp/faker2Rj1Ck",
"file_bootloader_v3": "/tmp/fakerEaRhFF",
"file_bootloader_v4": "/tmp/fakereLMqvK",
"changelog": "Rem ex est consequatur et deserunt. Eos quaerat quas quis quo repellendus. Numquam doloribus animi in nam. Nisi molestias aperiam inventore aliquid.",
"created_at": "2026-09-17T09:23:34.000000Z",
"updated_at": "2026-09-17T09:23:34.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "7.36.61",
"hardware_id": "",
"created_at": "2026-09-17T09:23:34.000000Z",
"updated_at": "2026-09-17T09:23:34.000000Z"
},
{
"id": 3,
"name": "4.77.42",
"hardware_id": "",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z"
}
]
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to list versions",
"code": "PCB_VERSION:LIST:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "2.29.60",
"hardware_id": "",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z"
}
Example response (403, Insufficient permission):
{
"message": "Insufficient permission to create versions",
"code": "PCB_VERSION:CREATE:INSUFFICIENT_PERMISSION"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "0.36.55",
"hardware_id": "",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List compatibilities
requires authentication
Most typical scenarios to use compatibility matrix:
- full matrix (no filters) - for admin panel displaying,
- filtered by all of the versions (software, firmware, PCB and device model) - for checking specific scenario compatibility and supported features.
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": 1,
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z",
"features": [
{
"id": 1,
"compatibility_id": 1,
"feature_id": 5,
"is_compatible": 1,
"reason": "Autem enim nam ipsam. Enim fuga incidunt eum voluptatem. Veritatis dolorem incidunt minima dolorem veniam explicabo tempore.",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z",
"feature": {
"id": 5,
"name": "fuchsia",
"slug": "dolorum-officia-placeat-qui",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z"
}
},
{
"id": 2,
"compatibility_id": 1,
"feature_id": 7,
"is_compatible": 1,
"reason": "Praesentium soluta vitae rerum eum. Incidunt excepturi voluptatem dolor facere. Voluptas qui laborum qui quidem.",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z",
"feature": {
"id": 7,
"name": "lime",
"slug": "doloribus-qui-pariatur-at-dignissimos-voluptatem-nostrum-sit",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z"
}
},
{
"id": 3,
"compatibility_id": 1,
"feature_id": 9,
"is_compatible": 1,
"reason": "Odit non omnis corporis fugiat. Qui nesciunt culpa eveniet quaerat. Eos eligendi error cum illum consequatur non. Quo quo rerum consequatur. Molestiae non nesciunt saepe corporis nam odit voluptas.",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z",
"feature": {
"id": 9,
"name": "navy",
"slug": "repudiandae-dolor-accusamus-vitae-molestiae-explicabo-est-esse-maxime",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z"
}
}
]
},
{
"id": 5,
"device_model_id": 14,
"software_version_id": 8,
"firmware_version_id": 18,
"pcb_version_id": 10,
"is_fully_compatible": 1,
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z",
"features": [
{
"id": 4,
"compatibility_id": 5,
"feature_id": 10,
"is_compatible": 1,
"reason": "Provident necessitatibus atque cum laboriosam. Quia velit tempore blanditiis eum reprehenderit. Illum ipsa nam provident magnam et ipsam. Vel sequi maiores et et est voluptate.",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z",
"feature": {
"id": 10,
"name": "olive",
"slug": "in-laudantium-enim-eos-vero-perspiciatis-velit-maiores",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z"
}
},
{
"id": 5,
"compatibility_id": 5,
"feature_id": 12,
"is_compatible": 0,
"reason": "Nihil non facere laboriosam. Pariatur alias id qui ea eos rem. Dolorem nemo in placeat molestiae quo et.",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z",
"feature": {
"id": 12,
"name": "teal",
"slug": "animi-consectetur-consequatur-officiis",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z"
}
},
{
"id": 6,
"compatibility_id": 5,
"feature_id": 14,
"is_compatible": 0,
"reason": "Hic consequatur quae sequi voluptates enim ut. Velit quia aut minima animi impedit aliquam. Quia corporis excepturi dolor quo sed possimus.",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.000000Z",
"feature": {
"id": 14,
"name": "white",
"slug": "delectus-veniam-fugiat-iure-voluptatem-facere-sequi",
"created_at": "2026-09-17T09:23:35.000000Z",
"updated_at": "2026-09-17T09:23:35.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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\": 15,
\"software_version_id\": 6,
\"firmware_version_id\": 1,
\"pcb_version_id\": 16,
\"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": 15,
"software_version_id": 6,
"firmware_version_id": 1,
"pcb_version_id": 16,
"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-09-17T09:23:37.000000Z",
"updated_at": "2026-09-17T09:23:37.000000Z",
"features": [
{
"id": 7,
"compatibility_id": 9,
"feature_id": 15,
"is_compatible": 1,
"reason": "Quod quibusdam et voluptate doloremque. Incidunt alias fuga tenetur quos. Quia minus molestias pariatur rerum maxime enim.",
"created_at": "2026-09-17T09:23:37.000000Z",
"updated_at": "2026-09-17T09:23:37.000000Z",
"feature": {
"id": 15,
"name": "silver",
"slug": "odit-sunt-voluptas-quo-qui-dolore",
"created_at": "2026-09-17T09:23:37.000000Z",
"updated_at": "2026-09-17T09:23:37.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": "b6cf348bc9b1a71d9db0ce76c3b2645a3d57e2a6b2119b58a236adbef5e05c43",
"jwt_guest": "b47adbb3f08d0a8ff225a5fd2d79169fdb27ea7a0cf9650a2baad50f0c043a36",
"room_name": "room_9b1c9a6f51fbc2c91915c91e0900df69",
"expires": 1789637839,
"status": "open",
"created_at": "2026-09-17T09:22:20.000000Z",
"updated_at": "2026-09-17T09:22:20.000000Z"
},
{
"id": 2,
"moderator_id": 131,
"guest_id": 132,
"jwt_moderator": "469cc643a19fb75901e5d331b8dc14befa8b98810b246c2fb22fff0c382dc39e",
"jwt_guest": "7e085b4198b6bc904d8489968fc9a8054c476c578e4de3dbf820832b458de9e7",
"room_name": "room_d3ac916adea80cc5c9a99f9e0e0362b9",
"expires": 1789637841,
"status": "open",
"created_at": "2026-09-17T09:22:21.000000Z",
"updated_at": "2026-09-17T09:22: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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:openexpiredclosed
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": "a69e4986f807d53cf2d5bfd7ddf485555eaa8ef5748fd862ccd2520691ec0370",
"jwt_guest": "a941ea708fa6dbcb9f4dc76bbc141a619d5a3bdbb11da8c8cfe859005277d504",
"room_name": "room_8d01d67ee5e97e7f4410c892dc11d093",
"expires": 1789637846,
"status": "open",
"created_at": "2026-09-17T09:22:27.000000Z",
"updated_at": "2026-09-17T09:22:27.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:openexpiredclosed
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": "469cc643a19fb75901e5d331b8dc14befa8b98810b246c2fb22fff0c382dc39e",
"jwt_guest": "f22e89c251e50eec7c9e184f5584b99fdf48fdbde7317acd6388ce05ea691a43",
"room_name": "room_40f251bf097fc76e14f836028fa7a331",
"expires": 1789637848,
"status": "open",
"created_at": "2026-09-17T09:22:28.000000Z",
"updated_at": "2026-09-17T09:22:28.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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:openexpiredclosed
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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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": 64,
"choice": "dismissed",
"dont_ask_again": 0,
"created_at": "2026-09-17T09:21:47.000000Z",
"updated_at": "2026-09-17T09:21:47.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"
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.