MENU navbar-image

Introduction

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

Authenticating requests

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

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

Token based authentication

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

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

Cookie based authentication

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

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

Multi-Factor Authorization (MFA)

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

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

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

Multi-Factor Authorization (MFA) - Remember Session

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

Appendix A. Laravel validation rules

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

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

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

Appendix B. Custom validation rules

List of custom validation rules messages:

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

Acadle

Endpoints related to Acadle integration

Acadle SSO

requires authentication

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

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

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

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

Example response (200, OK):


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

Example response (403, Insufficient permission):


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

Example response (403, Survey required):


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

Request   

POST api/acadle/sso

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Check Acadle survey status

requires authentication

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

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

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

Example response (200, OK):


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

Example response (403, Insufficient permission):


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

Request   

GET api/acadle/survey/status

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get Acadle survey data

requires authentication

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

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

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

Example response (201):


{
    "id": 1,
    "user_id": 296,
    "cpo_number": "767",
    "country": "Guyana",
    "medical_training": "physiotherapist",
    "myo_exp_zeus": "1",
    "has_demo_hand_access": 1,
    "wants_demo_hand": 0,
    "myo_exp_covvi": 0,
    "myo_exp_fillauer": 0,
    "myo_exp_ossur": 1,
    "myo_exp_ottobock": 1,
    "myo_exp_steeper": 0,
    "myo_exp_taska": 0,
    "myo_exp_vincent": 1,
    "myo_exp_pattern_recognition": 0,
    "myo_exp_other": "In quam alias quas vero quo rerum nihil a.",
    "partial_hand_protheses": "3",
    "below_elbow_protheses_single_action": "1",
    "below_elbow_protheses_multi_action": "0",
    "above_elbow_protheses": "4",
    "shoulder_protheses": "1",
    "zeus_components_description": "In quia sint aspernatur aut quo ducimus.",
    "contact_name": "Wilma",
    "contact_surname": "Quigley",
    "company_name": "Kreiger LLC",
    "street": "2757 Larkin Squares Apt. 828",
    "city": "Holliebury",
    "postal_code": "41946",
    "email": "shields.kenny@koepp.com",
    "phone": "(228) 591-0530",
    "phone_country": "mh",
    "device_side": "R",
    "created_at": "2025-12-08T15:50:49.000000Z",
    "updated_at": "2025-12-08T15:50:49.000000Z"
}

Example response (403, Insufficient permission):


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

Example response (404, Survey not found):


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

Request   

GET api/acadle/survey

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

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": 297,
    "cpo_number": "167",
    "country": "Haiti",
    "medical_training": "physiotherapist",
    "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": 0,
    "myo_exp_steeper": 1,
    "myo_exp_taska": 1,
    "myo_exp_vincent": 1,
    "myo_exp_pattern_recognition": 0,
    "myo_exp_other": "Sint enim ex sunt voluptates consequatur.",
    "partial_hand_protheses": "0",
    "below_elbow_protheses_single_action": "1",
    "below_elbow_protheses_multi_action": "2",
    "above_elbow_protheses": "1",
    "shoulder_protheses": "0",
    "zeus_components_description": "Quas magnam omnis aut.",
    "contact_name": "Fermin",
    "contact_surname": "Marvin",
    "company_name": "Kohler, Schulist and Luettgen",
    "street": "684 Leilani Crossroad",
    "city": "Port Lea",
    "postal_code": "10591",
    "email": "marquardt.elvera@rohan.com",
    "phone": "(828) 232-3723",
    "phone_country": "ck",
    "device_side": "R",
    "created_at": "2025-12-08T15:50:49.000000Z",
    "updated_at": "2025-12-08T15:50:49.000000Z"
}

Example response (403, Insufficient permission):


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

Example response (404, User not found):


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

Example response (404, Survey not found):


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

Request   

GET api/acadle/survey/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

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": 298,
            "cpo_number": "95859519",
            "country": "Malta",
            "medical_training": "biomedical_engineer",
            "myo_exp_zeus": "0",
            "has_demo_hand_access": 1,
            "wants_demo_hand": 0,
            "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": 0,
            "myo_exp_other": "Sunt ea et temporibus.",
            "partial_hand_protheses": "4",
            "below_elbow_protheses_single_action": "1",
            "below_elbow_protheses_multi_action": "1",
            "above_elbow_protheses": "1",
            "shoulder_protheses": "3",
            "zeus_components_description": "Amet expedita autem et nulla qui.",
            "contact_name": "Audreanne",
            "contact_surname": "Shields",
            "company_name": "Schneider-Deckow",
            "street": "455 Cassie Rest Apt. 672",
            "city": "Maryamhaven",
            "postal_code": "81842-0395",
            "email": "crooks.kenneth@keebler.com",
            "phone": "+1.402.586.8601",
            "phone_country": "ne",
            "device_side": "L",
            "created_at": "2025-12-08T15:50:49.000000Z",
            "updated_at": "2025-12-08T15:50:49.000000Z"
        },
        {
            "id": 4,
            "user_id": 299,
            "cpo_number": "88168",
            "country": "Zambia",
            "medical_training": "biomedical_engineer",
            "myo_exp_zeus": "0",
            "has_demo_hand_access": 0,
            "wants_demo_hand": 0,
            "myo_exp_covvi": 1,
            "myo_exp_fillauer": 0,
            "myo_exp_ossur": 0,
            "myo_exp_ottobock": 1,
            "myo_exp_steeper": 0,
            "myo_exp_taska": 1,
            "myo_exp_vincent": 1,
            "myo_exp_pattern_recognition": 0,
            "myo_exp_other": "Laborum recusandae exercitationem voluptatem molestias iusto et.",
            "partial_hand_protheses": "5",
            "below_elbow_protheses_single_action": "1",
            "below_elbow_protheses_multi_action": "5",
            "above_elbow_protheses": "0",
            "shoulder_protheses": "2",
            "zeus_components_description": "Reprehenderit eveniet at qui explicabo quibusdam repudiandae ullam dolorum.",
            "contact_name": "Andreanne",
            "contact_surname": "Connelly",
            "company_name": "Wilderman LLC",
            "street": "499 Maggio Stream",
            "city": "Beerside",
            "postal_code": "90844-6915",
            "email": "egusikowski@conroy.com",
            "phone": "989-812-9650",
            "phone_country": "ke",
            "device_side": "R",
            "created_at": "2025-12-08T15:50:49.000000Z",
            "updated_at": "2025-12-08T15:50:49.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


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

Request   

GET api/acadle/surveys

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

search   string  optional  

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

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

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

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

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\": 11520,
    \"country\": \"Wallis and Futuna\",
    \"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\": \"Consequatur nostrum tenetur consequatur excepturi vitae repellendus.\",
    \"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\": \"Vitae at quis asperiores id consequatur qui repellendus.\",
    \"contact_name\": \"Darrick\",
    \"company_name\": \"Carroll, Schuppe and O\'Connell\",
    \"street\": \"98957 Bergstrom Parkway\",
    \"city\": \"Ollieburgh\",
    \"postal_code\": \"38478-3750\",
    \"email\": \"lakin.bart@conroy.org\",
    \"phone\": \"+1-872-259-7726\",
    \"phone_country\": \"MY\",
    \"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": 11520,
    "country": "Wallis and Futuna",
    "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": "Consequatur nostrum tenetur consequatur excepturi vitae repellendus.",
    "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": "Vitae at quis asperiores id consequatur qui repellendus.",
    "contact_name": "Darrick",
    "company_name": "Carroll, Schuppe and O'Connell",
    "street": "98957 Bergstrom Parkway",
    "city": "Ollieburgh",
    "postal_code": "38478-3750",
    "email": "lakin.bart@conroy.org",
    "phone": "+1-872-259-7726",
    "phone_country": "MY",
    "device_side": "R"
};

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

Example response (201):


{
    "id": 5,
    "user_id": 300,
    "cpo_number": "5168576",
    "country": "Rwanda",
    "medical_training": "physician",
    "myo_exp_zeus": "0",
    "has_demo_hand_access": 0,
    "wants_demo_hand": 1,
    "myo_exp_covvi": 0,
    "myo_exp_fillauer": 1,
    "myo_exp_ossur": 0,
    "myo_exp_ottobock": 1,
    "myo_exp_steeper": 1,
    "myo_exp_taska": 1,
    "myo_exp_vincent": 0,
    "myo_exp_pattern_recognition": 1,
    "myo_exp_other": "Dicta expedita minima eaque dolor enim.",
    "partial_hand_protheses": "0",
    "below_elbow_protheses_single_action": "2",
    "below_elbow_protheses_multi_action": "2",
    "above_elbow_protheses": "1",
    "shoulder_protheses": "2",
    "zeus_components_description": "Est atque fugiat excepturi labore maiores nemo laborum molestiae.",
    "contact_name": "Niko",
    "contact_surname": "Orn",
    "company_name": "O'Keefe Group",
    "street": "10479 Ramiro Common Suite 195",
    "city": "Jakubowskistad",
    "postal_code": "75925-5570",
    "email": "melisa.weimann@kuphal.com",
    "phone": "(478) 403-5013",
    "phone_country": "mv",
    "device_side": "L",
    "created_at": "2025-12-08T15:50:49.000000Z",
    "updated_at": "2025-12-08T15:50:49.000000Z"
}

Example response (403, Insufficient permission):


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

Example response (403, Survey already sent):


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

Request   

POST api/acadle/survey

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

cpo_number   string  optional  

CPO Number. Example: 11520

country   string   

Country name. Example: Wallis and Futuna

medical_training   string   

Clinician's medical/clinical training. Example: clinician

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

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

myo_exp_covvi   boolean   

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

myo_exp_fillauer   boolean   

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

myo_exp_ossur   boolean   

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

myo_exp_ottobock   boolean   

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

myo_exp_steeper   boolean   

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

myo_exp_taska   boolean   

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

myo_exp_vincent   boolean   

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

myo_exp_pattern_recognition   boolean   

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

myo_exp_other   string  optional  

Does clinician have an experience working with any other hands. MINIMUM:STRING_LENGTH:3. Example: Consequatur nostrum tenetur consequatur excepturi vitae repellendus.

has_demo_hand_access   boolean   

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

wants_demo_hand   boolean   

Does clinician want a demo hand. Example: false

partial_hand_protheses   string  optional  

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

below_elbow_protheses_single_action   string  optional  

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

below_elbow_protheses_multi_action   string  optional  

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

above_elbow_protheses   string  optional  

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

shoulder_protheses   string  optional  

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

zeus_components_description   string  optional  

Description which components would clinician like to use with a Zeus hand. MINIMUM:STRING_LENGTH:10. Example: Vitae at quis asperiores id consequatur qui repellendus.

contact_name   string  optional  

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

company_name   string  optional  

Contact information: company name. This field is required when wants_demo_hand is true. Example: Carroll, Schuppe and O'Connell

street   string  optional  

Contact information: street. This field is required when wants_demo_hand is true. Example: 98957 Bergstrom Parkway

city   string  optional  

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

postal_code   string  optional  

Contact information: postal code. This field is required when wants_demo_hand is true. Example: 38478-3750

email   string  optional  

Contact information: email. This field is required when wants_demo_hand is true. MUST_BE_EMAIL. Example: lakin.bart@conroy.org

phone   string  optional  

Contact information: phone. This field is required when wants_demo_hand is true. Example: +1-872-259-7726

phone_country   string  optional  

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

device_side   string  optional  

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

Must be one of:
  • L
  • R

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": "WZF6YK",
            "created_by": 37,
            "used_by": 38,
            "used_at": null,
            "active": 0,
            "created_at": "2025-12-08T15:50:26.000000Z",
            "updated_at": "2025-12-08T15:50:26.000000Z"
        },
        {
            "id": 2,
            "code": "H09G7U",
            "created_by": 39,
            "used_by": 40,
            "used_at": null,
            "active": 1,
            "created_at": "2025-12-08T15:50:26.000000Z",
            "updated_at": "2025-12-08T15:50:26.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


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

Request   

GET api/activation-codes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

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": "HSVD84",
            "created_by": 41,
            "used_by": 42,
            "used_at": null,
            "active": 0,
            "created_at": "2025-12-08T15:50:26.000000Z",
            "updated_at": "2025-12-08T15:50:26.000000Z"
        },
        {
            "id": 4,
            "code": "32AFSL",
            "created_by": 43,
            "used_by": 44,
            "used_at": null,
            "active": 1,
            "created_at": "2025-12-08T15:50:26.000000Z",
            "updated_at": "2025-12-08T15:50:26.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


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

Request   

GET api/activation-codes/active

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Find activation code

requires authentication

Example request:
curl --request GET \
    --get "http://localhost:8000/api/activation-codes/find/expedita" \
    --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/expedita"
);

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": "UFCVV1",
    "created_by": null,
    "used_by": null,
    "used_at": null,
    "active": 1,
    "created_at": "2025-12-08T15:50:26.000000Z",
    "updated_at": "2025-12-08T15:50:26.000000Z"
}

Example response (403, Insufficient permission):


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

Example response (404, Activation code not found):


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

code   string   

Activation code (not ID). Example: expedita

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": "0NDLRK",
    "created_by": null,
    "used_by": null,
    "used_at": null,
    "active": 0,
    "created_at": "2025-12-08T15:50:27.000000Z",
    "updated_at": "2025-12-08T15:50:27.000000Z"
}

Example response (403, Insufficient permission):


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

Example response (404, Server error):


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

Request   

POST api/activation-codes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Create activation code (multi-region)

requires authentication

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

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": "YAYQ8K",
    "created_by": null,
    "used_by": null,
    "used_at": null,
    "active": 0,
    "created_at": "2025-12-08T15:50:27.000000Z",
    "updated_at": "2025-12-08T15:50:27.000000Z"
}

Example response (403, Insufficient permission):


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

Request   

POST api/activation-codes/{code}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

code   integer   

Example: 5

Deactivate activation code

requires authentication

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

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": "E1YRF4",
    "created_by": null,
    "used_by": null,
    "used_at": null,
    "active": 0,
    "created_at": "2025-12-08T15:50:27.000000Z",
    "updated_at": "2025-12-08T15:50:27.000000Z"
}

Example response (403, Insufficient permission):


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

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


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

Example response (404, Activation code not found):


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

Example response (500, Server error):


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

Request   

DELETE api/activation-codes/{codeId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

codeId   integer   

Activation code ID. Example: 19

Authentication

API endpoints for managing authentication

Login user

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

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

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

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

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

Example response (200, OK):


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

Example response (403, Too many attempts):


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

Example response (422, Invalid credentials):


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

Request   

POST api/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

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

password   string   

User password. Example: secretpassword

Register user

Example request:
curl --request POST \
    "http://localhost:8000/api/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"region\": \"us\",
    \"name\": \"Tom Smith\",
    \"email\": \"name@domain.com\",
    \"password\": \"Test123!\",
    \"phone\": \"(909) 966-4929\",
    \"phone_country\": \"US\",
    \"language\": \"en\",
    \"clinic_name\": \"Smith Inc\",
    \"clinic_location\": \"Kuhicbury\",
    \"address1\": \"79046 Jadyn Coves\",
    \"address2\": \"West Miguelhaven, AR 37321\",
    \"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": "(909) 966-4929",
    "phone_country": "US",
    "language": "en",
    "clinic_name": "Smith Inc",
    "clinic_location": "Kuhicbury",
    "address1": "79046 Jadyn Coves",
    "address2": "West Miguelhaven, AR 37321",
    "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": "0GREMEH31765209022",
    "name": "Daphnee Huels",
    "email": "1765209022imani06@example.org",
    "language": "en",
    "phone": "+1-435-293-8451",
    "phone_country": "AE",
    "phone_verified_at": null,
    "address1": "9805 Arnold Square",
    "address2": "North Lonnie, NE 88756-0395",
    "postal_code": "52672",
    "city": "Mertz, Sporer and Shields",
    "clinic_name": "Lake Alanafurt",
    "clinic_location": "949 Moen Greens Suite 119\nRhettport, NV 53040",
    "image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2025-12-08T15:50:22.000000Z",
    "updated_at": "2025-12-08T15:50:22.000000Z",
    "invitation_status": "accepted",
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 2,
            "name": "ClinicAdmin"
        }
    ]
}

Example response (403, Too many attempts):


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

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


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

Example response (403, Activation code is incorrect):


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

Example response (500, Server error):


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

Request   

POST api/register

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

region   string   

User region. Example: us

name   string   

User name. Example: Tom Smith

email   string   

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

password   string   

User password. Example: Test123!

phone   string   

User phone number. Example: (909) 966-4929

phone_country   string   

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

language   string   

User language. Example: en

clinic_name   string  optional  

Clinic name. Example: Smith Inc

clinic_location   string  optional  

Clinic location. Example: Kuhicbury

address1   string  optional  

Address line 1. Example: 79046 Jadyn Coves

address2   string  optional  

Address line 2. Example: West Miguelhaven, AR 37321

mfa_enabled   boolean  optional  

MFA enabled. Example: true

mfa_method   string  optional  

MFA method. Example: email

Must be one of:
  • email
  • sms
activation_code   string   

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

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": "SSJOJOW91765209022",
    "name": "Letitia Rippin",
    "email": "1765209022little.corene@example.com",
    "language": "en",
    "phone": "+1-806-459-6950",
    "phone_country": "TL",
    "phone_verified_at": null,
    "address1": "73297 Monte Shoal",
    "address2": "Elouisestad, WA 30494-5327",
    "postal_code": "63060",
    "city": "Ritchie-Fritsch",
    "clinic_name": "North Johnniefort",
    "clinic_location": "89109 Wuckert Orchard\nNorth Candida, OR 91013-9116",
    "image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2025-12-08T15:50:22.000000Z",
    "updated_at": "2025-12-08T15:50:22.000000Z",
    "invitation_status": "accepted",
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 2,
            "name": "ClinicAdmin"
        }
    ]
}

Example response (403, Too many attempts):


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

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


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

Example response (500, Server error):


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

Request   

POST api/mobile/register

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

region   string   

User region. Example: us

name   string   

User name. Example: Tom Smith

email   string   

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

password   string   

User password. Example: Test123!

language   string  optional  

User language. Example: en

terms_accepted   boolean   

User accepted terms. Must be accepted. Example: true

Request password reset

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

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

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

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

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

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

Example response (200, OK):


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

Example response (400, Throttled request):


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

Request   

POST api/password/reset

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

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

Verify password reset token

Check if token is valid before using it to reset password

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

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

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

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

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

Example response (200, OK):


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

Example response (400, Invalid token):


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

Example response (404, User not found):


{
    "message": "User not found",
    "code": "AUTH:PASSWORD_RESET_VERIFY:USER_NOT_FOUND"
}

Request   

POST api/password/reset/verify

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

Password reset token. Example: 158bed12188492617e43ecfcca43f5990b3f5f0383b5083247389482b70af019

email   string   

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

Change password with token

Change user password using password reset token sent to email address

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

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

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

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

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

Example response (200, OK):


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

Example response (400, Invalid token):


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

Example response (404, User not found):


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

Request   

POST api/password/reset/change

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

Password reset token. Example: 158bed12188492617e43ecfcca43f5990b3f5f0383b5083247389482b70af019

email   string   

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

password   string   

User new password. Example: secretpassword

Logout current device

requires authentication

Logout and delete current access token

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

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

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

Example response (202):


[]

Request   

POST api/logout

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Logout everywhere

requires authentication

Logout and delete all access tokens owned by account

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

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

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

Example response (202):


[]

Request   

POST api/logout/everywhere

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Refresh access token

requires authentication

Refresh the new access token from the expiring token

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

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

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

Example response (200, OK):


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

Request   

POST api/token/refresh

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Check MFA status

requires authentication

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

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

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

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

Example response (200, OK):


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

Request   

GET api/mfa/status

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Response

Response Fields

enabled   string   

Determines if user enabled MFA

method   string   

Preferred MFA method

phone   string   

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

otp   string   

Determines if user has setup OTP with authenticator application

Use recovery code

requires authentication

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

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

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

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

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

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

Example response (200, OK):


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

Example response (401, Invalid code):


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

Request   

POST api/mfa/recovery-code

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

code   string   

Recovery code. Example: ZZASRM6S

Send MFA code

requires authentication

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

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

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

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

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

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

Example response (200, OK):


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

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


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

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


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

Request   

POST api/mfa/send

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

channel   string   

Authentication channel. Example: email

Must be one of:
  • email
  • sms

Verify MFA code

requires authentication

Verify multi-factor code obtained from selected channel.

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

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

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

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

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

Example response (200, OK, token auth):


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

Example response (200, OK, cookie auth):


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

Example response (401, Invalid code):


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

Request   

POST api/mfa/verify

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

channel   string   

Authentication channel. Example: email

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

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

code   string   

Authentication code. Example: 445566

machine_key   string  optional  

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

Verify phone number

requires authentication

Verify phone number with text message

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

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

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

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

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

Example response (200, OK):


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

Example response (401, Invalid code):


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

Request   

POST api/mfa/phone/verify

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

code   string   

Verification code. Example: 445566

Verify MFA OTP

requires authentication

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

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

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

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

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

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

Example response (200, OK, token auth):


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

Example response (200, OK, cookie auth):


{
    "message": "OK"
}

Example response (401, Invalid code):


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

Request   

POST api/mfa/otp/verify

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

code   string   

One-time password from app. Example: 445566

Change password

requires authentication

Change authenticated user password

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

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

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

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

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

Example response (200, OK):


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

Example response (422, Invalid old password):


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

Request   

POST api/password/change

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

old_password   string   

User old password. Example: oldpassword

new_password   string   

User new password. Example: newpassword

Set MFA status

requires authentication

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

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

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

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

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

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

Example response (200, OK):


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

Request   

POST api/mfa/status

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

enabled   boolean  optional  

Use MFA after login. Example: true

method   string  optional  

Preferred MFA method. Example: email

Must be one of:
  • email
  • sms
  • otp

Generate recovery codes

requires authentication

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

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

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

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

Example response (200, OK):


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

Request   

GET api/mfa/recovery-codes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Setup MFA OTP

requires authentication

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

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

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

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

Example response (200, OK):


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

Request   

POST api/mfa/otp/setup

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Login user (SPA)

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

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

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

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

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

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

Example response (200):


{
    "id": 310,
    "mrn": "8PPBUUTA1765209050",
    "name": "Enoch Weissnat",
    "email": "1765209050gerda.smitham@example.net",
    "language": "en",
    "phone": "(628) 819-9224",
    "phone_country": "OM",
    "phone_verified_at": null,
    "address1": "38444 Sabina Island Suite 526",
    "address2": "Hamillstad, CO 86204-5553",
    "postal_code": "75938",
    "city": "Kulas Ltd",
    "clinic_name": "New Hilmaland",
    "clinic_location": "2451 Cecil Loaf\nWest Alvena, WY 51154-9985",
    "image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2025-12-08T15:50:50.000000Z",
    "updated_at": "2025-12-08T15:50:50.000000Z",
    "invitation_status": null,
    "acadle_invitation_status": null,
    "roles": []
}

Example response (403, Too many attempts):


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

Example response (422, Invalid credentials):


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

Request   

POST login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

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

password   string   

User password. Example: secretpassword

Chat

API endpoints for chat management

Authorize a user

requires authentication

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

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

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

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

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

Example response (401):

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

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

Request   

GET api/chat/authorize-user

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

List all chat rooms

requires authentication

This method retrieves all chat rooms. Possible extend options:

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

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "owner": null,
            "patient_id": null,
            "encryption_key": "4/BXSOu5ZM9iheA1r5l2iq3ldcjdiXpRyR2i7bkYRNo=",
            "name": "unde",
            "friendly_name": "unde",
            "created_at": "2025-12-08T15:50:48.000000Z",
            "deleted_at": null,
            "updated_at": "2025-12-08T15:50:48.000000Z"
        },
        {
            "id": 2,
            "owner": null,
            "patient_id": null,
            "encryption_key": "iPVdOvSO187855RZSwylprQIwaj3DzY3chTbwFd8/G4=",
            "name": "laudantium",
            "friendly_name": "laudantium",
            "created_at": "2025-12-08T15:50:48.000000Z",
            "deleted_at": null,
            "updated_at": "2025-12-08T15:50:48.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


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

Request   

GET api/chat/rooms

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Retrieve a chat room

requires authentication

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

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

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": "Rd0Gb5EAYIM4E+shSesI2Kp4s8tttcY8XIASI2hmWow=",
    "name": "sint",
    "friendly_name": "sint",
    "created_at": "2025-12-08T15:50:48.000000Z",
    "deleted_at": null,
    "updated_at": "2025-12-08T15:50:48.000000Z"
}

Example response (403, Insufficient permission):


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

Example response (404, Chat room not found):


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

Request   

GET api/chat/room/{roomName}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

roomName   string   

Example: quam

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": "SopY304mADK9+1Y2du4M+ZQ2sG1ePmGruL6PMpm66l8=",
    "name": "quod",
    "friendly_name": "quod",
    "created_at": "2025-12-08T15:50:48.000000Z",
    "deleted_at": null,
    "updated_at": "2025-12-08T15:50:48.000000Z"
}

Example response (403, Insufficient permission):


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

Request   

POST api/chat/room

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

owner   string   

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

name   string   

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

patient_id   string   

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

participants   string[]  optional  

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

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/enim" \
    --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/enim"
);

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": "cC2uhBa+NF1bfmvh/bmZ8/35hABh0sbhD8YCKG8O8XY=",
    "name": "quaerat",
    "friendly_name": "quaerat",
    "created_at": "2025-12-08T15:50:48.000000Z",
    "deleted_at": null,
    "updated_at": "2025-12-08T15:50:48.000000Z"
}

Example response (403, Insufficient permission):


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

Example response (404, Chat room not found):


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

Request   

PUT api/chat/room/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the room. Example: enim

Body Parameters

owner   string  optional  

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

name   string  optional  

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

participants   string[]  optional  

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

participants_del   string[]  optional  

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

Chat room archives

requires authentication

Get archived messages for room Possible extend options:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/chat/room/voluptate/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/voluptate/archive"
);

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

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

Example response (200, OK):


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

Example response (403, Insufficient permission):


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

Example response (404, Chat room not found):


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the room. Example: voluptate

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

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

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

Unread messages

requires authentication

Get unread messaged for chat room. Possible extend options:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/chat/messages/unread?room=1" \
    --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": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200, OK):


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

Example response (403, Insufficient permission):


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

Request   

GET api/chat/messages/unread

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

room   integer  optional  

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

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

Delete chat message

requires authentication

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

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

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

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

Example response (202, OK):


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

Example response (403, Insufficient permission):


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

Example response (404, Message not found):


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

Request   

DELETE api/chat/messages/{msgId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

msgId   integer   

Example: 2

Query Parameters

msgId   string   

Message ID. Example: aut

Get tickets list for chat room

requires authentication

Possible extend options:

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

const params = {
    "status": "omnis",
    "sender": "16",
    "recipient": "3",
};
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": 288,
            "recipient_id": 289,
            "device_id": null,
            "meeting_date": "2025-12-08 15:50:48",
            "meeting_type": "online_meeting",
            "contact_email": "amara68@gmail.com",
            "status": "new",
            "created_at": "2025-12-08T15:50:48.000000Z",
            "updated_at": "2025-12-08T15:50:48.000000Z",
            "sender": {
                "id": 288,
                "mrn": "P2CHPAB01765209048",
                "name": "Dessie Windler I",
                "email": "1765209048amir.heathcote@example.com",
                "language": "en",
                "phone": "1-352-275-1755",
                "phone_country": "DZ",
                "phone_verified_at": null,
                "address1": "98694 Tavares Terrace",
                "address2": "East Forestview, RI 10141-5052",
                "postal_code": "01738-1694",
                "city": "Sanford Inc",
                "clinic_name": "North Morgan",
                "clinic_location": "18530 Josue Views Suite 164\nMyronhaven, AZ 94330",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:48.000000Z",
                "updated_at": "2025-12-08T15:50:48.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "recipient": {
                "id": 289,
                "mrn": "F067TJS31765209048",
                "name": "Mr. Milford Shanahan",
                "email": "1765209048diamond.blick@example.net",
                "language": "en",
                "phone": "(364) 964-9450",
                "phone_country": "KW",
                "phone_verified_at": null,
                "address1": "51449 Otho Place Suite 748",
                "address2": "Jovanyland, ND 84163",
                "postal_code": "99680-0476",
                "city": "Waelchi-Roob",
                "clinic_name": "Ruthieland",
                "clinic_location": "46435 Oran Circle Suite 445\nLeuschkeview, DC 74685",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:48.000000Z",
                "updated_at": "2025-12-08T15:50:48.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "device": null,
            "messages": []
        },
        {
            "id": 88,
            "sender_id": 290,
            "recipient_id": 291,
            "device_id": null,
            "meeting_date": "2025-12-08 15:50:48",
            "meeting_type": "online_meeting",
            "contact_email": "savion.okon@hotmail.com",
            "status": "new",
            "created_at": "2025-12-08T15:50:48.000000Z",
            "updated_at": "2025-12-08T15:50:48.000000Z",
            "sender": {
                "id": 290,
                "mrn": "OPACMFWN1765209048",
                "name": "Marcellus Nicolas",
                "email": "1765209048oschmitt@example.org",
                "language": "en",
                "phone": "(479) 482-9617",
                "phone_country": "NZ",
                "phone_verified_at": null,
                "address1": "80576 Unique Row",
                "address2": "West Andreaneton, MD 05254",
                "postal_code": "73168",
                "city": "Fay-Nicolas",
                "clinic_name": "New Carolina",
                "clinic_location": "76864 Jolie Row\nNew Mortonfort, AZ 39367",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:48.000000Z",
                "updated_at": "2025-12-08T15:50:48.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "recipient": {
                "id": 291,
                "mrn": "PC0ZTMPW1765209048",
                "name": "Rachelle Rempel DVM",
                "email": "1765209048ahmad33@example.org",
                "language": "en",
                "phone": "+1.234.945.2738",
                "phone_country": "MS",
                "phone_verified_at": null,
                "address1": "319 Simonis Overpass Suite 330",
                "address2": "Fernemouth, NM 73598-6327",
                "postal_code": "65106",
                "city": "Bosco-Ledner",
                "clinic_name": "Port Tanya",
                "clinic_location": "207 Toy Overpass\nWest Jolieshire, ME 24620",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:48.000000Z",
                "updated_at": "2025-12-08T15:50:48.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "device": null,
            "messages": []
        }
    ]
}

Example response (403, Insufficient permission):


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

Example response (404, Chat room not found):


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

Request   

GET api/chat/tickets/{roomId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

roomId   string   

Example: ea

Query Parameters

status   string  optional  

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

sender   integer  optional  

Filter tickets by sender. Example: 16

recipient   integer  optional  

Filter tickets by recipient. Example: 3

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

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

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

List of available patients for chat

requires authentication

Possible extend options:

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

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 292,
            "mrn": "8ORP1VMW1765209048",
            "name": "Damien Schaden",
            "email": "1765209048cleta14@example.org",
            "language": "en",
            "phone": "320-684-0377",
            "phone_country": "SX",
            "phone_verified_at": null,
            "address1": "9786 Ullrich Rue Apt. 909",
            "address2": "Rosebury, AZ 00009-3139",
            "postal_code": "57472-2789",
            "city": "McGlynn Ltd",
            "clinic_name": "North Krystina",
            "clinic_location": "5839 Weldon Brook Apt. 116\nNorth Cleoview, KS 83150",
            "image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2025-12-08T15:50:49.000000Z",
            "updated_at": "2025-12-08T15:50:49.000000Z",
            "invitation_status": null,
            "acadle_invitation_status": null,
            "devices": [
                {
                    "id": 140,
                    "serial": "39467fb9-462e-34a2-8de0-2c801a04e18a",
                    "bluetooth_id": "51b69d04-cade-35d4-8194-2de5a55c5a7b",
                    "company_id": null,
                    "model_id": null,
                    "amputee_id": 292,
                    "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",
                    "created_at": "2025-12-08T15:50:49.000000Z",
                    "updated_at": "2025-12-08T15:50:49.000000Z"
                }
            ],
            "roles": [
                {
                    "id": 1,
                    "name": "SuperAdmin"
                }
            ]
        },
        {
            "id": 293,
            "mrn": "FRAL6DDW1765209049",
            "name": "Ludie Legros DVM",
            "email": "1765209049carrie03@example.net",
            "language": "en",
            "phone": "781.396.8204",
            "phone_country": "LY",
            "phone_verified_at": null,
            "address1": "703 Marc Parkway Suite 954",
            "address2": "Littleshire, MA 65548",
            "postal_code": "65861",
            "city": "Schuster, Halvorson and Farrell",
            "clinic_name": "North Daphnee",
            "clinic_location": "88838 Jakubowski Cove Suite 063\nRosalindaborough, ME 63436",
            "image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2025-12-08T15:50:49.000000Z",
            "updated_at": "2025-12-08T15:50:49.000000Z",
            "invitation_status": "accepted",
            "acadle_invitation_status": null,
            "devices": [
                {
                    "id": 141,
                    "serial": "4818373b-6b14-3efc-94c9-efceaeb4f0cd",
                    "bluetooth_id": "53b90f0b-a4e7-3b44-be11-025c8cae5626",
                    "company_id": null,
                    "model_id": null,
                    "amputee_id": 293,
                    "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",
                    "created_at": "2025-12-08T15:50:49.000000Z",
                    "updated_at": "2025-12-08T15:50:49.000000Z"
                }
            ],
            "roles": [
                {
                    "id": 2,
                    "name": "ClinicAdmin"
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


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

Request   

GET api/chat/available-patients

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

List of available participants for chat

requires authentication

Possible extend options:

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

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 294,
            "mrn": "1YB2IGKG1765209049",
            "name": "Prof. Broderick Donnelly DVM",
            "email": "1765209049armand37@example.net",
            "language": "en",
            "phone": "+12708427746",
            "phone_country": "TV",
            "phone_verified_at": null,
            "address1": "5188 Kulas Rue",
            "address2": "Bahringerton, SD 68833-5625",
            "postal_code": "30382-2287",
            "city": "Leannon, Christiansen and Kuvalis",
            "clinic_name": "Zachariahtown",
            "clinic_location": "6867 Pfannerstill Via Suite 870\nLake Brenden, VT 25881",
            "image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2025-12-08T15:50:49.000000Z",
            "updated_at": "2025-12-08T15:50:49.000000Z",
            "invitation_status": null,
            "acadle_invitation_status": null,
            "roles": [
                {
                    "id": 1,
                    "name": "SuperAdmin"
                }
            ]
        },
        {
            "id": 295,
            "mrn": "Q4JQ3K601765209049",
            "name": "Floyd Bergnaum",
            "email": "1765209049anna85@example.com",
            "language": "en",
            "phone": "+1 (830) 522-8868",
            "phone_country": "AW",
            "phone_verified_at": null,
            "address1": "80832 Boehm Trail Apt. 352",
            "address2": "North Cristopher, IL 57753",
            "postal_code": "74066",
            "city": "Littel-Senger",
            "clinic_name": "Port Meghanhaven",
            "clinic_location": "411 Chyna Rapid\nNorth Erna, IN 42706",
            "image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2025-12-08T15:50:49.000000Z",
            "updated_at": "2025-12-08T15:50:49.000000Z",
            "invitation_status": null,
            "acadle_invitation_status": null,
            "roles": [
                {
                    "id": 1,
                    "name": "SuperAdmin"
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


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

Example response (404, Chat room not found):


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Chat room ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

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

Config

API endpoints for device config management

Get device config

requires authentication

Definitions:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1/config?_format=est" \
    --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": "est",
};
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": 13,
        "mode_id": 1,
        "key": "odio",
        "value": "et",
        "created_at": "2025-12-08T15:50:27.000000Z",
        "updated_at": "2025-12-08T15:50:27.000000Z",
        "mode": {
            "id": 1,
            "device_id": 14,
            "slot": null,
            "name": "Aliquid enim incidunt illum repellendus qui enim eos.",
            "active": 0,
            "created_at": "2025-12-08T15:50:27.000000Z",
            "updated_at": "2025-12-08T15:50:27.000000Z"
        }
    },
    {
        "id": 2,
        "device_id": 15,
        "mode_id": 2,
        "key": "voluptas",
        "value": "mollitia",
        "created_at": "2025-12-08T15:50:27.000000Z",
        "updated_at": "2025-12-08T15:50:27.000000Z",
        "mode": {
            "id": 2,
            "device_id": 16,
            "slot": null,
            "name": "Autem fugiat non sed qui qui tempore pariatur.",
            "active": 0,
            "created_at": "2025-12-08T15:50:27.000000Z",
            "updated_at": "2025-12-08T15:50:27.000000Z"
        }
    }
]

Example response (403, Insufficient permission):


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

Example response (404, Device not found):


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

Request   

GET api/device/{deviceId}/config

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Query Parameters

_format   string  optional  

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

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]\",
    \"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]",
    "modes": [
        {
            "id": 1,
            "config": "{\"gripPairsConfig\": [1, 4, 2, 3, 6, 7, 9, 8], \"controlConfig\": [0, 1, 0, 0, 0], \"gripSequentialConfig\": [1, 2, 4, 3, 0, 255, 6, 7, 9, 8, 255, 255]"
        }
    ]
};

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

Example response (200, OK):


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

Example response (403, Insufficient permission):


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

Example response (404, Device not found):


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

Example response (422, Invalid config):


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

Request   

POST api/device/{deviceId}/config

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Body Parameters

name   string  optional  

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

common   string  optional  

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

modes   object[]  optional  
id   string  optional  

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

config   string  optional  

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

Get device config history

requires authentication

For amputees only restore points are returned.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/1/config/history?restore_point=1&factory_reset_point=1&date_from=1642003200&date_to=1642003200" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"restore_point\": false,
    \"factory_reset_point\": 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,
            "device_id": 17,
            "index": null,
            "name": "Eligendi adipisci qui eum eaque voluptatum omnis.",
            "config": "{\"common\":{\"fingerStrength\":[1,100],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[24,22,61,18,30],\"limit\":[77,49,76,79,48]},\"1\":{\"initial\":[29,26,8,1,50],\"limit\":[49,73,66,54,87]},\"2\":{\"initial\":[10,70,25,23,22],\"limit\":[37,89,68,34,62]},\"3\":{\"initial\":[7,57,5,5,11],\"limit\":[82,66,18,61,29]},\"4\":{\"initial\":[12,75,70,40,20],\"limit\":[14,79,80,65,29]},\"5\":{\"initial\":[39,44,55,46,71],\"limit\":[61,60,81,73,91]},\"6\":{\"initial\":[22,81,9,20,51],\"limit\":[84,93,70,41,95]},\"7\":{\"initial\":[88,29,43,50,19],\"limit\":[95,80,62,72,20]},\"8\":{\"initial\":[14,8,9,9,31],\"limit\":[26,62,77,88,60]},\"9\":{\"initial\":[21,5,12,49,22],\"limit\":[69,28,54,86,63]},\"10\":{\"initial\":[1,47,28,32,34],\"limit\":[81,75,61,50,38]},\"11\":{\"initial\":[24,9,7,26,27],\"limit\":[93,83,78,80,43]},\"12\":{\"initial\":[28,48,16,13,8],\"limit\":[56,67,55,71,59]},\"13\":{\"initial\":[35,4,59,16,2],\"limit\":[37,40,64,55,62]}},\"inputSite\":[1]},\"modes\":[{\"id\":3,\"name\":\"Tenetur cum voluptatem saepe aut quia dolorum et.\",\"slot\":0,\"config\":{\"autoGrasp\":[0,100],\"coContractionTimings\":[500,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[10,50,30,10,60,70,30,0,70,30],\"gripPairsConfig\":[3,9,8,12,5,11,1,13],\"gripSequentialConfig\":[255,12,8,1,4,255,3,6,7,255,255,5],\"gripSwitchingMode\":[3],\"holdOpen\":[2000,2500],\"pulseTimings\":[700,450,150,980],\"softGrip\":[1],\"speedControlStrategy\":[0]}},{\"id\":4,\"name\":\"Eum ratione qui voluptatem fuga dolorem occaecati.\",\"slot\":1,\"config\":{\"autoGrasp\":[0,0],\"coContractionTimings\":[200,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[20,100,40,100,10,80,40,0,90,80],\"gripPairsConfig\":[2,11,10,5,1,8,9,7],\"gripSequentialConfig\":[255,3,13,10,255,255,255,1,255,255,255,11],\"gripSwitchingMode\":[2],\"holdOpen\":[2000,2500],\"pulseTimings\":[900,580,920,220],\"softGrip\":[1],\"speedControlStrategy\":[1]}},{\"id\":5,\"name\":\"Consequatur sit esse in tempore.\",\"slot\":2,\"config\":{\"autoGrasp\":[1,0],\"coContractionTimings\":[400,100],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[100,50,50,20,50,60,60,10,80,20],\"gripPairsConfig\":[8,10,2,6,11,4,9,1],\"gripSequentialConfig\":[255,255,12,255,255,3,9,1,255,4,6,255],\"gripSwitchingMode\":[1],\"holdOpen\":[2000,2500],\"pulseTimings\":[270,420,370,490],\"softGrip\":[0],\"speedControlStrategy\":[1]}}]}",
            "restore_point": 0,
            "factory_reset_point": 0,
            "changed_by": 46,
            "created_at": "2025-12-08T15:50:27.000000Z",
            "updated_at": "2025-12-08T15:50:27.000000Z",
            "author": {
                "id": 46,
                "mrn": "H1YPZKPY1765209027",
                "name": "Rene Kassulke",
                "email": "1765209027rowland.turner@example.net",
                "language": "en",
                "phone": "(878) 761-3865",
                "phone_country": "KY",
                "phone_verified_at": null,
                "address1": "2411 Cruickshank Island Apt. 061",
                "address2": "North Shakirafurt, AK 15086",
                "postal_code": "38618",
                "city": "Champlin, Hagenes and Kunze",
                "clinic_name": "West Art",
                "clinic_location": "8728 Jacobs Union\nMyraton, IN 74761",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:27.000000Z",
                "updated_at": "2025-12-08T15:50:27.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "entries": [
                {
                    "id": 1,
                    "config_history_id": 1,
                    "config_id": 3,
                    "old_value": "ducimus",
                    "new_value": "id",
                    "created_at": "2025-12-08T15:50:27.000000Z",
                    "updated_at": "2025-12-08T15:50:27.000000Z",
                    "config_entry": {
                        "id": 3,
                        "device_id": 25,
                        "mode_id": null,
                        "key": "et",
                        "value": "dolorum",
                        "created_at": "2025-12-08T15:50:27.000000Z",
                        "updated_at": "2025-12-08T15:50:27.000000Z"
                    }
                }
            ]
        },
        {
            "id": 3,
            "device_id": 26,
            "index": null,
            "name": "Vel quidem deleniti placeat.",
            "config": "{\"common\":{\"fingerStrength\":[1,400],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[27,22,3,38,31],\"limit\":[88,81,82,74,94]},\"1\":{\"initial\":[56,59,11,3,84],\"limit\":[87,75,41,23,92]},\"2\":{\"initial\":[71,67,53,17,11],\"limit\":[95,90,54,67,42]},\"3\":{\"initial\":[14,36,18,30,16],\"limit\":[48,75,20,50,34]},\"4\":{\"initial\":[16,23,49,26,20],\"limit\":[94,67,67,54,38]},\"5\":{\"initial\":[11,23,59,12,27],\"limit\":[87,94,77,14,32]},\"6\":{\"initial\":[6,77,36,72,11],\"limit\":[13,85,73,72,41]},\"7\":{\"initial\":[5,32,50,4,52],\"limit\":[79,56,66,60,74]},\"8\":{\"initial\":[78,35,4,85,5],\"limit\":[89,69,65,93,34]},\"9\":{\"initial\":[39,23,35,86,52],\"limit\":[45,52,46,92,72]},\"10\":{\"initial\":[10,24,59,24,3],\"limit\":[85,35,62,46,68]},\"11\":{\"initial\":[12,77,1,44,5],\"limit\":[35,91,87,75,38]},\"12\":{\"initial\":[32,31,64,16,84],\"limit\":[37,42,82,53,94]},\"13\":{\"initial\":[61,8,18,15,41],\"limit\":[82,51,70,24,90]}},\"inputSite\":[0]},\"modes\":[{\"id\":9,\"name\":\"Velit veritatis facilis dolor nam.\",\"slot\":0,\"config\":{\"autoGrasp\":[0,100],\"coContractionTimings\":[400,400],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[90,90,0,0,0,40,50,50,60,90],\"gripPairsConfig\":[3,8,12,13,11,6,5,4],\"gripSequentialConfig\":[6,11,9,255,2,4,5,3,255,12,1,13],\"gripSwitchingMode\":[1],\"holdOpen\":[1500,2500],\"pulseTimings\":[980,860,180,660],\"softGrip\":[1],\"speedControlStrategy\":[1]}},{\"id\":10,\"name\":\"Consequuntur voluptatibus dolorem officia.\",\"slot\":1,\"config\":{\"autoGrasp\":[0,0],\"coContractionTimings\":[300,200],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[90,70,60,20,50,60,70,10,40,70],\"gripPairsConfig\":[10,4,9,3,8,7,13,12],\"gripSequentialConfig\":[3,9,255,10,255,1,7,255,11,2,255,13],\"gripSwitchingMode\":[2],\"holdOpen\":[1500,2500],\"pulseTimings\":[700,290,520,220],\"softGrip\":[1],\"speedControlStrategy\":[0]}},{\"id\":11,\"name\":\"In non et temporibus dicta.\",\"slot\":2,\"config\":{\"autoGrasp\":[0,100],\"coContractionTimings\":[400,300],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[0,50,40,80,20,50,50,50,0,0],\"gripPairsConfig\":[9,4,13,7,11,3,1,8],\"gripSequentialConfig\":[255,10,6,255,255,13,11,8,3,255,5,2],\"gripSwitchingMode\":[2],\"holdOpen\":[2000,2500],\"pulseTimings\":[380,820,630,150],\"softGrip\":[1],\"speedControlStrategy\":[1]}}]}",
            "restore_point": 0,
            "factory_reset_point": 0,
            "changed_by": 49,
            "created_at": "2025-12-08T15:50:27.000000Z",
            "updated_at": "2025-12-08T15:50:27.000000Z",
            "author": {
                "id": 49,
                "mrn": "F3AK25EY1765209027",
                "name": "Ernestine McDermott",
                "email": "1765209027ltillman@example.org",
                "language": "en",
                "phone": "+1-279-996-2455",
                "phone_country": "GU",
                "phone_verified_at": null,
                "address1": "147 Norval Throughway Apt. 887",
                "address2": "South Shania, PA 64992-0069",
                "postal_code": "27081",
                "city": "Brakus-Wunsch",
                "clinic_name": "North Keshaun",
                "clinic_location": "7284 Kiehn Hollow Suite 763\nNew Christophermouth, MN 08409",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:27.000000Z",
                "updated_at": "2025-12-08T15:50:27.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "entries": [
                {
                    "id": 2,
                    "config_history_id": 3,
                    "config_id": 4,
                    "old_value": "qui",
                    "new_value": "voluptate",
                    "created_at": "2025-12-08T15:50:27.000000Z",
                    "updated_at": "2025-12-08T15:50:27.000000Z",
                    "config_entry": {
                        "id": 4,
                        "device_id": 34,
                        "mode_id": null,
                        "key": "libero",
                        "value": "ea",
                        "created_at": "2025-12-08T15:50:27.000000Z",
                        "updated_at": "2025-12-08T15:50:27.000000Z"
                    }
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


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

Example response (404, Device not found):


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Query Parameters

restore_point   boolean  optional  

Filter config entries by restore point status. Example: 1

factory_reset_point   boolean  optional  

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

date_from   integer  optional  

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

date_to   integer  optional  

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

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

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

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

Body Parameters

restore_point   boolean  optional  

Example: false

factory_reset_point   boolean  optional  

Example: false

date_from   string  optional  
date_to   string  optional  

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,
    "device_id": 35,
    "index": null,
    "name": "Iste repellat vel labore est quia.",
    "config": "{\"common\":{\"fingerStrength\":[1,400],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[17,6,53,40,38],\"limit\":[74,39,78,77,82]},\"1\":{\"initial\":[21,12,81,36,7],\"limit\":[46,13,89,66,92]},\"2\":{\"initial\":[15,47,32,77,54],\"limit\":[36,66,74,82,79]},\"3\":{\"initial\":[37,33,12,29,12],\"limit\":[42,83,89,52,89]},\"4\":{\"initial\":[26,18,38,55,59],\"limit\":[44,33,45,89,76]},\"5\":{\"initial\":[7,31,22,48,28],\"limit\":[52,41,51,89,95]},\"6\":{\"initial\":[12,31,26,5,24],\"limit\":[78,59,94,7,68]},\"7\":{\"initial\":[31,49,26,5,40],\"limit\":[44,75,62,72,50]},\"8\":{\"initial\":[22,87,69,20,43],\"limit\":[52,91,78,77,73]},\"9\":{\"initial\":[1,29,35,69,19],\"limit\":[77,43,41,94,78]},\"10\":{\"initial\":[19,11,19,8,32],\"limit\":[57,19,82,78,45]},\"11\":{\"initial\":[3,37,40,54,69],\"limit\":[46,82,93,67,89]},\"12\":{\"initial\":[22,51,7,12,61],\"limit\":[86,56,25,93,82]},\"13\":{\"initial\":[44,32,42,63,4],\"limit\":[55,38,94,65,82]}},\"inputSite\":[1]},\"modes\":[{\"id\":15,\"name\":\"Nesciunt exercitationem aut ea temporibus dolores.\",\"slot\":0,\"config\":{\"autoGrasp\":[0,100],\"coContractionTimings\":[400,300],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[100,50,80,40,20,70,30,50,70,60],\"gripPairsConfig\":[3,6,11,4,10,9,8,13],\"gripSequentialConfig\":[255,10,8,3,7,255,255,11,255,2,6,255],\"gripSwitchingMode\":[3],\"holdOpen\":[1500,2500],\"pulseTimings\":[370,780,80,10],\"softGrip\":[1],\"speedControlStrategy\":[1]}},{\"id\":16,\"name\":\"Cupiditate ad quo error officia.\",\"slot\":1,\"config\":{\"autoGrasp\":[1,100],\"coContractionTimings\":[500,400],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[10,80,70,90,20,40,80,10,100,20],\"gripPairsConfig\":[9,1,11,10,2,6,8,7],\"gripSequentialConfig\":[11,12,3,9,1,255,6,8,13,2,255,255],\"gripSwitchingMode\":[2],\"holdOpen\":[2000,2500],\"pulseTimings\":[500,470,150,210],\"softGrip\":[1],\"speedControlStrategy\":[0]}},{\"id\":17,\"name\":\"Quis ipsam sint itaque quos.\",\"slot\":2,\"config\":{\"autoGrasp\":[0,0],\"coContractionTimings\":[200,100],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[20,30,90,60,60,90,0,90,80,50],\"gripPairsConfig\":[3,4,2,13,6,10,8,5],\"gripSequentialConfig\":[255,255,8,255,13,255,4,255,9,255,7,2],\"gripSwitchingMode\":[2],\"holdOpen\":[1500,1500],\"pulseTimings\":[230,770,810,570],\"softGrip\":[0],\"speedControlStrategy\":[0]}}]}",
    "restore_point": 0,
    "factory_reset_point": 0,
    "changed_by": 51,
    "created_at": "2025-12-08T15:50:27.000000Z",
    "updated_at": "2025-12-08T15:50:27.000000Z"
}

Example response (403, Insufficient permission):


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

Example response (404, Device not found):


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

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


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

Query Parameters

extend   string  optional  

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

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,
    "device_id": 39,
    "index": null,
    "name": "Praesentium modi beatae voluptas.",
    "config": "{\"common\":{\"fingerStrength\":[1,500],\"gripPositions\":{\"_\":0,\"0\":{\"initial\":[56,48,11,16,27],\"limit\":[57,90,94,39,32]},\"1\":{\"initial\":[32,80,41,29,8],\"limit\":[50,95,43,80,69]},\"2\":{\"initial\":[39,72,9,69,31],\"limit\":[50,95,86,87,87]},\"3\":{\"initial\":[13,25,46,14,36],\"limit\":[78,34,87,83,36]},\"4\":{\"initial\":[40,86,49,37,2],\"limit\":[88,89,65,84,11]},\"5\":{\"initial\":[7,26,73,28,51],\"limit\":[60,71,82,33,73]},\"6\":{\"initial\":[14,12,10,4,11],\"limit\":[71,19,35,50,85]},\"7\":{\"initial\":[26,40,49,32,43],\"limit\":[35,93,69,44,66]},\"8\":{\"initial\":[67,75,16,22,2],\"limit\":[72,84,67,86,91]},\"9\":{\"initial\":[30,29,5,22,10],\"limit\":[94,43,25,43,49]},\"10\":{\"initial\":[4,35,26,56,64],\"limit\":[11,51,70,92,86]},\"11\":{\"initial\":[31,48,64,54,38],\"limit\":[32,63,69,57,77]},\"12\":{\"initial\":[41,20,26,7,10],\"limit\":[83,59,77,77,65]},\"13\":{\"initial\":[22,25,61,19,7],\"limit\":[26,47,80,95,54]}},\"inputSite\":[1]},\"modes\":[{\"id\":18,\"name\":\"Expedita sit quis dolor inventore laboriosam non numquam.\",\"slot\":0,\"config\":{\"autoGrasp\":[1,0],\"coContractionTimings\":[400,400],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[40,70,40,50,60,10,10,0,0,30],\"gripPairsConfig\":[8,12,4,5,2,3,9,11],\"gripSequentialConfig\":[2,9,255,11,7,10,8,255,4,255,255,13],\"gripSwitchingMode\":[3],\"holdOpen\":[2000,2000],\"pulseTimings\":[660,140,320,480],\"softGrip\":[0],\"speedControlStrategy\":[0]}},{\"id\":19,\"name\":\"Veniam itaque minima rerum velit consequatur.\",\"slot\":1,\"config\":{\"autoGrasp\":[1,0],\"coContractionTimings\":[500,300],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[100,50,80,20,60,0,30,30,30,90],\"gripPairsConfig\":[2,7,12,11,1,4,3,6],\"gripSequentialConfig\":[12,255,7,11,3,10,8,1,13,255,5,9],\"gripSwitchingMode\":[2],\"holdOpen\":[1500,1500],\"pulseTimings\":[750,600,410,990],\"softGrip\":[0],\"speedControlStrategy\":[0]}},{\"id\":20,\"name\":\"Autem enim sit voluptate ducimus sunt ipsa.\",\"slot\":2,\"config\":{\"autoGrasp\":[0,0],\"coContractionTimings\":[500,500],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[10,80,90,40,90,90,30,40,60,0],\"gripPairsConfig\":[8,11,6,7,1,5,4,12],\"gripSequentialConfig\":[5,255,12,11,255,2,1,7,3,255,10,13],\"gripSwitchingMode\":[3],\"holdOpen\":[1500,2500],\"pulseTimings\":[550,10,460,80],\"softGrip\":[0],\"speedControlStrategy\":[1]}}]}",
    "restore_point": 1,
    "factory_reset_point": 0,
    "changed_by": 52,
    "created_at": "2025-12-08T15:50:28.000000Z",
    "updated_at": "2025-12-08T15:50:28.000000Z"
}

Example response (403, Insufficient permission):


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

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


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

Example response (404, Device not found):


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

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


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

Body Parameters

name   string  optional  

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

restore_point   boolean  optional  

Restore point status. Example: true

factory_reset_point   boolean  optional  

Point of factory reset. Example: false

Undo single config history change

requires authentication

Returns updated config in response.

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

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

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

Example response (202, Normal/compact response):


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

Example response (403, Insufficient permission):


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

Example response (404, Device not found):


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

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


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

Restore config history entry

requires authentication

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

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

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

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

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


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

Example response (202):


{
    "id": 1,
    "sender_id": 53,
    "recipient_id": 54,
    "device_id": null,
    "meeting_date": "2025-12-08 15:50:28",
    "meeting_type": "online_meeting",
    "contact_email": "droob@larson.biz",
    "status": "new",
    "created_at": "2025-12-08T15:50:28.000000Z",
    "updated_at": "2025-12-08T15:50:28.000000Z",
    "sender": {
        "id": 53,
        "mrn": "AAWABR161765209028",
        "name": "Ms. Carissa Ryan",
        "email": "1765209028dana.kiehn@example.org",
        "language": "en",
        "phone": "(443) 409-4667",
        "phone_country": "MC",
        "phone_verified_at": null,
        "address1": "4107 Rex Locks",
        "address2": "Dudleyside, TN 81302-6615",
        "postal_code": "93062-7151",
        "city": "Reichel-Beatty",
        "clinic_name": "Port Jeff",
        "clinic_location": "602 Wilbert Plaza\nLaurinetown, NC 32388",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:28.000000Z",
        "updated_at": "2025-12-08T15:50:28.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 54,
        "mrn": "TOE7J13S1765209028",
        "name": "Gaylord Greenholt",
        "email": "1765209028jordane.stracke@example.net",
        "language": "en",
        "phone": "+1.380.961.1906",
        "phone_country": "BG",
        "phone_verified_at": null,
        "address1": "246 Trantow Parks",
        "address2": "South Bret, KY 70589",
        "postal_code": "98647-6312",
        "city": "McClure PLC",
        "clinic_name": "Port Petra",
        "clinic_location": "8522 Laurie Freeway\nLubowitzland, VA 03235",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:28.000000Z",
        "updated_at": "2025-12-08T15:50:28.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": null,
    "messages": [
        {
            "id": 1,
            "ticket_id": 1,
            "sender_id": 55,
            "title": "Prof.",
            "content": "Accusamus et quo eum quos qui sit maxime.",
            "is_read": false,
            "created_at": "2025-12-08T15:50:28.000000Z",
            "updated_at": "2025-12-08T15:50:28.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


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

Example response (404, Device not found):


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

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


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

Restore to factory reset point

requires authentication

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

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

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

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

Example response (200, OK):


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

Example response (403, Insufficient permission):


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

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


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

Example response (404, Device not found):


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Send test config

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/config/send" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Fixed problem with grips.\",
    \"p2p_session\": 1,
    \"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]\",
    \"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,
    "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]",
    "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": 64,
    "recipient_id": 65,
    "device_id": null,
    "meeting_date": "2025-12-08 15:50:29",
    "meeting_type": "online_meeting",
    "contact_email": "dawn78@schroeder.com",
    "status": "new",
    "created_at": "2025-12-08T15:50:29.000000Z",
    "updated_at": "2025-12-08T15:50:29.000000Z",
    "sender": {
        "id": 64,
        "mrn": "A97JKSX91765209028",
        "name": "Miss Elza Greenholt",
        "email": "1765209028rbosco@example.com",
        "language": "en",
        "phone": "941.253.0615",
        "phone_country": "EG",
        "phone_verified_at": null,
        "address1": "8924 Nicolas Brook Apt. 687",
        "address2": "North Juanitaberg, IL 61612",
        "postal_code": "67675",
        "city": "Murray and Sons",
        "clinic_name": "South Jovaniview",
        "clinic_location": "335 Jessy Villages\nNorth Justicetown, DE 77165",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:29.000000Z",
        "updated_at": "2025-12-08T15:50:29.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 65,
        "mrn": "8SB24DHI1765209029",
        "name": "Ricky Schmitt",
        "email": "1765209029flavie53@example.org",
        "language": "en",
        "phone": "(270) 637-2077",
        "phone_country": "SH",
        "phone_verified_at": null,
        "address1": "223 Strosin Dale Suite 013",
        "address2": "Treverfort, LA 43080",
        "postal_code": "18111-2068",
        "city": "Farrell, Welch and Harris",
        "clinic_name": "Lake Audreannefort",
        "clinic_location": "18572 Hegmann Knolls\nKozeychester, NV 08731",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:29.000000Z",
        "updated_at": "2025-12-08T15:50:29.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": null,
    "messages": [
        {
            "id": 4,
            "ticket_id": 7,
            "sender_id": 66,
            "title": "Dr.",
            "content": "Repudiandae suscipit incidunt quo sit qui temporibus consequatur commodi.",
            "is_read": false,
            "created_at": "2025-12-08T15:50:29.000000Z",
            "updated_at": "2025-12-08T15:50:29.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"
}

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Body Parameters

description   string  optional  

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

p2p_session   integer  optional  

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

common   string  optional  

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

modes   object[]  optional  
id   string  optional  

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

config   string  optional  

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

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\": \"[\\\"dolorum\\\",\\\"nam\\\"]\",
    \"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": "[\"dolorum\",\"nam\"]",
    "firmware": 1
};

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

Example response (200, OK):


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

Example response (403, Insufficient permission):


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

Example response (404, Firmware version not found):


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

Request   

POST api/config/convert

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

config   string   

Full config JSON. MUST_BE_JSON. Example: ["dolorum","nam"]

firmware   string   

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

Config Demo

API endpoints for managing config demos

List config demos

requires authentication

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

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

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "device_id": 71,
            "message_id": 8,
            "config": "Ad beatae ut assumenda ut voluptas eum voluptas.",
            "is_accepted": 1,
            "notes": "Consequatur at velit quam tempore.",
            "created_at": "2025-12-08T15:50:30.000000Z",
            "updated_at": "2025-12-08T15:50:30.000000Z",
            "message": {
                "id": 8,
                "ticket_id": 15,
                "sender_id": 87,
                "title": "Prof.",
                "content": "Iste nihil impedit sint voluptatem at voluptatibus debitis.",
                "is_read": false,
                "created_at": "2025-12-08T15:50:30.000000Z",
                "updated_at": "2025-12-08T15:50:30.000000Z"
            }
        },
        {
            "id": 2,
            "device_id": 72,
            "message_id": 10,
            "config": "Nemo ducimus nostrum necessitatibus dolores.",
            "is_accepted": 0,
            "notes": "Voluptatem qui enim et blanditiis culpa qui natus.",
            "created_at": "2025-12-08T15:50:31.000000Z",
            "updated_at": "2025-12-08T15:50:31.000000Z",
            "message": {
                "id": 10,
                "ticket_id": 18,
                "sender_id": 92,
                "title": "Prof.",
                "content": "Facilis vel aliquid commodi enim.",
                "is_read": false,
                "created_at": "2025-12-08T15:50:31.000000Z",
                "updated_at": "2025-12-08T15:50:31.000000Z"
            }
        }
    ]
}

Example response (403, Insufficient permission):


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

Example response (404, Device not found):


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Query Parameters

accepted   integer  optional  

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

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

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

Update config demo

requires authentication

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

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

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

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

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

Example response (202):


{
    "id": 3,
    "device_id": 73,
    "message_id": 11,
    "config": "Temporibus id odio recusandae cumque omnis.",
    "is_accepted": 1,
    "notes": "A quia delectus iusto accusantium non ad accusamus expedita.",
    "created_at": "2025-12-08T15:50:31.000000Z",
    "updated_at": "2025-12-08T15:50:31.000000Z"
}

Example response (403, Insufficient permission):


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

Example response (404, Device not found):


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

Example response (404, Config demo not found):


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

demoId   integer   

Config demo ID. Example: 1

Body Parameters

is_accepted   boolean  optional  

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

notes   string  optional  

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

Config Modes

API endpoints for managing config modes

List config modes

requires authentication

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

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

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

Example response (200):


[
    {
        "id": 72,
        "device_id": 102,
        "slot": null,
        "name": "Commodi reiciendis dolor aliquid accusamus esse iure quos tenetur.",
        "active": 1,
        "created_at": "2025-12-08T15:50:32.000000Z",
        "updated_at": "2025-12-08T15:50:32.000000Z",
        "device": {
            "id": 102,
            "serial": "5d9f4bcc-19f9-305c-9495-4eac7c76c8a3",
            "bluetooth_id": "ab0be4b3-7ec8-36f2-900f-9e2228a49cbc",
            "company_id": null,
            "model_id": null,
            "amputee_id": 105,
            "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",
            "created_at": "2025-12-08T15:50:32.000000Z",
            "updated_at": "2025-12-08T15:50:32.000000Z"
        }
    },
    {
        "id": 73,
        "device_id": 104,
        "slot": null,
        "name": "Praesentium est et sint.",
        "active": 1,
        "created_at": "2025-12-08T15:50:32.000000Z",
        "updated_at": "2025-12-08T15:50:32.000000Z",
        "config": {}
    }
]

Example response (403, Insufficient permission):


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

Example response (404, Device not found):


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

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": 105,
    "slot": null,
    "name": "Ullam quam illo ut minima quas quis qui.",
    "active": 0,
    "created_at": "2025-12-08T15:50:32.000000Z",
    "updated_at": "2025-12-08T15:50:32.000000Z"
}

Example response (403, Insufficient permission):


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

Example response (404, Device not found):


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

Example response (404, Config mode not found):


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

modeId   integer   

Config mode ID. Example: 1

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": 106,
    "slot": null,
    "name": "Harum sed quia praesentium quaerat molestiae delectus.",
    "active": 0,
    "created_at": "2025-12-08T15:50:32.000000Z",
    "updated_at": "2025-12-08T15:50:32.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create config modes",
    "code": "CONFIG_MODES:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Body Parameters

slot   integer  optional  

Mode index on device. Example: 0

Must be one of:
  • 0
  • 1
  • 2
name   string   

Name of mode. Example: Sport mode

active   boolean  optional  

Active status. Default: 1. Example: true

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": 107,
    "slot": null,
    "name": "Corrupti reiciendis animi consequatur voluptas hic ad.",
    "active": 1,
    "created_at": "2025-12-08T15:50:32.000000Z",
    "updated_at": "2025-12-08T15:50:32.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update config mode",
    "code": "CONFIG_MODES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


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

Example response (404, Config mode not found):


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

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

modeId   integer   

Config mode ID. Example: 1

Body Parameters

slot   integer  optional  

Mode index on device. Example: 0

Must be one of:
  • 0
  • 1
  • 2
name   string  optional  

Name of mode. Example: Sport mode

active   boolean  optional  

Active status. Default: 1. Example: true

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": 107,
    "recipient_id": 108,
    "device_id": null,
    "meeting_date": "2025-12-08 15:50:32",
    "meeting_type": "online_meeting",
    "contact_email": "krajcik.brionna@yahoo.com",
    "status": "new",
    "created_at": "2025-12-08T15:50:33.000000Z",
    "updated_at": "2025-12-08T15:50:33.000000Z",
    "sender": {
        "id": 107,
        "mrn": "FRQDLHIO1765209032",
        "name": "Thurman Hoppe I",
        "email": "1765209032vmaggio@example.net",
        "language": "en",
        "phone": "283-876-7116",
        "phone_country": "IE",
        "phone_verified_at": null,
        "address1": "6251 Ethyl Stravenue Suite 510",
        "address2": "Prohaskaborough, ME 03415-3286",
        "postal_code": "05559-9793",
        "city": "Beatty-Strosin",
        "clinic_name": "Port Jacklynside",
        "clinic_location": "7434 Beatty Trail\nSchneiderland, CT 60070",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:32.000000Z",
        "updated_at": "2025-12-08T15:50:32.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 108,
        "mrn": "A92DQGYQ1765209032",
        "name": "Derick Mohr",
        "email": "1765209032meggie56@example.org",
        "language": "en",
        "phone": "(678) 595-5361",
        "phone_country": "CU",
        "phone_verified_at": null,
        "address1": "33602 Klein Spring Suite 768",
        "address2": "Dooleyberg, GA 64824-5598",
        "postal_code": "30614-5821",
        "city": "Luettgen Ltd",
        "clinic_name": "Adrianhaven",
        "clinic_location": "445 Boyle Ranch Suite 410\nConnellyland, NE 32886-4550",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:33.000000Z",
        "updated_at": "2025-12-08T15:50:33.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": null,
    "messages": [
        {
            "id": 12,
            "ticket_id": 21,
            "sender_id": 109,
            "title": "Prof.",
            "content": "Libero provident laborum non consequatur corrupti rerum.",
            "is_read": false,
            "created_at": "2025-12-08T15:50:33.000000Z",
            "updated_at": "2025-12-08T15:50:33.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update config mode",
    "code": "CONFIG_MODES:COPY_TEMPLATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


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

Example response (404, Config mode not found):


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

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_MODES:COPY_TEMPLATE:TEMPLATE_NOT_FOUND"
}

Request   

POST api/device/{deviceId}/config-modes/{modeId}/from-template/{templateId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

modeId   integer   

Config mode ID. Example: 1

templateId   integer   

Config template ID. Example: 1

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": 76,
            "note": "Voluptate aliquid occaecati qui et laboriosam cum.",
            "type": "public",
            "created_at": "2025-12-08T15:50:29.000000Z",
            "updated_at": "2025-12-08T15:50:29.000000Z",
            "author": {
                "id": 76,
                "mrn": "G5E29SWV1765209029",
                "name": "Mrs. Vida McKenzie",
                "email": "1765209029zquigley@example.com",
                "language": "en",
                "phone": "505-803-1334",
                "phone_country": "ME",
                "phone_verified_at": null,
                "address1": "4316 Cheyenne Avenue",
                "address2": "Stammside, MS 67168-1179",
                "postal_code": "15737-6908",
                "city": "Gulgowski, Baumbach and Schinner",
                "clinic_name": "North Ivaview",
                "clinic_location": "10311 Turcotte Lane\nEmilville, WA 10430-0728",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:29.000000Z",
                "updated_at": "2025-12-08T15:50:29.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        },
        {
            "id": 2,
            "config_history_id": 8,
            "user_id": 78,
            "note": "Sint et cupiditate dolorum hic.",
            "type": "public",
            "created_at": "2025-12-08T15:50:30.000000Z",
            "updated_at": "2025-12-08T15:50:30.000000Z",
            "author": {
                "id": 78,
                "mrn": "EW91VSL51765209030",
                "name": "Shea Ratke",
                "email": "1765209030bart15@example.org",
                "language": "en",
                "phone": "432-518-8581",
                "phone_country": "SI",
                "phone_verified_at": null,
                "address1": "70359 Will Wells Suite 806",
                "address2": "Westtown, IL 58268-5242",
                "postal_code": "88257",
                "city": "Schoen Inc",
                "clinic_name": "Strackestad",
                "clinic_location": "52522 Kovacek Turnpike\nGranttown, AR 12310",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:30.000000Z",
                "updated_at": "2025-12-08T15:50:30.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access config notes",
    "code": "CONFIG_NOTES:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


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

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


{
    "message": "Config history entry not found",
    "code": "CONFIG_NOTES:LIST:HISTORY_ENTRY_NOT_FOUND"
}

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

Query Parameters

user   integer  optional  

Filter notes by user. Example: 1

type   string  optional  

Filter notes by type (available: public and private) Example: public

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

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

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

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": 80,
    "note": "Numquam doloremque expedita voluptatem quo beatae ad.",
    "type": "public",
    "created_at": "2025-12-08T15:50:30.000000Z",
    "updated_at": "2025-12-08T15:50:30.000000Z",
    "author": {
        "id": 80,
        "mrn": "WVBPT2N21765209030",
        "name": "Concepcion DuBuque",
        "email": "1765209030croberts@example.org",
        "language": "en",
        "phone": "+1.463.874.9615",
        "phone_country": "IL",
        "phone_verified_at": null,
        "address1": "1679 Gina Gateway",
        "address2": "North Darrylmouth, WA 43216-9711",
        "postal_code": "23344",
        "city": "Gaylord, Hills and Hyatt",
        "clinic_name": "Schmelermouth",
        "clinic_location": "373 Jabari Burgs Suite 029\nPort Reyesview, OK 75959-0897",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:30.000000Z",
        "updated_at": "2025-12-08T15:50:30.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access config notes",
    "code": "CONFIG_NOTES:GET_ENTRY:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_NOTES:GET_ENTRY:DEVICE_NOT_FOUND"
}

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


{
    "message": "Config history entry not found",
    "code": "CONFIG_NOTES:GET_ENTRY:HISTORY_ENTRY_NOT_FOUND"
}

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


{
    "message": "Config history note not found",
    "code": "CONFIG_NOTES:GET_ENTRY:HISTORY_NOTE_NOT_FOUND"
}

Request   

GET api/device/{deviceId}/config/{configId}/notes/{noteId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

noteId   integer   

Device config entry note ID. Example: 1

Query Parameters

extend   string  optional  

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

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\": \"Velit culpa laborum consectetur facere est aut.\",
    \"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": "Velit culpa laborum consectetur facere est aut.",
    "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": 82,
    "note": "Consectetur temporibus libero a aliquid qui.",
    "type": "public",
    "created_at": "2025-12-08T15:50:30.000000Z",
    "updated_at": "2025-12-08T15:50:30.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to add config notes",
    "code": "CONFIG_NOTES:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_NOTES:CREATE:DEVICE_NOT_FOUND"
}

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


{
    "message": "Config history entry not found",
    "code": "CONFIG_NOTES:CREATE:HISTORY_ENTRY_NOT_FOUND"
}

Request   

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

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

Body Parameters

note   string  optional  

Note text. Example: Velit culpa laborum consectetur facere est aut.

type   string  optional  

Type of the note. Default: public. Example: public

Must be one of:
  • public
  • private

Delete config note

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Config history note deleted",
    "code": "CONFIG_NOTES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete config notes",
    "code": "CONFIG_NOTES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CONFIG_NOTES:DELETE:DEVICE_NOT_FOUND"
}

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


{
    "message": "Config history entry not found",
    "code": "CONFIG_NOTES:DELETE:HISTORY_ENTRY_NOT_FOUND"
}

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


{
    "message": "Config history note not found",
    "code": "CONFIG_NOTES:DELETE:HISTORY_NOTE_NOT_FOUND"
}

Request   

DELETE api/device/{deviceId}/config/{configId}/notes/{noteId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

configId   integer   

Config history entry ID. Example: 1

noteId   integer   

Device config entry note ID. Example: 1

Config Schema

API endpoints for config schema management

Get config schema

requires authentication

Returns list of config schema entries for given firmware version.

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

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

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

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

Example response (200):


[
    {
        "id": 1,
        "firmware_id": 7,
        "key": "impedit",
        "is_common": 0,
        "created_at": "2025-12-08T15:50:44.000000Z",
        "updated_at": "2025-12-08T15:50:44.000000Z"
    },
    {
        "id": 2,
        "firmware_id": 9,
        "key": "enim",
        "is_common": 0,
        "created_at": "2025-12-08T15:50:44.000000Z",
        "updated_at": "2025-12-08T15:50:44.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view config schema",
    "code": "CONFIG_SCHEMA:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Firmware version not found):


{
    "message": "Firmware version not found",
    "code": "CONFIG_SCHEMA:GET:FIRMWARE_NOT_FOUND"
}

Request   

GET api/versions/firmware/{firmwareId}/schema

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

firmwareId   integer   

Firmware version ID. Example: 1

Query Parameters

filter   string  optional  

Filter entries by type (available: common, modes). By default all entries all returned. Example: modes

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/praesentium/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/praesentium/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": "quia",
        "is_common": 1,
        "created_at": "2025-12-08T15:50:44.000000Z",
        "updated_at": "2025-12-08T15:50:44.000000Z"
    },
    {
        "id": 4,
        "firmware_id": 13,
        "key": "quia",
        "is_common": 1,
        "created_at": "2025-12-08T15:50:44.000000Z",
        "updated_at": "2025-12-08T15:50:44.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage config schema",
    "code": "CONFIG_SCHEMA:ADD:INSUFFICIENT_PERMISSION"
}

Example response (404, Firmware version not found):


{
    "message": "Firmware version not found",
    "code": "CONFIG_SCHEMA:ADD:FIRMWARE_NOT_FOUND"
}

Request   

POST api/versions/firmware/{firmwareId}/schema

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

firmwareId   string   

Example: praesentium

Body Parameters

The request body is an array (object[]`). Each item has the following properties:

key   string  optional  

Config key. Example: gripsPosition.0.initial

is_common   integer  optional  

Information if the key belongs to common config (1) or to modes (0). Default: 1. Example: 1

Delete config schema

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Config schema entry deleted",
    "code": "CONFIG_SCHEMA:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage config schema",
    "code": "CONFIG_SCHEMA:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Firmware version not found):


{
    "message": "Firmware version not found",
    "code": "CONFIG_SCHEMA:DELETE:FIRMWARE_NOT_FOUND"
}

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


{
    "message": "Config schema entry not found",
    "code": "CONFIG_SCHEMA:DELETE:SCHEMA_NOT_FOUND"
}

Request   

DELETE api/versions/firmware/{firmwareId}/schema/{schemaId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

firmwareId   integer   

Firmware version ID. Example: 1

schemaId   integer   

Config schema ID. Example: 1

Config Templates

API endpoints for managing config templates

Get config templates list

requires authentication

Entries where author is present are private and owned by its author. Entries where author is null should be considered as global templates prepared by Aether team.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/config/templates?search=sport&author=1&scope=me" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/config/templates"
);

const params = {
    "search": "sport",
    "author": "1",
    "scope": "me",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "name": "Voluptas qui non dolorem quas repellendus id rerum.",
            "description": "Doloremque excepturi corrupti voluptas non ab quo nemo.",
            "author_id": 96,
            "company_id": null,
            "config": "{\"autoGrasp\":[0,100],\"coContractionTimings\":[400,200],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[0,300],\"emgThresholds\":[20,70,50,10,30,40,80,60,0,20],\"gripPairsConfig\":[2,12,1,3,4,11,13,7],\"gripSequentialConfig\":[255,6,10,255,11,7,255,255,2,255,5,255],\"gripSwitchingMode\":[3],\"holdOpen\":[2000,2500],\"pulseTimings\":[200,170,870,530],\"softGrip\":[0],\"speedControlStrategy\":[0]}",
            "created_at": "2025-12-08T15:50:31.000000Z",
            "updated_at": "2025-12-08T15:50:31.000000Z",
            "author": {
                "id": 96,
                "mrn": "BYB92R3L1765209031",
                "name": "Kole Stracke",
                "email": "1765209031hans.considine@example.org",
                "language": "en",
                "phone": "+1-623-615-3236",
                "phone_country": "UM",
                "phone_verified_at": null,
                "address1": "691 Johnson Groves",
                "address2": "Feestshire, MI 07983-3474",
                "postal_code": "53878-9972",
                "city": "Harris PLC",
                "clinic_name": "East Lonnie",
                "clinic_location": "3945 Katelynn Burg\nLake Donald, ND 03900-2208",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:31.000000Z",
                "updated_at": "2025-12-08T15:50:31.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        },
        {
            "id": 2,
            "name": "Nihil ea facere amet sed.",
            "description": "Est rem ipsum mollitia expedita consequatur ipsum.",
            "author_id": 97,
            "company_id": null,
            "config": "{\"autoGrasp\":[1,0],\"coContractionTimings\":[400,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[10,60,100,30,30,0,10,10,20,0],\"gripPairsConfig\":[8,1,7,13,6,11,3,2],\"gripSequentialConfig\":[2,7,4,11,1,13,8,5,12,255,10,255],\"gripSwitchingMode\":[1],\"holdOpen\":[1500,2500],\"pulseTimings\":[840,690,890,90],\"softGrip\":[0],\"speedControlStrategy\":[1]}",
            "created_at": "2025-12-08T15:50:31.000000Z",
            "updated_at": "2025-12-08T15:50:31.000000Z",
            "author": {
                "id": 97,
                "mrn": "LKFNCQJU1765209031",
                "name": "Christophe Lind",
                "email": "1765209031zora40@example.com",
                "language": "en",
                "phone": "1-458-650-1109",
                "phone_country": "MW",
                "phone_verified_at": null,
                "address1": "32488 Dietrich Parkway Apt. 526",
                "address2": "Kesslerhaven, NE 24910-3034",
                "postal_code": "99593",
                "city": "Hill-Emard",
                "clinic_name": "New Sydnietown",
                "clinic_location": "608 Koss Mission Suite 165\nWest Brett, RI 81516",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:31.000000Z",
                "updated_at": "2025-12-08T15:50:31.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list config templates",
    "code": "CONFIG_TEMPLATES:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/config/templates

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

search   string  optional  

Filter config templates by name. Example: sport

author   integer  optional  

Super Admin only: Filter config templates by author. Example: 1

scope   string  optional  

ClinicAdmin/Clinician/ClinicianSupport only: Filter config templates by scope. The value must be one of:

  • me (entries where current user is author),
  • global (entries added by Aether).
Example: `me`
perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

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

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": "Amet in ut dolorum modi.",
    "description": "Ipsam rerum eum facilis.",
    "author_id": 98,
    "company_id": null,
    "config": "{\"autoGrasp\":[1,100],\"coContractionTimings\":[500,200],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[10,100,10,10,40,90,80,100,20,0],\"gripPairsConfig\":[3,11,13,12,5,10,2,7],\"gripSequentialConfig\":[10,9,255,13,5,4,11,2,12,1,8,255],\"gripSwitchingMode\":[2],\"holdOpen\":[2000,2500],\"pulseTimings\":[600,330,190,950],\"softGrip\":[0],\"speedControlStrategy\":[1]}",
    "created_at": "2025-12-08T15:50:31.000000Z",
    "updated_at": "2025-12-08T15:50:31.000000Z",
    "author": {
        "id": 98,
        "mrn": "VX5S6L0U1765209031",
        "name": "Augustus Rodriguez",
        "email": "1765209031cole.gus@example.org",
        "language": "en",
        "phone": "+1-469-845-9787",
        "phone_country": "IT",
        "phone_verified_at": null,
        "address1": "571 Keeley Loop Suite 603",
        "address2": "East Gerard, OK 22881",
        "postal_code": "04512-4899",
        "city": "Runolfsdottir-Cummings",
        "clinic_name": "East Armando",
        "clinic_location": "27848 Bashirian Views\nEthanburgh, NE 17844-5598",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:31.000000Z",
        "updated_at": "2025-12-08T15:50:31.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view config template",
    "code": "CONFIG_TEMPLATES:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_TEMPLATES:GET:TEMPLATE_NOT_FOUND"
}

Request   

GET api/config/templates/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Config template ID. Example: 1

Query Parameters

extend   string  optional  

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

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": "Est est excepturi natus et voluptatibus possimus.",
    "description": "Quia nobis voluptatum aliquam nam cum adipisci et et.",
    "author_id": 99,
    "company_id": null,
    "config": "{\"autoGrasp\":[0,0],\"coContractionTimings\":[500,200],\"controlMode\":[1],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[50,50,70,20,50,30,20,0,0,0],\"gripPairsConfig\":[10,2,5,8,12,1,11,6],\"gripSequentialConfig\":[255,5,8,255,2,10,7,255,13,255,255,9],\"gripSwitchingMode\":[3],\"holdOpen\":[2000,2500],\"pulseTimings\":[80,330,570,470],\"softGrip\":[0],\"speedControlStrategy\":[1]}",
    "created_at": "2025-12-08T15:50:31.000000Z",
    "updated_at": "2025-12-08T15:50:31.000000Z",
    "author": {
        "id": 99,
        "mrn": "XVVELERR1765209031",
        "name": "Keara Abbott",
        "email": "1765209031bmclaughlin@example.net",
        "language": "en",
        "phone": "380.448.0636",
        "phone_country": "YT",
        "phone_verified_at": null,
        "address1": "92301 Okuneva Keys",
        "address2": "East Dannie, NJ 60550",
        "postal_code": "64229-4920",
        "city": "Little, Crooks and Breitenberg",
        "clinic_name": "Khalidshire",
        "clinic_location": "292 Cartwright Canyon\nJasonmouth, AR 63921-6625",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:31.000000Z",
        "updated_at": "2025-12-08T15:50:31.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create config template",
    "code": "CONFIG_TEMPLATES:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/config/templates

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Name of the config template. Example: Default config for Aether Zeus

description   string  optional  

Description of the config template. Example: Description of the config template.

owner   string  optional  

Mark config template owned by clinician or company. Default: me (clinician). Example: company

Must be one of:
  • me
  • company
author   string  optional  

Super Admin only: User ID to be the author of template. The id of an existing record in the App\Models\User table. Example: 1

config   string   

Full config. MUST_BE_JSON. Example: {"param_1": [100, 200], "param_2": [100, 200, 300]}

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": "Ut doloribus aperiam officia quia necessitatibus.",
    "description": "Sequi omnis rem natus qui.",
    "author_id": 100,
    "company_id": null,
    "config": "{\"autoGrasp\":[1,0],\"coContractionTimings\":[500,200],\"controlMode\":[0],\"emgGains\":[100,100],\"emgSpike\":[1,300],\"emgThresholds\":[100,60,20,40,60,80,20,0,50,50],\"gripPairsConfig\":[6,3,5,2,10,4,13,11],\"gripSequentialConfig\":[255,3,255,8,12,10,6,2,11,4,13,1],\"gripSwitchingMode\":[1],\"holdOpen\":[2000,2000],\"pulseTimings\":[660,680,960,660],\"softGrip\":[1],\"speedControlStrategy\":[1]}",
    "created_at": "2025-12-08T15:50:32.000000Z",
    "updated_at": "2025-12-08T15:50:32.000000Z",
    "author": {
        "id": 100,
        "mrn": "KFOC2PGQ1765209032",
        "name": "Madyson Cronin",
        "email": "1765209032zackery42@example.com",
        "language": "en",
        "phone": "+1.763.759.5058",
        "phone_country": "JE",
        "phone_verified_at": null,
        "address1": "5795 Isabelle Station Apt. 859",
        "address2": "Considinefurt, IN 02402-5239",
        "postal_code": "61986-8500",
        "city": "Kutch-Kuhlman",
        "clinic_name": "Kelsifort",
        "clinic_location": "120 Leta Mount Apt. 956\nKshlerinville, SD 10384",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:32.000000Z",
        "updated_at": "2025-12-08T15:50:32.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update config template",
    "code": "CONFIG_TEMPLATES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_TEMPLATES:UPDATE:TEMPLATE_NOT_FOUND"
}

Request   

PUT api/config/templates/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Config template ID. Example: 1

Body Parameters

name   string  optional  

Name of the config template. Example: Default config for Aether Zeus

description   string  optional  

Description of the config template. Example: Description of the config template.

owner   string  optional  

Mark config template owned by clinician or company. Default: me (clinician). Example: company

Must be one of:
  • me
  • company
author   string  optional  

Super Admin only: User ID to be the author of template. The id of an existing record in the App\Models\User table. Example: 1

config   string  optional  

Full config. MUST_BE_JSON. Example: {"param_1": [100, 200], "param_2": [100, 200, 300]}

Delete config template

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Config template deleted",
    "code": "CONFIG_TEMPLATES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete config template",
    "code": "CONFIG_TEMPLATES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_TEMPLATES:DELETE:TEMPLATE_NOT_FOUND"
}

Request   

DELETE api/config/templates/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Config template ID. Example: 1

Config Templates Notes

API endpoints for config templates notes

Get config templates notes list

requires authentication

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

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

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "template_id": 6,
            "user_id": 101,
            "note": "Deserunt sit sed laudantium nostrum fugit doloremque illum.",
            "created_at": "2025-12-08T15:50:32.000000Z",
            "updated_at": "2025-12-08T15:50:32.000000Z",
            "author": {
                "id": 101,
                "mrn": "PRAIMY3J1765209032",
                "name": "Ms. Leila Dickinson IV",
                "email": "1765209032jmertz@example.net",
                "language": "en",
                "phone": "858-447-7101",
                "phone_country": "NL",
                "phone_verified_at": null,
                "address1": "62321 Fisher Expressway Apt. 204",
                "address2": "East Annieview, CT 93277-7549",
                "postal_code": "06143",
                "city": "Wiegand-Flatley",
                "clinic_name": "New Susiebury",
                "clinic_location": "57398 Gottlieb Mission\nFletafurt, OR 66554",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:32.000000Z",
                "updated_at": "2025-12-08T15:50:32.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        },
        {
            "id": 2,
            "template_id": 7,
            "user_id": 102,
            "note": "Est enim ipsum nesciunt totam consectetur est.",
            "created_at": "2025-12-08T15:50:32.000000Z",
            "updated_at": "2025-12-08T15:50:32.000000Z",
            "author": {
                "id": 102,
                "mrn": "AON7RDYZ1765209032",
                "name": "Cecil Treutel",
                "email": "1765209032roob.dejuan@example.com",
                "language": "en",
                "phone": "1-401-803-4250",
                "phone_country": "GM",
                "phone_verified_at": null,
                "address1": "3115 Nader Shore",
                "address2": "Fordshire, MS 42806-3118",
                "postal_code": "27909",
                "city": "Feil, Willms and Ankunding",
                "clinic_name": "Harleybury",
                "clinic_location": "8575 Callie Via Apt. 969\nSauerchester, MT 31133",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:32.000000Z",
                "updated_at": "2025-12-08T15:50:32.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access config templates notes",
    "code": "CONFIG_TEMPLATE_NOTES:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_TEMPLATE_NOTES:LIST:TEMPLATE_NOT_FOUND"
}

Request   

GET api/config/templates/{id}/notes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Config template ID. Example: 1

Query Parameters

user   integer  optional  

Filter notes by user. Example: 1

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

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

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

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": 103,
    "note": "Exercitationem voluptatum impedit qui enim ratione.",
    "created_at": "2025-12-08T15:50:32.000000Z",
    "updated_at": "2025-12-08T15:50:32.000000Z",
    "author": {
        "id": 103,
        "mrn": "0GMBI0051765209032",
        "name": "Alana Medhurst",
        "email": "1765209032ariel.marquardt@example.net",
        "language": "en",
        "phone": "+1.717.678.0560",
        "phone_country": "TV",
        "phone_verified_at": null,
        "address1": "2159 McLaughlin Streets Apt. 531",
        "address2": "Jesschester, OR 47195",
        "postal_code": "65028-3898",
        "city": "Stroman-Douglas",
        "clinic_name": "Luettgenmouth",
        "clinic_location": "636 Gulgowski Drive Apt. 035\nCoreneville, KY 00675",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:32.000000Z",
        "updated_at": "2025-12-08T15:50:32.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access config templates notes",
    "code": "CONFIG_TEMPLATE_NOTES:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_TEMPLATE_NOTES:GET:TEMPLATE_NOT_FOUND"
}

Example response (404, Config template note not found):


{
    "message": "Config template note not found",
    "code": "CONFIG_TEMPLATE_NOTES:GET:NOTE_NOT_FOUND"
}

Request   

GET api/config/templates/{id}/notes/{noteId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Config template ID. Example: 1

noteId   integer   

Config template note ID. Example: 1

Query Parameters

extend   string  optional  

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

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\": \"Eligendi iure pariatur tenetur aspernatur porro provident.\"
}"

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": "Eligendi iure pariatur tenetur aspernatur porro provident."
};

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

Example response (201):


{
    "id": 4,
    "template_id": 9,
    "user_id": 104,
    "note": "Perspiciatis nihil rem incidunt cumque.",
    "created_at": "2025-12-08T15:50:32.000000Z",
    "updated_at": "2025-12-08T15:50:32.000000Z",
    "author": {
        "id": 104,
        "mrn": "M1JMH1VW1765209032",
        "name": "Hannah Prohaska",
        "email": "1765209032reynolds.gregorio@example.com",
        "language": "en",
        "phone": "+1-608-204-2017",
        "phone_country": "PH",
        "phone_verified_at": null,
        "address1": "623 Barton Square",
        "address2": "North Tracey, IL 73357",
        "postal_code": "55405",
        "city": "Hessel-Heathcote",
        "clinic_name": "New Heberfort",
        "clinic_location": "2676 Baylee Mountains\nNorth Derrick, WA 27553-4515",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:32.000000Z",
        "updated_at": "2025-12-08T15:50:32.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to add config templates notes",
    "code": "CONFIG_TEMPLATE_NOTES:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_TEMPLATE_NOTES:CREATE:TEMPLATE_NOT_FOUND"
}

Request   

POST api/config/templates/{id}/notes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Config template ID. Example: 1

Body Parameters

note   string  optional  

Note text. Example: Eligendi iure pariatur tenetur aspernatur porro provident.

Delete config template note

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Config template note deleted",
    "code": "CONFIG_TEMPLATE_NOTES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete config templates notes",
    "code": "CONFIG_TEMPLATE_NOTES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Config template not found):


{
    "message": "Config template not found",
    "code": "CONFIG_TEMPLATE_NOTES:DELETE:TEMPLATE_NOT_FOUND"
}

Example response (404, Config template note not found):


{
    "message": "Config template note not found",
    "code": "CONFIG_TEMPLATE_NOTES:DELETE:NOTE_NOT_FOUND"
}

Request   

DELETE api/config/templates/{id}/notes/{noteId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Config template ID. Example: 1

noteId   integer   

Config template note ID. Example: 1

Custom Grips

API endpoints for custom grips management

List custom grips templates

requires authentication

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

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "user_id": 255,
            "name": "letitia.mosciski",
            "initial_position": "[50, 50, 50, 50, 50]",
            "limit_position": "[900, 900, 900, 900, 900]",
            "active_fingers": "[0, 1, 1, 1, 1]",
            "created_at": "2025-12-08T15:50:45.000000Z",
            "updated_at": "2025-12-08T15:50:45.000000Z"
        },
        {
            "id": 2,
            "user_id": 256,
            "name": "hildegard44",
            "initial_position": "[50, 50, 50, 50, 50]",
            "limit_position": "[900, 900, 900, 900, 900]",
            "active_fingers": "[0, 1, 1, 1, 1]",
            "created_at": "2025-12-08T15:50:45.000000Z",
            "updated_at": "2025-12-08T15:50:45.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage custom grips templates",
    "code": "CUSTOM_GRIPS_TEMPLATES:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/custom-grips-templates

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

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": 257,
    "name": "lubowitz.maureen",
    "initial_position": "[50, 50, 50, 50, 50]",
    "limit_position": "[900, 900, 900, 900, 900]",
    "active_fingers": "[0, 1, 1, 1, 1]",
    "created_at": "2025-12-08T15:50:45.000000Z",
    "updated_at": "2025-12-08T15:50:45.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage custom grips templates",
    "code": "CUSTOM_GRIPS_TEMPLATES:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Custom grip template name in use):


{
    "message": "Custom grip template name already in use",
    "code": "CUSTOM_GRIPS_TEMPLATES:CREATE:NAME_IN_USE"
}

Request   

POST api/custom-grips-templates

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Name of custom grip template. Example: Custom Grip Template 1

initial_position   string   

Grip initial position. Value should be a string containing the array of values. Example: "[50, 50, 50, 50, 50]". Must start with one of [ Must end with one of ]. Example: [50, 50, 50, 50, 50]

limit_position   string   

Grip limit position. Value should be a string containing the array of values. Example: "[900, 900, 900, 900, 900]". Must start with one of [ Must end with one of ]. Example: [900, 900, 900, 900, 900]

active_fingers   string   

Grip active fingers. Value should be a string containing the array of values. Example: "[0, 1, 1, 1, 1]". Must start with one of [ Must end with one of ]. Example: [0, 1, 1, 1, 1]

Delete custom grip template

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Custom grip deleted",
    "code": "CUSTOM_GRIPS_TEMPLATES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage custom grips templates",
    "code": "CUSTOM_GRIPS_TEMPLATES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Custom grip template not found):


{
    "message": "Custom grip template not found",
    "code": "CUSTOM_GRIPS_TEMPLATES:DELETE:TEMPLATE_NOT_FOUND"
}

Request   

DELETE api/custom-grips-templates/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Custom Grip Template ID. Example: 1

List custom grips

requires authentication

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

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "device_id": 129,
            "name": "dwill",
            "opposed": 1,
            "grip_number": 0,
            "created_at": "2025-12-08T15:50:45.000000Z",
            "updated_at": "2025-12-08T15:50:45.000000Z"
        },
        {
            "id": 2,
            "device_id": 130,
            "name": "davis.lura",
            "opposed": 1,
            "grip_number": 0,
            "created_at": "2025-12-08T15:50:45.000000Z",
            "updated_at": "2025-12-08T15:50:45.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view custom grips",
    "code": "CUSTOM_GRIPS:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


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

Request   

GET api/device/{deviceId}/custom-grips

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

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": 131,
    "name": "lucie48",
    "opposed": 1,
    "grip_number": 0,
    "created_at": "2025-12-08T15:50:45.000000Z",
    "updated_at": "2025-12-08T15:50:45.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage custom grips",
    "code": "CUSTOM_GRIPS:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Custom grip name in use):


{
    "message": "Custom grip name already in use",
    "code": "CUSTOM_GRIPS:CREATE:NAME_IN_USE"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CUSTOM_GRIPS:CREATE:DEVICE_NOT_FOUND"
}

Request   

POST api/device/{deviceId}/custom-grips

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Body Parameters

name   string   

Name of custom grip. Example: Custom Grip 1

opposed   boolean   

Grip opposed status. Example: true

grip_number   integer   

Grip number (not ID). Example: 1

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": 132,
    "name": "johnathon78",
    "opposed": 1,
    "grip_number": 0,
    "created_at": "2025-12-08T15:50:45.000000Z",
    "updated_at": "2025-12-08T15:50:45.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage custom grips",
    "code": "CUSTOM_GRIPS:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Custom grip name in use):


{
    "message": "Custom grip name already in use",
    "code": "CUSTOM_GRIPS:UPDATE:NAME_IN_USE"
}

Example response (404, Device not found):


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

Example response (404, Custom grip not found):


{
    "message": "Custom grip not found",
    "code": "CUSTOM_GRIPS:UPDATE:GRIP_NOT_FOUND"
}

Request   

PUT api/device/{deviceId}/custom-grips/{gripId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

gripId   integer   

Custom Grip ID. Example: 1

Body Parameters

name   string  optional  

Name of custom grip. Example: Custom Grip 1

opposed   boolean  optional  

Grip opposed status. Example: true

grip_number   integer  optional  

Grip number (not ID). Example: 1

Delete custom grip

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Custom grip template deleted",
    "code": "CUSTOM_GRIPS:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage custom grips",
    "code": "CUSTOM_GRIPS:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "CUSTOM_GRIPS:DELETE:DEVICE_NOT_FOUND"
}

Example response (404, Custom grip not found):


{
    "message": "Custom grip not found",
    "code": "CUSTOM_GRIPS:DELETE:GRIP_NOT_FOUND"
}

Request   

DELETE api/device/{deviceId}/custom-grips/{gripId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

gripId   integer   

Custom Grip ID. Example: 1

Device 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": "arm",
        "orientation": "right",
        "active": 1,
        "created_at": "2025-12-08T15:50:25.000000Z",
        "updated_at": "2025-12-08T15:50:25.000000Z"
    },
    {
        "id": 4,
        "name": "Zeus hand v1",
        "type": "arm",
        "orientation": "right",
        "active": 1,
        "created_at": "2025-12-08T15:50:25.000000Z",
        "updated_at": "2025-12-08T15:50:25.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list device models",
    "code": "DEVICE_MODELS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/devices/models

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

active   integer  optional  

Filter device models by active status (available: 0 - only inactive, 1 - only active, any - all users). Default: 1. Example: 1

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": "2025-12-08T15:50:25.000000Z",
    "updated_at": "2025-12-08T15:50:25.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create device model",
    "code": "DEVICE_MODELS:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/devices/models

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Model name. Example: Zeus hand v1

type   string  optional  

Model type (e.g. hand). Example: hand

orientation   string  optional  

Model orientation if specified. Example: right

active   boolean  optional  

Device model active status (0 - inactive, 1 - active). Example: true

Update device model

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/devices/models/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Zeus hand v1\",
    \"type\": \"hand\",
    \"orientation\": \"left\",
    \"active\": true
}"

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

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

let body = {
    "name": "Zeus hand v1",
    "type": "hand",
    "orientation": "left",
    "active": true
};

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

Example response (202):


{
    "id": 6,
    "name": "Zeus hand v1",
    "type": "leg",
    "orientation": "right",
    "active": 1,
    "created_at": "2025-12-08T15:50:25.000000Z",
    "updated_at": "2025-12-08T15:50: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"
}

Request   

PUT api/devices/models/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

DeviceModel ID. Example: 1

Body Parameters

name   string  optional  

Model name. Example: Zeus hand v1

type   string  optional  

Model type (e.g. hand). Example: hand

orientation   string  optional  

Model orientation if specified. Example: left

active   boolean  optional  

Device model active status (0 - inactive, 1 - active). Example: true

Devices

API endpoints for devices management

Check serial number or bluetooth ID

Public endpoint responding with status of given device serial number or bluetooth ID. If any of these numbers can be found in database, status will be true. Otherwise, status will be false (device does not exist).

Example request:
curl --request GET \
    --get "http://localhost:8000/api/device/check/S3R1AL-NUM83R" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"serial\"
}"

const url = new URL(
    "http://localhost:8000/api/device/check/S3R1AL-NUM83R"
);

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

let body = {
    "type": "serial"
};

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

Example response (200, OK):


{
    "status": true
}

Request   

GET api/device/check/{serial}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

serial   string   

Device serial number or bluetooth ID. Example: S3R1AL-NUM83R

Body Parameters

type   string  optional  

Type of checked identifier. Example: serial

Must be one of:
  • serial
  • bluetooth_id

Get devices list

requires authentication

Possible extend options:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/devices?search=S3R1AL-NUM83R&active=-1&amputee=1&clinician=1&model=1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/devices"
);

const params = {
    "search": "S3R1AL-NUM83R",
    "active": "-1",
    "amputee": "1",
    "clinician": "1",
    "model": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 5,
            "serial": "35dbb4b6-dd74-34ee-ba09-604d682fb151",
            "bluetooth_id": "58a723e8-7546-3f3b-96df-da5a4ba71b43",
            "company_id": null,
            "model_id": 7,
            "amputee_id": 34,
            "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",
            "created_at": "2025-12-08T15:50:25.000000Z",
            "updated_at": "2025-12-08T15:50:25.000000Z",
            "model": {
                "id": 7,
                "name": "Zeus hand v1",
                "type": "arm",
                "orientation": "left",
                "active": 1,
                "created_at": "2025-12-08T15:50:25.000000Z",
                "updated_at": "2025-12-08T15:50:25.000000Z"
            },
            "amputee": {
                "id": 34,
                "mrn": "KQWF2YN71765209025",
                "name": "Prof. Emanuel Kub",
                "email": "1765209025napoleon31@example.org",
                "language": "en",
                "phone": "+1-315-297-3573",
                "phone_country": "BW",
                "phone_verified_at": null,
                "address1": "73405 Danial Tunnel Apt. 158",
                "address2": "Beermouth, NC 89789",
                "postal_code": "11841-1247",
                "city": "Grimes and Sons",
                "clinic_name": "Strosinberg",
                "clinic_location": "43882 Gretchen Squares\nFaymouth, ND 76951-5543",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:25.000000Z",
                "updated_at": "2025-12-08T15:50:25.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        },
        {
            "id": 6,
            "serial": "d1ebe434-89d6-3005-89f4-c743790b4908",
            "bluetooth_id": "2a5631b1-1af0-3426-9975-888f3dc97e11",
            "company_id": null,
            "model_id": 8,
            "amputee_id": 35,
            "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",
            "created_at": "2025-12-08T15:50:25.000000Z",
            "updated_at": "2025-12-08T15:50:25.000000Z",
            "model": {
                "id": 8,
                "name": "Zeus hand v1",
                "type": "leg",
                "orientation": "right",
                "active": 1,
                "created_at": "2025-12-08T15:50:25.000000Z",
                "updated_at": "2025-12-08T15:50:25.000000Z"
            },
            "amputee": {
                "id": 35,
                "mrn": "C83Y07KT1765209025",
                "name": "Francesca Wuckert",
                "email": "1765209025clyde51@example.com",
                "language": "en",
                "phone": "1-813-503-3960",
                "phone_country": "DK",
                "phone_verified_at": null,
                "address1": "299 Dicki Walk Apt. 782",
                "address2": "Annieton, AZ 97573-6282",
                "postal_code": "46894-7486",
                "city": "Ziemann-Bosco",
                "clinic_name": "Lake Kiarraland",
                "clinic_location": "5456 Langosh Loaf\nWest Wilhelmine, OK 15416",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:25.000000Z",
                "updated_at": "2025-12-08T15:50: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"
}

Request   

GET api/devices

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

search   string  optional  

Filter devices by searching in: serial number, bluetooth ID. Example: S3R1AL-NUM83R

active   integer  optional  

Filter devices by active status (available: 0 - only inactive, 1 - only active, -1 - all users). Default: 1. Example: -1

amputee   string  optional  

Filter devices by amputees. Provide single ID (amputee=1), array of IDs (amputee[]=1&amputee[]=2) or comma-separated list of IDs (amputee=1,2). Pass value 0 to get devices unassigned to any amputee. Example: 1

clinician   string  optional  

Filter devices by clinicians. Provide single ID (clinician=1), array of IDs (clinician[]=1&clinician[]=2) or comma-separated list of IDs (clinician=1,2). Pass value 0 to get devices unassigned to any clinician. Example: 1

model   string  optional  

Filter devices by device models. Provide single ID (model=1), array of IDs (model[]=1&model[]=2) or comma-separated list of IDs (model=1,2). Pass value 0 to get devices without model. Example: 1

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: model, amputee, clinicians, firmwareVersion, pcbVersion, config, joinedElectrodes).

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

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": "290d7d5d-cc97-32f5-a296-a8c5b9691cda",
    "bluetooth_id": "facfe45c-3007-3367-949a-0ceaaf68d713",
    "company_id": null,
    "model_id": 9,
    "amputee_id": 36,
    "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",
    "created_at": "2025-12-08T15:50:26.000000Z",
    "updated_at": "2025-12-08T15:50:26.000000Z",
    "model": {
        "id": 9,
        "name": "Zeus hand v1",
        "type": "arm",
        "orientation": "left",
        "active": 1,
        "created_at": "2025-12-08T15:50:25.000000Z",
        "updated_at": "2025-12-08T15:50:25.000000Z"
    },
    "amputee": {
        "id": 36,
        "mrn": "I3UKDHTS1765209025",
        "name": "Hannah Gislason",
        "email": "1765209025ortiz.laron@example.net",
        "language": "en",
        "phone": "+1-609-858-9112",
        "phone_country": "NU",
        "phone_verified_at": null,
        "address1": "344 Miller Village",
        "address2": "Mantefurt, ND 07022",
        "postal_code": "87587",
        "city": "Gulgowski, Will and Fritsch",
        "clinic_name": "Bartonmouth",
        "clinic_location": "662 Leola Land\nRosemariebury, ME 25527",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:26.000000Z",
        "updated_at": "2025-12-08T15:50:26.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "pcb_version": {
        "id": 1,
        "name": "2.17.41",
        "model_id": null,
        "hardware_id": "",
        "created_at": "2025-12-08T15:50:26.000000Z",
        "updated_at": "2025-12-08T15:50: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"
}

Request   

GET api/device/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Query Parameters

extend   string  optional  

Comma-separated list of relation extensions (available: model, amputee, firmwareVersion, pcbVersion, clinicians, joinedElectrodes).

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
    ],
    \"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\"
}"

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
    ],
    "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"
};

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

Example response (201):


{
    "id": 8,
    "serial": "7e382afa-15f4-3595-961f-3286a7f79fdf",
    "bluetooth_id": "7bbe0f8b-298d-395a-8be4-4c65c2f8f19c",
    "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",
    "created_at": "2025-12-08T15:50:26.000000Z",
    "updated_at": "2025-12-08T15:50:26.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create device",
    "code": "DEVICES:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Firmware has no schema):


{
    "message": "Cannot create: firmware has no schema",
    "code": "DEVICES:CREATE:NO_FIRMWARE_SCHEMA"
}

Example response (500, Server error):


{
    "message": "Server error: device not created",
    "code": "DEVICES:CREATE:SERVER_ERROR"
}

Request   

POST api/device

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

serial   string   

Device serial number. Example: S3R1AL-NUM83R

bluetooth_id   string   

Device Bluetooth ID. Example: BL0123456789

model_id   string   

Device Model ID. The id of an existing record in the App\Models\DeviceModel table. Example: 1

amputee_id   string  optional  

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

clinicians   integer[]  optional  

Clinician ID. The id of an existing record in the App\Models\User table.

firmware_version_id   string  optional  

Firmware Version ID. The id of an existing record in the App\Models\FirmwareVersion table. Example: 1

pcb_version_id   string  optional  

PCB Version ID. The id of an existing record in the App\Models\PCBVersion table. Example: 1

reverse_magnets   boolean  optional  

Device reverse magnets. Default: 0. Example: false

is_electrode   boolean  optional  

Super Admin only: Device is electrode. Default: 0. Example: false

active   boolean  optional  

Device active status (0 - inactive, 1 - active). Example: true

last_activity_at   string  optional  

Device last activity date. Update this value each time device connects to the mobile app. Always shift local datetime to UTC timezone. Must be a valid date in the format Y-m-d H:i:s. Example: 2022-08-15 12:00:00

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
    ],
    \"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\"
}"

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
    ],
    "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"
};

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

Example response (202):


{
    "id": 9,
    "serial": "5434dc43-8dcd-3a81-9899-adf12849c917",
    "bluetooth_id": "83fb71f8-8ae3-3bf0-9d13-fe5b4529a565",
    "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",
    "created_at": "2025-12-08T15:50:26.000000Z",
    "updated_at": "2025-12-08T15:50:26.000000Z"
}

Example response (403, Insufficient permission):


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

Example response (403, Firmware has no schema):


{
    "message": "Cannot update: firmware has no schema",
    "code": "DEVICES:UPDATE:NO_FIRMWARE_SCHEMA"
}

Example response (403):


{
    "message": "Cannot update: no clinicians left for patient relation",
    "code": "DEVICES:UPDATE:NO_CLINICIANS"
}

Example response (404, Device not found):


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

Request   

PUT api/device/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Body Parameters

serial   string  optional  

Device serial number. Example: S3R1AL-NUM83R

bluetooth_id   string  optional  

Device Bluetooth ID. Example: BL0123456789

model_id   string  optional  

Device Model ID. The id of an existing record in the App\Models\DeviceModel table. Example: 1

amputee_id   string  optional  

Device amputee ID. Pass null to remove assignment. The id of an existing record in the App\Models\User table. Example: 1

clinicians   integer[]  optional  

Clinician ID. The id of an existing record in the App\Models\User table.

firmware_version_id   string  optional  

Firmware Version ID. The id of an existing record in the App\Models\FirmwareVersion table. Example: 1

pcb_version_id   string  optional  

PCB Version ID. The id of an existing record in the App\Models\PCBVersion table. Example: 1

reverse_magnets   boolean  optional  

Device reverse magnets. Default: 0. Example: false

is_electrode   boolean  optional  

Super Admin only: Device is electrode. Default: 0. Example: false

active   boolean  optional  

Device active status (0 - inactive, 1 - active). Example: true

last_activity_at   string  optional  

Device last activity date. Update this value each time device connects to the mobile app. Always shift local datetime to UTC timezone. Must be a valid date in the format Y-m-d H:i:s. Example: 2022-08-15 12:00:00

Delete device

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Device deleted",
    "code": "DEVICES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete device",
    "code": "DEVICES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:DELETE:DEVICE_NOT_FOUND"
}

Request   

DELETE api/device/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Get device hashes

requires authentication

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

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

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

Example response (200, OK):


{
    "hash_global": "123456789012345",
    "hash_common_settings": "123456789012345",
    "hash_common_grips": "123456789012345",
    "hash_mode1": "123456789012345",
    "hash_mode2": "123456789012345",
    "hash_mode3": "123456789012345"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access device hashes",
    "code": "DEVICES:GET_HASHES:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:GET_HASHES:DEVICE_NOT_FOUND"
}

Request   

GET api/device/{id}/hash

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Update device hashes

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/1/hash" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"hash_global\": \"123456789012345\",
    \"hash_common_settings\": \"123456789012345\",
    \"hash_common_grips\": \"123456789012345\",
    \"hash_mode1\": \"123456789012345\",
    \"hash_mode2\": \"123456789012345\",
    \"hash_mode3\": \"123456789012345\"
}"

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

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

let body = {
    "hash_global": "123456789012345",
    "hash_common_settings": "123456789012345",
    "hash_common_grips": "123456789012345",
    "hash_mode1": "123456789012345",
    "hash_mode2": "123456789012345",
    "hash_mode3": "123456789012345"
};

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

Example response (202, OK):


{
    "hash_global": "123456789012345",
    "hash_common_settings": "123456789012345",
    "hash_common_grips": "123456789012345",
    "hash_mode1": "123456789012345",
    "hash_mode2": "123456789012345",
    "hash_mode3": "123456789012345"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access device hashes",
    "code": "DEVICES:SET_HASHES:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:SET_HASHES:DEVICE_NOT_FOUND"
}

Request   

POST api/device/{id}/hash

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Body Parameters

hash_global   string  optional  

Global hash. Example: 123456789012345

hash_common_settings   string  optional  

Common settings hash. Example: 123456789012345

hash_common_grips   string  optional  

Common grips hash. Example: 123456789012345

hash_mode1   string  optional  

Mode 1 hash. Example: 123456789012345

hash_mode2   string  optional  

Mode 2 hash. Example: 123456789012345

hash_mode3   string  optional  

Mode 3 hash. Example: 123456789012345

Detach device

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Device detached",
    "code": "DEVICES:DETACH:DETACHED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to detach device",
    "code": "DEVICES:DETACH:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:DETACH:DEVICE_NOT_FOUND"
}

Request   

POST api/device/{id}/detach

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Add device

requires authentication

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

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

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

Example response (202):


{
    "id": 10,
    "serial": "2db346d3-7f80-346b-98da-dbf797cb8fd6",
    "bluetooth_id": "3d2f0c09-133a-3565-aefa-f5af2eb2a104",
    "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",
    "created_at": "2025-12-08T15:50:26.000000Z",
    "updated_at": "2025-12-08T15:50:26.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to assign devices with code",
    "code": "DEVICES:ASSIGN:INSUFFICIENT_PERMISSION"
}

Example response (403, User reached the temporary limit of attached devices):


{
    "message": "Reached the limit of assigned devices",
    "code": "DEVICES:ASSIGN:LIMIT_REACHED"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:ASSIGN:DEVICE_NOT_FOUND"
}

Request   

POST api/device/add/{serial}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

serial   string   

Device serial number or bluetooth ID. Example: S3R1AL-NUM83R

Connect device

requires authentication

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

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

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

Example response (200, OK):


{
    "message": "Device connected",
    "code": "DEVICES:CONNECT:CONNECTED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view device data",
    "code": "DEVICES:CONNECT:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:CONNECT:DEVICE_NOT_FOUND"
}

Request   

POST api/device/connect/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Disconnect device

requires authentication

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

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

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

Example response (200, OK):


{
    "message": "Device disconnected",
    "code": "DEVICES:DISCONNECT:DISCONNECTED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view device data",
    "code": "DEVICES:DISCONNECT:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:DISCONNECT:DEVICE_NOT_FOUND"
}

Request   

POST api/device/disconnect/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

Join devices

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/device/join/1/2" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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",
};

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

Example response (200):


{
    "id": 11,
    "serial": "c7fed698-4374-3007-89cd-3e28e75a684d",
    "bluetooth_id": "addd0327-ce3f-39a5-afea-67d77dbb94f2",
    "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",
    "created_at": "2025-12-08T15:50:26.000000Z",
    "updated_at": "2025-12-08T15:50:26.000000Z",
    "joined_electrodes": [
        {
            "id": 12,
            "serial": "77df4585-8d36-3a38-93b8-faaaad2cdac9",
            "bluetooth_id": "3308cf69-10eb-353f-9186-f0f1d3e4e093",
            "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",
            "created_at": "2025-12-08T15:50:26.000000Z",
            "updated_at": "2025-12-08T15:50:26.000000Z",
            "pivot": {
                "device_id": 11,
                "electrode_id": 12,
                "created_at": "2025-12-08T15:50:26.000000Z",
                "updated_at": "2025-12-08T15:50:26.000000Z"
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to join devices",
    "code": "DEVICES:JOIN:INSUFFICIENT_PERMISSION"
}

Example response (403, Devices already joined):


{
    "message": "Device and electrode already 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"
}

Request   

POST api/device/join/{deviceId}/{electrodeId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID (hand). Example: 1

electrodeId   integer   

Device ID (electrode). Example: 2

Detach joined devices

requires authentication

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

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

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

Example response (200, OK):


{
    "message": "Devices unjoined",
    "code": "DEVICES:UNJOIN:UNJOINED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to join devices",
    "code": "DEVICES:UNJOIN:INSUFFICIENT_PERMISSION"
}

Example response (403, OK):


{
    "message": "Devices are not joined",
    "code": "DEVICES:UNJOIN:NOT_JOINED"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:UNJOIN:DEVICE_NOT_FOUND"
}

Request   

POST api/device/unjoin/{deviceId}/{electrodeId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

electrodeId   integer   

Electrode ID. Example: 2

Create demo patient

requires authentication

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

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

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

Example response (201, OK):


{
    "email": "SERIAL@gmail.com",
    "password": "Demo@123"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create dummy patient",
    "code": "DEVICES:DUMMY_PATIENT:INSUFFICIENT_PERMISSION"
}

Example response (403, Device already has a patient):


{
    "message": "Device already has a patient",
    "code": "DEVICES:DUMMY_PATIENT:PATIENT_EXISTS"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "DEVICES:DUMMY_PATIENT:DEVICE_NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error: dummy patient not created",
    "code": "DEVICES:DUMMY_PATIENT:SERVER_ERROR"
}

Request   

POST api/device/{id}/dummy-patient

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Device ID. Example: 1

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": "Infantry",
            "type": "web",
            "created_at": "2025-12-08T15:50:45.000000Z",
            "updated_at": "2025-12-08T15:50:45.000000Z"
        },
        {
            "id": 2,
            "name": "Pipefitter",
            "type": "web",
            "created_at": "2025-12-08T15:50:45.000000Z",
            "updated_at": "2025-12-08T15:50:45.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage documents",
    "code": "DOCUMENTS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/documents

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

type   string  optional  

Filter documents by type. Example: web

Must be one of:
  • web
  • mobile
perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

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": "Automotive Body Repairer",
    "type": "web",
    "created_at": "2025-12-08T15:50:45.000000Z",
    "updated_at": "2025-12-08T15:50:45.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage documents",
    "code": "DOCUMENTS:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/documents

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Document name. Example: Privacy Policy

type   string   

Document destination. Example: web

Must be one of:
  • web
  • mobile

Delete document

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Document deleted",
    "code": "DOCUMENTS:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage documents",
    "code": "DOCUMENTS:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (403, Document has existing versions):


{
    "message": "Cannot delete: document has existing versions (1)",
    "code": "DOCUMENTS:DELETE:HAS_VERSIONS"
}

Example response (404, Document not found):


{
    "message": "Document not found",
    "code": "DOCUMENTS:DELETE:DOCUMENT_NOT_FOUND"
}

Request   

DELETE api/documents/{documentId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

documentId   integer   

Document ID. Example: 1

List document versions

requires authentication

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

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

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

Example response (200):


[
    {
        "id": 1,
        "document_id": null,
        "index": 42524,
        "file": "http://wiza.com/autem-dolorem-rerum-eum-cum-est",
        "created_at": "2025-12-08T15:50:45.000000Z",
        "updated_at": "2025-12-08T15:50:45.000000Z"
    },
    {
        "id": 2,
        "document_id": null,
        "index": 83,
        "file": "https://huels.com/molestiae-rerum-architecto-tempore-est-ex-quod.html",
        "created_at": "2025-12-08T15:50:45.000000Z",
        "updated_at": "2025-12-08T15:50:45.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage documents",
    "code": "DOCUMENTS:LIST_VERSIONS:INSUFFICIENT_PERMISSION"
}

Example response (404, Document not found):


{
    "message": "Document not found",
    "code": "DOCUMENTS:LIST_VERSIONS:DOCUMENT_NOT_FOUND"
}

Request   

GET api/documents/{documentId}/versions

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

documentId   integer   

Document ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

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": 892296,
    "file": "http://mclaughlin.com/error-dolor-porro-explicabo-qui-cupiditate-est-et-quos.html",
    "created_at": "2025-12-08T15:50:45.000000Z",
    "updated_at": "2025-12-08T15:50:45.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage documents",
    "code": "DOCUMENTS:CREATE_VERSION:INSUFFICIENT_PERMISSION"
}

Example response (404, Document not found):


{
    "message": "Document not found",
    "code": "DOCUMENTS:CREATE_VERSION:DOCUMENT_NOT_FOUND"
}

Request   

POST api/documents/{documentId}/versions

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

documentId   integer   

Document ID. Example: 1

Body Parameters

file   string   

URL to document file. Must be a valid URL. Example: https://www.aetherbiomedical.com/privacy-policy

Delete document version

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Document version deleted",
    "code": "DOCUMENTS:DELETE_VERSION:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage documents",
    "code": "DOCUMENTS:DELETE_VERSION:INSUFFICIENT_PERMISSION"
}

Example response (404, Document not found):


{
    "message": "Document not found",
    "code": "DOCUMENTS:DELETE_VERSION:DOCUMENT_NOT_FOUND"
}

Example response (404, Document version not found):


{
    "message": "Document version not found",
    "code": "DOCUMENTS:DELETE_VERSION:VERSION_NOT_FOUND"
}

Request   

DELETE api/documents/{documentId}/versions/{versionId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

documentId   integer   

Document ID. Example: 1

versionId   integer   

DocumentVersion ID. Example: 1

Get documents status

requires authentication

Any document on the list has to be accepted. Use POST /documents/accept endpoint to mark them as accepted once user agrees to that. Empty list means that user is up-to-date with all required documents and nothing has to be accepted.

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

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

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

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

Example response (200, OK):


{
    "documents": [],
    "texts": {
        "title": "Changes to the Privacy Policy",
        "description": "Due to the addition of a new data processing entity, please familiarize yourself with and accept the new privacy policy",
        "checkbox": "I declare that I have read the content of the Privacy Policy and the Terms and Conditions and accept their provisions. I understand that acceptance is a condition for using the application."
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view documents status",
    "code": "DOCUMENTS:STATUS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/documents/status

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

type   string  optional  

Filter documents by type. Example: web

Must be one of:
  • web
  • mobile

Accept documents

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/documents/accept" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"documents\": [
        1
    ]
}"

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

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

let body = {
    "documents": [
        1
    ]
};

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

Example response (202, OK):


{
    "message": "Accepted 1 document(s)",
    "code": "DOCUMENTS:ACCEPT:ACCEPTED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update documents status",
    "code": "DOCUMENTS:ACCEPT:INSUFFICIENT_PERMISSION"
}

Request   

POST api/documents/accept

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

documents   integer[]   

Document Version ID. The id of an existing record in the App\Models\DocumentVersion table.

Feedback

Endpoints related to feedback collecting

Check feedback token

Example request:
curl --request POST \
    "http://localhost:8000/api/feedback/4KJ2YLM0MA64Y6D6FUY2OFY690IICO1OJ2DHR6T68IZNI528H3SKUFJMY0C5DHOA/check" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/feedback/4KJ2YLM0MA64Y6D6FUY2OFY690IICO1OJ2DHR6T68IZNI528H3SKUFJMY0C5DHOA/check"
);

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

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

Example response (200, OK):


{
    "valid": true
}

Request   

POST api/feedback/{token}/check

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

token   string   

Authentication token Example: 4KJ2YLM0MA64Y6D6FUY2OFY690IICO1OJ2DHR6T68IZNI528H3SKUFJMY0C5DHOA

Send feedback with token

Example request:
curl --request POST \
    "http://localhost:8000/api/feedback/4KJ2YLM0MA64Y6D6FUY2OFY690IICO1OJ2DHR6T68IZNI528H3SKUFJMY0C5DHOA" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rate\": 5,
    \"description\": \"That was amazing!\",
    \"skipped\": false
}"

const url = new URL(
    "http://localhost:8000/api/feedback/4KJ2YLM0MA64Y6D6FUY2OFY690IICO1OJ2DHR6T68IZNI528H3SKUFJMY0C5DHOA"
);

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

let body = {
    "rate": 5,
    "description": "That was amazing!",
    "skipped": false
};

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

Example response (201):


{
    "id": 1,
    "user_id": 6,
    "type": "on_demand",
    "trigger": "new_config",
    "platform": "mobile",
    "rate": 4,
    "description": "Aut iure repudiandae facilis dignissimos tenetur.",
    "skipped": 0,
    "created_at": "2025-12-08T15:50:22.000000Z",
    "updated_at": "2025-12-08T15:50:22.000000Z"
}

Example response (403, Invalid token):


{
    "message": "Invalid token",
    "code": "FEEDBACK:SEND_WITH_TOKEN:INVALID_TOKEN"
}

Request   

POST api/feedback/{token}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

token   string   

Authentication token Example: 4KJ2YLM0MA64Y6D6FUY2OFY690IICO1OJ2DHR6T68IZNI528H3SKUFJMY0C5DHOA

Body Parameters

rate   integer  optional  

User's rating. MINIMUM:NUMBER:0 MAXIMUM:NUMBER:5. Example: 5

description   string  optional  

User's description. Example: That was amazing!

skipped   boolean  optional  

Feedback skipped by the user. Example: false

Get feedback status

requires authentication

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

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

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

Example response (200, OK):


{
    "remote_session": true,
    "firmware_update": true,
    "local_session": true,
    "async_session": true,
    "patient_create": false,
    "clinician_invite": true
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to check feedback status",
    "code": "FEEDBACK:STATUS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/feedback/status

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Send feedback

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/feedback" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"contextual\",
    \"trigger\": \"remote_session\",
    \"platform\": \"web\",
    \"rate\": 5,
    \"description\": \"That was amazing!\",
    \"skipped\": false
}"

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
};

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

Example response (201):


{
    "id": 2,
    "user_id": 306,
    "type": "periodic",
    "trigger": "patient_create",
    "platform": "web",
    "rate": 2,
    "description": "Provident perferendis sunt natus neque delectus.",
    "skipped": 0,
    "created_at": "2025-12-08T15:50:50.000000Z",
    "updated_at": "2025-12-08T15:50:50.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to send feedback",
    "code": "FEEDBACK:SEND:INSUFFICIENT_PERMISSION"
}

Request   

POST api/feedback

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

type   string   

Type of feedback. Example: contextual

Must be one of:
  • contextual
  • on_demand
  • periodic
trigger   string  optional  

Feedback trigger. Example: remote_session

Must be one of:
  • remote_session
  • local_session
  • async_session
  • patient_create
  • clinician_invite
  • firmware_update
  • new_config
  • grip_change
platform   string   

Feedback platform. Example: web

Must be one of:
  • web
  • mobile
rate   integer  optional  

User's rating. MINIMUM:NUMBER:0 MAXIMUM:NUMBER:5. Example: 5

description   string  optional  

User's description. Example: That was amazing!

skipped   boolean  optional  

Feedback skipped by the user. Example: false

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": 307,
            "type": "on_demand",
            "trigger": "local_session",
            "platform": "mobile",
            "rate": 5,
            "description": "Eum odio reiciendis consequatur animi qui voluptas ut.",
            "skipped": 1,
            "created_at": "2025-12-08T15:50:50.000000Z",
            "updated_at": "2025-12-08T15:50:50.000000Z"
        },
        {
            "id": 4,
            "user_id": 308,
            "type": "periodic",
            "trigger": "patient_create",
            "platform": "web",
            "rate": 3,
            "description": "Tenetur ea quam dolore.",
            "skipped": 1,
            "created_at": "2025-12-08T15:50:50.000000Z",
            "updated_at": "2025-12-08T15:50:50.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list feedback",
    "code": "FEEDBACK:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/feedback

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

Export feedback to CSV

requires authentication

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

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

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

Example response (200, CSV file):


{
    "file": "https://staging-us-east-2-aether-biomedical-s3-us-bucket.s3.us-east-2.amazonaws.com/feedback/feedback-1759228216.csv",
    "expires": "2025-09-30 10:40:00"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to export feedback",
    "code": "FEEDBACK:EXPORT_CSV:INSUFFICIENT_PERMISSION"
}

Request   

GET api/feedback/csv

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get feedback cooldowns

requires authentication

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

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

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

Example response (200, OK):


{
    "remote_session": 1,
    "local_session": 1,
    "async_session": 1,
    "patient_create": 1,
    "clinician_invite": 1,
    "firmware_update": 1,
    "new_config": 1,
    "grip_change": 1
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage feedback cooldowns",
    "code": "FEEDBACK:GET_COOLDOWNS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/feedback/cooldowns

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Update feedback cooldowns

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/feedback/cooldowns" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"remote_session\": 1,
    \"local_session\": 1,
    \"async_session\": 1,
    \"patient_create\": 1,
    \"clinician_invite\": 1,
    \"firmware_update\": 1,
    \"new_config\": 1,
    \"grip_change\": 1
}"

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

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

let body = {
    "remote_session": 1,
    "local_session": 1,
    "async_session": 1,
    "patient_create": 1,
    "clinician_invite": 1,
    "firmware_update": 1,
    "new_config": 1,
    "grip_change": 1
};

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

Example response (200, OK):


{
    "remote_session": 1,
    "local_session": 1,
    "async_session": 1,
    "patient_create": 1,
    "clinician_invite": 1,
    "firmware_update": 1,
    "new_config": 1,
    "grip_change": 1
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage feedback cooldowns",
    "code": "FEEDBACK:UPDATE_COOLDOWNS:INSUFFICIENT_PERMISSION"
}

Request   

PUT api/feedback/cooldowns

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

remote_session   integer  optional  

Cooldown for remote session trigger. MINIMUM:NUMBER:1. Example: 1

local_session   integer  optional  

Cooldown for local session trigger. MINIMUM:NUMBER:1. Example: 1

async_session   integer  optional  

Cooldown for async session trigger. MINIMUM:NUMBER:1. Example: 1

patient_create   integer  optional  

Cooldown for patient create trigger. MINIMUM:NUMBER:1. Example: 1

clinician_invite   integer  optional  

Cooldown for clinician invite trigger. MINIMUM:NUMBER:1. Example: 1

firmware_update   integer  optional  

Cooldown for firmware update trigger. MINIMUM:NUMBER:1. Example: 1

new_config   integer  optional  

Cooldown for new config trigger. MINIMUM:NUMBER:1. Example: 1

grip_change   integer  optional  

Cooldown for grip change trigger. MINIMUM:NUMBER:1. Example: 1

GeoData

API endpoints for geodata

Get supported timezones list

Example request:
curl --request GET \
    --get "http://localhost:8000/api/timezones" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/timezones"
);

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

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

Example response (200, OK):


[
    "Africa/Abidjan",
    "Africa/Accra",
    "Africa/Addis_Ababa",
    "Africa/Algiers",
    "Africa/Asmara",
    "Africa/Bamako",
    "Africa/Bangui",
    "Africa/Banjul",
    "Africa/Bissau",
    "Africa/Blantyre",
    "Africa/Brazzaville",
    "Africa/Bujumbura",
    "Africa/Cairo",
    "Africa/Casablanca",
    "Africa/Ceuta",
    "Africa/Conakry",
    "Africa/Dakar",
    "Africa/Dar_es_Salaam",
    "Africa/Djibouti",
    "Africa/Douala",
    "Africa/El_Aaiun",
    "Africa/Freetown",
    "Africa/Gaborone",
    "Africa/Harare",
    "Africa/Johannesburg",
    "Africa/Juba",
    "Africa/Kampala",
    "Africa/Khartoum",
    "Africa/Kigali",
    "Africa/Kinshasa",
    "Africa/Lagos",
    "Africa/Libreville",
    "Africa/Lome",
    "Africa/Luanda",
    "Africa/Lubumbashi",
    "Africa/Lusaka",
    "Africa/Malabo",
    "Africa/Maputo",
    "Africa/Maseru",
    "Africa/Mbabane",
    "Africa/Mogadishu",
    "Africa/Monrovia",
    "Africa/Nairobi",
    "Africa/Ndjamena",
    "Africa/Niamey",
    "Africa/Nouakchott",
    "Africa/Ouagadougou",
    "Africa/Porto-Novo",
    "Africa/Sao_Tome",
    "Africa/Tripoli",
    "Africa/Tunis",
    "Africa/Windhoek",
    "America/Adak",
    "America/Anchorage",
    "America/Anguilla",
    "America/Antigua",
    "America/Araguaina",
    "America/Argentina/Buenos_Aires",
    "America/Argentina/Catamarca",
    "America/Argentina/Cordoba",
    "America/Argentina/Jujuy",
    "America/Argentina/La_Rioja",
    "America/Argentina/Mendoza",
    "America/Argentina/Rio_Gallegos",
    "America/Argentina/Salta",
    "America/Argentina/San_Juan",
    "America/Argentina/San_Luis",
    "America/Argentina/Tucuman",
    "America/Argentina/Ushuaia",
    "America/Aruba",
    "America/Asuncion",
    "America/Atikokan",
    "America/Bahia",
    "America/Bahia_Banderas",
    "America/Barbados",
    "America/Belem",
    "America/Belize",
    "America/Blanc-Sablon",
    "America/Boa_Vista",
    "America/Bogota",
    "America/Boise",
    "America/Cambridge_Bay",
    "America/Campo_Grande",
    "America/Cancun",
    "America/Caracas",
    "America/Cayenne",
    "America/Cayman",
    "America/Chicago",
    "America/Chihuahua",
    "America/Costa_Rica",
    "America/Creston",
    "America/Cuiaba",
    "America/Curacao",
    "America/Danmarkshavn",
    "America/Dawson",
    "America/Dawson_Creek",
    "America/Denver",
    "America/Detroit",
    "America/Dominica",
    "America/Edmonton",
    "America/Eirunepe",
    "America/El_Salvador",
    "America/Fort_Nelson",
    "America/Fortaleza",
    "America/Glace_Bay",
    "America/Goose_Bay",
    "America/Grand_Turk",
    "America/Grenada",
    "America/Guadeloupe",
    "America/Guatemala",
    "America/Guayaquil",
    "America/Guyana",
    "America/Halifax",
    "America/Havana",
    "America/Hermosillo",
    "America/Indiana/Indianapolis",
    "America/Indiana/Knox",
    "America/Indiana/Marengo",
    "America/Indiana/Petersburg",
    "America/Indiana/Tell_City",
    "America/Indiana/Vevay",
    "America/Indiana/Vincennes",
    "America/Indiana/Winamac",
    "America/Inuvik",
    "America/Iqaluit",
    "America/Jamaica",
    "America/Juneau",
    "America/Kentucky/Louisville",
    "America/Kentucky/Monticello",
    "America/Kralendijk",
    "America/La_Paz",
    "America/Lima",
    "America/Los_Angeles",
    "America/Lower_Princes",
    "America/Maceio",
    "America/Managua",
    "America/Manaus",
    "America/Marigot",
    "America/Martinique",
    "America/Matamoros",
    "America/Mazatlan",
    "America/Menominee",
    "America/Merida",
    "America/Metlakatla",
    "America/Mexico_City",
    "America/Miquelon",
    "America/Moncton",
    "America/Monterrey",
    "America/Montevideo",
    "America/Montserrat",
    "America/Nassau",
    "America/New_York",
    "America/Nipigon",
    "America/Nome",
    "America/Noronha",
    "America/North_Dakota/Beulah",
    "America/North_Dakota/Center",
    "America/North_Dakota/New_Salem",
    "America/Nuuk",
    "America/Ojinaga",
    "America/Panama",
    "America/Pangnirtung",
    "America/Paramaribo",
    "America/Phoenix",
    "America/Port-au-Prince",
    "America/Port_of_Spain",
    "America/Porto_Velho",
    "America/Puerto_Rico",
    "America/Punta_Arenas",
    "America/Rainy_River",
    "America/Rankin_Inlet",
    "America/Recife",
    "America/Regina",
    "America/Resolute",
    "America/Rio_Branco",
    "America/Santarem",
    "America/Santiago",
    "America/Santo_Domingo",
    "America/Sao_Paulo",
    "America/Scoresbysund",
    "America/Sitka",
    "America/St_Barthelemy",
    "America/St_Johns",
    "America/St_Kitts",
    "America/St_Lucia",
    "America/St_Thomas",
    "America/St_Vincent",
    "America/Swift_Current",
    "America/Tegucigalpa",
    "America/Thule",
    "America/Thunder_Bay",
    "America/Tijuana",
    "America/Toronto",
    "America/Tortola",
    "America/Vancouver",
    "America/Whitehorse",
    "America/Winnipeg",
    "America/Yakutat",
    "America/Yellowknife",
    "Antarctica/Casey",
    "Antarctica/Davis",
    "Antarctica/DumontDUrville",
    "Antarctica/Macquarie",
    "Antarctica/Mawson",
    "Antarctica/McMurdo",
    "Antarctica/Palmer",
    "Antarctica/Rothera",
    "Antarctica/Syowa",
    "Antarctica/Troll",
    "Antarctica/Vostok",
    "Arctic/Longyearbyen",
    "Asia/Aden",
    "Asia/Almaty",
    "Asia/Amman",
    "Asia/Anadyr",
    "Asia/Aqtau",
    "Asia/Aqtobe",
    "Asia/Ashgabat",
    "Asia/Atyrau",
    "Asia/Baghdad",
    "Asia/Bahrain",
    "Asia/Baku",
    "Asia/Bangkok",
    "Asia/Barnaul",
    "Asia/Beirut",
    "Asia/Bishkek",
    "Asia/Brunei",
    "Asia/Chita",
    "Asia/Choibalsan",
    "Asia/Colombo",
    "Asia/Damascus",
    "Asia/Dhaka",
    "Asia/Dili",
    "Asia/Dubai",
    "Asia/Dushanbe",
    "Asia/Famagusta",
    "Asia/Gaza",
    "Asia/Hebron",
    "Asia/Ho_Chi_Minh",
    "Asia/Hong_Kong",
    "Asia/Hovd",
    "Asia/Irkutsk",
    "Asia/Jakarta",
    "Asia/Jayapura",
    "Asia/Jerusalem",
    "Asia/Kabul",
    "Asia/Kamchatka",
    "Asia/Karachi",
    "Asia/Kathmandu",
    "Asia/Khandyga",
    "Asia/Kolkata",
    "Asia/Krasnoyarsk",
    "Asia/Kuala_Lumpur",
    "Asia/Kuching",
    "Asia/Kuwait",
    "Asia/Macau",
    "Asia/Magadan",
    "Asia/Makassar",
    "Asia/Manila",
    "Asia/Muscat",
    "Asia/Nicosia",
    "Asia/Novokuznetsk",
    "Asia/Novosibirsk",
    "Asia/Omsk",
    "Asia/Oral",
    "Asia/Phnom_Penh",
    "Asia/Pontianak",
    "Asia/Pyongyang",
    "Asia/Qatar",
    "Asia/Qostanay",
    "Asia/Qyzylorda",
    "Asia/Riyadh",
    "Asia/Sakhalin",
    "Asia/Samarkand",
    "Asia/Seoul",
    "Asia/Shanghai",
    "Asia/Singapore",
    "Asia/Srednekolymsk",
    "Asia/Taipei",
    "Asia/Tashkent",
    "Asia/Tbilisi",
    "Asia/Tehran",
    "Asia/Thimphu",
    "Asia/Tokyo",
    "Asia/Tomsk",
    "Asia/Ulaanbaatar",
    "Asia/Urumqi",
    "Asia/Ust-Nera",
    "Asia/Vientiane",
    "Asia/Vladivostok",
    "Asia/Yakutsk",
    "Asia/Yangon",
    "Asia/Yekaterinburg",
    "Asia/Yerevan",
    "Atlantic/Azores",
    "Atlantic/Bermuda",
    "Atlantic/Canary",
    "Atlantic/Cape_Verde",
    "Atlantic/Faroe",
    "Atlantic/Madeira",
    "Atlantic/Reykjavik",
    "Atlantic/South_Georgia",
    "Atlantic/St_Helena",
    "Atlantic/Stanley",
    "Australia/Adelaide",
    "Australia/Brisbane",
    "Australia/Broken_Hill",
    "Australia/Darwin",
    "Australia/Eucla",
    "Australia/Hobart",
    "Australia/Lindeman",
    "Australia/Lord_Howe",
    "Australia/Melbourne",
    "Australia/Perth",
    "Australia/Sydney",
    "Europe/Amsterdam",
    "Europe/Andorra",
    "Europe/Astrakhan",
    "Europe/Athens",
    "Europe/Belgrade",
    "Europe/Berlin",
    "Europe/Bratislava",
    "Europe/Brussels",
    "Europe/Bucharest",
    "Europe/Budapest",
    "Europe/Busingen",
    "Europe/Chisinau",
    "Europe/Copenhagen",
    "Europe/Dublin",
    "Europe/Gibraltar",
    "Europe/Guernsey",
    "Europe/Helsinki",
    "Europe/Isle_of_Man",
    "Europe/Istanbul",
    "Europe/Jersey",
    "Europe/Kaliningrad",
    "Europe/Kiev",
    "Europe/Kirov",
    "Europe/Lisbon",
    "Europe/Ljubljana",
    "Europe/London",
    "Europe/Luxembourg",
    "Europe/Madrid",
    "Europe/Malta",
    "Europe/Mariehamn",
    "Europe/Minsk",
    "Europe/Monaco",
    "Europe/Moscow",
    "Europe/Oslo",
    "Europe/Paris",
    "Europe/Podgorica",
    "Europe/Prague",
    "Europe/Riga",
    "Europe/Rome",
    "Europe/Samara",
    "Europe/San_Marino",
    "Europe/Sarajevo",
    "Europe/Saratov",
    "Europe/Simferopol",
    "Europe/Skopje",
    "Europe/Sofia",
    "Europe/Stockholm",
    "Europe/Tallinn",
    "Europe/Tirane",
    "Europe/Ulyanovsk",
    "Europe/Uzhgorod",
    "Europe/Vaduz",
    "Europe/Vatican",
    "Europe/Vienna",
    "Europe/Vilnius",
    "Europe/Volgograd",
    "Europe/Warsaw",
    "Europe/Zagreb",
    "Europe/Zaporozhye",
    "Europe/Zurich",
    "Indian/Antananarivo",
    "Indian/Chagos",
    "Indian/Christmas",
    "Indian/Cocos",
    "Indian/Comoro",
    "Indian/Kerguelen",
    "Indian/Mahe",
    "Indian/Maldives",
    "Indian/Mauritius",
    "Indian/Mayotte",
    "Indian/Reunion",
    "Pacific/Apia",
    "Pacific/Auckland",
    "Pacific/Bougainville",
    "Pacific/Chatham",
    "Pacific/Chuuk",
    "Pacific/Easter",
    "Pacific/Efate",
    "Pacific/Fakaofo",
    "Pacific/Fiji",
    "Pacific/Funafuti",
    "Pacific/Galapagos",
    "Pacific/Gambier",
    "Pacific/Guadalcanal",
    "Pacific/Guam",
    "Pacific/Honolulu",
    "Pacific/Kanton",
    "Pacific/Kiritimati",
    "Pacific/Kosrae",
    "Pacific/Kwajalein",
    "Pacific/Majuro",
    "Pacific/Marquesas",
    "Pacific/Midway",
    "Pacific/Nauru",
    "Pacific/Niue",
    "Pacific/Norfolk",
    "Pacific/Noumea",
    "Pacific/Pago_Pago",
    "Pacific/Palau",
    "Pacific/Pitcairn",
    "Pacific/Pohnpei",
    "Pacific/Port_Moresby",
    "Pacific/Rarotonga",
    "Pacific/Saipan",
    "Pacific/Tahiti",
    "Pacific/Tarawa",
    "Pacific/Tongatapu",
    "Pacific/Wake",
    "Pacific/Wallis",
    "UTC"
]

Request   

GET api/timezones

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Goals

API endpoints for goals

The goals module consists of:

List grips

requires authentication

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

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

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

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

Example response (200):


[
    {
        "id": 1,
        "number": 3529,
        "name": "neque grip",
        "description": null,
        "opposed": 0,
        "created_at": "2025-12-08T15:50:45.000000Z",
        "updated_at": "2025-12-08T15:50:45.000000Z"
    },
    {
        "id": 2,
        "number": 2073,
        "name": "quis grip",
        "description": null,
        "opposed": 0,
        "created_at": "2025-12-08T15:50:45.000000Z",
        "updated_at": "2025-12-08T15:50:45.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view grips",
    "code": "GOALS:LIST_GRIPS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/grips

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

model   integer  optional  

Device Model ID. Use this parameter to receive the correct grip images in the image field. When not present, all images will be listed in images array. Example: 1

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.Regan Trafficway",
            "description": "exercises.Dolor laboriosam maxime suscipit facilis atque quia laboriosam.",
            "icon": "😷",
            "created_at": "2025-12-08T15:50:45.000000Z",
            "updated_at": "2025-12-08T15:50:45.000000Z"
        },
        {
            "id": 2,
            "name": "exercises.O'Connell Flat",
            "description": "exercises.Accusamus eum tempore architecto iusto omnis dolor.",
            "icon": "😷",
            "created_at": "2025-12-08T15:50:45.000000Z",
            "updated_at": "2025-12-08T15:50:45.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view exercises",
    "code": "GOALS:LIST_EXERCISES:INSUFFICIENT_PERMISSION"
}

Request   

GET api/exercises

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

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.Cloyd Lane",
    "description": "exercises.Repudiandae aut vero dolorum.",
    "icon": "😯",
    "created_at": "2025-12-08T15:50:45.000000Z",
    "updated_at": "2025-12-08T15:50:45.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage exercises",
    "code": "GOALS:CREATE_EXERCISE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/exercises

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Exercise name. Example: Water plants

description   string   

Exercise description. Example: Use Tripod Close Grip and water your plants

icon   string   

Emoji icon. Example: 🪴

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.Glennie Flats",
    "description": "exercises.Consequatur similique aut earum.",
    "icon": "😃",
    "created_at": "2025-12-08T15:50:45.000000Z",
    "updated_at": "2025-12-08T15:50:45.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage exercises",
    "code": "GOALS:UPDATE_EXERCISE:INSUFFICIENT_PERMISSION"
}

Example response (404, Exercise not found):


{
    "message": "Exercise not found",
    "code": "GOALS:UPDATE_EXERCISE:EXERCISE_NOT_FOUND"
}

Request   

PUT api/exercises/{exerciseId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

exerciseId   integer   

Exercise ID. Example: 1

Body Parameters

name   string  optional  

Exercise name. Example: Water plants

description   string  optional  

Exercise description. Example: Use Tripod Close Grip and water your plants

icon   string  optional  

Emoji icon. Example: 🪴

Delete exercise

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Exercise deleted",
    "code": "GOALS:DELETE_EXERCISE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage exercises",
    "code": "GOALS:DELETE_EXERCISE:INSUFFICIENT_PERMISSION"
}

Example response (403, Exercise is used in goals):


{
    "message": "Cannot delete: exercise is used in goals (1)",
    "code": "GOALS:DELETE_EXERCISE:HAS_GOALS"
}

Example response (404, Exercise not found):


{
    "message": "Exercise not found",
    "code": "GOALS:DELETE_EXERCISE:EXERCISE_NOT_FOUND"
}

Request   

DELETE api/exercises/{exerciseId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

exerciseId   integer   

Exercise ID. Example: 1

List user goals

requires authentication

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

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

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "amputee_id": 258,
            "clinician_id": 259,
            "start_date": "1998-02-17",
            "end_date": "1978-09-11",
            "active": 0,
            "created_at": "2025-12-08T15:50:46.000000Z",
            "updated_at": "2025-12-08T15:50:46.000000Z"
        },
        {
            "id": 2,
            "amputee_id": 260,
            "clinician_id": 261,
            "start_date": "2004-09-23",
            "end_date": "2010-06-04",
            "active": 1,
            "created_at": "2025-12-08T15:50:46.000000Z",
            "updated_at": "2025-12-08T15:50:46.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view user goals",
    "code": "GOALS:LIST_GOALS:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "GOALS:LIST_GOALS:USER_NOT_FOUND"
}

Request   

GET api/user/{userId}/goals

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Query Parameters

active   boolean  optional  

Goal active status. Example: 1

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

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": 262,
    "clinician_id": 263,
    "start_date": "2016-04-02",
    "end_date": "1991-03-18",
    "active": 0,
    "created_at": "2025-12-08T15:50:46.000000Z",
    "updated_at": "2025-12-08T15:50:46.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user goals",
    "code": "GOALS:CREATE_GOAL:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "GOALS:CREATE_GOAL:USER_NOT_FOUND"
}

Request   

POST api/user/{userId}/goals

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Body Parameters

start_date   string   

Start date of the goal tracking. MUST_BE_DATE Must be a valid date in the format Y-m-d. MUST_BE_AFTER_OR_EQUAL:today. Example: 2023-05-12

end_date   string   

End date of goal tracking. MUST_BE_DATE Must be a valid date in the format Y-m-d. MUST_BE_AFTER:start_date. Example: 2023-05-15

active   boolean  optional  

Status of goal activity. Example: true

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": 264,
    "clinician_id": 265,
    "start_date": "1997-02-04",
    "end_date": "1996-11-05",
    "active": 1,
    "created_at": "2025-12-08T15:50:46.000000Z",
    "updated_at": "2025-12-08T15:50: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"
}

Request   

PUT api/user/{userId}/goals/{goalId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

goalId   integer   

Goal ID. Example: 1

Body Parameters

start_date   string  optional  

Start date of the goal tracking. MUST_BE_DATE Must be a valid date in the format Y-m-d. MUST_BE_AFTER_OR_EQUAL:today. Example: 2023-05-12

end_date   string  optional  

End date of goal tracking. MUST_BE_DATE Must be a valid date in the format Y-m-d. MUST_BE_AFTER:start_date. Example: 2023-05-15

active   boolean  optional  

Status of goal activity. Example: true

Delete user goal

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Goal deleted",
    "code": "GOALS:DELETE_GOAL:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user goals",
    "code": "GOALS:DELETE_GOAL:INSUFFICIENT_PERMISSION"
}

Example response (403, Cannot delete ongoing goal):


{
    "message": "Cannot delete active ongoing goal",
    "code": "GOALS:DELETE_GOAL:GOAL_IS_ONGOING"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "GOALS:DELETE_GOAL:USER_NOT_FOUND"
}

Example response (404, Goal not found):


{
    "message": "Goal not found",
    "code": "GOALS:DELETE_GOAL:GOAL_NOT_FOUND"
}

Request   

DELETE api/user/{userId}/goals/{goalId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

goalId   integer   

Goal ID. Example: 1

List user goal conditions

requires authentication

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

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "goal_id": 5,
            "type": "exercise",
            "grip_id": 3,
            "grips_frequency": "m",
            "grips_count": 439,
            "switches_frequency": "w",
            "switches_count": 671,
            "exercise_id": 5,
            "exercise_frequency": "m",
            "exercise_count": 6,
            "created_at": "2025-12-08T15:50:46.000000Z",
            "updated_at": "2025-12-08T15:50:46.000000Z"
        },
        {
            "id": 2,
            "goal_id": 6,
            "type": "exercise",
            "grip_id": 4,
            "grips_frequency": "w",
            "grips_count": 1000,
            "switches_frequency": "d",
            "switches_count": 526,
            "exercise_id": 6,
            "exercise_frequency": "d",
            "exercise_count": 10,
            "created_at": "2025-12-08T15:50:46.000000Z",
            "updated_at": "2025-12-08T15:50:46.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view user goals",
    "code": "GOALS:LIST_CONDITIONS:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "GOALS:LIST_CONDITIONS:USER_NOT_FOUND"
}

Example response (404, Goal not found):


{
    "message": "Goal not found",
    "code": "GOALS:LIST_CONDITIONS:GOAL_NOT_FOUND"
}

Request   

GET api/user/{userId}/goals/{goalId}/conditions

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

goalId   integer   

Goal ID. Example: 1

Create user goal condition

requires authentication

Each goal condition could be one of type: grip, switch or exercise.

If goal condition is type of grip, fill only grip_id (optional), grips_frequency and grips_count.
If grip_id is null or missing, patient can perform any grip to fulfill objective.

If goal condition is type of switch, fill only switches_frequency and switches_count.

If goal condition is type of exercise, fill only exercise_id, exercise_frequency and exercise_count.


Restrictions:

  • you can add one grip-any condition (grip_id=null, any grip is counted) and many grip-specific conditions (for example: grip 1 - 100 times and grip 2 - 50 times),
  • all grips conditions must have same frequency (grips_frequency field),
  • sum of grip-specific conditions (grips_count field) cannot be greater than grip-any condition for same goal
  • you can add only one switch condition for same goal,
  • you can add multiple exercise conditions, but each exercise can be used only once.
Example request:
curl --request POST \
    "http://localhost:8000/api/user/1/goals/1/conditions" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"grip\",
    \"grip_id\": 1,
    \"grips_frequency\": \"d\",
    \"grips_count\": 100,
    \"switches_frequency\": \"d\",
    \"switches_count\": 100,
    \"exercise_id\": 1,
    \"exercise_frequency\": \"d\",
    \"exercise_count\": 5
}"

const url = new URL(
    "http://localhost:8000/api/user/1/goals/1/conditions"
);

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

let body = {
    "type": "grip",
    "grip_id": 1,
    "grips_frequency": "d",
    "grips_count": 100,
    "switches_frequency": "d",
    "switches_count": 100,
    "exercise_id": 1,
    "exercise_frequency": "d",
    "exercise_count": 5
};

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

Example response (201):


{
    "id": 3,
    "goal_id": 7,
    "type": "grip",
    "grip_id": 5,
    "grips_frequency": "d",
    "grips_count": 533,
    "switches_frequency": "w",
    "switches_count": 74,
    "exercise_id": 7,
    "exercise_frequency": "d",
    "exercise_count": 4,
    "created_at": "2025-12-08T15:50:46.000000Z",
    "updated_at": "2025-12-08T15:50:46.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user goals",
    "code": "GOALS:CREATE_CONDITION:INSUFFICIENT_PERMISSION"
}

Example response (403, Cannot create condition: all grip conditions have to be same frequency):


{
    "message": "Cannot create condition: all grip conditions have to be same frequency",
    "code": "GOALS:CREATE_CONDITION:INVALID_FREQUENCY"
}

Example response (403, Cannot create condition: grip-any condition for this goal already exist):


{
    "message": "Cannot create condition: grip-any condition for this goal already exist",
    "code": "GOALS:CREATE_CONDITION:GRIP_ANY_ALREADY_EXISTS"
}

Example response (403, Cannot create condition: condition with this grip already exist):


{
    "message": "Cannot create condition: condition with this grip already exist",
    "code": "GOALS:CREATE_CONDITION:GRIP_CONDITION_ALREADY_EXISTS"
}

Example response (403, Cannot create condition: grip-any value cannot be lower than sum of grip-specific conditions):


{
    "message": "Cannot create condition: grip-any value cannot be lower than sum of grip-specific conditions",
    "code": "GOALS:CREATE_CONDITION:GRIP_ANY_LOWER_THAN_GRIPS_SUM"
}

Example response (403, Cannot create condition: sum of grip-specific conditions cannot be greater than value of grip-any condition):


{
    "message": "Cannot create condition: sum of grip-specific conditions cannot be greater than value of grip-any condition",
    "code": "GOALS:CREATE_CONDITION:GRIPS_SUM_GREATER_THAN_GRIP_ANY"
}

Example response (403, Cannot create condition: switch condition for this goal already exist):


{
    "message": "Cannot create condition: switch condition for this goal already exist",
    "code": "GOALS:CREATE_CONDITION:SWITCH_CONDITION_ALREADY_EXISTS"
}

Example response (403, Cannot create condition: condition with this exercise already exist):


{
    "message": "Cannot create condition: condition with this exercise already exist",
    "code": "GOALS:CREATE_CONDITION:EXERCISE_CONDITION_ALREADY_EXISTS"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "GOALS:CREATE_CONDITION:USER_NOT_FOUND"
}

Example response (404, Goal not found):


{
    "message": "Goal not found",
    "code": "GOALS:CREATE_CONDITION:GOAL_NOT_FOUND"
}

Request   

POST api/user/{userId}/goals/{goalId}/conditions

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

goalId   integer   

Goal ID. Example: 1

Body Parameters

type   string   

Goal condition type. Example: grip

Must be one of:
  • grip
  • switch
  • exercise
grip_id   integer  optional  

Grip number required for condition. Pass null to allow any grip. The id of an existing record in the App\Models\Grip table. Example: 1

grips_frequency   string  optional  

Grips frequency unit. d - daily, w - weekly, m - monthly, a - all time (within goal). This field is required when type is grip. Example: d

Must be one of:
  • d
  • w
  • m
  • a
grips_count   integer  optional  

Required number of grips per frequency unit. This field is required when type is grip. MINIMUM:NUMBER:1. Example: 100

switches_frequency   string  optional  

Switches frequency unit. d - daily, w - weekly, m - monthly, a - all time (within goal). This field is required when type is switch. Example: d

Must be one of:
  • d
  • w
  • m
  • a
switches_count   integer  optional  

Required number of switches per frequency unit. This field is required when type is switch. MINIMUM:NUMBER:1. Example: 100

exercise_id   integer  optional  

Exercise ID. This field is required when type is exercise. The id of an existing record in the App\Models\Exercise table. Example: 1

exercise_frequency   string  optional  

Exercise frequency unit. d - daily, w - weekly, m - monthly. This field is required when type is exercise. Example: d

Must be one of:
  • d
  • w
  • m
exercise_count   integer  optional  

Required number of performed exercises per frequency unit. This field is required when type is exercise. MINIMUM:NUMBER:1. Example: 5

Delete user goal condition

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Goal condition deleted",
    "code": "GOALS:DELETE_CONDITION:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user goals",
    "code": "GOALS:DELETE_CONDITION:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "GOALS:DELETE_CONDITION:USER_NOT_FOUND"
}

Example response (404, Goal not found):


{
    "message": "Goal not found",
    "code": "GOALS:DELETE_CONDITION:GOAL_NOT_FOUND"
}

Request   

DELETE api/user/{userId}/goals/{goalId}/conditions/{conditionId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

goalId   integer   

Goal ID. Example: 1

conditionId   integer   

Goal condition ID. Example: 1

Get user goal progress

requires authentication

Data is grouped into three parts:
  • grips - data about grips progress,
  • switches - data about switches progress,
  • exercises - data about exercises progress and attempts made.
For grips and switches there is summary, which is divided into 4 parts:
  • overall - summary of whole goal time-frame,
  • period - summary of given period, according to frequency (for example: if frequency of conditions is "weekly", these data is summary of current's week).
  • today - summary of today's, used mainly to send daily summary notifications,
  • conditions - goal conditions with progress for each one.
There are also extra fields inside the summary parts:
  • type for grips overall summary, which points which conditions were used to calculate the summary. If grip-any condition exists, it has priority over grip-specific conditions, otherwise summary contains sum of all grip-specific conditions,
  • frequency, frequency_from and frequency_to for period summary for both grips and switches, which describe time-frame of frequency and period,
  • done for today's summary for both grips and switches, indicates if today's goal is reached (it's calculated only for conditions of frequency "daily").
Example request:
curl --request GET \
    --get "http://localhost:8000/api/goals/1/progress" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/goals/1/progress"
);

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

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

Example response (200, OK):


{
    "grips": {
        "meta": {
            "overall": {
                "from": "2023-09-01 00:00:00",
                "to": "2023-08-30 23:59:59"
            },
            "period": {
                "from": "2023-09-15 23:59:59",
                "to": "2023-09-21 23:59:59",
                "frequency": "w"
            }
        },
        "summary": {
            "type": "grips-specific",
            "progress": 222,
            "goal": 2535
        },
        "progress": [
            {
                "grip": {
                    "id": 1,
                    "number": 0,
                    "name": "Rest Opposition",
                    "description": null,
                    "created_at": "2023-08-30T12:20:00.000000Z",
                    "updated_at": "2023-08-30T12:20:00.000000Z"
                },
                "overall": {
                    "progress": 125,
                    "goal": 200
                },
                "period": {
                    "progress": 22,
                    "goal": 50
                }
            },
            {
                "grip": {
                    "id": 2,
                    "number": 1,
                    "name": "Power",
                    "description": null,
                    "created_at": "2023-05-18T11:24:11.000000Z",
                    "updated_at": "2023-05-18T11:24:11.000000Z"
                },
                "overall": {
                    "progress": 90,
                    "goal": 150
                },
                "period": {
                    "progress": 10,
                    "goal": 30
                }
            },
            {
                "grip": null,
                "overall": {
                    "progress": 78,
                    "goal": 1250
                },
                "period": {
                    "progress": 17,
                    "goal": 240
                }
            }
        ],
        "today": {
            "performed": 0,
            "goal": 0,
            "done": true
        }
    },
    "switches": {
        "overall": {
            "performed": 55,
            "goal": 300
        },
        "period": {
            "performed": 25,
            "goal": 30,
            "frequency": "d",
            "frequency_from": "2023-09-20 00:00:00",
            "frequency_to": "2023-09-20 23:59:59"
        },
        "today": {
            "performed": 25,
            "goal": 30,
            "done": false
        },
        "condition": {
            "type": "switch",
            "switches_frequency": "d",
            "switches_count": 30
        }
    },
    "exercises": {
        "performed": 1,
        "goal": 3,
        "done": false,
        "conditions": [
            {
                "type": "exercise",
                "exercise_id": 1,
                "exercise_frequency": "d",
                "exercise_count": 3,
                "attempts": [
                    {
                        "date_from": "2023-06-06",
                        "date_to": "2023-06-12",
                        "count_done": 1,
                        "count_not_done": 1
                    },
                    {
                        "date_from": "2023-06-13",
                        "date_to": "2023-06-19",
                        "count_done": 0,
                        "count_not_done": 0
                    },
                    {
                        "date_from": "2023-06-20",
                        "date_to": "2023-06-26",
                        "count_done": 0,
                        "count_not_done": 0
                    },
                    {
                        "date_from": "2023-06-27",
                        "date_to": "2023-07-03",
                        "count_done": 0,
                        "count_not_done": 0
                    }
                ],
                "exercise": {
                    "id": 1,
                    "name": "Water plants",
                    "description": "Use Tripod Grip and water your plants",
                    "icon": "🪴",
                    "created_at": "2023-05-19T10:25:37.000000Z",
                    "updated_at": "2023-05-19T10:25:37.000000Z"
                }
            }
        ]
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view goal progress",
    "code": "GOALS:GET_PROGRESS:INSUFFICIENT_PERMISSION"
}

Example response (404, Goal not found):


{
    "message": "Goal not found",
    "code": "GOALS:GET_PROGRESS:GOAL_NOT_FOUND"
}

Request   

GET api/goals/{goalId}/progress

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

goalId   integer   

Goal ID. Example: 1

Update user goal progress

requires authentication

Use this endpoint to update goal progress as patient. Add exercise attempts and mark them as done or not done.

Example request:
curl --request POST \
    "http://localhost:8000/api/goals/1/progress" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"exercise_id\": 1,
    \"exercise_done\": true
}"

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

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

let body = {
    "exercise_id": 1,
    "exercise_done": true
};

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

Example response (202):


{
    "id": 1,
    "user_id": 272,
    "goal_id": 8,
    "type": "exercise",
    "grip_id": null,
    "grips": 58,
    "switches": 570,
    "exercise_id": 8,
    "exercise_done": 0,
    "created_at": "2025-12-08T15:50:47.000000Z",
    "updated_at": "2025-12-08T15:50:47.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update goal progress",
    "code": "GOALS:UPDATE_PROGRESS:INSUFFICIENT_PERMISSION"
}

Example response (404, Goal not found):


{
    "message": "Goal not found",
    "code": "GOALS:UPDATE_PROGRESS:GOAL_NOT_FOUND"
}

Example response (422, User timezone not set):


{
    "message": "User timezone not set",
    "code": "GOALS:UPDATE_PROGRESS:NO_TIMEZONE"
}

Request   

POST api/goals/{goalId}/progress

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

goalId   integer   

Goal ID. Example: 1

Body Parameters

exercise_id   integer   

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

exercise_done   boolean  optional  

Status of exercise attempt. Example: true

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\": \"719 Drew Plains Apt. 460\",
    \"address2\": \"Hartmannmouth, OK 18287\",
    \"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": "719 Drew Plains Apt. 460",
    "address2": "Hartmannmouth, OK 18287",
    "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": "YSIKLVGA1765209022",
    "name": "Queenie Hilpert",
    "email": "1765209022samara49@example.net",
    "language": "en",
    "phone": "(929) 267-6389",
    "phone_country": "NR",
    "phone_verified_at": null,
    "address1": "22993 Terry Highway Apt. 362",
    "address2": "Darronton, IL 01338",
    "postal_code": "49805-7918",
    "city": "Braun, Nader and Schowalter",
    "clinic_name": "Port Estell",
    "clinic_location": "322 Eric Camp Suite 086\nDavisview, CO 39030",
    "image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2025-12-08T15:50:22.000000Z",
    "updated_at": "2025-12-08T15:50:22.000000Z",
    "invitation_status": "accepted",
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 3,
            "name": "Clinician"
        }
    ]
}

Example response (403, Invitation expired):


{
    "message": "Invitation expired",
    "code": "INVITATIONS:ACCEPT:INVITATION_EXPIRED"
}

Example response (404, Invitation not found):


{
    "message": "Invitation not found",
    "code": "INVITATIONS:ACCEPT:INVITATION_NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error: invitation not accepted",
    "code": "INVITATIONS:ACCEPT:SERVER_ERROR"
}

Request   

POST api/invite/accept

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

Invitation token sent by e-mail. SIZE:STRING_LENGTH:24. Example: ABC123DEF456GHI789JKL0

email   string   

User e-mail. MUST_BE_EMAIL The email of an existing record in the App\Models\User table. Example: example@domain.com

password   string   

User password. Example: Test123!

language   string   

User language. Example: en

name   string   

User name. Example: Tom Smith

clinic_name   string  optional  

Clinic name. Example: My clinic Ltd

clinic_location   string  optional  

Clinic location. Example: Example St 1/345 New York, NY

address1   string  optional  

User address line 1. Example: 719 Drew Plains Apt. 460

address2   string  optional  

User address line 2. Example: Hartmannmouth, OK 18287

mfa_enabled   boolean  optional  

MFA enabled. Example: true

mfa_method   string  optional  

MFA method. Example: email

Must be one of:
  • email
  • sms

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.386.387.7421\",
    \"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.386.387.7421",
    "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": "SE0Y0SLX1765209022",
    "name": "Edwardo Aufderhar I",
    "email": "1765209022bbraun@example.net",
    "language": "en",
    "phone": "+17625827811",
    "phone_country": "MD",
    "phone_verified_at": null,
    "address1": "83964 Stracke Highway Suite 677",
    "address2": "East Dax, MT 37428-1092",
    "postal_code": "78539-9142",
    "city": "Koelpin-Parisian",
    "clinic_name": "East Ellenside",
    "clinic_location": "3321 Rosina Shores Suite 207\nJewellfurt, UT 65147-5546",
    "image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2025-12-08T15:50:22.000000Z",
    "updated_at": "2025-12-08T15:50:22.000000Z",
    "invitation_status": null,
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 5,
            "name": "Amputee"
        }
    ]
}

Example response (403, Invitation expired):


{
    "message": "Invitation expired",
    "code": "INVITATIONS_ACADLE:ACCEPT:INVITATION_EXPIRED"
}

Example response (404, Invitation not found):


{
    "message": "Invitation not found",
    "code": "INVITATIONS_ACADLE:ACCEPT:INVITATION_NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error: invitation not accepted",
    "code": "INVITATIONS_ACADLE:ACCEPT:SERVER_ERROR"
}

Request   

POST api/invite/acadle/accept

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

Invitation token. SIZE:STRING_LENGTH:24. Example: a1b2c3d4e5f6g7h8i9j0k1l2m3

email   string   

Email address of the Acadle user. MUST_BE_EMAIL The email of an existing record in the App\Models\User table. Example: user@example.com

password   string   

User password. Example: securePassword123

phone   string   

User phone number. Example: +1.386.387.7421

phone_country   string   

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

name   string   

User name. Example: John Doe

language   string   

User preferred language. Example: en

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": "HUNGA3RU1765209024",
            "name": "Jordy O'Reilly",
            "email": "1765209024gschultz@example.net",
            "language": "en",
            "phone": "(909) 975-6799",
            "phone_country": "DO",
            "phone_verified_at": null,
            "address1": "889 Randal Common Apt. 968",
            "address2": "East Brice, DC 29957",
            "postal_code": "50986",
            "city": "Mohr, Kuvalis and Rolfson",
            "clinic_name": "Lake Nico",
            "clinic_location": "5585 Weston Loaf\nNorth Lyricland, DE 98706",
            "image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2025-12-08T15:50:24.000000Z",
            "updated_at": "2025-12-08T15:50:24.000000Z",
            "invitation_status": "accepted",
            "acadle_invitation_status": null,
            "roles": [
                {
                    "id": 2,
                    "name": "ClinicAdmin"
                }
            ]
        },
        {
            "id": 16,
            "mrn": "AD3VWERJ1765209024",
            "name": "Vernon Altenwerth",
            "email": "1765209024konopelski.velva@example.net",
            "language": "en",
            "phone": "+1-312-646-8822",
            "phone_country": "PM",
            "phone_verified_at": null,
            "address1": "53608 Lucy Avenue",
            "address2": "North Santiagoville, FL 20510",
            "postal_code": "64442-3483",
            "city": "Eichmann Ltd",
            "clinic_name": "Colemouth",
            "clinic_location": "4163 Stella Lock\nLake Betty, WV 88766-6532",
            "image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2025-12-08T15:50:24.000000Z",
            "updated_at": "2025-12-08T15:50:24.000000Z",
            "invitation_status": null,
            "acadle_invitation_status": null,
            "roles": [
                {
                    "id": 1,
                    "name": "SuperAdmin"
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list users for invitations",
    "code": "INVITATIONS:USERS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/invite/users

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: clinicians, patients, devices, devicesAsClinician, roles, permissions).

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\": [
                \"provident\"
            ]
        }
    ]
}"

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": [
                "provident"
            ]
        }
    ]
};

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": "EFVZ7OHG1765209024",
            "name": "Hattie Lindgren",
            "email": "1765209024rohan.destinee@example.com",
            "language": "en",
            "phone": "534.288.3518",
            "phone_country": "AS",
            "phone_verified_at": null,
            "address1": "37980 Simonis Ridges Suite 736",
            "address2": "Port Porter, MO 04155-2345",
            "postal_code": "18990-5188",
            "city": "Schinner and Sons",
            "clinic_name": "Jaynemouth",
            "clinic_location": "20517 Leannon Walk\nPricemouth, NM 33889-1581",
            "image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2025-12-08T15:50:24.000000Z",
            "updated_at": "2025-12-08T15:50:24.000000Z",
            "invitation_status": "accepted",
            "acadle_invitation_status": null,
            "invitations": [
                {
                    "id": 1,
                    "user_id": 18,
                    "invited_user_id": 17,
                    "type": "clinician",
                    "training_confirmed": 0,
                    "created_at": "2025-12-08T15:50:24.000000Z",
                    "updated_at": "2025-12-08T15:50:24.000000Z"
                }
            ],
            "roles": [
                {
                    "id": 3,
                    "name": "Clinician"
                }
            ]
        },
        {
            "id": 20,
            "mrn": "GI9HJFP91765209024",
            "name": "Dr. Jeffrey Schulist",
            "email": "1765209024lhaley@example.net",
            "language": "en",
            "phone": "623.551.0460",
            "phone_country": "TK",
            "phone_verified_at": null,
            "address1": "1991 Deckow Walk Apt. 279",
            "address2": "Kreigerchester, RI 44469-4463",
            "postal_code": "69569-7409",
            "city": "Douglas, Paucek and Huels",
            "clinic_name": "Port Kennedyfort",
            "clinic_location": "3137 Citlalli Lake Apt. 807\nPort Coralie, NY 68064",
            "image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2025-12-08T15:50:24.000000Z",
            "updated_at": "2025-12-08T15:50:24.000000Z",
            "invitation_status": "accepted",
            "acadle_invitation_status": null,
            "invitations": [
                {
                    "id": 2,
                    "user_id": 21,
                    "invited_user_id": 20,
                    "type": "clinician",
                    "training_confirmed": 0,
                    "created_at": "2025-12-08T15:50:24.000000Z",
                    "updated_at": "2025-12-08T15:50:24.000000Z"
                }
            ],
            "roles": [
                {
                    "id": 4,
                    "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"
}

Request   

POST api/invite

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

patient_id   string   

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

invitations   object[]   

List of invitations (maximum entries: 10, array of objects).
user_id   integer  optional  

Invited user ID. Use only for existing users. Don't use together with user_email. This field is required when invitations.*.user_email is not present. The id of an existing record in the App\Models\User table. Example: 1

user_email   string  optional  

Invited user e-mail. Use only for non-existing users. Don't use together with user_id. This field is required when invitations.*.user_id is not present. MUST_BE_EMAIL. Example: newuser@domain.com

role   string  optional  

Invited user role. Use only for non-existing users. This field is required when invitations.*.user_id is not present. Example: Clinician

Must be one of:
  • ClinicAdmin
  • Clinician
  • ClinicianSupport
training_confirmed   boolean   

Confirmation that invited user was properly trained to use ADP. Must be accepted. Example: true

permissions   string[]  optional  

List of permissions to assign to the user (use that for ClinicianSupport role).

permissions[]   string  optional  

Permission name. Example: nam

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": "VVQZP5EQ1765209024",
    "name": "Dr. Edwin Bahringer",
    "email": "1765209024mluettgen@example.net",
    "language": "en",
    "phone": "+18709478988",
    "phone_country": "CG",
    "phone_verified_at": null,
    "address1": "850 Vella Drive",
    "address2": "Port Evie, MO 08906-5360",
    "postal_code": "74862",
    "city": "Kovacek-Schultz",
    "clinic_name": "Reyborough",
    "clinic_location": "941 Walter Rapid\nWest Jermain, SD 39006",
    "image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2025-12-08T15:50:24.000000Z",
    "updated_at": "2025-12-08T15:50:24.000000Z",
    "invitation_status": null,
    "acadle_invitation_status": "accepted",
    "invitations": [
        {
            "id": 3,
            "user_id": 24,
            "invited_user_id": 23,
            "type": "clinician",
            "training_confirmed": 0,
            "created_at": "2025-12-08T15:50:24.000000Z",
            "updated_at": "2025-12-08T15:50:24.000000Z"
        }
    ],
    "roles": [
        {
            "id": 6,
            "name": "AcadleUser"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to resend invitations",
    "code": "INVITATIONS:RESEND:INSUFFICIENT_PERMISSION"
}

Example response (403, User not found):


{
    "message": "User not found",
    "code": "INVITATIONS:RESEND:USER_NOT_FOUND"
}

Example response (403, Invitation already accepted):


{
    "message": "Invitation already accepted",
    "code": "INVITATIONS:RESEND:INVITATION_ALREADY_ACCEPTED"
}

Request   

POST api/invite/{userId}/resend

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

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": "ZKX4PKY41765209024",
            "name": "Miss Juana Hyatt Jr.",
            "email": "1765209024mabelle.durgan@example.net",
            "language": "en",
            "phone": "+14085645704",
            "phone_country": "LR",
            "phone_verified_at": null,
            "address1": "2530 Bennett Village Apt. 807",
            "address2": "Sarinamouth, NM 63419",
            "postal_code": "31579",
            "city": "Gleichner, Jakubowski and Renner",
            "clinic_name": "Tadland",
            "clinic_location": "50617 O'Kon Ways\nNorth Justusshire, OR 27830",
            "image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2025-12-08T15:50:25.000000Z",
            "updated_at": "2025-12-08T15:50:25.000000Z",
            "invitation_status": "accepted",
            "acadle_invitation_status": null,
            "roles": [
                {
                    "id": 2,
                    "name": "ClinicAdmin"
                }
            ]
        },
        {
            "id": 27,
            "mrn": "I928E6OY1765209025",
            "name": "Haskell Daniel",
            "email": "1765209025cmitchell@example.com",
            "language": "en",
            "phone": "+15594698869",
            "phone_country": "BJ",
            "phone_verified_at": null,
            "address1": "463 Florence Place Apt. 310",
            "address2": "North Medabury, MT 66696",
            "postal_code": "82665-4180",
            "city": "Nikolaus-Bauch",
            "clinic_name": "Stiedemannville",
            "clinic_location": "2403 Dominique Island\nChristamouth, AZ 07884",
            "image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2025-12-08T15:50:25.000000Z",
            "updated_at": "2025-12-08T15:50:25.000000Z",
            "invitation_status": "accepted",
            "acadle_invitation_status": null,
            "roles": [
                {
                    "id": 4,
                    "name": "ClinicianSupport"
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list users for invitations",
    "code": "INVITATIONS_ACADLE:USERS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/invite/acadle/users

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

search   string  optional  

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

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

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

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

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\": \"kareem.mann@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": "kareem.mann@example.org"
};

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

Example response (201):


{
    "id": 28,
    "mrn": "LH24E8AC1765209025",
    "name": "Shanna Schroeder MD",
    "email": "1765209025grady83@example.org",
    "language": "en",
    "phone": "(813) 939-5889",
    "phone_country": "HN",
    "phone_verified_at": null,
    "address1": "968 Halie Ramp",
    "address2": "Nelsonport, NM 13117",
    "postal_code": "66663-0615",
    "city": "Schultz, Grimes and Marvin",
    "clinic_name": "Keonview",
    "clinic_location": "2452 Murazik Ford Suite 875\nGloverville, OH 02447-6036",
    "image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2025-12-08T15:50:25.000000Z",
    "updated_at": "2025-12-08T15:50:25.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": "2025-12-08T15:50:25.000000Z",
            "updated_at": "2025-12-08T15:50:25.000000Z"
        }
    ],
    "roles": [
        {
            "id": 4,
            "name": "ClinicianSupport"
        }
    ]
}

Example response (400, User already exists):


{
    "message": "User with this email already exists in the system",
    "code": "INVITATIONS_ACADLE:CREATE:USER_ALREADY_EXISTS"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create invitations",
    "code": "INVITATIONS_ACADLE:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/invite/acadle

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

Email address of the Acadle user. Example: kareem.mann@example.org

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": "N13TBQ9C1765209025",
    "name": "Zoe Wyman DDS",
    "email": "1765209025douglas.mandy@example.org",
    "language": "en",
    "phone": "931-834-7420",
    "phone_country": "AS",
    "phone_verified_at": null,
    "address1": "977 Davis Parkways",
    "address2": "Aubreeport, CA 73200",
    "postal_code": "84326",
    "city": "Lesch, Grady and Hansen",
    "clinic_name": "Jasthaven",
    "clinic_location": "625 Carey Pines\nBridgetshire, AK 11566",
    "image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2025-12-08T15:50:25.000000Z",
    "updated_at": "2025-12-08T15:50:25.000000Z",
    "invitation_status": "accepted",
    "acadle_invitation_status": null,
    "invitations": [
        {
            "id": 5,
            "user_id": 32,
            "invited_user_id": 31,
            "type": "clinician",
            "training_confirmed": 1,
            "created_at": "2025-12-08T15:50:25.000000Z",
            "updated_at": "2025-12-08T15:50:25.000000Z"
        }
    ],
    "roles": [
        {
            "id": 4,
            "name": "ClinicianSupport"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to resend invitations",
    "code": "INVITATIONS_ACADLE:RESEND:INSUFFICIENT_PERMISSION"
}

Example response (403, User not found):


{
    "message": "User not found",
    "code": "INVITATIONS_ACADLE:RESEND:USER_NOT_FOUND"
}

Example response (403, Invitation already accepted):


{
    "message": "Invitation already accepted",
    "code": "INVITATIONS_ACADLE:RESEND:INVITATION_ALREADY_ACCEPTED"
}

Request   

POST api/invite/acadle/{userId}/resend

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Admin access to invitation tokens

requires authentication

Requires admin.invitations_tokens_access permission.
Fetches only non-accepted and non-expired invitations.

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

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

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

Example response (200, OK):


[
    {
        "id": 1,
        "user_id": 1,
        "invited_user_id": 2,
        "token": "I0V25NUVMHC0F8RRF1YEY5BT",
        "training_confirmed": 1,
        "created_at": "2025-05-12T12:00:00.000000Z",
        "updated_at": "2025-05-12T12:00:00.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to get invitation tokens",
    "code": "INVITATIONS:ADMIN_TOKENS:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "INVITATIONS:ADMIN_TOKENS:USER_NOT_FOUND"
}

Request   

GET api/invite/tokens/{userId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Logs

API endpoints for managing event logs

Get events log

requires authentication

user - user account that performed the action
element - element model that has been affected by the action

Example request:
curl --request GET \
    --get "http://localhost:8000/api/logs?search=Test&ip=200.200.100.5&user=1&type=user&date_from=1642003200&date_to=1642003200&include_sessions=1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

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

const params = {
    "search": "Test",
    "ip": "200.200.100.5",
    "user": "1",
    "type": "user",
    "date_from": "1642003200",
    "date_to": "1642003200",
    "include_sessions": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "user_id": 277,
            "event_name": "event_factory",
            "element_type": "App\\Models\\User",
            "element_id": 276,
            "comments": "",
            "ip_address": "191.48.99.76",
            "created_at": "1998-04-15T12:24:31.000000Z",
            "updated_at": "2025-12-08T15:50:47.000000Z",
            "user": {
                "id": 277,
                "mrn": "HIC1G40D1765209047",
                "name": "Layne Wisozk Jr.",
                "email": "1765209047nkuhic@example.net",
                "language": "en",
                "phone": "(424) 798-9015",
                "phone_country": "TZ",
                "phone_verified_at": null,
                "address1": "5641 Shaylee Pine",
                "address2": "Purdyborough, KY 61999",
                "postal_code": "01997",
                "city": "Greenfelder LLC",
                "clinic_name": "Hansenhaven",
                "clinic_location": "6310 Chaz Summit\nWest Lincolnside, WI 04832",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:47.000000Z",
                "updated_at": "2025-12-08T15:50:47.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "element": {
                "id": 276,
                "mrn": "NIGC6F8H1765209047",
                "name": "Giovanni Schulist",
                "email": "1765209047einar.tremblay@example.net",
                "language": "en",
                "phone": "325.644.2575",
                "phone_country": "AZ",
                "phone_verified_at": null,
                "address1": "10073 Bruen Neck Suite 286",
                "address2": "Karinemouth, RI 09320",
                "postal_code": "67789-0966",
                "city": "Rau, Brekke and Maggio",
                "clinic_name": "Garrisonmouth",
                "clinic_location": "209 McKenzie Corners\nSouth Virgiebury, IL 11795-6990",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:47.000000Z",
                "updated_at": "2025-12-08T15:50:47.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        },
        {
            "id": 2,
            "user_id": 280,
            "event_name": "event_factory",
            "element_type": "App\\Models\\User",
            "element_id": 279,
            "comments": "",
            "ip_address": "40.133.119.7",
            "created_at": "1972-01-06T06:08:06.000000Z",
            "updated_at": "2025-12-08T15:50:47.000000Z",
            "user": {
                "id": 280,
                "mrn": "AOB02BB71765209047",
                "name": "Dr. Carlos Carroll",
                "email": "1765209047matilde.wintheiser@example.org",
                "language": "en",
                "phone": "469.514.5974",
                "phone_country": "ML",
                "phone_verified_at": null,
                "address1": "7381 Block Mission",
                "address2": "Lake Liabury, AL 41144",
                "postal_code": "65844-9844",
                "city": "Koepp-Kreiger",
                "clinic_name": "North Braxton",
                "clinic_location": "850 Mara Cliff Apt. 108\nEast Mayafurt, CO 33372-8440",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:47.000000Z",
                "updated_at": "2025-12-08T15:50:47.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "element": {
                "id": 279,
                "mrn": "CTL67N1S1765209047",
                "name": "Mckayla Thompson",
                "email": "1765209047christina64@example.net",
                "language": "en",
                "phone": "+16628226835",
                "phone_country": "LB",
                "phone_verified_at": null,
                "address1": "9233 Russel Gateway",
                "address2": "South Alexandre, AK 45951-4077",
                "postal_code": "21424",
                "city": "Goyette, Waters and Wolff",
                "clinic_name": "Mrazshire",
                "clinic_location": "9711 Olin Station\nKavonfort, MI 48168",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:47.000000Z",
                "updated_at": "2025-12-08T15:50:47.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access event logs",
    "code": "EVENT_LOGS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/logs

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

search   string  optional  

Filter logs by related element data:

  • for users: search by name or email
  • for devices: search by serial or bluetooth_id
  • for P2P sessions: search by amputee_uuid or clinician_uuid
Example: `Test`
ip   string  optional  

Filter logs by IP address. Example: 200.200.100.5

user   integer  optional  

Filter logs by user. Example: 1

type   string  optional  

Filter logs by event type (available: user, device, p2p_session. Example: user

date_from   integer  optional  

Filter logs from date (timestamp). Example: 1642003200

date_to   integer  optional  

Filter logs to date (timestamp). Example: 1642003200

include_sessions   integer  optional  

Login and logout events are filtered out by default. Set this parameter to 1 to include these events. Example: 1

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

Body Parameters

date_from   string  optional  
date_to   string  optional  

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": "Voluptatum sunt facere est est blanditiis pariatur dolor.",
                "content": "Ab consectetur fugiat provident a.",
                "created_at": "2025-12-08T15:50:35.000000Z",
                "updated_at": "2025-12-08T15:50:35.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": "Quos maiores et cupiditate aspernatur voluptatibus nisi.",
                "content": "Ipsam et amet deleniti.",
                "created_at": "2025-12-08T15:50:35.000000Z",
                "updated_at": "2025-12-08T15:50:35.000000Z",
                "sender": null
            }
        }
    ]
}

Request   

GET api/messages

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

Body Parameters

filter   string  optional  

Filter results by message status (available: archived, all). Defaults to non-archived only. Example: all

Send message to multiple users

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/message" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"Reminder about your vaccination\",
    \"content\": \"Lorem ipsum dolor sit amet\",
    \"roles\": \"Clinician,Amputee\"
}"

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

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

let body = {
    "title": "Reminder about your vaccination",
    "content": "Lorem ipsum dolor sit amet",
    "roles": "Clinician,Amputee"
};

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

Example response (202, OK):


{
    "message": "Messages sent",
    "count": 3,
    "code": "MESSAGES:SEND:SENT"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to send messages",
    "code": "MESSAGES:SEND:INSUFFICIENT_PERMISSION"
}

Request   

POST api/message

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

Message title. MINIMUM:STRING_LENGTH:3. Example: Reminder about your vaccination

content   string  optional  

Message content text. Example: Lorem ipsum dolor sit amet

roles   string  optional  

Filter recipients with given role (comma-separated). Example: Clinician,Amputee

Mark message as read

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/message/1/read" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"state\": true
}"

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

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

let body = {
    "state": true
};

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

Example response (202):


{
    "id": 3,
    "user_id": 143,
    "message_id": 3,
    "is_read": 0,
    "is_archived": 0,
    "is_deleted": 0
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to mark this message as read",
    "code": "MESSAGES:READ:INSUFFICIENT_PERMISSION"
}

Example response (404, Message not found):


{
    "message": "Message not found",
    "code": "MESSAGES:READ:MESSAGE_NOT_FOUND"
}

Request   

POST api/message/{id}/read

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User Message ID (id from messages list; do not confuse with message_id). Example: 1

Body Parameters

state   boolean  optional  

Explicit read state. Default: 1 (true). Example: true

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": 144,
    "message_id": 4,
    "is_read": 0,
    "is_archived": 0,
    "is_deleted": 0
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to mark this message as archived",
    "code": "MESSAGES:ARCHIVE:INSUFFICIENT_PERMISSION"
}

Example response (404, Message not found):


{
    "message": "Message not found",
    "code": "MESSAGES:ARCHIVE:MESSAGE_NOT_FOUND"
}

Request   

POST api/message/{id}/archive

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User Message ID (id from messages list; do not confuse with message_id). Example: 1

Body Parameters

state   boolean  optional  

Explicit archived state. Default: 1 (true). Example: true

List of messages and tickets

requires authentication

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

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

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

Example response (200, OK):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 2
    },
    "items": [
        {
            "type": "UserMessage",
            "date": "2024-11-02T10:00:00.000000Z",
            "item": {
                "id": 1,
                "user_id": 1,
                "message_id": 1,
                "is_read": 0,
                "is_archived": 0,
                "is_deleted": 0,
                "message": {
                    "id": 1,
                    "sender_id": 1,
                    "title": "Message title",
                    "content": "Message content",
                    "created_at": "2024-11-02T10:00:00.000000Z",
                    "updated_at": "2024-11-02T10:00:00.000000Z",
                    "sender": {
                        "id": 1,
                        "mrn": "MRN",
                        "name": "User name",
                        "email": "user@domain.com",
                        "language": "en",
                        "phone": "",
                        "phone_verified_at": null,
                        "address1": "",
                        "address2": "",
                        "postal_code": "",
                        "city": "",
                        "clinic_name": "Test Company",
                        "clinic_location": "Test Company Location",
                        "image": null,
                        "mfa_enabled": 0,
                        "mfa_method": "email",
                        "mfa_verified_to": null,
                        "created_by": null,
                        "active": 1,
                        "notifications_timezone": "Europe/Warsaw",
                        "notifications_at": "08:00:00",
                        "created_at": "2024-09-01T15:00:00.000000Z",
                        "updated_at": "2024-10-10T10:30:00.000000Z",
                        "invitation_status": "accepted",
                        "roles": [
                            {
                                "id": 3,
                                "name": "Clinician",
                                "guard_name": "web",
                                "created_at": "2024-01-01T12:00:00.000000Z",
                                "updated_at": "2024-01-01T12:00:00.000000Z",
                                "pivot": {
                                    "model_id": 1,
                                    "role_id": 3,
                                    "model_type": "App\\Models\\User"
                                }
                            }
                        ]
                    }
                }
            }
        },
        {
            "type": "SupportTicket",
            "date": "2024-11-01T15:15:00.000000Z",
            "item": {
                "id": 1,
                "sender_id": 1,
                "recipient_id": 999,
                "device_id": null,
                "meeting_date": "2024-11-10T15:00:00.000000Z",
                "meeting_type": "none",
                "contact_email": null,
                "status": "new",
                "created_at": "2024-11-01T15:15:00.000000Z",
                "updated_at": "2024-11-01T15:15:00.000000Z",
                "sender": {
                    "id": 1,
                    "mrn": "MRN",
                    "name": "User name",
                    "email": "user@domain.com",
                    "language": "en",
                    "phone": "",
                    "phone_verified_at": null,
                    "address1": "",
                    "address2": "",
                    "postal_code": "",
                    "city": "",
                    "clinic_name": "Test Company",
                    "clinic_location": "Test Company Location",
                    "image": null,
                    "mfa_enabled": 0,
                    "mfa_method": "email",
                    "mfa_verified_to": null,
                    "created_by": null,
                    "active": 1,
                    "notifications_timezone": "Europe/Warsaw",
                    "notifications_at": "08:00:00",
                    "created_at": "2024-09-01T15:00:00.000000Z",
                    "updated_at": "2024-10-10T10:30:00.000000Z",
                    "invitation_status": "accepted",
                    "roles": [
                        {
                            "id": 3,
                            "name": "Clinician",
                            "guard_name": "web",
                            "created_at": "2024-01-01T12:00:00.000000Z",
                            "updated_at": "2024-01-01T12:00:00.000000Z",
                            "pivot": {
                                "model_id": 1,
                                "role_id": 3,
                                "model_type": "App\\Models\\User"
                            }
                        }
                    ]
                },
                "recipient": {
                    "id": 2,
                    "mrn": "MRN2",
                    "name": "Patient",
                    "email": "patient4@domain.com",
                    "language": "en",
                    "phone": "",
                    "phone_verified_at": null,
                    "address1": "",
                    "address2": "",
                    "postal_code": "",
                    "city": "",
                    "clinic_name": null,
                    "clinic_location": null,
                    "image": null,
                    "mfa_enabled": 0,
                    "mfa_method": null,
                    "mfa_verified_to": null,
                    "created_by": 1,
                    "active": 1,
                    "notifications_timezone": null,
                    "notifications_at": null,
                    "created_at": "2024-10-01T15:00:00.000000Z",
                    "updated_at": "2024-10-10T10:30:00.000000Z",
                    "invitation_status": null,
                    "roles": [
                        {
                            "id": 5,
                            "name": "Amputee",
                            "guard_name": "web",
                            "created_at": "2024-01-01T12:00:00.000000Z",
                            "updated_at": "2024-01-01T12:00:00.000000Z",
                            "pivot": {
                                "model_id": 2,
                                "role_id": 5,
                                "model_type": "App\\Models\\User"
                            }
                        }
                    ]
                },
                "device": null,
                "messages": [
                    {
                        "id": 1,
                        "ticket_id": 1,
                        "sender_id": 1,
                        "title": "Communication channel",
                        "content": "Welcome to the digital platform. Please use this channel for communicating with your clinician.",
                        "is_read": false,
                        "created_at": "2024-11-01T15:15:00.000000Z",
                        "updated_at": "2024-11-01T15:15:00.000000Z",
                        "attachments": [],
                        "sender": {
                            "id": 1,
                            "mrn": "MRN",
                            "name": "User name",
                            "email": "user@domain.com",
                            "language": "en",
                            "phone": "",
                            "phone_verified_at": null,
                            "address1": "",
                            "address2": "",
                            "postal_code": "",
                            "city": "",
                            "clinic_name": "Test Company",
                            "clinic_location": "Test Company Location",
                            "image": null,
                            "mfa_enabled": 0,
                            "mfa_method": "email",
                            "mfa_verified_to": null,
                            "created_by": null,
                            "active": 1,
                            "notifications_timezone": "Europe/Warsaw",
                            "notifications_at": "08:00:00",
                            "created_at": "2024-09-01T15:00:00.000000Z",
                            "updated_at": "2024-10-10T10:30:00.000000Z",
                            "invitation_status": "accepted",
                            "roles": [
                                {
                                    "id": 3,
                                    "name": "Clinician",
                                    "guard_name": "web",
                                    "created_at": "2024-01-01T12:00:00.000000Z",
                                    "updated_at": "2024-01-01T12:00:00.000000Z",
                                    "pivot": {
                                        "model_id": 1,
                                        "role_id": 3,
                                        "model_type": "App\\Models\\User"
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ]
}

Request   

GET api/messages-and-tickets

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

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=2017-01-05 07:48:51"\
    --form "date_end=1987-05-06 20:03:41"\
    --form "encrypt_key=autem"\
    --form "encrypt_iv=quo"\
    --form "file=@/tmp/php7GmfkC" 
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', '2017-01-05 07:48:51');
body.append('date_end', '1987-05-06 20:03:41');
body.append('encrypt_key', 'autem');
body.append('encrypt_iv', 'quo');
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": 281,
    "device_id": 133,
    "file": "/tmp/fakervR745a",
    "date_start": "1984-12-05 08:22:36",
    "date_end": "2014-11-21 21:49:13",
    "created_at": "2025-12-08T15:50:47.000000Z",
    "updated_at": "2025-12-08T15:50:47.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to write mobile logs",
    "code": "MOBILE_LOGS:STORE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/mobile-logs

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

device_id   string  optional  

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

file   file   

Log file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/php7GmfkC

date_start   string   

Log start date. MUST_BE_DATE Must be a valid date in the format Y-m-d H:i:s. Example: 2017-01-05 07:48:51

date_end   string   

Log end date. MUST_BE_DATE Must be a valid date in the format Y-m-d H:i:s. MUST_BE_AFTER:date_start. Example: 1987-05-06 20:03:41

encrypt_key   string   

Encryption key. Example: autem

encrypt_iv   string   

Encryption IV (Initialization Vector). Example: quo

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": 282,
            "device_id": 134,
            "file": "/tmp/fakerCE9zJp",
            "date_start": "1970-05-14 16:19:14",
            "date_end": "1989-04-30 22:41:54",
            "created_at": "2025-12-08T15:50:47.000000Z",
            "updated_at": "2025-12-08T15:50:47.000000Z"
        },
        {
            "id": 3,
            "user_id": 283,
            "device_id": 135,
            "file": "/tmp/fakereRXD1J",
            "date_start": "2009-02-02 03:36:29",
            "date_end": "1978-01-12 23:43:13",
            "created_at": "2025-12-08T15:50:48.000000Z",
            "updated_at": "2025-12-08T15:50:48.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view mobile logs",
    "code": "MOBILE_LOGS:GET:INSUFFICIENT_PERMISSION"
}

Request   

GET api/mobile-logs

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

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

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

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": 284,
            "device_id": 136,
            "file": "/tmp/fakerNNaDux",
            "date_start": "1977-07-23 10:05:37",
            "date_end": "1984-01-28 06:31:43",
            "created_at": "2025-12-08T15:50:48.000000Z",
            "updated_at": "2025-12-08T15:50:48.000000Z"
        },
        {
            "id": 5,
            "user_id": 285,
            "device_id": 137,
            "file": "/tmp/faker3yMuAL",
            "date_start": "2016-12-24 09:52:02",
            "date_end": "2020-12-23 16:49:44",
            "created_at": "2025-12-08T15:50:48.000000Z",
            "updated_at": "2025-12-08T15:50:48.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view mobile logs",
    "code": "MOBILE_LOGS:GET_BY_USER:INSUFFICIENT_PERMISSION"
}

Request   

GET api/mobile-logs/user/{userId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

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

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

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": 286,
            "device_id": 138,
            "file": "/tmp/fakerKjGkoD",
            "date_start": "2010-07-03 16:34:08",
            "date_end": "2009-11-26 06:57:48",
            "created_at": "2025-12-08T15:50:48.000000Z",
            "updated_at": "2025-12-08T15:50:48.000000Z"
        },
        {
            "id": 7,
            "user_id": 287,
            "device_id": 139,
            "file": "/tmp/fakerQXRWDW",
            "date_start": "1979-06-23 22:24:52",
            "date_end": "2014-09-03 17:40:31",
            "created_at": "2025-12-08T15:50:48.000000Z",
            "updated_at": "2025-12-08T15:50:48.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view mobile logs",
    "code": "MOBILE_LOGS:GET_BY_DEVICE:INSUFFICIENT_PERMISSION"
}

Request   

GET api/mobile-logs/device/{deviceId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

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/1/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/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": "7ec4f598-a99e-3dd4-ac2a-3878b7b41137",
    "clinician_uuid": "2aacb53e-cd71-309d-b751-0ea4d6761e86",
    "token": "IXZWDVS67TNLG3X2S8JE5Y0TMZJPYLQIVJKYNOPLW5P8FZMDTX0LB5MB6BEXWVDM",
    "status": "waiting_for_decision",
    "created_at": "2025-12-08T15:50:33.000000Z",
    "updated_at": "2025-12-08T15:50:33.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view active P2P session",
    "code": "P2P_SESSIONS:GET_ACTIVE:INSUFFICIENT_PERMISSION"
}

Example response (404, Session not found):


{
    "message": "P2P session not found",
    "code": "P2P_SESSIONS:GET_ACTIVE:SESSION_NOT_FOUND"
}

Request   

GET api/p2p/{clinicianId}/{amputeeId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

clinicianId   integer   

User clinician ID. Example: 1

amputeeId   integer   

User amputee entry ID. Example: 1

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": "0b833152-8d29-300b-9e28-a81c41279f9c",
    "clinician_uuid": "f5795999-4a4f-37da-8764-a629228ac4ae",
    "token": "E95Y6WY62MXS3JZAKJTD9APJZQTZTVPNRQN1X3XCFBR3J03P5YQKC01YAE9R9L4H",
    "status": "waiting_for_decision",
    "created_at": "2025-12-08T15:50:33.000000Z",
    "updated_at": "2025-12-08T15:50:33.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view P2P session",
    "code": "P2P_SESSIONS:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Session not found):


{
    "message": "P2P session not found",
    "code": "P2P_SESSIONS:GET:SESSION_NOT_FOUND"
}

Request   

GET api/p2p/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

P2P session ID. Example: 1

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\": \"7934d7d6-da18-3ff6-8891-30cd3cbf44ae\",
    \"clinician_uuid\": \"f8b87193-dcf4-3f89-9a84-3ff32949d14b\"
}"

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": "7934d7d6-da18-3ff6-8891-30cd3cbf44ae",
    "clinician_uuid": "f8b87193-dcf4-3f89-9a84-3ff32949d14b"
};

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

Example response (201):


{
    "id": 3,
    "amputee_id": 118,
    "device_id": null,
    "clinician_id": 119,
    "amputee_uuid": "f71cdb00-1278-3f5b-984e-d0c99199738b",
    "clinician_uuid": "e7e6d588-2e69-34b7-9ed1-0aa47eea50ef",
    "token": "Y78ZRP3URHB4UMIA5EUFBCATO2OR46KVUN87YY9AF9PPEDIAGMEASV52NQ1JWHWA",
    "status": "waiting_for_decision",
    "created_at": "2025-12-08T15:50:33.000000Z",
    "updated_at": "2025-12-08T15:50:33.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create P2P session",
    "code": "P2P_SESSIONS:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (403, Device not assigned to patient):


{
    "message": "Device is not assigned to the patient",
    "code": "P2P_SESSIONS:CREATE:DEVICE_NOT_ASSIGNED"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "P2P_SESSIONS:CREATE:USER_NOT_FOUND"
}

Request   

POST api/p2p/create

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

amputee_id   string   

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

device_id   string   

Device ID. The id of an existing record in the App\Models\Device table. Example: 5

amputee_uuid   string   

Amputee's UUID generated by integration platform. Example: 7934d7d6-da18-3ff6-8891-30cd3cbf44ae

clinician_uuid   string   

Clinician's UUID generated by integration platform. Example: f8b87193-dcf4-3f89-9a84-3ff32949d14b

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": "830684e3-2709-36ab-ab29-184d4c095ffb",
    "clinician_uuid": "65f692ad-3c5b-3987-80ce-92eb9cfb8cb7",
    "token": "KBZ61L3EFOLGJO46J6RUKOJDSZ7DB7C610KOPBHGFD4U19OR0V23GCYKVEC07DQM",
    "status": "waiting_for_decision",
    "created_at": "2025-12-08T15:50:33.000000Z",
    "updated_at": "2025-12-08T15:50:33.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update P2P session",
    "code": "P2P_SESSIONS:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Session not found):


{
    "message": "P2P session not found",
    "code": "P2P_SESSIONS:UPDATE:SESSION_NOT_FOUND"
}

Request   

POST api/p2p/{id}/update

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

P2P session ID. Example: 1

Body Parameters

status   string   

Session status. Example: closed

Must be one of:
  • waiting_for_decision
  • in_progress
  • closed

Product features and toggles

API endpoints for product features and toggles management

Definitions:

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": "navy",
        "slug": "nostrum-rerum-vero-explicabo-ullam",
        "created_at": "2025-12-08T15:50:43.000000Z",
        "updated_at": "2025-12-08T15:50:43.000000Z"
    },
    {
        "id": 2,
        "name": "black",
        "slug": "modi-quia-deleniti-odio-et-qui-quas",
        "created_at": "2025-12-08T15:50:43.000000Z",
        "updated_at": "2025-12-08T15:50:43.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view product features and toggles",
    "code": "PRODUCT_FEATURES:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/product/features

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

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": "aqua",
    "slug": "quasi-sed-necessitatibus-natus-aut-debitis-quam-consequatur-harum",
    "created_at": "2025-12-08T15:50:43.000000Z",
    "updated_at": "2025-12-08T15:50:43.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "PRODUCT_FEATURES:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/product/features

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Name of product feature. Example: Remote config

slug   string   

Simplified name of product feature without spaces (e.g. remote_config for Remote config name). Example: remote_config

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": "yellow",
    "slug": "sed-sit-optio-commodi-omnis-unde-debitis-consequatur",
    "created_at": "2025-12-08T15:50:43.000000Z",
    "updated_at": "2025-12-08T15:50:43.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "PRODUCT_FEATURES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Product feature not found):


{
    "message": "Product feature not found",
    "code": "PRODUCT_FEATURES:UPDATE:FEATURE_NOT_FOUND"
}

Request   

PUT api/product/features/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Product Feature ID. Example: 1

Body Parameters

name   string  optional  

Name of product feature. Example: Remote config

slug   string  optional  

Simplified name of product feature without spaces (e.g. remote_config for Remote config name). Example: remote_config

Delete product feature

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Product feature deleted",
    "code": "PRODUCT_FEATURES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "PRODUCT_FEATURES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (403, Product feature belongs to compatibility entries):


{
    "message": "Cannot delete: product feature belongs to existing compatibility entries (1)",
    "code": "PRODUCT_FEATURES:DELETE:HAS_COMPATIBILITY_ENTRIES"
}

Example response (404, Product feature not found):


{
    "message": "Product feature not found",
    "code": "PRODUCT_FEATURES:DELETE:FEATURE_NOT_FOUND"
}

Request   

DELETE api/product/features/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Product Feature ID. Example: 1

List product toggles

requires authentication

This endpoint returns list of global toggles. For some users there could exist user toggle which overrides these settings.

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

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

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

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

Example response (200):


[
    {
        "id": 1,
        "name": "fuchsia",
        "slug": "ut-nesciunt-nihil-et",
        "enabled": 0,
        "created_at": "2025-12-08T15:50:43.000000Z",
        "updated_at": "2025-12-08T15:50:43.000000Z"
    },
    {
        "id": 2,
        "name": "white",
        "slug": "rerum-doloremque-modi-odio-et-corporis",
        "enabled": 1,
        "created_at": "2025-12-08T15:50:43.000000Z",
        "updated_at": "2025-12-08T15:50:43.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view product features and toggles",
    "code": "PRODUCT_TOGGLES:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/product/toggles

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

global   integer  optional  

Pass value 1 to fetch list of global toggles without user overrides Example: 1

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": "navy",
    "slug": "ratione-sint-commodi-quibusdam-labore-beatae-earum-veniam",
    "enabled": 0,
    "created_at": "2025-12-08T15:50:43.000000Z",
    "updated_at": "2025-12-08T15:50:43.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "PRODUCT_TOGGLES:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/product/toggles

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Name of product toggle. Example: Remote config

slug   string   

Simplified name of product toggle without spaces (e.g. remote_config for Remote config name). Example: remote_config

enabled   boolean   

Is toggle enabled on this environment?. Example: true

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": "teal",
    "slug": "eos-non-in-eum-ipsum-beatae-sint-autem",
    "enabled": 0,
    "created_at": "2025-12-08T15:50:43.000000Z",
    "updated_at": "2025-12-08T15:50:43.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "PRODUCT_TOGGLES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Product toggle not found):


{
    "message": "Product toggle not found",
    "code": "PRODUCT_TOGGLES:UPDATE:TOGGLE_NOT_FOUND"
}

Request   

PUT api/product/toggles/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Product Toggle ID. Example: 1

Body Parameters

name   string  optional  

Name of product toggle. Example: Remote config

slug   string  optional  

Simplified name of product toggle without spaces (e.g. remote_config for Remote config name). Example: remote_config

enabled   boolean  optional  

Is toggle enabled on this environment?. Example: true

Delete product toggle

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Product toggle deleted",
    "code": "PRODUCT_TOGGLES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "PRODUCT_TOGGLES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Product toggle not found):


{
    "message": "Product toggle not found",
    "code": "PRODUCT_TOGGLES:DELETE:TOGGLE_NOT_FOUND"
}

Request   

DELETE api/product/toggles/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Product Toggle ID. Example: 1

List product FAQ

requires authentication

This endpoint returns list of product FAQ.

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

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "question": "Sed iusto eaque non quisquam architecto rerum ducimus aut. Fugiat et eos corporis voluptatum adipisci. Quia ut voluptate officia dignissimos excepturi ea mollitia.",
            "answer": "Doloremque quasi et quam voluptatem. Accusamus esse totam fuga modi consequuntur quia voluptatem. Rem eaque consectetur ab minus. Nulla qui soluta dolorem sed aut et.",
            "created_at": "2025-12-08T15:50:43.000000Z",
            "updated_at": "2025-12-08T15:50:43.000000Z"
        },
        {
            "id": 2,
            "question": "Quia ut saepe vel voluptatem mollitia. Asperiores sequi dolor sed est dolorem delectus.",
            "answer": "Et est a soluta laboriosam. Autem dolorum inventore repellendus sapiente culpa et dolor. Sed et quia sit. Consequatur quia perferendis maxime id ea.",
            "created_at": "2025-12-08T15:50:43.000000Z",
            "updated_at": "2025-12-08T15:50:43.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view product features and toggles",
    "code": "FAQ:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/product/faq

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

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": 251,
        "enabled": 1,
        "created_at": "2025-12-08T15:50:44.000000Z",
        "updated_at": "2025-12-08T15:50:44.000000Z",
        "toggle": {
            "id": 6,
            "name": "navy",
            "slug": "explicabo-omnis-consequatur-asperiores-est-nobis-non",
            "enabled": 1,
            "created_at": "2025-12-08T15:50:44.000000Z",
            "updated_at": "2025-12-08T15:50:44.000000Z"
        }
    },
    {
        "id": 2,
        "toggle_id": 8,
        "user_id": 252,
        "enabled": 1,
        "created_at": "2025-12-08T15:50:44.000000Z",
        "updated_at": "2025-12-08T15:50:44.000000Z",
        "toggle": {
            "id": 8,
            "name": "yellow",
            "slug": "nihil-tempora-fugit-voluptatem-numquam-dolorum",
            "enabled": 0,
            "created_at": "2025-12-08T15:50:44.000000Z",
            "updated_at": "2025-12-08T15:50:44.000000Z"
        }
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view product features and toggles",
    "code": "USER_TOGGLES:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USER_TOGGLES:LIST:USER_NOT_FOUND"
}

Request   

GET api/user/{userId}/toggles

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

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": 253,
    "enabled": 0,
    "created_at": "2025-12-08T15:50:44.000000Z",
    "updated_at": "2025-12-08T15:50:44.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "USER_TOGGLES:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USER_TOGGLES:CREATE:USER_NOT_FOUND"
}

Request   

POST api/user/{userId}/toggles

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

Body Parameters

toggle_id   integer   

Product toggle ID. The id of an existing record in the App\Models\ProductToggle table. Example: 1

enabled   boolean   

Is user toggle enabled on this environment?. Example: true

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": 254,
    "enabled": 0,
    "created_at": "2025-12-08T15:50:44.000000Z",
    "updated_at": "2025-12-08T15:50:44.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "USER_TOGGLES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USER_TOGGLES:UPDATE:USER_NOT_FOUND"
}

Example response (404, User toggle not found):


{
    "message": "User toggle not found",
    "code": "USER_TOGGLES:UPDATE:TOGGLE_NOT_FOUND"
}

Request   

PUT api/user/{userId}/toggles/{toggleId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

toggleId   integer   

User Toggle ID. Example: 1

Body Parameters

enabled   boolean  optional  

Is user toggle enabled on this environment?. Example: true

Delete user toggle

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "User toggle deleted",
    "code": "USER_TOGGLES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage product features and toggles",
    "code": "USER_TOGGLES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USER_TOGGLES:DELETE:USER_NOT_FOUND"
}

Example response (404, User toggle not found):


{
    "message": "User toggle not found",
    "code": "USER_TOGGLES:DELETE:TOGGLE_NOT_FOUND"
}

Request   

DELETE api/user/{userId}/toggles/{toggleId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

userId   integer   

User ID. Example: 1

toggleId   integer   

User Toggle ID. Example: 1

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": "In sint totam maiores voluptatem debitis quod. Qui eum aut repellat magnam. Deleniti consequatur officia laudantium cumque earum.",
            "created_at": "2025-12-08T15:50:45.000000Z",
            "updated_at": "2025-12-08T15:50:45.000000Z",
            "version": {
                "id": 14,
                "name": "8.71.94",
                "created_at": "2025-12-08T15:50:45.000000Z",
                "updated_at": "2025-12-08T15:50:45.000000Z"
            }
        },
        {
            "id": 2,
            "version_type": "App\\Models\\SoftwareVersion",
            "version_id": 15,
            "description": "Provident aut molestiae quae. Veniam nisi quo facilis et. Neque nesciunt voluptas nesciunt dolorem nihil.",
            "created_at": "2025-12-08T15:50:45.000000Z",
            "updated_at": "2025-12-08T15:50:45.000000Z",
            "version": {
                "id": 15,
                "name": "7.98.23",
                "created_at": "2025-12-08T15:50:45.000000Z",
                "updated_at": "2025-12-08T15:50:45.000000Z"
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list releases",
    "code": "RELEASES:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/releases

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

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": "Rerum veniam veritatis possimus at cum qui. Repudiandae vero ipsam impedit ad perferendis. Reiciendis quia quia iure. Vitae vitae et illo aut.",
    "created_at": "2025-12-08T15:50:45.000000Z",
    "updated_at": "2025-12-08T15:50:45.000000Z",
    "version": {
        "id": 16,
        "name": "1.41.15",
        "created_at": "2025-12-08T15:50:45.000000Z",
        "updated_at": "2025-12-08T15:50:45.000000Z"
    }
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view release",
    "code": "RELEASES:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Release not found):


{
    "message": "Release not found",
    "code": "RELEASES:GET:RELEASE_NOT_FOUND"
}

Request   

GET api/releases/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Release ID. Example: 1

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": "Laboriosam occaecati consequuntur quibusdam commodi aspernatur ut ipsa. Earum saepe nihil officia occaecati inventore. Quaerat dolor ab dolore quidem quas ad provident. Libero ut unde aut.",
    "created_at": "2025-12-08T15:50:45.000000Z",
    "updated_at": "2025-12-08T15:50:45.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create release",
    "code": "RELEASES:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/releases

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

version_type   string   

Version type. Example: SoftwareVersion

Must be one of:
  • DeviceModel
  • SoftwareVersion
  • FirmwareVersion
  • PCBVersion
version_id   integer   

Version ID. Example: 1

description   string  optional  

Release description. Example: This version fixes minor bugs.

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": "A sit rerum nihil autem. Est nihil reiciendis dolor ipsa. Doloremque perferendis ut commodi voluptatum aut rem sed. Et et aliquam voluptatem molestiae enim optio et omnis.",
    "created_at": "2025-12-08T15:50:45.000000Z",
    "updated_at": "2025-12-08T15:50:45.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update release",
    "code": "RELEASES:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Release not found):


{
    "message": "Release not found",
    "code": "RELEASES:UPDATE:RELEASE_NOT_FOUND"
}

Request   

PUT api/releases/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Release ID. Example: 1

Body Parameters

version_type   string  optional  

Version type. Example: SoftwareVersion

Must be one of:
  • DeviceModel
  • SoftwareVersion
  • FirmwareVersion
  • PCBVersion
version_id   integer  optional  

Version ID. Example: 1

description   string  optional  

Release description. Example: This version fixes minor bugs.

Delete release

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Version deleted",
    "code": "RELEASES:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete release",
    "code": "RELEASES:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Release not found):


{
    "message": "Release not found",
    "code": "RELEASES:DELETE:RELEASE_NOT_FOUND"
}

Request   

DELETE api/releases/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Release ID. Example: 1

Search

API endpoints for search

requires authentication

Searches in:
  • users (by name and email)
  • devices (by serial number)

Returned collection contains entries of type User or Device.

If the device has a patient assigned, this patient is included in the results as an entry of type User. If the device has no patient, the device is included in the results.

Users included in the results, but not found directly have "devices" relation filled in with the devices that match the search query.

Example request:
curl --request GET \
    --get "http://localhost:8000/api/search" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"Tom\"
}"

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

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

let body = {
    "query": "Tom"
};

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

Example response (200, OK):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "type": "User",
            "item": {
                "id": 1,
                "mrn": "MRN",
                "name": "User name",
                "email": "user@domain.com",
                "language": "en",
                "phone": "",
                "phone_verified_at": null,
                "address1": "",
                "address2": "",
                "postal_code": "",
                "city": "",
                "clinic_name": "Test Company",
                "clinic_location": "Test Company Location",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": "email",
                "mfa_verified_to": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": "Europe/Warsaw",
                "notifications_at": "08:00:00",
                "created_at": "2024-09-01T15:00:00.000000Z",
                "updated_at": "2024-10-10T10:30:00.000000Z",
                "invitation_status": "accepted",
                "pivot": {
                    "assigned_user_id": 2,
                    "user_id": 1
                },
                "devices": [],
                "roles": [
                    {
                        "id": 5,
                        "name": "Amputee",
                        "guard_name": "web",
                        "created_at": "2024-01-01T12:00:00.000000Z",
                        "updated_at": "2024-01-01T12:00:00.000000Z",
                        "pivot": {
                            "model_id": 1,
                            "role_id": 5,
                            "model_type": "App\\Models\\User"
                        }
                    }
                ]
            }
        },
        {
            "type": "Device",
            "item": {
                "id": 1,
                "serial": "SERIAL-NUMBER",
                "bluetooth_id": "BLUETOOTH_ID",
                "model_id": 1,
                "amputee_id": 1,
                "firmware_version_id": 1,
                "pcb_version_id": 1,
                "active": 1,
                "last_activity_at": "2024-11-11 12:00:00",
                "created_at": "2024-08-30T15:00:00.000000Z",
                "updated_at": "2024-09-01T16:00:00.000000Z",
                "pivot": {
                    "user_id": 2,
                    "device_id": 1
                }
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to search",
    "code": "SEARCH:SEARCH:INSUFFICIENT_PERMISSION"
}

Servicing

API endpoints for servicing

List of parts

requires authentication

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

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "device_model": null,
            "name": "Visa",
            "created_at": "2025-12-08T15:50:35.000000Z",
            "updated_at": "2025-12-08T15:50:35.000000Z"
        },
        {
            "id": 2,
            "device_model": null,
            "name": "MasterCard",
            "created_at": "2025-12-08T15:50:35.000000Z",
            "updated_at": "2025-12-08T15:50:35.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list service parts",
    "code": "SERVICING:LIST_PARTS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/servicing/parts

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

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/phpWXhzwz" 
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": 136,
    "device_id": 114,
    "created_at": "2025-12-08T15:50:35.000000Z",
    "updated_at": "2025-12-08T15:50:35.000000Z",
    "parts": [
        {
            "id": 1,
            "repair_id": 1,
            "part_id": 3,
            "reason": "Distinctio et et enim nostrum. Aut ea qui et cumque. Animi quia blanditiis et deserunt soluta ex. Rerum magnam et deserunt quisquam. Architecto omnis ipsa unde.",
            "created_at": "2025-12-08T15:50:35.000000Z",
            "updated_at": "2025-12-08T15:50:35.000000Z",
            "part": {
                "id": 3,
                "device_model": null,
                "name": "JCB",
                "created_at": "2025-12-08T15:50:35.000000Z",
                "updated_at": "2025-12-08T15:50:35.000000Z"
            }
        },
        {
            "id": 2,
            "repair_id": 1,
            "part_id": 4,
            "reason": "Voluptates qui rerum distinctio ipsam incidunt rem dignissimos et. Corporis velit dolorem occaecati sit ut illo modi. Minima est autem explicabo sed quo ut sint. Est qui impedit et tempore facere.",
            "created_at": "2025-12-08T15:50:35.000000Z",
            "updated_at": "2025-12-08T15:50:35.000000Z",
            "part": {
                "id": 4,
                "device_model": null,
                "name": "Visa",
                "created_at": "2025-12-08T15:50:35.000000Z",
                "updated_at": "2025-12-08T15:50:35.000000Z"
            }
        },
        {
            "id": 3,
            "repair_id": 1,
            "part_id": 5,
            "reason": "Voluptatem et ex laudantium quisquam quo. Provident enim est consequatur unde laudantium. Aut quidem corrupti veritatis voluptas cupiditate.",
            "created_at": "2025-12-08T15:50:35.000000Z",
            "updated_at": "2025-12-08T15:50:35.000000Z",
            "part": {
                "id": 5,
                "device_model": null,
                "name": "Visa",
                "created_at": "2025-12-08T15:50:35.000000Z",
                "updated_at": "2025-12-08T15:50:35.000000Z"
            }
        }
    ],
    "attachments": [
        {
            "id": 1,
            "repair_id": 1,
            "file": "/tmp/faker18CwW6",
            "created_at": "2025-12-08T15:50:35.000000Z",
            "updated_at": "2025-12-08T15:50:35.000000Z"
        },
        {
            "id": 2,
            "repair_id": 1,
            "file": "/tmp/faker10mZFa",
            "created_at": "2025-12-08T15:50:35.000000Z",
            "updated_at": "2025-12-08T15:50:35.000000Z"
        },
        {
            "id": 3,
            "repair_id": 1,
            "file": "/tmp/fakerA5nueN",
            "created_at": "2025-12-08T15:50:35.000000Z",
            "updated_at": "2025-12-08T15:50:35.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to report service repair",
    "code": "SERVICING:REPORT_REPAIR:INSUFFICIENT_PERMISSION"
}

Request   

POST api/servicing/repair

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

user_id   integer   

User ID. Example: 1

device_id   integer   

Device ID. Example: 1

files   file[]  optional  

Array of attachment files.

parts   object[]  optional  

Array of replaced parts.
part_id   integer  optional  

Service part ID. Example: 1

reason   string  optional  

Reason of part replacement. Example: Mechanical issue

Settings

API endpoints for app settings

Get app version

requires authentication

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

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

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

Example response (200, OK):


{
    "version": "1.6.0"
}

Request   

GET api/settings/app-version

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get silent push timeout

requires authentication

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

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

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

Example response (200, OK):


{
    "timeout": "15"
}

Request   

GET api/settings/silent-push

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get available languages

requires authentication

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

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

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

Example response (200, OK):


{
    "languages": [
        "de",
        "en",
        "es",
        "it",
        "pl",
        "ru",
        "uk"
    ]
}

Request   

GET api/settings/languages

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get mobile stores versions

requires authentication

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

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

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

Example response (200, OK):


{
    "ios": "1.0",
    "android": "1.0"
}

Request   

GET api/mobile/versions

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Update app version

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/settings/app-version" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"version\": \"1.6.0\"
}"

const url = new URL(
    "http://localhost:8000/api/settings/app-version"
);

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

let body = {
    "version": "1.6.0"
};

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

Example response (200, OK):


{
    "version": "1.6.0"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update settings",
    "code": "SETTINGS:UPDATE_APP_VERSION:INSUFFICIENT_PERMISSION"
}

Request   

POST api/settings/app-version

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

version   string  optional  

App version. Example: 1.6.0

Update silent push timeout

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/settings/silent-push" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"timeout\": 15
}"

const url = new URL(
    "http://localhost:8000/api/settings/silent-push"
);

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

let body = {
    "timeout": 15
};

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

Example response (200, OK):


{
    "timeout": "15"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update settings",
    "code": "SETTINGS:UPDATE_SILENT_PUSH:INSUFFICIENT_PERMISSION"
}

Request   

POST api/settings/silent-push

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

timeout   integer  optional  

Silent push timeout in minutes. Minimum value is 1 minute (15 for production environment), maximum is 60 minutes. MINIMUM:NUMBER:1 MAXIMUM:NUMBER:60. Example: 15

Update mobile stores versions

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/mobile/versions" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ios\": \"1.1\",
    \"android\": \"1.1\"
}"

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

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

let body = {
    "ios": "1.1",
    "android": "1.1"
};

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

Example response (200, OK):


{
    "ios": "1.0",
    "android": "1.0"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update settings",
    "code": "SETTINGS:UPDATE_MOBILE_STORES_VERSION:INSUFFICIENT_PERMISSION"
}

Request   

POST api/mobile/versions

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

ios   string  optional  

Apple AppStore current version. Example: 1.1

android   string  optional  

Google Play current version. Example: 1.1

Support Ticket

API endpoints for managing support tickets

Get tickets list

requires authentication

Possible extend options:

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

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

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 27,
            "sender_id": 145,
            "recipient_id": 146,
            "device_id": 121,
            "meeting_date": "2025-12-08 15:50:36",
            "meeting_type": "online_meeting",
            "contact_email": "schumm.nickolas@harvey.net",
            "status": "new",
            "created_at": "2025-12-08T15:50:36.000000Z",
            "updated_at": "2025-12-08T15:50:36.000000Z",
            "sender": {
                "id": 145,
                "mrn": "HSMIYDRT1765209036",
                "name": "Dr. Elliot Conn",
                "email": "1765209036rene23@example.org",
                "language": "en",
                "phone": "443-783-2658",
                "phone_country": "CW",
                "phone_verified_at": null,
                "address1": "7983 Kareem Mission",
                "address2": "Raheemton, AZ 77429-0880",
                "postal_code": "62677-8712",
                "city": "Schroeder LLC",
                "clinic_name": "Lake Jennieshire",
                "clinic_location": "1542 April Freeway\nO'Connellbury, TN 92278-5151",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:36.000000Z",
                "updated_at": "2025-12-08T15:50:36.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "recipient": {
                "id": 146,
                "mrn": "UFU26OA91765209036",
                "name": "Kirk Baumbach",
                "email": "1765209036obie.herman@example.net",
                "language": "en",
                "phone": "(321) 782-3324",
                "phone_country": "GW",
                "phone_verified_at": null,
                "address1": "660 Easter Flat Suite 250",
                "address2": "Schoenbury, MN 46678",
                "postal_code": "14124",
                "city": "Reinger Group",
                "clinic_name": "Reillyhaven",
                "clinic_location": "15976 Pattie Ramp Suite 953\nSouth Magaliview, LA 79298",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:36.000000Z",
                "updated_at": "2025-12-08T15:50:36.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "device": {
                "id": 121,
                "serial": "f160c14b-61fb-387f-9cb0-096c66a60484",
                "bluetooth_id": "e41c3d5f-ad81-3ed8-83bc-d2f0dedb4c72",
                "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",
                "created_at": "2025-12-08T15:50:36.000000Z",
                "updated_at": "2025-12-08T15:50:36.000000Z"
            },
            "messages": [
                {
                    "id": 15,
                    "ticket_id": 27,
                    "sender_id": 147,
                    "title": "Ms.",
                    "content": "Mollitia aut ipsa explicabo voluptas voluptatem et.",
                    "is_read": false,
                    "created_at": "2025-12-08T15:50:36.000000Z",
                    "updated_at": "2025-12-08T15:50:36.000000Z"
                }
            ]
        },
        {
            "id": 35,
            "sender_id": 159,
            "recipient_id": 160,
            "device_id": 122,
            "meeting_date": "2025-12-08 15:50:37",
            "meeting_type": "online_meeting",
            "contact_email": "nicolas.brown@yahoo.com",
            "status": "new",
            "created_at": "2025-12-08T15:50:37.000000Z",
            "updated_at": "2025-12-08T15:50:37.000000Z",
            "sender": {
                "id": 159,
                "mrn": "SWLG6Y8E1765209037",
                "name": "Ethan Keeling Sr.",
                "email": "1765209037ymuller@example.net",
                "language": "en",
                "phone": "845.924.2553",
                "phone_country": "BE",
                "phone_verified_at": null,
                "address1": "2728 Heller Hills Apt. 770",
                "address2": "Port Stephon, WV 04364-1517",
                "postal_code": "06236",
                "city": "Dietrich, Langworth and Hansen",
                "clinic_name": "Lebsackmouth",
                "clinic_location": "79734 Block Crescent Suite 100\nNew Esperanzafurt, CT 02385-3106",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:37.000000Z",
                "updated_at": "2025-12-08T15:50:37.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "recipient": {
                "id": 160,
                "mrn": "2PS8HWPF1765209037",
                "name": "Brandyn Goodwin",
                "email": "1765209037bayer.estell@example.org",
                "language": "en",
                "phone": "669.940.4101",
                "phone_country": "SS",
                "phone_verified_at": null,
                "address1": "2493 Breitenberg Square Suite 768",
                "address2": "West Mohammadton, WA 51527-4421",
                "postal_code": "89442",
                "city": "Gulgowski-Roob",
                "clinic_name": "East Zoeshire",
                "clinic_location": "6841 Oral Hill\nBrooksside, NE 43781",
                "image": null,
                "mfa_enabled": 0,
                "mfa_method": null,
                "mfa_verified_to": null,
                "location_id": null,
                "created_by": null,
                "active": 1,
                "notifications_timezone": null,
                "notifications_at": null,
                "created_at": "2025-12-08T15:50:37.000000Z",
                "updated_at": "2025-12-08T15:50:37.000000Z",
                "invitation_status": null,
                "acadle_invitation_status": null,
                "roles": []
            },
            "device": {
                "id": 122,
                "serial": "0b72e830-79fe-3fd7-855d-777615749ec6",
                "bluetooth_id": "b55f8ada-50e7-37db-9e33-c60bf5cb005f",
                "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",
                "created_at": "2025-12-08T15:50:37.000000Z",
                "updated_at": "2025-12-08T15:50:37.000000Z"
            },
            "messages": [
                {
                    "id": 19,
                    "ticket_id": 35,
                    "sender_id": 161,
                    "title": "Dr.",
                    "content": "Et nesciunt libero alias.",
                    "is_read": false,
                    "created_at": "2025-12-08T15:50:37.000000Z",
                    "updated_at": "2025-12-08T15:50:37.000000Z"
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list support tickets",
    "code": "TICKETS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/tickets

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

status   string  optional  

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

sender   integer  optional  

Filter tickets by sender. Example: 1

recipient   integer  optional  

Filter tickets by recipient. Example: 1

device   integer  optional  

Filter tickets by device. Example: 1

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

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

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

Get tickets status

requires authentication

Counts tickets by their status

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

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

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

Example response (200, OK):


{
    "unread": 1
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list support tickets",
    "code": "TICKETS:STATUS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/tickets/status

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get support ticket

requires authentication

Returns single support ticket in the response.

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

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

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

Example response (200):


{
    "id": 43,
    "sender_id": 173,
    "recipient_id": 174,
    "device_id": 123,
    "meeting_date": "2025-12-08 15:50:38",
    "meeting_type": "online_meeting",
    "contact_email": "karen.schuppe@hotmail.com",
    "status": "new",
    "created_at": "2025-12-08T15:50:38.000000Z",
    "updated_at": "2025-12-08T15:50:38.000000Z",
    "sender": {
        "id": 173,
        "mrn": "52HI66LS1765209038",
        "name": "Ms. Juliana Bradtke",
        "email": "1765209038fshields@example.com",
        "language": "en",
        "phone": "1-716-808-8026",
        "phone_country": "LU",
        "phone_verified_at": null,
        "address1": "57678 Hill Greens Suite 007",
        "address2": "Isaiport, SD 40522",
        "postal_code": "08380-7826",
        "city": "Reichert PLC",
        "clinic_name": "Volkmanfort",
        "clinic_location": "4751 Weber Loaf Apt. 597\nSchummport, PA 55909",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:38.000000Z",
        "updated_at": "2025-12-08T15:50:38.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 174,
        "mrn": "6LNJ7TLQ1765209038",
        "name": "Brionna Turner",
        "email": "1765209038quinten.miller@example.org",
        "language": "en",
        "phone": "+1-773-356-4277",
        "phone_country": "GP",
        "phone_verified_at": null,
        "address1": "76268 Bogan Valley Suite 977",
        "address2": "East Stantonberg, WI 17745-6479",
        "postal_code": "93935",
        "city": "Orn Ltd",
        "clinic_name": "Rickmouth",
        "clinic_location": "1606 Cronin Parkways\nRollinville, DE 90772",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:38.000000Z",
        "updated_at": "2025-12-08T15:50:38.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": {
        "id": 123,
        "serial": "58abccb8-adf6-316d-880d-0eb813ad7fff",
        "bluetooth_id": "8e1068d4-fadf-303e-84a9-fa59ff0a7b24",
        "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",
        "created_at": "2025-12-08T15:50:38.000000Z",
        "updated_at": "2025-12-08T15:50:38.000000Z"
    },
    "messages": [
        {
            "id": 23,
            "ticket_id": 43,
            "sender_id": 175,
            "title": "Prof.",
            "content": "Recusandae autem dicta occaecati non natus vero.",
            "is_read": false,
            "created_at": "2025-12-08T15:50:38.000000Z",
            "updated_at": "2025-12-08T15:50:38.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view support ticket",
    "code": "TICKETS:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, Support ticket not found):


{
    "message": "Support ticket not found",
    "code": "TICKETS:GET:TICKET_NOT_FOUND"
}

Request   

GET api/ticket/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Support ticket ID. Example: 1

Query Parameters

extend   string  optional  

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

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": 188,
            "action": "optio",
            "reason": "Itaque aliquid nulla natus et debitis culpa alias.",
            "created_at": "2025-12-08T15:50:39.000000Z",
            "updated_at": "2025-12-08T15:50:39.000000Z"
        },
        {
            "id": 2,
            "ticket_id": 52,
            "author_id": 190,
            "action": "molestias",
            "reason": "Iure fugit praesentium vel voluptatem dolore aut.",
            "created_at": "2025-12-08T15:50:39.000000Z",
            "updated_at": "2025-12-08T15:50:39.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view support ticket",
    "code": "TICKETS:HISTORY:INSUFFICIENT_PERMISSION"
}

Example response (404, Support ticket not found):


{
    "message": "Support ticket not found",
    "code": "TICKETS:HISTORY:TICKET_NOT_FOUND"
}

Request   

GET api/ticket/{id}/history

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Support ticket ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

Get support ticket available filters

requires authentication

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

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

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

Example response (200, OK):


{
    "clinicians": [
        {
            "id": 95,
            "mrn": null,
            "name": "Name",
            "email": "email",
            "region": "us",
            "language": "pl",
            "phone": "+48-555555555",
            "phone_verified_at": null,
            "address1": "Address",
            "address2": "Address 2",
            "postal_code": "",
            "city": "",
            "clinic_name": "Name",
            "clinic_location": "Name",
            "image": "https://aether-dev-bucket.s3.amazonaws.com/users/LDueuv1uG218G7owaiLAaWRkpaGxjB0jEFwzZsT1.png",
            "mfa_enabled": 0,
            "mfa_method": "sms",
            "mfa_verified_to": null,
            "location_id": 2,
            "created_by": 1,
            "active": 1,
            "notifications_timezone": "America/Adak",
            "notifications_at": null,
            "created_at": "2022-07-19T14:43:37.000000Z",
            "updated_at": "2024-09-27T05:52:51.000000Z",
            "invitation_status": "expired",
            "roles": [
                {
                    "id": 2,
                    "name": "Clinician",
                    "guard_name": "web",
                    "created_at": "2022-03-21T17:15:47.000000Z",
                    "updated_at": "2022-03-21T17:15:47.000000Z",
                    "pivot": {
                        "model_id": 95,
                        "role_id": 2,
                        "model_type": "App\\Models\\User"
                    }
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create support ticket",
    "code": "TICKETS:AVAILABLE_FILTERS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/tickets/available-filters

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Create new support ticket

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/tickets" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "recipient=1"\
    --form "device=1"\
    --form "meeting_type=online_meeting"\
    --form "meeting_date=2025-12-08 15:50:39"\
    --form "contact_email=strosin.alexane@hotmail.com"\
    --form "message[content]=Vitae error omnis qui."\
    --form "message[title]=Numquam est."\
    --form "message[attachments][]=@/tmp/phpfLH9ZZ" 
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', '2025-12-08 15:50:39');
body.append('contact_email', 'strosin.alexane@hotmail.com');
body.append('message[content]', 'Vitae error omnis qui.');
body.append('message[title]', 'Numquam est.');
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": 191,
    "recipient_id": 192,
    "device_id": 124,
    "meeting_date": "2025-12-08 15:50:39",
    "meeting_type": "online_meeting",
    "contact_email": "lily.gottlieb@stanton.net",
    "status": "new",
    "created_at": "2025-12-08T15:50:39.000000Z",
    "updated_at": "2025-12-08T15:50:39.000000Z",
    "sender": {
        "id": 191,
        "mrn": "L9QQ2JZ31765209039",
        "name": "Prof. Zachery Heathcote III",
        "email": "1765209039solon26@example.com",
        "language": "en",
        "phone": "+1 (878) 367-5225",
        "phone_country": "NA",
        "phone_verified_at": null,
        "address1": "2912 Bennett Pass",
        "address2": "North Magalistad, WY 01314",
        "postal_code": "19966-3925",
        "city": "Bode, Schneider and Emard",
        "clinic_name": "Lake Otilia",
        "clinic_location": "8099 Gennaro Orchard\nPurdychester, MD 43723-8244",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:39.000000Z",
        "updated_at": "2025-12-08T15:50:39.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 192,
        "mrn": "IGTP1EJT1765209039",
        "name": "Francesco Fahey",
        "email": "1765209039cassandre08@example.org",
        "language": "en",
        "phone": "+1-862-992-0809",
        "phone_country": "ES",
        "phone_verified_at": null,
        "address1": "898 Nelle Tunnel",
        "address2": "Watsicaberg, NE 27053-7341",
        "postal_code": "05026",
        "city": "Grant Group",
        "clinic_name": "Zboncakton",
        "clinic_location": "758 Ashton Mountain\nGradystad, MO 58625-0746",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:39.000000Z",
        "updated_at": "2025-12-08T15:50:39.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": {
        "id": 124,
        "serial": "b5db65ff-df3b-3f6f-a046-7319f37a6ade",
        "bluetooth_id": "ab96807b-9aaa-39af-88a9-fd805e31a4ed",
        "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",
        "created_at": "2025-12-08T15:50:39.000000Z",
        "updated_at": "2025-12-08T15:50:39.000000Z"
    },
    "messages": [
        {
            "id": 27,
            "ticket_id": 53,
            "sender_id": 193,
            "title": "Dr.",
            "content": "Dolor necessitatibus quod repellendus exercitationem tempore quos.",
            "is_read": false,
            "created_at": "2025-12-08T15:50:39.000000Z",
            "updated_at": "2025-12-08T15:50:39.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create support ticket",
    "code": "TICKETS:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/tickets

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

recipient   integer   

User the support ticket is assigned to. For Amputee role main clinician will be automatically assigned instead. The id of an existing record in the App\Models\User table. Example: 1

device   integer  optional  

Device the support ticket is assigned to. The id of an existing record in the App\Models\Device table. Example: 1

meeting_type   string   

Type of support meeting. Example: online_meeting

Must be one of:
  • online_meeting
  • phone_call
  • personally
  • none
meeting_date   string   

Date of support meeting. MUST_BE_DATE. Example: 2025-12-08 15:50:39

contact_email   string  optional  

Email address for later contact. MUST_BE_EMAIL. Example: strosin.alexane@hotmail.com

message   object  optional  
content   string  optional  

Content of message. Example: Vitae error omnis qui.

title   string  optional  

Message title. Example: Numquam est.

attachments   file[]  optional  

Must be a file.

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": 205,
    "recipient_id": 206,
    "device_id": 125,
    "meeting_date": "2025-12-08 15:50:40",
    "meeting_type": "online_meeting",
    "contact_email": "baumbach.lia@yahoo.com",
    "status": "new",
    "created_at": "2025-12-08T15:50:40.000000Z",
    "updated_at": "2025-12-08T15:50:40.000000Z",
    "sender": {
        "id": 205,
        "mrn": "TBP9E51D1765209040",
        "name": "Bartholome Muller",
        "email": "1765209040ywiza@example.net",
        "language": "en",
        "phone": "+1 (947) 818-4537",
        "phone_country": "RU",
        "phone_verified_at": null,
        "address1": "391 Cornell Flat",
        "address2": "Hiramberg, VA 78463-3715",
        "postal_code": "26410-3511",
        "city": "Stracke, Lind and Wilderman",
        "clinic_name": "Port Emeliafort",
        "clinic_location": "20476 Noah Islands\nCreolaberg, ME 58617",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:40.000000Z",
        "updated_at": "2025-12-08T15:50:40.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 206,
        "mrn": "M12TPSKW1765209040",
        "name": "Don Ratke I",
        "email": "1765209040anita65@example.com",
        "language": "en",
        "phone": "+1-313-353-5525",
        "phone_country": "SX",
        "phone_verified_at": null,
        "address1": "93666 Retha Plain",
        "address2": "Oscarville, WY 17305",
        "postal_code": "23589",
        "city": "Abbott-Hickle",
        "clinic_name": "West Carlo",
        "clinic_location": "9011 Sheila View\nVolkmanshire, VT 83392",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:40.000000Z",
        "updated_at": "2025-12-08T15:50:40.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": {
        "id": 125,
        "serial": "984f60b6-636a-3a02-9609-e85290ad1b83",
        "bluetooth_id": "21a26a52-db5f-3e11-91fa-620428a55f1d",
        "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",
        "created_at": "2025-12-08T15:50:40.000000Z",
        "updated_at": "2025-12-08T15:50:40.000000Z"
    },
    "messages": []
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to close support ticket",
    "code": "TICKETS:CLOSE:INSUFFICIENT_PERMISSION"
}

Example response (404, Support ticket not found):


{
    "message": "Support ticket not found",
    "code": "TICKETS:CLOSE:TICKET_NOT_FOUND"
}

Request   

POST api/ticket/{id}/close

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Support ticket ID. Example: 1

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": 208,
    "action": "quis",
    "reason": "Nihil accusamus commodi id maxime totam cum ex.",
    "created_at": "2025-12-08T15:50:40.000000Z",
    "updated_at": "2025-12-08T15:50:40.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to reopen support ticket",
    "code": "TICKETS:REOPEN:INSUFFICIENT_PERMISSION"
}

Example response (404, Support ticket not found):


{
    "message": "Support ticket not found",
    "code": "TICKETS:REOPEN:TICKET_NOT_FOUND"
}

Request   

POST api/ticket/{id}/reopen

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Support ticket ID. Example: 1

Body Parameters

reason   string  optional  

Reason for reopen action. Example: Something is still not working

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=Quasi magnam possimus."\
    --form "content=Quod error vel voluptas eius voluptas."\
    --form "attachments[]=@/tmp/php1juDjk" 
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', 'Quasi magnam possimus.');
body.append('content', 'Quod error vel voluptas eius voluptas.');
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": 209,
    "recipient_id": 210,
    "device_id": 126,
    "meeting_date": "2025-12-08 15:50:40",
    "meeting_type": "online_meeting",
    "contact_email": "nettie.crist@hotmail.com",
    "status": "new",
    "created_at": "2025-12-08T15:50:40.000000Z",
    "updated_at": "2025-12-08T15:50:40.000000Z",
    "sender": {
        "id": 209,
        "mrn": "AV58OSF61765209040",
        "name": "Ellen Fadel V",
        "email": "1765209040rosemarie15@example.net",
        "language": "en",
        "phone": "1-947-458-8840",
        "phone_country": "DE",
        "phone_verified_at": null,
        "address1": "409 Darion Route Apt. 414",
        "address2": "Adamsmouth, NY 44872",
        "postal_code": "62496",
        "city": "Littel PLC",
        "clinic_name": "New Edafurt",
        "clinic_location": "663 Pagac Spring\nVeumchester, NM 21411-9634",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:40.000000Z",
        "updated_at": "2025-12-08T15:50:40.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 210,
        "mrn": "TZ066ZPH1765209040",
        "name": "Hertha Doyle Sr.",
        "email": "1765209040casandra82@example.net",
        "language": "en",
        "phone": "+1-914-624-6629",
        "phone_country": "VE",
        "phone_verified_at": null,
        "address1": "930 Daniel Pine Suite 367",
        "address2": "Port Francisco, SC 36400-0663",
        "postal_code": "59151",
        "city": "Schultz, Ullrich and Mayer",
        "clinic_name": "East Deonte",
        "clinic_location": "302 Crooks Drives\nEast Mac, IL 12132-7580",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:40.000000Z",
        "updated_at": "2025-12-08T15:50:40.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": {
        "id": 126,
        "serial": "d349b8c9-1fd2-39ed-a168-b08e1ab4d334",
        "bluetooth_id": "f2f8ba79-6927-3e09-850b-56ed70967451",
        "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",
        "created_at": "2025-12-08T15:50:40.000000Z",
        "updated_at": "2025-12-08T15:50:40.000000Z"
    },
    "messages": [
        {
            "id": 31,
            "ticket_id": 63,
            "sender_id": 211,
            "title": "Miss",
            "content": "Velit sapiente et vitae saepe impedit sed rem ducimus.",
            "is_read": false,
            "created_at": "2025-12-08T15:50:41.000000Z",
            "updated_at": "2025-12-08T15:50:41.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create support ticket",
    "code": "TICKETS:CREATE_MESSAGE:INSUFFICIENT_PERMISSION"
}

Example response (404, Support ticket not found):


{
    "message": "Support ticket not found",
    "code": "TICKETS:CREATE_MESSAGE:TICKET_NOT_FOUND"
}

Request   

POST api/ticket/{id}/messages

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

id   integer   

Support ticket ID. Example: 1

Body Parameters

title   string  optional  

Message title. Example: Quasi magnam possimus.

content   string  optional  

Content of message. Example: Quod error vel voluptas eius voluptas.

attachments   file[]  optional  

Must be a file.

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": 223,
    "recipient_id": 224,
    "device_id": 127,
    "meeting_date": "2025-12-08 15:50:41",
    "meeting_type": "online_meeting",
    "contact_email": "hand.colby@gmail.com",
    "status": "new",
    "created_at": "2025-12-08T15:50:41.000000Z",
    "updated_at": "2025-12-08T15:50:41.000000Z",
    "sender": {
        "id": 223,
        "mrn": "Q5XZT3OZ1765209041",
        "name": "Prof. Jeanne Feeney",
        "email": "1765209041joana.goldner@example.net",
        "language": "en",
        "phone": "901.617.4460",
        "phone_country": "FM",
        "phone_verified_at": null,
        "address1": "14706 Robert Estate Suite 491",
        "address2": "Cremintown, ND 91747",
        "postal_code": "35220",
        "city": "Thompson, Hammes and Braun",
        "clinic_name": "Wildermanville",
        "clinic_location": "3664 Shawn Prairie\nNorth Jordyville, MS 73595",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:41.000000Z",
        "updated_at": "2025-12-08T15:50:41.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 224,
        "mrn": "E08E3FC61765209041",
        "name": "Ewell Beer",
        "email": "1765209041heaney.marcia@example.org",
        "language": "en",
        "phone": "680-988-2837",
        "phone_country": "PG",
        "phone_verified_at": null,
        "address1": "29061 Lela Circle",
        "address2": "New Assuntaport, MD 68222",
        "postal_code": "49973-1205",
        "city": "Rodriguez and Sons",
        "clinic_name": "Dexterburgh",
        "clinic_location": "5086 Victor Rapids\nEstellmouth, MS 15022",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:41.000000Z",
        "updated_at": "2025-12-08T15:50:41.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": {
        "id": 127,
        "serial": "ec388da5-0f9a-31cb-81c0-ac1406e4e376",
        "bluetooth_id": "9e970d9b-de09-339c-b23f-348968b12c66",
        "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",
        "created_at": "2025-12-08T15:50:41.000000Z",
        "updated_at": "2025-12-08T15:50:41.000000Z"
    },
    "messages": [
        {
            "id": 35,
            "ticket_id": 71,
            "sender_id": 225,
            "title": "Prof.",
            "content": "Nisi aliquam dolores quia sed nisi repellendus unde excepturi.",
            "is_read": false,
            "created_at": "2025-12-08T15:50:42.000000Z",
            "updated_at": "2025-12-08T15:50:42.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to read message",
    "code": "TICKETS:READ_ALL:INSUFFICIENT_PERMISSION"
}

Example response (404, Support ticket not found):


{
    "message": "Support ticket not found",
    "code": "TICKETS:READ_ALL:TICKET_NOT_FOUND"
}

Request   

POST api/ticket/{id}/read

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Support ticket ID (id from ticket list; do not confuse with messages.id). Example: 1

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": 237,
    "recipient_id": 238,
    "device_id": 128,
    "meeting_date": "2025-12-08 15:50:42",
    "meeting_type": "online_meeting",
    "contact_email": "dare.nichole@balistreri.org",
    "status": "new",
    "created_at": "2025-12-08T15:50:42.000000Z",
    "updated_at": "2025-12-08T15:50:42.000000Z",
    "sender": {
        "id": 237,
        "mrn": "1Y9INTC81765209042",
        "name": "Monserrat Ernser",
        "email": "1765209042bertrand88@example.org",
        "language": "en",
        "phone": "1-332-579-9495",
        "phone_country": "CX",
        "phone_verified_at": null,
        "address1": "841 Goyette Port",
        "address2": "Lauriannemouth, RI 66290-5132",
        "postal_code": "82973",
        "city": "Kihn-Windler",
        "clinic_name": "Beiershire",
        "clinic_location": "4148 Fritsch Divide\nLake Brigitte, KS 82867-2880",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:42.000000Z",
        "updated_at": "2025-12-08T15:50:42.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "recipient": {
        "id": 238,
        "mrn": "WSD2PCJP1765209042",
        "name": "Odie Schmidt",
        "email": "1765209042ella44@example.net",
        "language": "en",
        "phone": "(410) 858-9033",
        "phone_country": "PE",
        "phone_verified_at": null,
        "address1": "42635 Morar Mews",
        "address2": "Krisville, TN 87670",
        "postal_code": "27926-7142",
        "city": "Rippin-Harber",
        "clinic_name": "Cummingsburgh",
        "clinic_location": "75473 Little Track Suite 298\nAshleetown, WI 34316",
        "image": null,
        "mfa_enabled": 0,
        "mfa_method": null,
        "mfa_verified_to": null,
        "location_id": null,
        "created_by": null,
        "active": 1,
        "notifications_timezone": null,
        "notifications_at": null,
        "created_at": "2025-12-08T15:50:42.000000Z",
        "updated_at": "2025-12-08T15:50:42.000000Z",
        "invitation_status": null,
        "acadle_invitation_status": null,
        "roles": []
    },
    "device": {
        "id": 128,
        "serial": "dbb57c9c-65e4-3bd0-9e2b-fb005ad57d05",
        "bluetooth_id": "e9064ee6-630e-3cb5-bfcc-a892d18b4ddc",
        "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",
        "created_at": "2025-12-08T15:50:42.000000Z",
        "updated_at": "2025-12-08T15:50:42.000000Z"
    },
    "messages": [
        {
            "id": 39,
            "ticket_id": 79,
            "sender_id": 239,
            "title": "Mr.",
            "content": "Distinctio nemo similique magni iure facilis et nobis ipsa.",
            "is_read": false,
            "created_at": "2025-12-08T15:50:43.000000Z",
            "updated_at": "2025-12-08T15:50:43.000000Z"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to read message",
    "code": "TICKETS:READ_MESSAGE:INSUFFICIENT_PERMISSION"
}

Example response (404, Message not found):


{
    "message": "Message not found",
    "code": "TICKETS:READ_MESSAGE:MESSAGE_NOT_FOUND"
}

Request   

POST api/ticket/{id}/read/{messageId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Support ticket ID (id from ticket list; do not confuse with messages.id). Example: 1

messageId   integer   

Message ID. Example: 1

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": "Cortney Abbott Sr.",
            "type": "image",
            "language": "na",
            "file": "0",
            "created_by": 301,
            "created_at": "2025-12-08T15:50:49.000000Z",
            "updated_at": "2025-12-08T15:50:49.000000Z",
            "deleted_at": null
        },
        {
            "id": 2,
            "name": "Jane Thompson",
            "type": "video",
            "language": "an",
            "file": "0",
            "created_by": 302,
            "created_at": "2025-12-08T15:50:50.000000Z",
            "updated_at": "2025-12-08T15:50:50.000000Z",
            "deleted_at": null
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list tooltips",
    "code": "TOOLTIPS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/tooltips

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

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": "Mrs. Sandrine Ledner DVM",
            "type": "image",
            "language": "ng",
            "file": "0",
            "created_by": 303,
            "created_at": "2025-12-08T15:50:50.000000Z",
            "updated_at": "2025-12-08T15:50:50.000000Z",
            "deleted_at": null
        },
        {
            "id": 4,
            "name": "Harry Mayert",
            "type": "image",
            "language": "yi",
            "file": "0",
            "created_by": 304,
            "created_at": "2025-12-08T15:50:50.000000Z",
            "updated_at": "2025-12-08T15:50:50.000000Z",
            "deleted_at": null
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage tooltips",
    "code": "TOOLTIPS:LIST_ARCHIVE:INSUFFICIENT_PERMISSION"
}

Request   

GET api/tooltips/archive

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

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=Pietro Forges"\
    --form "type=video"\
    --form "language=nr"\
    --form "file=@/tmp/phpsHEzov" 
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', 'Pietro Forges');
body.append('type', 'video');
body.append('language', 'nr');
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": "Prof. Neha Von DDS",
    "type": "video",
    "language": "qu",
    "file": "0",
    "created_by": 305,
    "created_at": "2025-12-08T15:50:50.000000Z",
    "updated_at": "2025-12-08T15:50:50.000000Z",
    "deleted_at": null
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage tooltips",
    "code": "TOOLTIPS:CREATE:INSUFFICIENT_PERMISSION"
}

Example response (500, Server error):


{
    "message": "Server error: tooltip not created",
    "code": "TOOLTIPS:CREATE:SERVER_ERROR"
}

Request   

POST api/tooltips

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

name   string   

Tooltip name. Example: Pietro Forges

type   string   

Tooltip content type. Example: video

Must be one of:
  • image
  • video
language   string   

Tooltip content language. Example: nr

file   file   

Tooltip content file. Must have one of the following MIME types: webp, png, jpg, jpeg, mp4. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpsHEzov

Archive tooltip

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Tooltip archived",
    "code": "TOOLTIPS:ARCHIVE:ARCHIVED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage tooltips",
    "code": "TOOLTIPS:ARCHIVE:INSUFFICIENT_PERMISSION"
}

Example response (404, Tooltip not found):


{
    "message": "Tooltip not found",
    "code": "TOOLTIPS:ARCHIVE:TOOLTIP_NOT_FOUND"
}

Request   

POST api/tooltips/{id}/archive

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Tooltip ID. Example: 1

Restore archived tooltip

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Tooltip restored",
    "code": "TOOLTIPS:RESTORE:RESTORED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage tooltips",
    "code": "TOOLTIPS:RESTORE:INSUFFICIENT_PERMISSION"
}

Example response (404, Tooltip not found):


{
    "message": "Tooltip not found",
    "code": "TOOLTIPS:RESTORE:TOOLTIP_NOT_FOUND"
}

Example response (404, Tooltip is not archived):


{
    "message": "Tooltip is not archived",
    "code": "TOOLTIPS:RESTORE:TOOLTIP_NOT_ARCHIVED"
}

Request   

POST api/tooltips/{id}/restore

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Tooltip ID. Example: 1

Trainings

API endpoints for trainings

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": 1,
    "user_id": 309,
    "training_id": 1,
    "created_at": "2025-12-08T15:50:50.000000Z",
    "updated_at": "2025-12-08T15:50:50.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to manage user trainings",
    "code": "TRAININGS:START:INSUFFICIENT_PERMISSION"
}

Example response (403, User training already started):


{
    "message": "Cannot start: training already started",
    "code": "TRAININGS:START:ALREADY_STARTED"
}

Example response (404, Training not found):


{
    "message": "Training not found",
    "code": "TRAININGS:START:TRAINING_NOT_FOUND"
}

Request   

POST api/trainings/start/{trainingId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

trainingId   integer   

Training ID. Example: 1

Users

API endpoints for user management

Get users list

requires authentication

Possible extend options:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/users?search=Tom&active=-1&clinician[]=19&roles=Clinician%2CAmputee" \
    --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]": "19",
    "roles": "Clinician,Amputee",
};
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": "5UHQ5G1L1765209023",
            "name": "Alex Marvin",
            "email": "1765209023melany67@example.org",
            "language": "en",
            "phone": "+1-680-305-9309",
            "phone_country": "AI",
            "phone_verified_at": null,
            "address1": "45773 Kelton Manor Apt. 608",
            "address2": "New Mozellmouth, NC 54784-8304",
            "postal_code": "52344",
            "city": "Ratke, Greenholt and Willms",
            "clinic_name": "Macejkovichaven",
            "clinic_location": "10215 Kshlerin Roads Suite 416\nLebsackhaven, AK 72498",
            "image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2025-12-08T15:50:23.000000Z",
            "updated_at": "2025-12-08T15:50:23.000000Z",
            "invitation_status": null,
            "acadle_invitation_status": null,
            "clinicians": [
                {
                    "id": 8,
                    "mrn": "N32GJ9MI1765209023",
                    "name": "Lincoln Lynch",
                    "email": "1765209023kaylah.damore@example.com",
                    "language": "en",
                    "phone": "(706) 586-6662",
                    "phone_country": "NP",
                    "phone_verified_at": null,
                    "address1": "5016 Elijah Street Suite 834",
                    "address2": "North Lempiside, CA 55674",
                    "postal_code": "82274",
                    "city": "Von-Kub",
                    "clinic_name": "West Maximusshire",
                    "clinic_location": "51609 Bertha Junctions Suite 205\nKuphalville, LA 77825",
                    "image": null,
                    "mfa_enabled": 0,
                    "mfa_method": null,
                    "mfa_verified_to": null,
                    "location_id": null,
                    "created_by": null,
                    "active": 1,
                    "notifications_timezone": null,
                    "notifications_at": null,
                    "created_at": "2025-12-08T15:50:23.000000Z",
                    "updated_at": "2025-12-08T15:50:23.000000Z",
                    "invitation_status": null,
                    "acadle_invitation_status": null,
                    "pivot": {
                        "user_id": 7,
                        "assigned_user_id": 8
                    },
                    "roles": []
                }
            ],
            "devices": [
                {
                    "id": 1,
                    "serial": "3c830e6c-13e9-3936-905c-6b87b6b227a3",
                    "bluetooth_id": "7dfa2ad2-9098-30b0-8739-c70314b0cec7",
                    "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",
                    "created_at": "2025-12-08T15:50:23.000000Z",
                    "updated_at": "2025-12-08T15:50:23.000000Z"
                }
            ],
            "roles": [
                {
                    "id": 1,
                    "name": "SuperAdmin"
                }
            ]
        },
        {
            "id": 9,
            "mrn": "W8O9HUU71765209023",
            "name": "Eloisa Lockman V",
            "email": "1765209023xolson@example.org",
            "language": "en",
            "phone": "1-559-302-1612",
            "phone_country": "AL",
            "phone_verified_at": null,
            "address1": "89322 Janelle Glens",
            "address2": "Clovisshire, NH 86974-6675",
            "postal_code": "57669-6878",
            "city": "Hill Group",
            "clinic_name": "Lake Catherineville",
            "clinic_location": "5883 Stoltenberg Islands\nLake Montyfort, CO 86588-3836",
            "image": null,
            "mfa_enabled": 0,
            "mfa_method": null,
            "mfa_verified_to": null,
            "location_id": null,
            "created_by": null,
            "active": 1,
            "notifications_timezone": null,
            "notifications_at": null,
            "created_at": "2025-12-08T15:50:23.000000Z",
            "updated_at": "2025-12-08T15:50:23.000000Z",
            "invitation_status": "accepted",
            "acadle_invitation_status": null,
            "clinicians": [
                {
                    "id": 10,
                    "mrn": "2QY08N151765209023",
                    "name": "Daisy Corkery",
                    "email": "1765209023sandy.kulas@example.org",
                    "language": "en",
                    "phone": "+1-865-767-8646",
                    "phone_country": "EC",
                    "phone_verified_at": null,
                    "address1": "3470 Bennie Ranch",
                    "address2": "Hellerfurt, WY 06634",
                    "postal_code": "04634",
                    "city": "Fadel Inc",
                    "clinic_name": "West Rahulborough",
                    "clinic_location": "621 Berta Forges\nSouth Aryannatown, GA 23261",
                    "image": null,
                    "mfa_enabled": 0,
                    "mfa_method": null,
                    "mfa_verified_to": null,
                    "location_id": null,
                    "created_by": null,
                    "active": 1,
                    "notifications_timezone": null,
                    "notifications_at": null,
                    "created_at": "2025-12-08T15:50:23.000000Z",
                    "updated_at": "2025-12-08T15:50:23.000000Z",
                    "invitation_status": null,
                    "acadle_invitation_status": null,
                    "pivot": {
                        "user_id": 9,
                        "assigned_user_id": 10
                    },
                    "roles": []
                }
            ],
            "devices": [
                {
                    "id": 2,
                    "serial": "96b20e04-64ec-35c9-ac66-19cb0ce77792",
                    "bluetooth_id": "431ead6e-a38f-36d0-afa5-3824faa53064",
                    "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",
                    "created_at": "2025-12-08T15:50:23.000000Z",
                    "updated_at": "2025-12-08T15:50:23.000000Z"
                }
            ],
            "roles": [
                {
                    "id": 3,
                    "name": "Clinician"
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view user list",
    "code": "USERS:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/users

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

search   string  optional  

Filter users by name. For SuperAdmin role it filters by UUID. Example: Tom

active   integer  optional  

Filter users by active status (available: 0 - only inactive, 1 - only active, -1 - all users). Default: 1. Example: -1

clinician   integer[]  optional  

Filter users by clinician. Provide single ID (clinician=1), array of IDs (clinician[]=1&clinician[]=2) or comma-separated list of IDs (clinician=1,2).

roles   string  optional  

Filter users by roles (comma-separated). Example: Clinician,Amputee

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: clinicians, patients, devices, devicesAsClinician, roles, permissions).

sortby   string  optional  

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

sortdir   string  optional  

Sort direction (available: asc, desc).

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": "BXXIJBLP1765209023",
    "name": "Prof. Reina Bayer IV",
    "email": "1765209023autumn.mohr@example.net",
    "language": "en",
    "phone": "(813) 337-9389",
    "phone_country": "AI",
    "phone_verified_at": null,
    "address1": "25015 Abshire Road",
    "address2": "Wilkinsonbury, MT 69912",
    "postal_code": "91864-5670",
    "city": "McCullough-Altenwerth",
    "clinic_name": "Nicolahaven",
    "clinic_location": "312 Ernesto Village Apt. 652\nSouth Christopherborough, UT 84295",
    "image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2025-12-08T15:50:23.000000Z",
    "updated_at": "2025-12-08T15:50:23.000000Z",
    "invitation_status": "accepted",
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 4,
            "name": "ClinicianSupport"
        }
    ]
}

Request   

GET api/me

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

extend   string  optional  

Comma-separated list of relation extensions (available: clinicians, patients, devices, devicesAsClinician, roles, permissions).

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": "0ZM6SNAK1765209023",
    "name": "Betsy Stracke",
    "email": "1765209023angelina.hammes@example.com",
    "language": "en",
    "phone": "1-667-924-8363",
    "phone_country": "GS",
    "phone_verified_at": null,
    "address1": "770 Yost Shoals Suite 353",
    "address2": "Isabelltown, VT 16740-4363",
    "postal_code": "78910-3218",
    "city": "Gerlach Group",
    "clinic_name": "New Eleanorafort",
    "clinic_location": "594 Okey Forge\nNilschester, IN 98575-8624",
    "image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2025-12-08T15:50:23.000000Z",
    "updated_at": "2025-12-08T15:50:23.000000Z",
    "invitation_status": null,
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 1,
            "name": "SuperAdmin"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view user data",
    "code": "USERS:GET:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:GET:USER_NOT_FOUND"
}

Request   

GET api/user/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Query Parameters

extend   string  optional  

Comma-separated list of relation extensions (available: clinicians, patients, devices, devicesAsClinician, roles, permissions).

Create new user account

requires authentication

Predefined permissions:

Example request:
curl --request POST \
    "http://localhost:8000/api/user" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "mrn=MRN12345678"\
    --form "name=Tom Smith"\
    --form "email=test@example.com"\
    --form "language=en"\
    --form "address1=48624 Bechtelar Rue Suite 675"\
    --form "address2=Lake Raegan, ME 05898"\
    --form "postal_code=10894"\
    --form "city=Schultzfort"\
    --form "clinic_name=Aether"\
    --form "clinic_location=48624 Bechtelar Rue Suite 675"\
    --form "mfa_enabled=1"\
    --form "mfa_method=email"\
    --form "clinicians[]=2"\
    --form "notifications_timezone=Europe/Warsaw"\
    --form "notifications_at=8:00"\
    --form "role=Amputee"\
    --form "image=@/tmp/phppYfiTV" 
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', '48624 Bechtelar Rue Suite 675');
body.append('address2', 'Lake Raegan, ME 05898');
body.append('postal_code', '10894');
body.append('city', 'Schultzfort');
body.append('clinic_name', 'Aether');
body.append('clinic_location', '48624 Bechtelar Rue Suite 675');
body.append('mfa_enabled', '1');
body.append('mfa_method', 'email');
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]);

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

Example response (201):


{
    "id": 13,
    "mrn": "1DN2OY7Y1765209023",
    "name": "Oma Kassulke",
    "email": "1765209023hahn.nathan@example.org",
    "language": "en",
    "phone": "737-633-9783",
    "phone_country": "KY",
    "phone_verified_at": null,
    "address1": "566 Bogan Isle",
    "address2": "New Delilahborough, MN 79348-2886",
    "postal_code": "20637-2092",
    "city": "Jacobs Inc",
    "clinic_name": "New Mozell",
    "clinic_location": "83267 Bertrand Stravenue Apt. 315\nMitchellshire, MA 46105-8923",
    "image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2025-12-08T15:50:23.000000Z",
    "updated_at": "2025-12-08T15:50:23.000000Z",
    "invitation_status": "accepted",
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 2,
            "name": "ClinicAdmin"
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create user with given role",
    "code": "USERS:CREATE:INSUFFICIENT_PERMISSION"
}

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


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

Request   

POST api/user

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

mrn   string  optional  

Medical Record Number. Example: MRN12345678

name   string  optional  

User full name. Example: Tom Smith

email   string   

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

language   string  optional  

User language. Example: en

address1   string  optional  

Address line 1. MAXIMUM:STRING_LENGTH:100. Example: 48624 Bechtelar Rue Suite 675

address2   string  optional  

Address line 2. MAXIMUM:STRING_LENGTH:100. Example: Lake Raegan, ME 05898

postal_code   string  optional  

Postal code. MAXIMUM:STRING_LENGTH:100. Example: 10894

city   string  optional  

City. MAXIMUM:STRING_LENGTH:100. Example: Schultzfort

clinic_name   string  optional  

Clinic name. MAXIMUM:STRING_LENGTH:100. Example: Aether

clinic_location   string  optional  

Clinic location. MAXIMUM:STRING_LENGTH:100. Example: 48624 Bechtelar Rue Suite 675

image   file  optional  

Attached user image. MUST_BE_IMAGE MAXIMUM:FILE_KB:5120. Example: /tmp/phppYfiTV

mfa_enabled   boolean  optional  

Super Admin only: MFA enabled. Example: true

mfa_method   string  optional  

Super Admin only: MFA method. Example: email

Must be one of:
  • email
  • sms
clinicians   string[]  optional  

Clinician ID. The id of an existing record in the App\Models\User table.

notifications_timezone   string  optional  

User notifications timezone. Example: Europe/Warsaw

notifications_at   string  optional  

Time when notifications and reminders should be sent. Format: HH:MM. Set null to notify at default time. Must be a valid date in the format H:i. Example: 8:00

role   string   

Role name. Example: Amputee

Must be one of:
  • Amputee
  • ClinicianSupport
  • Clinician
  • ClinicAdmin
  • SuperAdmin
  • AcadleUser
permissions   object  optional  

List of permissions given to this user. For now, it is used for ClinicianSupport role to give access to specific actions (for example user.update means that user can update users). You can assign both predefined permissions (already checked by some endpoints) and custom permissions (check them on your own). You can also use wildcards like user.* to give access to all actions for given scope.

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=89216 Sincere Springs Apt. 202"\
    --form "address2=Johnnietown, SD 81392-2122"\
    --form "postal_code=92414-2768"\
    --form "city=Rippinbury"\
    --form "clinic_name=Aether"\
    --form "clinic_location=89216 Sincere Springs Apt. 202"\
    --form "image_delete=1"\
    --form "mfa_enabled=1"\
    --form "mfa_method=email"\
    --form "active=1"\
    --form "clinicians[]=2"\
    --form "notifications_timezone=Europe/Warsaw"\
    --form "notifications_at=8:00"\
    --form "role=Amputee"\
    --form "image=@/tmp/phpLzmn9m" 
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', '89216 Sincere Springs Apt. 202');
body.append('address2', 'Johnnietown, SD 81392-2122');
body.append('postal_code', '92414-2768');
body.append('city', 'Rippinbury');
body.append('clinic_name', 'Aether');
body.append('clinic_location', '89216 Sincere Springs Apt. 202');
body.append('image_delete', '1');
body.append('mfa_enabled', '1');
body.append('mfa_method', 'email');
body.append('active', '1');
body.append('clinicians[]', '2');
body.append('notifications_timezone', 'Europe/Warsaw');
body.append('notifications_at', '8:00');
body.append('role', 'Amputee');
body.append('image', document.querySelector('input[name="image"]').files[0]);

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

Example response (202):


{
    "id": 14,
    "mrn": "JGOHCPPT1765209023",
    "name": "Mr. Benjamin Bruen MD",
    "email": "1765209023else57@example.net",
    "language": "en",
    "phone": "+1-832-535-0926",
    "phone_country": "MQ",
    "phone_verified_at": null,
    "address1": "768 Rowe Drives",
    "address2": "Boyleside, TX 50987-9844",
    "postal_code": "77448-4760",
    "city": "Zboncak-Parisian",
    "clinic_name": "Maryberg",
    "clinic_location": "549 Lesly Crossroad\nMurphybury, IN 34761",
    "image": null,
    "mfa_enabled": 0,
    "mfa_method": null,
    "mfa_verified_to": null,
    "location_id": null,
    "created_by": null,
    "active": 1,
    "notifications_timezone": null,
    "notifications_at": null,
    "created_at": "2025-12-08T15:50:23.000000Z",
    "updated_at": "2025-12-08T15:50:23.000000Z",
    "invitation_status": "accepted",
    "acadle_invitation_status": null,
    "roles": [
        {
            "id": 3,
            "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"
}

Request   

PUT api/user/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Body Parameters

mrn   string  optional  

Medical Record Number. Example: MRN12345678

name   string  optional  

User full name. Example: Tom Smith

email   string  optional  

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

language   string  optional  

User language. Example: en

address1   string  optional  

Address line 1. MAXIMUM:STRING_LENGTH:100. Example: 89216 Sincere Springs Apt. 202

address2   string  optional  

Address line 2. MAXIMUM:STRING_LENGTH:100. Example: Johnnietown, SD 81392-2122

postal_code   string  optional  

Postal code. MAXIMUM:STRING_LENGTH:100. Example: 92414-2768

city   string  optional  

City. MAXIMUM:STRING_LENGTH:100. Example: Rippinbury

clinic_name   string  optional  

Clinic name. MAXIMUM:STRING_LENGTH:100. Example: Aether

clinic_location   string  optional  

Clinic location. MAXIMUM:STRING_LENGTH:100. Example: 89216 Sincere Springs Apt. 202

image   file  optional  

Attached user image. MUST_BE_IMAGE MAXIMUM:FILE_KB:5120. Example: /tmp/phpLzmn9m

image_delete   boolean  optional  

Send this parameter instead of image to remove previously added image. Example: true

mfa_enabled   boolean  optional  

Super Admin only: MFA enabled. Example: true

mfa_method   string  optional  

Super Admin only: MFA method. Example: email

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

User active status (0 - inactive, 1 - active). Example: true

clinicians   string[]  optional  

Clinician ID. The id of an existing record in the App\Models\User table.

notifications_timezone   string  optional  

User notifications timezone. Example: Europe/Warsaw

notifications_at   string  optional  

Time when notifications and reminders should be sent. Format: HH:MM. Set null to notify at default time. Must be a valid date in the format H:i. Example: 8:00

role   string  optional  

Role name. Example: Amputee

Must be one of:
  • Amputee
  • ClinicianSupport
  • Clinician
  • ClinicAdmin
  • SuperAdmin
  • AcadleUser
permissions   object  optional  

List of permissions given to this user. For now, it is used for ClinicianSupport role to give access to specific actions (for example user.update means that user can update users). You can assign both predefined permissions (already checked by some endpoints) and custom permissions (check them on your own). You can also use wildcards like user.* to give access to all actions for given scope.

Update user phone number

requires authentication

Phone number has to be verified after update. Call /api/mfa/phone/verify with user-filled code after performing this operation. If value is "0" phone number will be removed without any verification.

Example request:
curl --request POST \
    "http://localhost:8000/api/user/1/phone" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"phone\": \"+1 (208) 892-0242\",
    \"phone_country\": \"US\"
}"

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

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

let body = {
    "phone": "+1 (208) 892-0242",
    "phone_country": "US"
};

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

Example response (200, Phone number removed):


{
    "message": "Phone number removed",
    "code": "USERS:SET_PHONE:REMOVED"
}

Example response (200, Phone number updated):


{
    "message": "Verification code sent. Call /api/mfa/phone/verify to verify phone number.",
    "code": "USERS:SET_PHONE:UPDATED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update user data",
    "code": "USERS:SET_PHONE:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:SET_PHONE:USER_NOT_FOUND"
}

Example response (500, Code send failed):


{
    "message": "Verification code sending failed",
    "code": "USERS:SET_PHONE:SEND_FAILED"
}

Request   

POST api/user/{id}/phone

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Body Parameters

phone   string  optional  

User phone number. Pass "0" to remove current one. Example: +1 (208) 892-0242

phone_country   string  optional  

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

Delete user account

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "User deleted",
    "code": "USERS:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete user",
    "code": "USERS:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (403, User has existing patients or chat rooms):


{
    "message": "Cannot delete: user has existing patients or chat rooms (patients: 1, chat rooms: 0)",
    "code": "USERS:DELETE:HAS_PATIENTS"
}

Example response (403, User has existing devices):


{
    "message": "Cannot delete: user has existing devices (as patient: 1, as clinician: 0)",
    "code": "USERS:DELETE:HAS_DEVICES"
}

Example response (403, User has open P2P sessions):


{
    "message": "Cannot delete: user has open P2P sessions (as patient: 0, as clinician: 1)",
    "code": "USERS:DELETE:HAS_P2P_SESSIONS"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:DELETE:USER_NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error: user not deleted",
    "code": "USERS:DELETE:SERVER_ERROR"
}

Request   

DELETE api/user/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

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\": \"inventore\"
}"

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": "inventore"
};

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

Example response (202, OK):


{
    "message": "User password changed",
    "code": "USERS:PASSWORD_CHANGE:CHANGED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to change user password",
    "code": "USERS:PASSWORD_CHANGE:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:PASSWORD_CHANGE:USER_NOT_FOUND"
}

Request   

POST api/user/{id}/password

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Body Parameters

password   string   

Example: inventore

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": "75aa0aca-0df6-3fea-a473-b190ae4364e6",
            "bluetooth_id": "13623470-886b-3771-a951-587e95b830fa",
            "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",
            "created_at": "2025-12-08T15:50:23.000000Z",
            "updated_at": "2025-12-08T15:50:23.000000Z",
            "model": {
                "id": 1,
                "name": "Zeus hand v1",
                "type": "arm",
                "orientation": "right",
                "active": 1,
                "created_at": "2025-12-08T15:50:23.000000Z",
                "updated_at": "2025-12-08T15:50:23.000000Z"
            }
        },
        {
            "id": 4,
            "serial": "92b75c36-eee3-35e0-b209-a62ac61d7d5c",
            "bluetooth_id": "865929f9-d2b9-3899-a150-5b05438f60df",
            "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",
            "created_at": "2025-12-08T15:50:23.000000Z",
            "updated_at": "2025-12-08T15:50:23.000000Z",
            "model": {
                "id": 2,
                "name": "Zeus hand v1",
                "type": "arm",
                "orientation": "left",
                "active": 1,
                "created_at": "2025-12-08T15:50:23.000000Z",
                "updated_at": "2025-12-08T15:50:23.000000Z"
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to view user devices",
    "code": "USERS:DEVICES:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:DEVICES:USER_NOT_FOUND"
}

Request   

GET api/user/{id}/devices

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Query Parameters

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: model, firmwareVersion, pcbVersion).

Attach patient to clinician

requires authentication

Example request:
curl --request POST \
    "http://localhost:8000/api/user/attach" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"name@domain.com\"
}"

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

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

let body = {
    "email": "name@domain.com"
};

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

Example response (202, OK):


{
    "message": "Patient attached",
    "code": "USERS:ATTACH:ATTACHED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to attach patients",
    "code": "USERS:ATTACH:INSUFFICIENT_PERMISSION"
}

Example response (403, Patient is already assigned to another clinician):


{
    "message": "Patient is already assigned to another clinician",
    "code": "USERS:ATTACH:ALREADY_ASSIGNED"
}

Example response (403, User reached the temporary limit of attached devices):


{
    "message": "Reached the limit of assigned devices",
    "code": "USERS:ATTACH:LIMIT_REACHED"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:ATTACH:USER_NOT_FOUND"
}

Request   

POST api/user/attach

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

User e-mail address. MUST_BE_EMAIL The email of an existing record in the App\Models\User table. Example: name@domain.com

Detach patient from clinician

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Patient detached",
    "code": "USERS:DETACH:DETACHED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to detach patient",
    "code": "USERS:DETACH:INSUFFICIENT_PERMISSION"
}

Example response (403, Cannot detach last clinician):


{
    "message": "Cannot detach patient's last clinician",
    "code": "USERS:DETACH:CANNOT_DETACH_LAST_CLINICIAN"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:DETACH:USER_NOT_FOUND"
}

Request   

POST api/user/{id}/detach

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Admin access to MFA codes

requires authentication

Requires admin.mfa_access permission.

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

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

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

Example response (200, OK):


[
    {
        "id": 1,
        "user_id": 1,
        "code": "123456",
        "channel": "email",
        "expires": "2025-05-09 12:00:00"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access MFA codes",
    "code": "USERS:ADMIN_MFA_ACCESS:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:ADMIN_MFA_ACCESS:USER_NOT_FOUND"
}

Request   

GET api/user/{id}/mfa-codes

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

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": 1,
        "name": "perspiciatis",
        "value": "animi",
        "created_at": "1995-10-06T09:44:00.000000Z",
        "updated_at": "1975-07-08T20:34:51.000000Z"
    },
    {
        "id": 2,
        "user_id": 1,
        "name": "id",
        "value": "aliquam",
        "created_at": "1988-12-19T20:03:43.000000Z",
        "updated_at": "1979-05-07T05:39:23.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to use mobile consents",
    "code": "USERS:GET_MOBILE_CONSENTS:INSUFFICIENT_PERMISSION"
}

Request   

GET api/consents

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

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": 1,
        "name": "perspiciatis",
        "value": "est",
        "created_at": "1989-08-31T05:01:56.000000Z",
        "updated_at": "1971-11-19T05:45:54.000000Z"
    },
    {
        "id": 4,
        "user_id": 1,
        "name": "nesciunt",
        "value": "et",
        "created_at": "2003-04-04T19:43:10.000000Z",
        "updated_at": "2023-02-11T19:37:24.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to use mobile consents",
    "code": "USERS:SET_MOBILE_CONSENTS:INSUFFICIENT_PERMISSION"
}

Request   

POST api/consents

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Consent name. Example: Push notifications

value   string   

Consent value. Example: 1

Clear user notifications

requires authentication

Clearing notifications allow to receive another notification on same day. This endpoint deletes notifications of type:

    This endpoint is intended for testing use only.
Example request:
curl --request DELETE \
    "http://localhost:8000/api/notifications/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/notifications/1"
);

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

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

Example response (202, OK):


{
    "messages": "1 notifications deleted",
    "code": "USERS:CLEAR_NOTIFICATIONS:CLEARED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update user data",
    "code": "USERS:CLEAR_NOTIFICATIONS:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "USERS:CLEAR_NOTIFICATIONS:USER_NOT_FOUND"
}

Request   

DELETE api/notifications/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

User ID. Example: 1

Versions

API endpoints for versions management

Get software versions

requires authentication

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

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

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

Example response (200):


[
    {
        "id": 1,
        "name": "6.52.14",
        "created_at": "2025-12-08T15:50:44.000000Z",
        "updated_at": "2025-12-08T15:50:44.000000Z"
    },
    {
        "id": 2,
        "name": "4.96.57",
        "created_at": "2025-12-08T15:50:44.000000Z",
        "updated_at": "2025-12-08T15:50:44.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list versions",
    "code": "SOFTWARE_VERSION:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/versions/software

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

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": "7.58.82",
    "created_at": "2025-12-08T15:50:44.000000Z",
    "updated_at": "2025-12-08T15:50:44.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create versions",
    "code": "SOFTWARE_VERSION:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/versions/software

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Name of version. Example: 1.0

Delete software version

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Version deleted",
    "code": "SOFTWARE_VERSION:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete versions",
    "code": "SOFTWARE_VERSION:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (403, Version in use (compatibility)):


{
    "message": "Cannot delete: version is used in compatibility entries (1)",
    "code": "SOFTWARE_VERSION:DELETE:VERSION_IN_USE_COMPATIBILITY"
}

Example response (404, Version not found):


{
    "message": "Version not found",
    "code": "SOFTWARE_VERSION:DELETE:VERSION_NOT_FOUND"
}

Request   

DELETE api/versions/software/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Software Version ID. Example: 1

Get firmware versions

requires authentication

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

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

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

Example response (200):


[
    {
        "id": 2,
        "name": "3.68.1",
        "model_id": null,
        "file_firmware": "/tmp/fakerUMkGMD",
        "file_firmware_v2": "/tmp/fakervvuGOD",
        "file_firmware_v3": "/tmp/fakerYES7xs",
        "file_firmware_v4": "/tmp/fakerFIpzp3",
        "file_firmware_v5": "/tmp/fakersQ8IMr",
        "file_firmware_new_pcb": "/tmp/faker5krD9k",
        "file_bootloader": "/tmp/fakerwmfQOJ",
        "file_bootloader_v2": "/tmp/fakeryZYVcw",
        "file_bootloader_v3": "/tmp/fakerLT6N1O",
        "file_bootloader_v4": "/tmp/fakertRZiTo",
        "changelog": "Quos qui accusantium impedit nesciunt quia vel provident. Et a ipsa totam amet. Et et dolores eius quaerat harum placeat eligendi. Sapiente aliquid mollitia qui qui eos ut.",
        "created_at": "2025-12-08T15:50:44.000000Z",
        "updated_at": "2025-12-08T15:50:44.000000Z"
    },
    {
        "id": 3,
        "name": "1.61.70",
        "model_id": null,
        "file_firmware": "/tmp/fakerYqlEFR",
        "file_firmware_v2": "/tmp/fakera0f0kB",
        "file_firmware_v3": "/tmp/fakerOIjymw",
        "file_firmware_v4": "/tmp/fakerUEfNvp",
        "file_firmware_v5": "/tmp/fakerIB5HWv",
        "file_firmware_new_pcb": "/tmp/fakerA8TBAF",
        "file_bootloader": "/tmp/fakerCMrKWe",
        "file_bootloader_v2": "/tmp/fakery6HlTY",
        "file_bootloader_v3": "/tmp/fakerfxmG3c",
        "file_bootloader_v4": "/tmp/fakerWmZX87",
        "changelog": "Et placeat quisquam vitae aut iure. Incidunt sint nihil occaecati et repellendus enim. Similique quo expedita asperiores neque sunt officiis at. Non accusamus eaque repellat eligendi.",
        "created_at": "2025-12-08T15:50:44.000000Z",
        "updated_at": "2025-12-08T15:50:44.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list versions",
    "code": "FIRMWARE_VERSION:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/versions/firmware

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

extend   string  optional  

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

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 "model_id=1"\
    --form "changelog[][language]=en"\
    --form "changelog[][changelog]=Fixed bug with the connection"\
    --form "file_firmware=@/tmp/phpydlcj8" \
    --form "file_firmware_v2=@/tmp/phpfURU2c" \
    --form "file_firmware_v3=@/tmp/phpoY7TEe" \
    --form "file_firmware_v4=@/tmp/phpuziFi0" \
    --form "file_firmware_v5=@/tmp/phpNreS5N" \
    --form "file_firmware_new_pcb=@/tmp/phpgihpbG" \
    --form "file_bootloader=@/tmp/phpCsuEYh" \
    --form "file_bootloader_v2=@/tmp/phpBTOxVt" \
    --form "file_bootloader_v3=@/tmp/php1MaUoe" \
    --form "file_bootloader_v4=@/tmp/phpL4Lwrr" 
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('model_id', '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": "8.85.79",
    "model_id": null,
    "file_firmware": "/tmp/fakergdh5fc",
    "file_firmware_v2": "/tmp/fakerP63LCB",
    "file_firmware_v3": "/tmp/faker4BcEJX",
    "file_firmware_v4": "/tmp/fakerZ28xPp",
    "file_firmware_v5": "/tmp/fakerkFnLP5",
    "file_firmware_new_pcb": "/tmp/fakerS1cDbY",
    "file_bootloader": "/tmp/faker0onqJa",
    "file_bootloader_v2": "/tmp/fakerkWmWjT",
    "file_bootloader_v3": "/tmp/fakerwysEmB",
    "file_bootloader_v4": "/tmp/fakerlXv9Il",
    "changelog": "Deserunt et sit illo est expedita dolorem. Sed modi exercitationem consectetur sed architecto laudantium blanditiis maiores. Illo omnis excepturi aperiam quidem et error.",
    "created_at": "2025-12-08T15:50:44.000000Z",
    "updated_at": "2025-12-08T15:50:44.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create versions",
    "code": "FIRMWARE_VERSION:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/versions/firmware

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

name   string   

Name of version. Example: 1.0

model_id   integer   

Device Model ID. The id of an existing record in the App\Models\DeviceModel table. Example: 1

file_firmware   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpydlcj8

file_firmware_v2   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpfURU2c

file_firmware_v3   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpoY7TEe

file_firmware_v4   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpuziFi0

file_firmware_v5   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpNreS5N

file_firmware_new_pcb   file  optional  

Attached firmware for new PCB file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpgihpbG

file_bootloader   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpCsuEYh

file_bootloader_v2   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpBTOxVt

file_bootloader_v3   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/php1MaUoe

file_bootloader_v4   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpL4Lwrr

changelog   object[]  optional  

List of changelog translations.
language   string  optional  

Changelog language (2 characters code). Example: en

changelog   string  optional  

Changelog for the version. Example: Fixed bug with the connection

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 "model_id=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/phpdOkcxs" \
    --form "file_firmware_v2=@/tmp/phpbjPDIO" \
    --form "file_firmware_v3=@/tmp/phpScUNMZ" \
    --form "file_firmware_v4=@/tmp/phpuD2WQQ" \
    --form "file_firmware_v5=@/tmp/phpBC5fCQ" \
    --form "file_firmware_new_pcb=@/tmp/phpExAfX9" \
    --form "file_bootloader=@/tmp/phpEzJz11" \
    --form "file_bootloader_v2=@/tmp/phpDk1x8e" \
    --form "file_bootloader_v3=@/tmp/phpEk48Dy" \
    --form "file_bootloader_v4=@/tmp/phprdQxHj" 
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('model_id', '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": "1.95.51",
    "model_id": null,
    "file_firmware": "/tmp/faker6wyoFS",
    "file_firmware_v2": "/tmp/fakerOmtEcz",
    "file_firmware_v3": "/tmp/fakerFCvgUW",
    "file_firmware_v4": "/tmp/faker9hkrLX",
    "file_firmware_v5": "/tmp/fakerE8OsFI",
    "file_firmware_new_pcb": "/tmp/fakers7HRXo",
    "file_bootloader": "/tmp/fakeroxKoFW",
    "file_bootloader_v2": "/tmp/fakereE37MB",
    "file_bootloader_v3": "/tmp/fakerpaaiL1",
    "file_bootloader_v4": "/tmp/faker6bwrzo",
    "changelog": "Impedit quaerat in sed quas natus deleniti a. Aut occaecati error exercitationem minima et et voluptas inventore. Provident error est tenetur est. Omnis sint recusandae quasi.",
    "created_at": "2025-12-08T15:50:44.000000Z",
    "updated_at": "2025-12-08T15:50:44.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update versions",
    "code": "FIRMWARE_VERSION:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Version not found):


{
    "message": "Version not found",
    "code": "FIRMWARE_VERSION:UPDATE:VERSION_NOT_FOUND"
}

Request   

PUT api/versions/firmware/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

id   integer   

Firmware Version ID. Example: 1

Body Parameters

name   string  optional  

Name of version. Example: 1.0

model_id   integer  optional  

Device Model ID. The id of an existing record in the App\Models\DeviceModel table. Example: 1

file_firmware   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpdOkcxs

file_firmware_v2   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpbjPDIO

file_firmware_v3   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpScUNMZ

file_firmware_v4   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpuD2WQQ

file_firmware_v5   file  optional  

Attached firmware file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpBC5fCQ

file_firmware_new_pcb   file  optional  

Attached firmware for new PCB file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpExAfX9

file_bootloader   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpEzJz11

file_bootloader_v2   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpDk1x8e

file_bootloader_v3   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phpEk48Dy

file_bootloader_v4   file  optional  

Attached bootloader file. Must be a file. MAXIMUM:FILE_KB:102400. Example: /tmp/phprdQxHj

changelog   object[]  optional  

List of changelog translations.
language   string  optional  

Changelog language (2 characters code). Example: en

changelog   string  optional  

Changelog for the version. Pass "NULL" string to remove the entry for given language. Example: Fixed bug with the connection

file_firmware_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_firmware. Example: 1

file_firmware_v2_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_firmware_v2. Example: 1

file_firmware_v3_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_firmware_v3. Example: 1

file_firmware_v4_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_firmware_v4. Example: 1

file_firmware_v5_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_firmware_v5. Example: 1

file_firmware_new_pcb_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_firmware_new_pcb. Example: 1

file_bootloader_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_bootloader. Example: 1

file_bootloader_v2_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_bootloader_v2. Example: 1

file_bootloader_v3_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_bootloader_v3. Example: 1

file_bootloader_v4_delete   string  optional  

Send this parameter with value 1 to remove existing file for file_bootloader_v4. Example: 1

Delete firmware version

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Version deleted",
    "code": "FIRMWARE_VERSION:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete versions",
    "code": "FIRMWARE_VERSION:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (403, Version in use (compatibility)):


{
    "message": "Cannot delete: version is used in compatibility entries (1)",
    "code": "FIRMWARE_VERSION:DELETE:VERSION_IN_USE_COMPATIBILITY"
}

Example response (403, Version in use (device)):


{
    "message": "Cannot delete: version is assigned to devices (1)",
    "code": "FIRMWARE_VERSION:DELETE:VERSION_IN_USE_DEVICE"
}

Example response (404, Version not found):


{
    "message": "Version not found",
    "code": "FIRMWARE_VERSION:DELETE:VERSION_NOT_FOUND"
}

Request   

DELETE api/versions/firmware/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Firmware Version ID. Example: 1

Get PCB versions

requires authentication

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

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

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

Example response (200):


[
    {
        "id": 2,
        "name": "0.58.34",
        "model_id": null,
        "hardware_id": "",
        "created_at": "2025-12-08T15:50:44.000000Z",
        "updated_at": "2025-12-08T15:50:44.000000Z"
    },
    {
        "id": 3,
        "name": "5.65.93",
        "model_id": null,
        "hardware_id": "",
        "created_at": "2025-12-08T15:50:44.000000Z",
        "updated_at": "2025-12-08T15:50:44.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list versions",
    "code": "PCB_VERSION:LIST:INSUFFICIENT_PERMISSION"
}

Request   

GET api/versions/pcb

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

extend   string  optional  

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

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\",
    \"model_id\": 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",
    "model_id": 1,
    "hardware_id": "1"
};

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

Example response (201):


{
    "id": 4,
    "name": "4.12.87",
    "model_id": null,
    "hardware_id": "",
    "created_at": "2025-12-08T15:50:44.000000Z",
    "updated_at": "2025-12-08T15:50:44.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to create versions",
    "code": "PCB_VERSION:CREATE:INSUFFICIENT_PERMISSION"
}

Request   

POST api/versions/pcb

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Name of version. Example: 1.0

model_id   integer   

Device Model ID. The id of an existing record in the App\Models\DeviceModel table. Example: 1

hardware_id   string   

Hardware ID name. Example: 1

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\",
    \"model_id\": 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",
    "model_id": 1,
    "hardware_id": "1"
};

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

Example response (201):


{
    "id": 5,
    "name": "3.82.45",
    "model_id": null,
    "hardware_id": "",
    "created_at": "2025-12-08T15:50:44.000000Z",
    "updated_at": "2025-12-08T15:50:44.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update versions",
    "code": "PCB_VERSION:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Version not found):


{
    "message": "Version not found",
    "code": "PCB_VERSION:UPDATE:VERSION_NOT_FOUND"
}

Request   

PUT api/versions/pcb/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

PCB Version ID. Example: 1

Body Parameters

name   string  optional  

Name of version. Example: 1.0

model_id   integer  optional  

Device Model ID. The id of an existing record in the App\Models\DeviceModel table. Example: 1

hardware_id   string  optional  

Hardware ID name. Example: 1

Delete PCB version

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Version deleted",
    "code": "PCB_VERSION:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete versions",
    "code": "PCB_VERSION:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (403, Version in use (compatibility)):


{
    "message": "Cannot delete: version is used in compatibility entries (1)",
    "code": "PCB_VERSION:DELETE:VERSION_IN_USE_COMPATIBILITY"
}

Example response (403, Version in use (device)):


{
    "message": "Cannot delete: version is assigned to devices (1)",
    "code": "PCB_VERSION:DELETE:VERSION_IN_USE_DEVICE"
}

Example response (404, Version not found):


{
    "message": "Version not found",
    "code": "PCB_VERSION:DELETE:VERSION_NOT_FOUND"
}

Request   

DELETE api/versions/pcb/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

PCB Version ID. Example: 1

List compatibilities

requires authentication

Most typical scenarios to use compatibility matrix:

Example request:
curl --request GET \
    --get "http://localhost:8000/api/versions/compatibility?model=1&software=1.2&firmware=1.5&pcb=1.0&summary=" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost:8000/api/versions/compatibility"
);

const params = {
    "model": "1",
    "software": "1.2",
    "firmware": "1.5",
    "pcb": "1.0",
    "summary": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "paginator": {
        "total": 2,
        "count": 2,
        "perpage": 20,
        "current_page": 1,
        "last_page": 1
    },
    "items": [
        {
            "id": 1,
            "device_model_id": 10,
            "software_version_id": 4,
            "firmware_version_id": 14,
            "pcb_version_id": 6,
            "is_fully_compatible": 1,
            "created_at": "2025-12-08T15:50:44.000000Z",
            "updated_at": "2025-12-08T15:50:44.000000Z",
            "features": [
                {
                    "id": 1,
                    "compatibility_id": 1,
                    "feature_id": 5,
                    "is_compatible": 1,
                    "reason": "Consequatur quia esse sed commodi dicta rerum eum. Et cum est fugit sit totam ab ratione repellat. Tempora et sit quia voluptatem esse.",
                    "created_at": "2025-12-08T15:50:44.000000Z",
                    "updated_at": "2025-12-08T15:50:44.000000Z",
                    "feature": {
                        "id": 5,
                        "name": "olive",
                        "slug": "voluptatem-voluptatem-facilis-exercitationem-unde",
                        "created_at": "2025-12-08T15:50:44.000000Z",
                        "updated_at": "2025-12-08T15:50:44.000000Z"
                    }
                },
                {
                    "id": 2,
                    "compatibility_id": 1,
                    "feature_id": 7,
                    "is_compatible": 1,
                    "reason": "Esse voluptatem unde eos. Repudiandae qui quia ex et rerum ea aut quis. Id cupiditate tempora iure modi.",
                    "created_at": "2025-12-08T15:50:44.000000Z",
                    "updated_at": "2025-12-08T15:50:44.000000Z",
                    "feature": {
                        "id": 7,
                        "name": "maroon",
                        "slug": "et-fuga-aut-veniam-reiciendis-totam",
                        "created_at": "2025-12-08T15:50:44.000000Z",
                        "updated_at": "2025-12-08T15:50:44.000000Z"
                    }
                },
                {
                    "id": 3,
                    "compatibility_id": 1,
                    "feature_id": 9,
                    "is_compatible": 0,
                    "reason": "Quia est nobis beatae repudiandae similique fugit. Aut quia quaerat iusto. Iusto nobis ea voluptate numquam. Consectetur minus voluptas id fugit harum.",
                    "created_at": "2025-12-08T15:50:44.000000Z",
                    "updated_at": "2025-12-08T15:50:44.000000Z",
                    "feature": {
                        "id": 9,
                        "name": "green",
                        "slug": "voluptatem-necessitatibus-aut-earum-ut-consequuntur-qui-eveniet",
                        "created_at": "2025-12-08T15:50:44.000000Z",
                        "updated_at": "2025-12-08T15:50:44.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": "2025-12-08T15:50:44.000000Z",
            "updated_at": "2025-12-08T15:50:44.000000Z",
            "features": [
                {
                    "id": 4,
                    "compatibility_id": 5,
                    "feature_id": 10,
                    "is_compatible": 0,
                    "reason": "Rerum ullam illum nihil alias. Perspiciatis assumenda iure quos consectetur. Iusto architecto accusamus sint excepturi.",
                    "created_at": "2025-12-08T15:50:44.000000Z",
                    "updated_at": "2025-12-08T15:50:44.000000Z",
                    "feature": {
                        "id": 10,
                        "name": "black",
                        "slug": "nihil-vitae-repellat-aut-placeat-quos-sunt",
                        "created_at": "2025-12-08T15:50:44.000000Z",
                        "updated_at": "2025-12-08T15:50:44.000000Z"
                    }
                },
                {
                    "id": 5,
                    "compatibility_id": 5,
                    "feature_id": 12,
                    "is_compatible": 1,
                    "reason": "Quia nulla culpa et. Impedit sunt illo accusantium. Perferendis est quia aperiam quia perferendis. Voluptate est sapiente doloremque maxime voluptatem provident et.",
                    "created_at": "2025-12-08T15:50:44.000000Z",
                    "updated_at": "2025-12-08T15:50:44.000000Z",
                    "feature": {
                        "id": 12,
                        "name": "black",
                        "slug": "omnis-ab-rerum-cumque-eveniet-harum",
                        "created_at": "2025-12-08T15:50:44.000000Z",
                        "updated_at": "2025-12-08T15:50:44.000000Z"
                    }
                },
                {
                    "id": 6,
                    "compatibility_id": 5,
                    "feature_id": 14,
                    "is_compatible": 0,
                    "reason": "Blanditiis rerum est magni sit officiis error non. Et saepe et ad impedit provident labore tempora rerum.",
                    "created_at": "2025-12-08T15:50:44.000000Z",
                    "updated_at": "2025-12-08T15:50:44.000000Z",
                    "feature": {
                        "id": 14,
                        "name": "teal",
                        "slug": "quia-aut-assumenda-cum-ratione-qui-et-officiis",
                        "created_at": "2025-12-08T15:50:44.000000Z",
                        "updated_at": "2025-12-08T15:50:44.000000Z"
                    }
                }
            ]
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to list versions compatibilities",
    "code": "COMPATIBILITY:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, Device model not found):


{
    "message": "Device model not found",
    "code": "COMPATIBILITY:LIST:DEVICE_MODEL_NOT_FOUND"
}

Example response (404, Software version not found):


{
    "message": "Software version not found",
    "code": "COMPATIBILITY:LIST:SOFTWARE_VERSION_NOT_FOUND"
}

Example response (404, Firmware version not found):


{
    "message": "Firmware version not found",
    "code": "COMPATIBILITY:LIST:FIRMWARE_VERSION_NOT_FOUND"
}

Example response (404, PCB version not found):


{
    "message": "PCB version not found",
    "code": "COMPATIBILITY:LIST:PCB_VERSION_NOT_FOUND"
}

Request   

GET api/versions/compatibility

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

model   integer  optional  

Filter compatibility matrix by device model ID. Example: 1

software   string  optional  

Filter compatibility matrix by software version name (not ID!). Example: 1.2

firmware   string  optional  

Filter compatibility matrix by firmware version name (not ID!). Example: 1.5

pcb   string  optional  

Filter compatibility matrix by PCB version name (not ID!). Example: 1.0

summary   boolean  optional  

Add to response the device model, software, firmware and PCB entries used to filter the list. Example: false

perpage   integer  optional  

Elements per page (Default: 20).

page   integer  optional  

Page number (Default: 1).

extend   string  optional  

Comma-separated list of relation extensions (available: features, features.feature, deviceModel, softwareVersion, firmwareVersion, pcbVersion).

Add compatibility

requires authentication

Adds or updates compatibility matrix with assigned features. You can specify many versions for each list.

Example request:
curl --request POST \
    "http://localhost:8000/api/versions/compatibility" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"device_models\": [
        1
    ],
    \"software_versions\": [
        1
    ],
    \"firmware_versions\": [
        1
    ],
    \"pcb_versions\": [
        1
    ],
    \"is_fully_compatible\": true,
    \"features\": [
        {
            \"feature_id\": 1,
            \"compatible\": true,
            \"reason\": \"Firmware does not support...\"
        }
    ]
}"

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

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

let body = {
    "device_models": [
        1
    ],
    "software_versions": [
        1
    ],
    "firmware_versions": [
        1
    ],
    "pcb_versions": [
        1
    ],
    "is_fully_compatible": true,
    "features": [
        {
            "feature_id": 1,
            "compatible": true,
            "reason": "Firmware does not support..."
        }
    ]
};

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

Example response (202, OK):


{
    "added": 1,
    "updated": 0,
    "not_changed": 0
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to add versions compatibility",
    "code": "COMPATIBILITY:ADD:INSUFFICIENT_PERMISSION"
}

Request   

POST api/versions/compatibility

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

device_models   integer[]  optional  

Array of Device Model IDs. The id of an existing record in the App\Models\DeviceModel table.

software_versions   integer[]  optional  

Array of Software Version IDs. The id of an existing record in the App\Models\SoftwareVersion table.

firmware_versions   integer[]  optional  

Array of Firmware Version IDs. The id of an existing record in the App\Models\FirmwareVersion table.

pcb_versions   integer[]  optional  

Array of PCB Version IDs. The id of an existing record in the App\Models\PCBVersion table.

is_fully_compatible   boolean  optional  

Is this set of versions fully compatible?. Example: true

features   object[]  optional  

Array of features to be assigned to this set of versions.
feature_id   string  optional  

Product feature ID. The id of an existing record in the App\Models\ProductFeature table. Example: 1

compatible   boolean  optional  

Is this feature compatible?. Example: true

reason   string  optional  

Reason of incompatibility. Example: Firmware does not support...

Update compatibility

requires authentication

Example request:
curl --request PUT \
    "http://localhost:8000/api/versions/compatibility/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"device_model_id\": 6,
    \"software_version_id\": 7,
    \"firmware_version_id\": 4,
    \"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": 6,
    "software_version_id": 7,
    "firmware_version_id": 4,
    "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": 1,
    "created_at": "2025-12-08T15:50:44.000000Z",
    "updated_at": "2025-12-08T15:50:44.000000Z",
    "features": [
        {
            "id": 7,
            "compatibility_id": 9,
            "feature_id": 15,
            "is_compatible": 1,
            "reason": "Voluptas provident nihil similique. Debitis aspernatur ullam rem odit ipsa excepturi. Atque deserunt animi eum nihil.",
            "created_at": "2025-12-08T15:50:44.000000Z",
            "updated_at": "2025-12-08T15:50:44.000000Z",
            "feature": {
                "id": 15,
                "name": "black",
                "slug": "pariatur-nam-in-sapiente-nisi",
                "created_at": "2025-12-08T15:50:44.000000Z",
                "updated_at": "2025-12-08T15:50:44.000000Z"
            }
        }
    ]
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to update versions compatibility",
    "code": "COMPATIBILITY:UPDATE:INSUFFICIENT_PERMISSION"
}

Example response (404, Versions Compatibility not found):


{
    "message": "Versions compatibility not found",
    "code": "COMPATIBILITY:UPDATE:COMPATIBILITY_NOT_FOUND"
}

Request   

PUT api/versions/compatibility/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Versions Compatibility ID. Example: 1

Body Parameters

device_model_id   integer  optional  

Device Model ID. The id of an existing record in the App\Models\DeviceModel table. Example: 6

software_version_id   integer  optional  

Software Version ID. The id of an existing record in the App\Models\SoftwareVersion table. Example: 7

firmware_version_id   integer  optional  

Firmware Version ID. The id of an existing record in the App\Models\FirmwareVersion table. Example: 4

pcb_version_id   integer  optional  

PCB Version ID. The id of an existing record in the App\Models\PCBVersion table. Example: 16

is_fully_compatible   boolean  optional  

Is this set of versions fully compatible?. Example: true

features   object[]  optional  

Array of features to be assigned to this set of versions.
id   string  optional  

Versions compatibility feature ID. Use with delete parameter to delete specific entry. Do not confuse with feature_id, this field refers to ID of relation between versions compatibility and product feature. The id of an existing record in the App\Models\VersionsCompatibilityFeature table. Example: 1

feature_id   string  optional  

Product feature ID. The id of an existing record in the App\Models\ProductFeature table. Example: 1

compatible   boolean  optional  

Is this feature compatible?. Example: true

reason   string  optional  

Reason of incompatibility. Example: Firmware does not support...

delete   boolean  optional  

Pass 1 to detach feature from this set of versions, skip otherwise. Example: true

Delete compatibility

requires authentication

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

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

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

Example response (202, OK):


{
    "message": "Versions compatibility deleted",
    "code": "COMPATIBILITY:DELETE:DELETED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to delete versions compatibility",
    "code": "COMPATIBILITY:DELETE:INSUFFICIENT_PERMISSION"
}

Example response (404, Versions compatibility not found):


{
    "message": "Versions compatibility not found",
    "code": "COMPATIBILITY:DELETE:COMPATIBILITY_NOT_FOUND"
}

Request   

DELETE api/versions/compatibility/{id}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   integer   

Versions Compatibility ID. Example: 1

Video sessions

API endpoints for managing video sessions

List video sessions

requires authentication

Returns list of open video sessions. For most cases there should be exactly one entry (open/active session) or exactly zero entries (empty array, no open sessions).

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

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

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

Example response (200):


[
    {
        "id": 1,
        "moderator_id": 122,
        "guest_id": 123,
        "jwt_moderator": "ebeae82ebe8486baba588b7b54a1408ab9703b6af021a095950e28ab87640a68",
        "jwt_guest": "760176194068f3029466de5c06f1faa6471a566c66eda866e984f0ca6674d96f",
        "room_name": "room_682654bf9684fe7e6d843b72fcd520ef",
        "expires": 1765209934,
        "status": "open",
        "created_at": "2025-12-08T15:50:34.000000Z",
        "updated_at": "2025-12-08T15:50:34.000000Z"
    },
    {
        "id": 2,
        "moderator_id": 126,
        "guest_id": 127,
        "jwt_moderator": "760176194068f3029466de5c06f1faa6471a566c66eda866e984f0ca6674d96f",
        "jwt_guest": "584178e5e3517ddcebc66340917adc3a27ce4be359a29aa827563d481ff5d67a",
        "room_name": "room_682654bf9684fe7e6d843b72fcd520ef",
        "expires": 1765209934,
        "status": "open",
        "created_at": "2025-12-08T15:50:34.000000Z",
        "updated_at": "2025-12-08T15:50:34.000000Z"
    }
]

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to access video session",
    "code": "VIDEO_SESSIONS:LIST:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "VIDEO_SESSIONS:LIST:USER_NOT_FOUND"
}

Request   

GET api/sessions/video/{guestId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

guestId   integer   

User ID (guest of the meeting). Example: 1

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": 130,
    "guest_id": 131,
    "jwt_moderator": "a69e4986f807d53cf2d5bfd7ddf485555eaa8ef5748fd862ccd2520691ec0370",
    "jwt_guest": "8b5e2edff1ba56f948f2db85ca3b4e169440e1b9c5094d19d0d54fd9fc6df9cb",
    "room_name": "room_682654bf9684fe7e6d843b72fcd520ef",
    "expires": 1765209934,
    "status": "open",
    "created_at": "2025-12-08T15:50:34.000000Z",
    "updated_at": "2025-12-08T15:50:34.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to initialize video session",
    "code": "VIDEO_SESSIONS:INIT:INSUFFICIENT_PERMISSION"
}

Example response (404, User not found):


{
    "message": "User not found",
    "code": "VIDEO_SESSIONS:INIT:USER_NOT_FOUND"
}

Example response (500, Server error):


{
    "message": "Server error",
    "code": "VIDEO_SESSIONS:INIT:SERVER_ERROR"
}

Request   

POST api/sessions/video/{guestId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

guestId   integer   

User ID (guest of the meeting). Example: 1

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": 134,
    "guest_id": 135,
    "jwt_moderator": "59508e50faa1620dd7d0f430642b4e46f4cf44027a143f217626568e1f2ed113",
    "jwt_guest": "b1d6b91b67c2afa5e322988d9462638d354ddf8a1ef79dba987f815c22b4baee",
    "room_name": "room_76b97108146e680b229a0cbafc2b5b45",
    "expires": 1765209935,
    "status": "open",
    "created_at": "2025-12-08T15:50:35.000000Z",
    "updated_at": "2025-12-08T15:50:35.000000Z"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to refresh video session",
    "code": "VIDEO_SESSIONS:REFRESH:INSUFFICIENT_PERMISSION"
}

Example response (404, Session not found):


{
    "message": "Video session not found",
    "code": "VIDEO_SESSIONS:REFRESH:SESSION_NOT_FOUND"
}

Request   

POST api/sessions/video/{sessionId}/refresh

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

sessionId   integer   

Video Session ID. Example: 1

Close video session

requires authentication

Marks video session (database entry) as closed. Does not close session on Jitsi side.

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

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

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

Example response (202, OK):


{
    "message": "Video session closed",
    "code": "VIDEO_SESSIONS:CLOSE:CLOSED"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to close video session",
    "code": "VIDEO_SESSIONS:CLOSE:INSUFFICIENT_PERMISSION"
}

Example response (404, Session not found):


{
    "message": "Video session not found",
    "code": "VIDEO_SESSIONS:CLOSE:SESSION_NOT_FOUND"
}

Request   

DELETE api/sessions/video/{sessionId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

sessionId   integer   

Video Session ID. Example: 1

Invite technical support

requires authentication

Sends notification to Slack channel. Link to meeting is valid for 10 minutes.

Example request:
curl --request POST \
    "http://localhost:8000/api/sessions/video/invite-support/1" \
    --header "Authorization: Bearer {ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"room\": \"room_1081c785cf1464e4d6ebc3976561d490\",
    \"description\": \"Grip switching is not working, please join.\"
}"

const url = new URL(
    "http://localhost:8000/api/sessions/video/invite-support/1"
);

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

let body = {
    "room": "room_1081c785cf1464e4d6ebc3976561d490",
    "description": "Grip switching is not working, please join."
};

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

Example response (200, OK):


{
    "response": "success",
    "code": "VIDEO_SESSIONS:INVITE_TECH_SUPPORT:SUCCESS"
}

Example response (403, Insufficient permission):


{
    "message": "Insufficient permission to invite tech support",
    "code": "VIDEO_SESSIONS:INVITE_TECH_SUPPORT:INSUFFICIENT_PERMISSION"
}

Example response (404, Device not found):


{
    "message": "Device not found",
    "code": "VIDEO_SESSIONS:INVITE_TECH_SUPPORT:DEVICE_NOT_FOUND"
}

Example response (500, Request failed):


{
    "response": "invalid_payload",
    "code": "VIDEO_SESSIONS:INVITE_TECH_SUPPORT:FAILED"
}

Request   

POST api/sessions/video/invite-support/{deviceId}

Headers

Authorization      

Example: Bearer {ACCESS_TOKEN}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

deviceId   integer   

Device ID (current device of the session). Example: 1

Body Parameters

room   string   

Name of Jitsi room to connect. Example: room_1081c785cf1464e4d6ebc3976561d490

description   string  optional  

Description of problem provided by clinician. Example: Grip switching is not working, please join.