isiQuest

Postman collection → OpenAPI spec →

Introduction

Base URL: http://localhost:8000

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

Generate more by postman

Your Token

rFIT0Esl1RnvbZ97uDoVvsDWaHF0jFhJDsuA5szwf7c7ff6f

Authenticating requests

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

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

You can retrieve your token by create an account and go to the login page to Generate API token.

Account

Account Endpoint

User

Roles belongs

GET

http://localhost:8000

/api/v1/user/{userId}/roles

requires authentication

Get the roles associated to the user

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

userId

integer

required

represent the id of user for witch role ought to be returned.

Example:

Body Parameters

user_id

string

Auth

Bearer

Headers

URL Parameters

Body

{ "user_id": null }

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/user/1/roles" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

Example response :

{
    "data": [
        {
            "id": 1,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "is_direct_child": 1,
            "role_id": 1,
            "status_id": 1,
            "formated_code": "SAdm20260107132106",
            "parent_id": null,
            "act_as_global_admin": true,
            "voter_messages_count": null
        },
        {
            "id": 1,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "is_direct_child": 1,
            "role_id": 1,
            "status_id": 1,
            "formated_code": "SAdm20260107132106",
            "parent_id": null,
            "act_as_global_admin": true,
            "voter_messages_count": null
        }
    ]
}

Metadata | from Password reset

GET

http://localhost:8000

/api/v1/admins/{resetPasswordToken}/infos

Get all information about user role from passing a token and give a email as query parameter

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

resetPasswordToken

string

required

The password token sent via email or any other channels

Example:

dedede29393

Query Parameters

string

required

The email for company

Example:

lucchuala@gmail.com

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/admins/dedede29393/infos?email=lucchuala%40gmail.com" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": 1,
        "name": "yvan",
        "email": "ynguetse@gmail.com",
        "email_verified_at": "2026-01-07T13:21:06.000000Z",
        "surname": "Schneider",
        "address": "42, boulevard de Duhamel\n64544 Guibert",
        "city": "Lesage",
        "country": "VA",
        "po_box": "95141",
        "fix_phone": "04 08 58 96 89",
        "mobile_phone": "06 98 35 74 11",
        "fax": "+33 (0)1 68 97 72 78",
        "date_of_birth": null,
        "speciality": "Opérateur piquage",
        "society": "Hubert",
        "generic_language_id": null,
        "other_information": null,
        "created_at": "2026-01-07T13:21:06.000000Z",
        "updated_at": "2026-01-07T13:21:06.000000Z"
    }
}

Authenticated User

User

GET

http://localhost:8000

/api/v1/user

requires authentication

Get the authenticated user from request. as connected as user roles . you must provide a token from a user roles

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/user" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": 1,
        "name": "yvan",
        "email": "ynguetse@gmail.com",
        "email_verified_at": "2026-01-07T13:21:06.000000Z",
        "surname": "Schneider",
        "address": "42, boulevard de Duhamel\n64544 Guibert",
        "city": "Lesage",
        "country": "VA",
        "po_box": "95141",
        "fix_phone": "04 08 58 96 89",
        "mobile_phone": "06 98 35 74 11",
        "fax": "+33 (0)1 68 97 72 78",
        "date_of_birth": null,
        "speciality": "Opérateur piquage",
        "society": "Hubert",
        "generic_language_id": null,
        "other_information": null,
        "created_at": "2026-01-07T13:21:06.000000Z",
        "updated_at": "2026-01-07T13:21:06.000000Z"
    }
}

User Role

GET

http://localhost:8000

/api/v1/user-role

requires authentication

Get the authenticated user role from request

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/user-role" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

Update Profile

POST

http://localhost:8000

/api/v1/user/updateProfile

requires authentication

Update the information about a profile

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

X-PASSWORD-CONFIRM

Example:

password

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

Example:

architecto

surname

string

Example:

architecto

address

string

Example:

architecto

city

string

Example:

architecto

country

string

Example:

architecto

date_of_birth

string

Must be a valid date.

Example:

2026-01-08T21:24:53

fix_phone

string

Example:

architecto

mobile_phone

string

Example:

architecto

other_information

string

Example:

architecto

generic_language_id

integer

Example:

po_box

string

Example:

architecto

society

string

Example:

architecto

speciality

string

Example:

architecto

password

string

Example:

|]|{+-

password_confirmation

string

The value and password must match.

Auth

Bearer

Headers

Body

{ "name": "architecto", "surname": "architecto", "address": "architecto", "city": "architecto", "country": "architecto", "date_of_birth": "2026-01-08T21:24:53", "fix_phone": "architecto", "mobile_phone": "architecto", "other_information": "architecto", "generic_language_id": 16, "po_box": "architecto", "society": "architecto", "speciality": "architecto", "password": "|]|{+-", "password_confirmation": null }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/user/updateProfile" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "X-PASSWORD-CONFIRM: password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"surname\": \"architecto\",
    \"address\": \"architecto\",
    \"city\": \"architecto\",
    \"country\": \"architecto\",
    \"date_of_birth\": \"2026-01-08T21:24:53\",
    \"fix_phone\": \"architecto\",
    \"mobile_phone\": \"architecto\",
    \"other_information\": \"architecto\",
    \"generic_language_id\": 16,
    \"po_box\": \"architecto\",
    \"society\": \"architecto\",
    \"speciality\": \"architecto\",
    \"password\": \"|]|{+-\"
}"

Example response :

{
    "data": {
        "id": 1,
        "name": "yvan",
        "email": "ynguetse@gmail.com",
        "email_verified_at": "2026-01-07T13:21:06.000000Z",
        "surname": "Schneider",
        "address": "42, boulevard de Duhamel\n64544 Guibert",
        "city": "Lesage",
        "country": "VA",
        "po_box": "95141",
        "fix_phone": "04 08 58 96 89",
        "mobile_phone": "06 98 35 74 11",
        "fax": "+33 (0)1 68 97 72 78",
        "date_of_birth": null,
        "speciality": "Opérateur piquage",
        "society": "Hubert",
        "generic_language_id": null,
        "other_information": null,
        "created_at": "2026-01-07T13:21:06.000000Z",
        "updated_at": "2026-01-07T13:21:06.000000Z"
    }
}

Switch Account.

POST

http://localhost:8000

/api/v1/switchAccount/{roleId}

requires authentication

switch account

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

roleId

integer

required

id of role to switch to

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/switchAccount/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Show profile

GET

http://localhost:8000

/api/v1/users/activation/{token}

Show the information about a profile to be activated

Headers

X-PASSWORD-CONFIRM

Example:

password

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

The token containing emailId, roleId and languageId

Example:

lklsmdkjflsqkjfdmlsjlmfdkf11q

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/users/activation/lklsmdkjflsqkjfdmlsjlmfdkf11q" \
    --header "X-PASSWORD-CONFIRM: password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": 1,
        "name": "yvan",
        "email": "ynguetse@gmail.com",
        "email_verified_at": "2026-01-07T13:21:06.000000Z",
        "surname": "Schneider",
        "address": "42, boulevard de Duhamel\n64544 Guibert",
        "city": "Lesage",
        "country": "VA",
        "po_box": "95141",
        "fix_phone": "04 08 58 96 89",
        "mobile_phone": "06 98 35 74 11",
        "fax": "+33 (0)1 68 97 72 78",
        "date_of_birth": null,
        "speciality": "Opérateur piquage",
        "society": "Hubert",
        "generic_language_id": null,
        "other_information": null,
        "created_at": "2026-01-07T13:21:06.000000Z",
        "updated_at": "2026-01-07T13:21:06.000000Z"
    }
}

Show profile

GET

http://localhost:8000

/api/v1/users/joinPartitionedSpace/{token}

Show the information about a profile wanting to join a partitioned space

Headers

X-PASSWORD-CONFIRM

Example:

password

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

The token containing $parentId and $childId aell being userRoleIds)

Example:

lklsmdkjflsqkjfdmlsjlmfdkf11q

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/users/joinPartitionedSpace/lklsmdkjflsqkjfdmlsjlmfdkf11q" \
    --header "X-PASSWORD-CONFIRM: password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": 1,
        "name": "yvan",
        "email": "ynguetse@gmail.com",
        "email_verified_at": "2026-01-07T13:21:06.000000Z",
        "surname": "Schneider",
        "address": "42, boulevard de Duhamel\n64544 Guibert",
        "city": "Lesage",
        "country": "VA",
        "po_box": "95141",
        "fix_phone": "04 08 58 96 89",
        "mobile_phone": "06 98 35 74 11",
        "fax": "+33 (0)1 68 97 72 78",
        "date_of_birth": null,
        "speciality": "Opérateur piquage",
        "society": "Hubert",
        "generic_language_id": null,
        "other_information": null,
        "created_at": "2026-01-07T13:21:06.000000Z",
        "updated_at": "2026-01-07T13:21:06.000000Z"
    }
}

Visu

endpoint for visu

Visu | Update profile

POST

http://localhost:8000

/api/v1/companies/updateProfile

requires authentication

Update profile visu

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

X-PASSWORD-CONFIRM

Example:

password

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Example:

architecto

address

string

Example:

architecto

city

string

Example:

architecto

country

string

Example:

architecto

po_box

string

Example:

architecto

fix_phone

string

Example:

architecto

mobile_phone

string

Example:

architecto

generic_language_id

string

The id of an existing record in the languages table.

password

string

Example:

|]|{+-

password_confirmation

string

The value and password must match.

Auth

Bearer

Headers

Body

{ "name": "architecto", "address": "architecto", "city": "architecto", "country": "architecto", "po_box": "architecto", "fix_phone": "architecto", "mobile_phone": "architecto", "generic_language_id": null, "password": "|]|{+-", "password_confirmation": null }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/companies/updateProfile" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "X-PASSWORD-CONFIRM: password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"address\": \"architecto\",
    \"city\": \"architecto\",
    \"country\": \"architecto\",
    \"po_box\": \"architecto\",
    \"fix_phone\": \"architecto\",
    \"mobile_phone\": \"architecto\",
    \"password\": \"|]|{+-\"
}"

Example response :

{
    "data": {
        "id": 1,
        "name": "CU-yvan-cu",
        "email": "ynguetse@gmail.com",
        "email_verified_at": null,
        "address": "87, rue de Paul\n41658 Meunier",
        "city": "Benard",
        "country": "LA",
        "po_box": "64677",
        "fix_phone": null,
        "mobile_phone": null,
        "reference_number": null,
        "company_type_id": 1,
        "password": "$2y$12$Sd5JjV5WRwqSBnlF2wYPFOzpl8p0BNcxrKwidI2nJ1rNid1QP92vm",
        "user_role_id": 1,
        "creator_id": 1,
        "deletion_type_id": null,
        "status_id": 1,
        "formated_code": "Cu20260107132117",
        "company_email_designs_count": null,
        "company_languages_count": null,
        "company_questionnaire_designs_count": null,
        "company_report_designs_count": null,
        "partitioned_email_designs_count": null,
        "partitioned_languages_count": null,
        "partitioned_questionnaire_designs_count": null,
        "partitioned_report_designs_count": null,
        "other_information": null,
        "activated_at": "2026-01-07 13:21:17",
        "created_at": "2026-01-07T13:21:17.000000Z",
        "updated_at": "2026-01-07T13:21:17.000000Z",
        "deleted_at": null,
        "is_active_status": true,
        "remember_token": null,
        "generic_language_id": 1,
        "company_type": {
            "id": 1,
            "name": "Private",
            "created_at": "2026-01-07T13:21:04.000000Z"
        },
        "user_role": {
            "id": 1,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "is_direct_child": 1,
            "role_id": 1,
            "status_id": 1,
            "formated_code": "SAdm20260107132106",
            "parent_id": null,
            "role": {
                "id": 1,
                "name": "global_admin",
                "guard_name": "global_admin",
                "created_at": "2026-01-07T13:21:04.000000Z",
                "updated_at": "2026-01-07T13:21:04.000000Z"
            },
            "user": {
                "id": 1,
                "name": "yvan",
                "email": "ynguetse@gmail.com",
                "email_verified_at": "2026-01-07T13:21:06.000000Z",
                "surname": "Schneider",
                "address": "42, boulevard de Duhamel\n64544 Guibert",
                "city": "Lesage",
                "country": "VA",
                "po_box": "95141",
                "fix_phone": "04 08 58 96 89",
                "mobile_phone": "06 98 35 74 11",
                "fax": "+33 (0)1 68 97 72 78",
                "date_of_birth": null,
                "speciality": "Opérateur piquage",
                "society": "Hubert",
                "generic_language_id": null,
                "other_information": null,
                "created_at": "2026-01-07T13:21:06.000000Z",
                "updated_at": "2026-01-07T13:21:06.000000Z"
            },
            "act_as_global_admin": true,
            "voter_messages_count": null
        },
        "is_webinaire": false,
        "is_multicreatif": false
    }
}

UserRole

Confirm password

POST

http://localhost:8000

/api/v1/confirm-password

requires authentication

Confirm that the password provided is the correct password of the application

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

password

string

required

The password to check validity for

Example:

password

Auth

Bearer

Headers

Body

{ "password": "password" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/confirm-password" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"password\"
}"

Example response :

{
    "message": "Password valid"
}

UserRole | Exists

POST

http://localhost:8000

/api/v1/userRole/{roleType}/existsBy

requires authentication

Check if a user role exists in the system

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

roleType

string

required

The role type

Must be one of:

global_admin
super_admin
simple_admin

Example:

simple_admin

Body Parameters

string

required

Must be a valid email address.

Example:

gbailey@example.net

name

string

Must not be greater than 255 characters.

Example:

surname

string

Must not be greater than 255 characters.

Example:

city

string

Must not be greater than 255 characters.

Example:

country

string

Must not be greater than 255 characters.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "email": "gbailey@example.net", "name": "m", "surname": "i", "city": "y", "country": "v" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/userRole/simple_admin/existsBy" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\",
    \"name\": \"m\",
    \"surname\": \"i\",
    \"city\": \"y\",
    \"country\": \"v\"
}"

Example response :

{
    "data": {
        "exists": true,
        "can_append_in_my_space": true
    }
}

Delete My account

POST

http://localhost:8000

/api/v1/userRole/me/delete

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

emailLang

string

required

emailLang

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

French

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/userRole/me/delete?emailLang=French" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "ok"
}

User Role | Restore

POST

http://localhost:8000

/api/v1/userRole/{userRoleId}/restore

requires authentication

Restore an user role account after been deleted!

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/userRole/{userRoleId}/restore" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "restored successfully"
}

Validate Account

POST

http://localhost:8000

/api/v1/userRole/request/validate/{token}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

the token provided by email

Example:

X93h33j393h9hid939dh3idh93hd93hid3

Body Parameters

name

string

Example:

architecto

surname

string

Example:

architecto

address

string

Example:

architecto

city

string

Example:

architecto

country

string

Example:

architecto

fax

string

Example:

architecto

date_of_birth

string

Must be a valid date.

Example:

2026-01-08T21:24:55

fix_phone

string

Example:

architecto

mobile_phone

string

Example:

architecto

other_information

string

Example:

architecto

generic_language_id

integer

Example:

po_box

string

Example:

architecto

society

string

Example:

architecto

speciality

string

Example:

architecto

password

string

Example:

|]|{+-

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "architecto", "surname": "architecto", "address": "architecto", "city": "architecto", "country": "architecto", "fax": "architecto", "date_of_birth": "2026-01-08T21:24:55", "fix_phone": "architecto", "mobile_phone": "architecto", "other_information": "architecto", "generic_language_id": 16, "po_box": "architecto", "society": "architecto", "speciality": "architecto", "password": "|]|{+-" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/userRole/request/validate/X93h33j393h9hid939dh3idh93hd93hid3" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"surname\": \"architecto\",
    \"address\": \"architecto\",
    \"city\": \"architecto\",
    \"country\": \"architecto\",
    \"fax\": \"architecto\",
    \"date_of_birth\": \"2026-01-08T21:24:55\",
    \"fix_phone\": \"architecto\",
    \"mobile_phone\": \"architecto\",
    \"other_information\": \"architecto\",
    \"generic_language_id\": 16,
    \"po_box\": \"architecto\",
    \"society\": \"architecto\",
    \"speciality\": \"architecto\",
    \"password\": \"|]|{+-\"
}"

UserRole | Join Space

POST

http://localhost:8000

/api/v1/userRole/request/joinPartitionedSpace/{token}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

Example:

architecto

surname

string

Example:

architecto

address

string

Example:

architecto

city

string

Example:

architecto

country

string

Example:

architecto

fax

string

Example:

architecto

date_of_birth

string

Must be a valid date.

Example:

2026-01-08T21:24:55

fix_phone

string

Example:

architecto

mobile_phone

string

Example:

architecto

other_information

string

Example:

architecto

generic_language_id

integer

Example:

po_box

string

Example:

architecto

society

string

Example:

architecto

speciality

string

Example:

architecto

password

string

Example:

|]|{+-

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/userRole/request/joinPartitionedSpace/{token}" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"surname\": \"architecto\",
    \"address\": \"architecto\",
    \"city\": \"architecto\",
    \"country\": \"architecto\",
    \"fax\": \"architecto\",
    \"date_of_birth\": \"2026-01-08T21:24:55\",
    \"fix_phone\": \"architecto\",
    \"mobile_phone\": \"architecto\",
    \"other_information\": \"architecto\",
    \"generic_language_id\": 16,
    \"po_box\": \"architecto\",
    \"society\": \"architecto\",
    \"speciality\": \"architecto\",
    \"password\": \"|]|{+-\"
}"

UserRole| Email Activate

POST

http://localhost:8000

/api/v1/userRole/request/reactivate/{token}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

represent the token

Example:

X3930FD0-30394md

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/userRole/request/reactivate/X3930FD0-30394md" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

SuperAdmin

Super Admin List

GET

http://localhost:8000

/api/v1/superAdmin

requires authentication

List all the super admin account

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

status

string

required

The type of account to be exported (active | inactive) By default the value is active

Must be one of:

active
inactive

Example:

active

paginateNumber

integer

Number of items in pagination

Example:

pagination

boolean

Activate or not the pagination extra metadata

Must be one of:

true
false

Example:

Body Parameters

status

string

Auth

Bearer

Headers

Query Parameters

Body

{ "status": null }

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/superAdmin?status=active&paginateNumber=15&pagination=1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

Example response :

{
    "data": [
        {
            "id": 1,
            "activated_at": "2026-01-07 13:21:06",
            "is_active_status": true,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "deleted_at": null,
            "parent_id": null,
            "status_id": 1,
            "formated_code": "SAdm20260107132106",
            "generic_language_id": null,
            "role_id": 1
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=2",
        "prev": null,
        "next": "/?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": "/?page=2",
                "label": "2",
                "page": 2,
                "active": false
            },
            {
                "url": "/?page=2",
                "label": "Next &raquo;",
                "page": 2,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 1,
        "to": 1,
        "total": 2
    }
}

Super Admin Store

POST

http://localhost:8000

/api/v1/superAdmin

requires authentication

Create a new user

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

emailLang

string

sigle of email language

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

French

Body Parameters

string

required

Must be a valid email address. Must not be greater than 254 characters.

Example:

gbailey@example.net

Auth

Bearer

Headers

Query Parameters

Body

{ "email": "gbailey@example.net" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/superAdmin?emailLang=French" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\"
}"

Get SuperAdmin Details

GET

http://localhost:8000

/api/v1/superAdmin/{superAdminId}/details

requires authentication

Get information about super admin account

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

superAdminId

number

required

the id of the super admin account

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/superAdmin/1/details" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": 1,
        "name": "yvan",
        "email": "ynguetse@gmail.com",
        "email_verified_at": "2026-01-07T13:21:06.000000Z",
        "surname": "Schneider",
        "address": "42, boulevard de Duhamel\n64544 Guibert",
        "city": "Lesage",
        "country": "VA",
        "po_box": "95141",
        "fix_phone": "04 08 58 96 89",
        "mobile_phone": "06 98 35 74 11",
        "fax": "+33 (0)1 68 97 72 78",
        "date_of_birth": null,
        "speciality": "Opérateur piquage",
        "society": "Hubert",
        "generic_language_id": null,
        "other_information": null,
        "created_at": "2026-01-07T13:21:06.000000Z",
        "updated_at": "2026-01-07T13:21:06.000000Z"
    }
}

Update SuperAdmin Account

PUT

http://localhost:8000

/api/v1/superAdmin/{superAdminId}/update

requires authentication

Update information about the super admin account provide in request

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

superAdminId

integer

required

Represent the identifier of the superAdmin account

Example:

Body Parameters

name

string

required

Must not be greater than 255 characters.

Example:

city

string

Must not be greater than 255 characters.

Example:

country

string

Must not be greater than 255 characters.

Example:

po_box

string

Must not be greater than 255 characters.

Example:

surname

string

Must not be greater than 255 characters.

Example:

address

string

Must not be greater than 255 characters.

Example:

fix_phone

string

Must not be greater than 255 characters.

Example:

mobile_phone

string

Must not be greater than 255 characters.

Example:

date_of_birth

string

Must be a valid date.

Example:

2026-01-08T21:24:54

society

string

Must not be greater than 255 characters.

Example:

speciality

string

Must not be greater than 255 characters.

Example:

other_information

string

Must not be greater than 255 characters.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "b", "city": "n", "country": "g", "po_box": "z", "surname": "m", "address": "i", "fix_phone": "y", "mobile_phone": "v", "date_of_birth": "2026-01-08T21:24:54", "society": "d", "speciality": "l", "other_information": "j" }

Received response

Example request:

curl --request PUT \
    "http://localhost:8000/api/v1/superAdmin/1/update" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"city\": \"n\",
    \"country\": \"g\",
    \"po_box\": \"z\",
    \"surname\": \"m\",
    \"address\": \"i\",
    \"fix_phone\": \"y\",
    \"mobile_phone\": \"v\",
    \"date_of_birth\": \"2026-01-08T21:24:54\",
    \"society\": \"d\",
    \"speciality\": \"l\",
    \"other_information\": \"j\"
}"

Example response :

{
    "message": "Success",
    "status": "ok"
}

Deactivate Super Admin

DELETE

http://localhost:8000

/api/v1/superAdmin/{superAdminId}/delete

requires authentication

Deactivate a super admin account When Deactivate an account it will be totally delete after 30 day.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

superAdminId

integer

required

The id of Super Admin account to be deleted

Example:

Query Parameters

emailLang

string

sigle of email language

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

French

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/superAdmin/1/delete?emailLang=French" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "code": 2
}

Simple Admin

Simple Admin List

GET

http://localhost:8000

/api/v1/simpleAdmin

requires authentication

List all the super admin account

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

status

string

The type of account to be exported (active | inactive) By default the value is all

Must be one of:

active
inactive

Example:

active

paginateNumber

integer

Number of items in pagination

Example:

pagination

boolean

Activate or not the pagination extra metadata

Must be one of:

true
false

Example:

Body Parameters

status

string

pagination

boolean

paginateNumber

integer

This field is required when pagination is true.

Example:

requireAccessRight

boolean

Auth

Bearer

Headers

Query Parameters

Body

{ "status": null, "pagination": false, "paginateNumber": 16, "requireAccessRight": false }

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/simpleAdmin?status=active&paginateNumber=15&pagination=1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"pagination\": false,
    \"paginateNumber\": 16,
    \"requireAccessRight\": false
}"

Example response :

{
    "data": [
        {
            "id": 1,
            "activated_at": "2026-01-07 13:21:06",
            "is_active_status": true,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "deleted_at": null,
            "parent_id": null,
            "status_id": 1,
            "formated_code": "SAdm20260107132106",
            "generic_language_id": null,
            "role_id": 1
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=2",
        "prev": null,
        "next": "/?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": "/?page=2",
                "label": "2",
                "page": 2,
                "active": false
            },
            {
                "url": "/?page=2",
                "label": "Next &raquo;",
                "page": 2,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 1,
        "to": 1,
        "total": 2
    }
}

Simple Admin Create

POST

http://localhost:8000

/api/v1/simpleAdmin

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

emailLang

string

sigle of email language

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

French

Body Parameters

string

required

Must be a valid email address. Must not be greater than 254 characters.

Example:

gbailey@example.net

Auth

Bearer

Headers

Query Parameters

Body

{ "email": "gbailey@example.net" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/simpleAdmin?emailLang=French" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\"
}"

Simple Admin Show

GET

http://localhost:8000

/api/v1/simpleAdmin/{simpleAdminId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

simpleAdminId

integer

required

the id of the role corresponding to super admin

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/simpleAdmin/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "activated_at": "2026-01-07 13:21:06",
            "is_active_status": true,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "deleted_at": null,
            "parent_id": null,
            "status_id": 1,
            "formated_code": "SAdm20260107132106",
            "generic_language_id": null,
            "role_id": 1
        },
        {
            "id": 1,
            "activated_at": "2026-01-07 13:21:06",
            "is_active_status": true,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "deleted_at": null,
            "parent_id": null,
            "status_id": 1,
            "formated_code": "SAdm20260107132106",
            "generic_language_id": null,
            "role_id": 1
        }
    ]
}

Simple Admin Update

PUT

PATCH

http://localhost:8000

/api/v1/simpleAdmin/{simpleAdminId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

simpleAdminId

integer

required

the id of the role corresponding to super admin

Example:

Body Parameters

name

string

required

Must not be greater than 255 characters.

Example:

city

string

Must not be greater than 255 characters.

Example:

country

string

Must not be greater than 255 characters.

Example:

po_box

string

Must not be greater than 255 characters.

Example:

surname

string

Must not be greater than 255 characters.

Example:

address

string

Must not be greater than 255 characters.

Example:

fix_phone

string

Must not be greater than 255 characters.

Example:

mobile_phone

string

Must not be greater than 255 characters.

Example:

date_of_birth

string

Must be a valid date.

Example:

2026-01-08T21:24:54

society

string

Must not be greater than 255 characters.

Example:

speciality

string

Must not be greater than 255 characters.

Example:

other_information

string

Must not be greater than 255 characters.

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request PUT \
    "http://localhost:8000/api/v1/simpleAdmin/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"city\": \"n\",
    \"country\": \"g\",
    \"po_box\": \"z\",
    \"surname\": \"m\",
    \"address\": \"i\",
    \"fix_phone\": \"y\",
    \"mobile_phone\": \"v\",
    \"date_of_birth\": \"2026-01-08T21:24:54\",
    \"society\": \"d\",
    \"speciality\": \"l\",
    \"other_information\": \"j\"
}"

Example response :

{
    "message": "update successfully"
}

Simple Admin Destroy

DELETE

http://localhost:8000

/api/v1/simpleAdmin/{simpleAdminId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

simpleAdminId

integer

required

The id of Simple Admin account to be deleted

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/simpleAdmin/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "deactivate successfully"
}

Company

List of company

Company List

GET

http://localhost:8000

/api/v1/companies

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

status

string

required

The type of account to be exported (active | inactive) By default the value is active

Must be one of:

active
inactive

Example:

active

paginate

boolean

indicate if the result will be paginated

Example:

contributorOwner

boolean

if present determine if the owner type was contributor or user role
and if not just get all companies

Example:

Body Parameters

requireAccessRight

boolean

Example:

Auth

Bearer

Headers

Query Parameters

Body

{ "requireAccessRight": true }

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/companies?status=active&paginate=1&contributorOwner=1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"requireAccessRight\": true
}"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "CU-yvan-cu",
            "email": "ynguetse@gmail.com",
            "email_verified_at": null,
            "address": "87, rue de Paul\n41658 Meunier",
            "city": "Benard",
            "country": "LA",
            "po_box": "64677",
            "fix_phone": null,
            "mobile_phone": null,
            "reference_number": null,
            "company_type_id": 1,
            "password": "$2y$12$Sd5JjV5WRwqSBnlF2wYPFOzpl8p0BNcxrKwidI2nJ1rNid1QP92vm",
            "user_role_id": 1,
            "creator_id": 1,
            "deletion_type_id": null,
            "status_id": 1,
            "formated_code": "Cu20260107132117",
            "company_email_designs_count": null,
            "company_languages_count": null,
            "company_questionnaire_designs_count": null,
            "company_report_designs_count": null,
            "partitioned_email_designs_count": null,
            "partitioned_languages_count": null,
            "partitioned_questionnaire_designs_count": null,
            "partitioned_report_designs_count": null,
            "other_information": null,
            "activated_at": "2026-01-07 13:21:17",
            "created_at": "2026-01-07T13:21:17.000000Z",
            "updated_at": "2026-01-07T13:21:17.000000Z",
            "deleted_at": null,
            "is_active_status": true,
            "remember_token": null,
            "generic_language_id": 1,
            "status": {
                "id": 1,
                "name": "active",
                "created_at": "2026-01-07T13:21:04.000000Z",
                "updated_at": "2026-01-07T13:21:04.000000Z"
            },
            "user_role": {
                "id": 1,
                "created_at": "2026-01-07T13:21:06.000000Z",
                "updated_at": "2026-01-07T13:21:06.000000Z",
                "is_direct_child": 1,
                "role_id": 1,
                "status_id": 1,
                "formated_code": "SAdm20260107132106",
                "parent_id": null,
                "user": {
                    "id": 1,
                    "name": "yvan",
                    "email": "ynguetse@gmail.com",
                    "email_verified_at": "2026-01-07T13:21:06.000000Z",
                    "surname": "Schneider",
                    "address": "42, boulevard de Duhamel\n64544 Guibert",
                    "city": "Lesage",
                    "country": "VA",
                    "po_box": "95141",
                    "fix_phone": "04 08 58 96 89",
                    "mobile_phone": "06 98 35 74 11",
                    "fax": "+33 (0)1 68 97 72 78",
                    "date_of_birth": null,
                    "speciality": "Opérateur piquage",
                    "society": "Hubert",
                    "generic_language_id": null,
                    "other_information": null,
                    "created_at": "2026-01-07T13:21:06.000000Z",
                    "updated_at": "2026-01-07T13:21:06.000000Z"
                },
                "act_as_global_admin": true,
                "voter_messages_count": null
            },
            "creator": {
                "id": 1,
                "created_at": "2026-01-07T13:21:06.000000Z",
                "updated_at": "2026-01-07T13:21:06.000000Z",
                "is_direct_child": 1,
                "role_id": 1,
                "status_id": 1,
                "formated_code": "SAdm20260107132106",
                "parent_id": null,
                "role": {
                    "id": 1,
                    "name": "global_admin",
                    "guard_name": "global_admin",
                    "created_at": "2026-01-07T13:21:04.000000Z",
                    "updated_at": "2026-01-07T13:21:04.000000Z"
                },
                "user": {
                    "id": 1,
                    "name": "yvan",
                    "email": "ynguetse@gmail.com",
                    "email_verified_at": "2026-01-07T13:21:06.000000Z",
                    "surname": "Schneider",
                    "address": "42, boulevard de Duhamel\n64544 Guibert",
                    "city": "Lesage",
                    "country": "VA",
                    "po_box": "95141",
                    "fix_phone": "04 08 58 96 89",
                    "mobile_phone": "06 98 35 74 11",
                    "fax": "+33 (0)1 68 97 72 78",
                    "date_of_birth": null,
                    "speciality": "Opérateur piquage",
                    "society": "Hubert",
                    "generic_language_id": null,
                    "other_information": null,
                    "created_at": "2026-01-07T13:21:06.000000Z",
                    "updated_at": "2026-01-07T13:21:06.000000Z"
                },
                "act_as_global_admin": true,
                "voter_messages_count": null
            },
            "is_webinaire": false,
            "is_multicreatif": false
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=2",
        "prev": null,
        "next": "/?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": "/?page=2",
                "label": "2",
                "page": 2,
                "active": false
            },
            {
                "url": "/?page=2",
                "label": "Next &raquo;",
                "page": 2,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 1,
        "to": 1,
        "total": 2
    }
}

Company Store

POST

http://localhost:8000

/api/v1/companies

requires authentication

Store a new company to application

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

emailLang

string

email lang

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

French

Body Parameters

string

required

Must be a valid email address. Must not be greater than 254 characters.

Example:

gbailey@example.net

name

string

required

Example:

architecto

created_at

string

required

Must be a valid date.

Example:

2026-01-08T21:24:54

user_role_id

integer

required

The id of an existing record in the user_roles table.

Example:

reference_number

string

Example:

architecto

other_information

string

Example:

architecto

company_type

string

required

Must be one of:

Private
Enterprise

Example:

architecto

emailLang

string

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

Russian

Auth

Bearer

Headers

Query Parameters

Body

{ "email": "gbailey@example.net", "name": "architecto", "created_at": "2026-01-08T21:24:54", "user_role_id": 16, "reference_number": "architecto", "other_information": "architecto", "company_type": "architecto", "emailLang": "Russian" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/companies?emailLang=French" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\",
    \"name\": \"architecto\",
    \"created_at\": \"2026-01-08T21:24:54\",
    \"user_role_id\": 16,
    \"reference_number\": \"architecto\",
    \"other_information\": \"architecto\",
    \"company_type\": \"architecto\",
    \"emailLang\": \"Russian\"
}"

Company Details

GET

http://localhost:8000

/api/v1/companies/{companyId}

requires authentication

Get details about a company

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

companyId

number

required

the identifiers of the company actual(id)

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/companies/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": 1,
        "name": "CU-yvan-cu",
        "email": "ynguetse@gmail.com",
        "email_verified_at": null,
        "address": "87, rue de Paul\n41658 Meunier",
        "city": "Benard",
        "country": "LA",
        "po_box": "64677",
        "fix_phone": null,
        "mobile_phone": null,
        "reference_number": null,
        "company_type_id": 1,
        "password": "$2y$12$Sd5JjV5WRwqSBnlF2wYPFOzpl8p0BNcxrKwidI2nJ1rNid1QP92vm",
        "user_role_id": 1,
        "creator_id": 1,
        "deletion_type_id": null,
        "status_id": 1,
        "formated_code": "Cu20260107132117",
        "company_email_designs_count": null,
        "company_languages_count": null,
        "company_questionnaire_designs_count": null,
        "company_report_designs_count": null,
        "partitioned_email_designs_count": null,
        "partitioned_languages_count": null,
        "partitioned_questionnaire_designs_count": null,
        "partitioned_report_designs_count": null,
        "other_information": null,
        "activated_at": "2026-01-07 13:21:17",
        "created_at": "2026-01-07T13:21:17.000000Z",
        "updated_at": "2026-01-07T13:21:17.000000Z",
        "deleted_at": null,
        "is_active_status": true,
        "remember_token": null,
        "generic_language_id": 1,
        "is_webinaire": false,
        "is_multicreatif": false
    }
}

Company Update

PUT

PATCH

http://localhost:8000

/api/v1/companies/{companyId}

requires authentication

Update the company data

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

companyId

number

required

the id of the company

Example:

Body Parameters

company_type

string

required

Must be one of:

Private
Enterprise

Example:

architecto

user_role_id

string

required

The id of an existing record in the user_roles table.

Example:

architecto

reference_number

string

Example:

architecto

other_information

string

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "company_type": "architecto", "user_role_id": "architecto", "reference_number": "architecto", "other_information": "architecto" }

Received response

Example request:

curl --request PUT \
    "http://localhost:8000/api/v1/companies/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_type\": \"architecto\",
    \"user_role_id\": \"architecto\",
    \"reference_number\": \"architecto\",
    \"other_information\": \"architecto\"
}"

Example response :

{
    "code": 200,
    "message": "Update successfully"
}

Delete Company

DELETE

http://localhost:8000

/api/v1/companies/{companyId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

companyId

integer

required

Company id

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/companies/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "Delete success"
}

Company list | As Admin

GET

http://localhost:8000

/api/v1/companies/administrators/wallet

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/companies/administrators/wallet" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "CU-yvan-cu",
            "email": "ynguetse@gmail.com",
            "email_verified_at": null,
            "address": "87, rue de Paul\n41658 Meunier",
            "city": "Benard",
            "country": "LA",
            "po_box": "64677",
            "fix_phone": null,
            "mobile_phone": null,
            "reference_number": null,
            "company_type_id": 1,
            "password": "$2y$12$Sd5JjV5WRwqSBnlF2wYPFOzpl8p0BNcxrKwidI2nJ1rNid1QP92vm",
            "user_role_id": 1,
            "creator_id": 1,
            "deletion_type_id": null,
            "status_id": 1,
            "formated_code": "Cu20260107132117",
            "company_email_designs_count": null,
            "company_languages_count": null,
            "company_questionnaire_designs_count": null,
            "company_report_designs_count": null,
            "partitioned_email_designs_count": null,
            "partitioned_languages_count": null,
            "partitioned_questionnaire_designs_count": null,
            "partitioned_report_designs_count": null,
            "other_information": null,
            "activated_at": "2026-01-07 13:21:17",
            "created_at": "2026-01-07T13:21:17.000000Z",
            "updated_at": "2026-01-07T13:21:17.000000Z",
            "deleted_at": null,
            "is_active_status": true,
            "remember_token": null,
            "generic_language_id": 1,
            "is_webinaire": false,
            "is_multicreatif": false
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=2",
        "prev": null,
        "next": "/?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": "/?page=2",
                "label": "2",
                "page": 2,
                "active": false
            },
            {
                "url": "/?page=2",
                "label": "Next &raquo;",
                "page": 2,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 1,
        "to": 1,
        "total": 2
    }
}

Company list | As Contributor

GET

http://localhost:8000

/api/v1/companies/contributorGroups/wallet

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/companies/contributorGroups/wallet" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": null,
            "company_id": null,
            "name": null,
            "email": null,
            "created_at": null,
            "updated_at": null
        },
        {
            "id": null,
            "company_id": null,
            "name": null,
            "email": null,
            "created_at": null,
            "updated_at": null
        }
    ]
}

Restore Account

POST

http://localhost:8000

/api/v1/companies/{companyId}/restore

requires authentication

Restore an company account after been deleted!

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

companyId

integer

required

id of company

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/companies/1/restore" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "restored"
}

My admin

GET

http://localhost:8000

/api/v1/companies/my/userRoles

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/companies/my/userRoles" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "is_direct_child": 1,
            "role_id": 1,
            "status_id": 1,
            "formated_code": "SAdm20260107132106",
            "parent_id": null,
            "user": {
                "id": 1,
                "name": "yvan",
                "email": "ynguetse@gmail.com",
                "email_verified_at": "2026-01-07T13:21:06.000000Z",
                "surname": "Schneider",
                "address": "42, boulevard de Duhamel\n64544 Guibert",
                "city": "Lesage",
                "country": "VA",
                "po_box": "95141",
                "fix_phone": "04 08 58 96 89",
                "mobile_phone": "06 98 35 74 11",
                "fax": "+33 (0)1 68 97 72 78",
                "date_of_birth": null,
                "speciality": "Opérateur piquage",
                "society": "Hubert",
                "generic_language_id": null,
                "other_information": null,
                "created_at": "2026-01-07T13:21:06.000000Z",
                "updated_at": "2026-01-07T13:21:06.000000Z"
            },
            "act_as_global_admin": true,
            "voter_messages_count": null
        },
        {
            "id": 1,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "is_direct_child": 1,
            "role_id": 1,
            "status_id": 1,
            "formated_code": "SAdm20260107132106",
            "parent_id": null,
            "user": {
                "id": 1,
                "name": "yvan",
                "email": "ynguetse@gmail.com",
                "email_verified_at": "2026-01-07T13:21:06.000000Z",
                "surname": "Schneider",
                "address": "42, boulevard de Duhamel\n64544 Guibert",
                "city": "Lesage",
                "country": "VA",
                "po_box": "95141",
                "fix_phone": "04 08 58 96 89",
                "mobile_phone": "06 98 35 74 11",
                "fax": "+33 (0)1 68 97 72 78",
                "date_of_birth": null,
                "speciality": "Opérateur piquage",
                "society": "Hubert",
                "generic_language_id": null,
                "other_information": null,
                "created_at": "2026-01-07T13:21:06.000000Z",
                "updated_at": "2026-01-07T13:21:06.000000Z"
            },
            "act_as_global_admin": true,
            "voter_messages_count": null
        }
    ]
}

Revert Deletion

POST

http://localhost:8000

/api/v1/company/request/reactivate/{token}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

token

Example:

xdjfjedediiejdiejide

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/company/request/reactivate/xdjfjedediiejdiejide" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Company | Metadata

GET

http://localhost:8000

/api/v1/company/{token}/data

Get all meta data

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

token in creation email

Example:

7se889s7Qp9exy5rsCZXivoyVZ7phb5QegYxEbFs8567a748

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/company/7se889s7Qp9exy5rsCZXivoyVZ7phb5QegYxEbFs8567a748/data" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": 1,
        "name": "CU-yvan-cu",
        "email": "ynguetse@gmail.com",
        "email_verified_at": null,
        "address": "87, rue de Paul\n41658 Meunier",
        "city": "Benard",
        "country": "LA",
        "po_box": "64677",
        "fix_phone": null,
        "mobile_phone": null,
        "reference_number": null,
        "company_type_id": 1,
        "password": "$2y$12$Sd5JjV5WRwqSBnlF2wYPFOzpl8p0BNcxrKwidI2nJ1rNid1QP92vm",
        "user_role_id": 1,
        "creator_id": 1,
        "deletion_type_id": null,
        "status_id": 1,
        "formated_code": "Cu20260107132117",
        "company_email_designs_count": null,
        "company_languages_count": null,
        "company_questionnaire_designs_count": null,
        "company_report_designs_count": null,
        "partitioned_email_designs_count": null,
        "partitioned_languages_count": null,
        "partitioned_questionnaire_designs_count": null,
        "partitioned_report_designs_count": null,
        "other_information": null,
        "activated_at": "2026-01-07 13:21:17",
        "created_at": "2026-01-07T13:21:17.000000Z",
        "updated_at": "2026-01-07T13:21:17.000000Z",
        "deleted_at": null,
        "is_active_status": true,
        "remember_token": null,
        "generic_language_id": 1,
        "is_webinaire": false,
        "is_multicreatif": false
    }
}

Validate Company

POST

http://localhost:8000

/api/v1/companies/{token}/validate

Activate company with provided data

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

the token provided by email

Example:

X93h33j393h9hid939dh3idh93hd93hid3

Body Parameters

name

string

required

Example:

architecto

password

string

required

Example:

architecto

address

string

Example:

architecto

city

string

Example:

architecto

country

string

Example:

architecto

po_box

string

Example:

architecto

fix_phone

string

Example:

architecto

mobile_phone

string

Example:

architecto

reference_number

string

Example:

architecto

other_information

string

Example:

architecto

user_role_id

integer

required

The id of an existing record in the user_roles table.

Example:

company_type

string

required

Must be one of:

Private
Enterprise

Example:

architecto

generic_language

string

required

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

architecto

Headers

URL Parameters

Body

{ "name": "architecto", "password": "architecto", "address": "architecto", "city": "architecto", "country": "architecto", "po_box": "architecto", "fix_phone": "architecto", "mobile_phone": "architecto", "reference_number": "architecto", "other_information": "architecto", "user_role_id": 16, "company_type": "architecto", "generic_language": "architecto" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/companies/X93h33j393h9hid939dh3idh93hd93hid3/validate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"password\": \"architecto\",
    \"address\": \"architecto\",
    \"city\": \"architecto\",
    \"country\": \"architecto\",
    \"po_box\": \"architecto\",
    \"fix_phone\": \"architecto\",
    \"mobile_phone\": \"architecto\",
    \"reference_number\": \"architecto\",
    \"other_information\": \"architecto\",
    \"user_role_id\": 16,
    \"company_type\": \"architecto\",
    \"generic_language\": \"architecto\"
}"

Metadata | from Password reset

GET

http://localhost:8000

/api/v1/visu/{resetPasswordToken}/infos

Get all information about user role from passing a token and give a email as query parameter

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

resetPasswordToken

string

required

The password token sent via email or any other channels

Example:

dedede29393

Query Parameters

string

required

The email for company

Example:

lucchuala@gmail.com

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/visu/dedede29393/infos?email=lucchuala%40gmail.com" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": 1,
        "name": "CU-yvan-cu",
        "email": "ynguetse@gmail.com",
        "email_verified_at": null,
        "address": "87, rue de Paul\n41658 Meunier",
        "city": "Benard",
        "country": "LA",
        "po_box": "64677",
        "fix_phone": null,
        "mobile_phone": null,
        "reference_number": null,
        "company_type_id": 1,
        "password": "$2y$12$Sd5JjV5WRwqSBnlF2wYPFOzpl8p0BNcxrKwidI2nJ1rNid1QP92vm",
        "user_role_id": 1,
        "creator_id": 1,
        "deletion_type_id": null,
        "status_id": 1,
        "formated_code": "Cu20260107132117",
        "company_email_designs_count": null,
        "company_languages_count": null,
        "company_questionnaire_designs_count": null,
        "company_report_designs_count": null,
        "partitioned_email_designs_count": null,
        "partitioned_languages_count": null,
        "partitioned_questionnaire_designs_count": null,
        "partitioned_report_designs_count": null,
        "other_information": null,
        "activated_at": "2026-01-07 13:21:17",
        "created_at": "2026-01-07T13:21:17.000000Z",
        "updated_at": "2026-01-07T13:21:17.000000Z",
        "deleted_at": null,
        "is_active_status": true,
        "remember_token": null,
        "generic_language_id": 1,
        "company_type": {
            "id": 1,
            "name": "Private",
            "created_at": "2026-01-07T13:21:04.000000Z"
        },
        "user_role": {
            "id": 1,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "is_direct_child": 1,
            "role_id": 1,
            "status_id": 1,
            "formated_code": "SAdm20260107132106",
            "parent_id": null,
            "role": {
                "id": 1,
                "name": "global_admin",
                "guard_name": "global_admin",
                "created_at": "2026-01-07T13:21:04.000000Z",
                "updated_at": "2026-01-07T13:21:04.000000Z"
            },
            "user": {
                "id": 1,
                "name": "yvan",
                "email": "ynguetse@gmail.com",
                "email_verified_at": "2026-01-07T13:21:06.000000Z",
                "surname": "Schneider",
                "address": "42, boulevard de Duhamel\n64544 Guibert",
                "city": "Lesage",
                "country": "VA",
                "po_box": "95141",
                "fix_phone": "04 08 58 96 89",
                "mobile_phone": "06 98 35 74 11",
                "fax": "+33 (0)1 68 97 72 78",
                "date_of_birth": null,
                "speciality": "Opérateur piquage",
                "society": "Hubert",
                "generic_language_id": null,
                "other_information": null,
                "created_at": "2026-01-07T13:21:06.000000Z",
                "updated_at": "2026-01-07T13:21:06.000000Z"
            },
            "act_as_global_admin": true,
            "voter_messages_count": null
        },
        "is_webinaire": false,
        "is_multicreatif": false
    }
}

Voter

Metadata | from Password reset

GET

http://localhost:8000

/api/v1/voter/{resetPasswordToken}/infos

Get all information about user role from passing a token and give a email as query parameter

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

resetPasswordToken

string

required

The password token sent via email or any other channels

Example:

dedede29393

Query Parameters

string

required

The email for voter

Example:

lucchuala@gmail.com

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/voter/dedede29393/infos?email=lucchuala%40gmail.com" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": null,
        "email": null,
        "access_type_id": null,
        "status_id": null,
        "company_id": null,
        "created_at": null,
        "properties": [],
        "generic_language_id": null,
        "revert_deletion_type": null
    }
}

Authentication

Authenticate user and provide token for the user to access the system.

<h2>This Token is limited . to have the full version of token you have to generate a new token from the user role.</h2>
<p>Theses are functionality of the group:</p>

<li>Login user account : provide an token for the user account</li>
<li>Login user role account: provide a token for the user role account</li>
<li>Send a email reset password </li>
<li>Send an verification email</li>
<li>Reset user password</li>

User

POST

http://localhost:8000

/api/v1/login

Get the credentials of any user and return an unique token witch correspond to these credentials

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Must be a valid email address.

Example:

gbailey@example.net

password

string

required

Example:

|]|{+-

Response Fields

token

string

required

The token for the user

Example:

FJDHXDJS0930393DKDKxdkdedfde

Headers

Body

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\",
    \"password\": \"|]|{+-\"
}"

Example response :

{
    "data": {
        "token": "FJDHXDJS0930393DKDKxdkdedfd",
        "roles": []
    }
}

Send password Link

POST

http://localhost:8000

/api/v1/forgot-password

Send to the email provide an reset mail instructions

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Email of user. Must be a valid email address.

Example:

lucchuala@gmail.com

profile

string

Profile of user ; the default value is .admins.

Must be one of:

visu
admins
voter

Example:

admins

locale

string

Must be one of:

fr
en
es
de
pt
cn
jp
it
ru
nl

Example:

Response Fields

message

string

required

The message for the response

status

string

required

Represent the status of the response

Must be one of:

passwords.sent
passwords.user
passwords.throttled

Headers

Body

{ "email": "lucchuala@gmail.com", "profile": "admins", "locale": "en" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/forgot-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"lucchuala@gmail.com\",
    \"profile\": \"admins\",
    \"locale\": \"en\"
}"

Example response :

{
    "status": "passwords.sent",
    "message": "we have sent you a successfully password reset link"
}

Reset password

POST

http://localhost:8000

/api/v1/reset-password

Reset the password for the given token, either admins or companies

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

token

string

required

Token receive in the email

Example:

a88b7dcd1a9e3e17770bbaa6d7515b31a2d7e85d

string

required

email for user

Example:

user@email.com

password

string

required

the password

Example:

user@email.com

profile

string

Example:

architecto

password_confirmation

string

required

the confirmation for password

Example:

architecto

Headers

Body

{ "token": "a88b7dcd1a9e3e17770bbaa6d7515b31a2d7e85d", "email": "user@email.com", "password": "user@email.com", "profile": "architecto", "password_confirmation": "architecto" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/reset-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"a88b7dcd1a9e3e17770bbaa6d7515b31a2d7e85d\",
    \"email\": \"user@email.com\",
    \"password\": \"user@email.com\",
    \"profile\": \"architecto\",
    \"password_confirmation\": \"architecto\"
}"

Example response :

{
    "status": "reset success"
}

Send Email Verification

POST

http://localhost:8000

/api/v1/email/verification-notification

requires authentication

Send The verification email for reset password

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/email/verification-notification" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Logout

POST

http://localhost:8000

/api/v1/logout

requires authentication

Delete all the token for the authenticated user

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/logout" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

UserRole

POST

http://localhost:8000

/api/v1/user/role/login

Authenticate a user role by providing a token

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Must be a valid email address.

Example:

gbailey@example.net

password

string

required

Example:

|]|{+-

role_id

integer

required

The id of an existing record in the roles table.

Example:

Headers

Body

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/user/role/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\",
    \"password\": \"|]|{+-\",
    \"role_id\": 16
}"

Example response :

{
    "token": "19|deubX17LvquxOkIp8lkXqa3rCklCP6pF3qZwLG2x0f98e599",
    "auth": {
        "id": 1,
        "created_at": "2024-12-10T08:24:33.000000Z",
        "updated_at": "2024-12-10T14:00:14.000000Z",
        "is_direct_child": 1,
        "role_id": 1,
        "status_id": 1,
        "formated_code": "SAdm20241210082433",
        "parent_id": null,
        "user": {
            "id": 1,
            "name": "consequatur",
            "email": "lucchuala@gmail.com",
            "email_verified_at": "2024-12-10T14:00:14.000000Z",
            "surname": "consequatur",
            "address": "consequatur",
            "city": "consequatur",
            "country": "consequatur",
            "po_box": "consequatur",
            "fix_phone": "consequatur",
            "mobile_phone": "consequatur",
            "fax": "+33 (0)8 29 70 33 82",
            "date_of_birth": "2024-12-18",
            "speciality": "consequatur",
            "society": "consequatur",
            "other_information": "consequatur",
            "created_at": "2024-12-10T08:24:33.000000Z",
            "updated_at": "2024-12-23T06:04:58.000000Z"
        }
    }
}

Logout Account user role

POST

http://localhost:8000

/api/v1/user/role/logout

Authenticate a user role by providing a token

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/user/role/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Voter

Reset password

POST

http://localhost:8000

/api/v1/reset-password/voter

Reset the password for the given token, either admins or companies

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

token

string

required

Token receive in the email

Example:

a88b7dcd1a9e3e17770bbaa6d7515b31a2d7e85d

string

required

email for user

Example:

user@email.com

name

string

required

the name.

Example:

Nguemoue

surname

string

required

the sruname.

Example:

luc

password

string

required

the password

Example:

user@email.com

password_confirmation

string

required

the confirmation for password

Example:

architecto

Headers

Body

{ "token": "a88b7dcd1a9e3e17770bbaa6d7515b31a2d7e85d", "email": "user@email.com", "name": "Nguemoue", "surname": "luc", "password": "user@email.com", "password_confirmation": "architecto" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/reset-password/voter" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"a88b7dcd1a9e3e17770bbaa6d7515b31a2d7e85d\",
    \"email\": \"user@email.com\",
    \"name\": \"Nguemoue\",
    \"surname\": \"luc\",
    \"password\": \"user@email.com\",
    \"password_confirmation\": \"architecto\"
}"

Example response :

{
    "status": "reset success"
}

POST

http://localhost:8000

/api/v1/login/voterQuestionnaire/nominatif

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

questionnaire_id

integer

required

The id of an existing record in the questionnaires table.

Example:

string

required

email of voter. Must be a valid email address.

Example:

zbailey@example.net

password

string

required

password that voter uses to create account.

Example:

|]|{+-

Headers

Body

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/login/voterQuestionnaire/nominatif" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"questionnaire_id\": 16,
    \"email\": \"zbailey@example.net\",
    \"password\": \"|]|{+-\"
}"

Example response :

{
    "data": {
        "token": "EA119zBgr1RRgfprtCoopDqRE0JQ1Cbjh9L50lOo0038d6b1",
        "auth": {
            "id": 1,
            "email": "voter@gmail.com",
            "access_type_id": 1
        }
    }
}

POST

http://localhost:8000

/api/v1/login/voter

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

email of voter. Must be a valid email address.

Example:

gbailey@example.net

password

string

required

password that voter uses to create account.

Example:

|]|{+-

Headers

Body

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/login/voter" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\",
    \"password\": \"|]|{+-\"
}"

Example response :

{
    "data": {
        "token": "EA119zBgr1RRgfprtCoopDqRE0JQ1Cbjh9L50lOo0038d6b1",
        "auth": {
            "id": 1,
            "email": "voter@gmail.com",
            "access_type_id": 1
        }
    }
}

POST

http://localhost:8000

/api/v1/login/token/{token}/nominative

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

email of voter. Must be a valid email address.

Example:

gbailey@example.net

password

string

required

password that voter uses to create account.

Example:

|]|{+-

Headers

Body

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/login/token/{token}/nominative" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\",
    \"password\": \"|]|{+-\"
}"

Example response :

{
    "data": {
        "token": "EA119zBgr1RRgfprtCoopDqRE0JQ1Cbjh9L50lOo0038d6b1",
        "auth": {
            "id": 1,
            "email": "voter@gmail.com",
            "access_type_id": 1
        }
    }
}

Logout

POST

http://localhost:8000

/api/v1/logout/voter

Logout voter

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/logout/voter" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "Successfully logged out"
}

Library

POST

http://localhost:8000

/api/v1/login/library

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

product_id

integer

required

The id of an existing record in the products table.

Example:

code

string

required

The code of an existing record in the library_access_codes table.

Example:

architecto

Headers

Body

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/login/library" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"product_id\": 16,
    \"code\": \"architecto\"
}"

Example response :

{
    "data": {
        "token": "EA119zBgr1RRgfprtCoopDqRE0JQ1Cbjh9L50lOo0038d6b1"
    }
}

POST api/v1/logout/library

POST

http://localhost:8000

/api/v1/logout/library

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/logout/library" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Visu

POST

http://localhost:8000

/api/v1/login/visu

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

email of user account. Must be a valid email address.

Example:

berger.aurore@dias.fr

password

string

required

password that voter uses to create account.

Example:

|]|{+-

Headers

Body

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/login/visu" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"berger.aurore@dias.fr\",
    \"password\": \"|]|{+-\"
}"

Example response :

{
    "data": {
        "token": "EA119zBgr1RRgfprtCoopDqRE0JQ1Cbjh9L50lOo0038d6b1",
        "company": {
            "id": 1,
            "name": "name",
            "company_type": {
                "id": 1,
                "name": "name"
            },
            "use_role": {
                "id": 1,
                "name": "name",
                "user": {
                    "id": 1,
                    "name": "name"
                }
            }
        }
    }
}

Visu | Logout

POST

http://localhost:8000

/api/v1/logout/visu

requires authentication

Logout visu

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/logout/visu" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "Logged out"
}

Report

POST

http://localhost:8000

/api/v1/login/report

Report login end point

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

access_code

string

required

Example:

architecto

Headers

Body

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/login/report" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"access_code\": \"architecto\"
}"

Example response :

{
    "data": {
        "token": "EA119zBgr1RRgfprtCoopDqRE0JQ1Cbjh9L50lOo0038d6b1",
        "questionnaire": {
            "id": 1
        }
    }
}

Report logout

POST

http://localhost:8000

/api/v1/logout/report

Report logout end point

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/logout/report" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Base Option

Basic Option

Core | Get Shared Settings

GET

http://localhost:8000

/api/v1/baseOption/basicOptions/sharedSettings

requires authentication

Get the basic details for the application

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/baseOption/basicOptions/sharedSettings" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

Core | Update Shared Settings

POST

http://localhost:8000

/api/v1/baseOption/basicOptions/sharedSettings

requires authentication

Update the current information about basic option

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

sender_name

string

required

the sender name of application

Example:

John Doe

sending_email

string

required

the sender email of application

Example:

johndoe@gmail.com

cc_email

string[]

required

List of Bcc email

Example:

["cc@gmail.com","cc2@gmail.com"]

Auth

Bearer

Headers

Body

{ "sender_name": "John Doe", "sending_email": "johndoe@gmail.com", "cc_email": [ "cc@gmail.com", "cc2@gmail.com" ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/baseOption/basicOptions/sharedSettings" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"sender_name\": \"John Doe\",
    \"sending_email\": \"johndoe@gmail.com\",
    \"cc_email\": [
        \"cc@gmail.com\",
        \"cc2@gmail.com\"
    ]
}"

Example response :

{
    "status": 200,
    "message": "Update success"
}

Reset| Shared Setting

POST

http://localhost:8000

/api/v1/baseOption/basicOptions/sharedSettings/reset

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/baseOption/basicOptions/sharedSettings/reset" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

SuperAdmin | Get Basic Config

GET

http://localhost:8000

/api/v1/baseOption/basicOptions/superAdministrator

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

user_role_id

integer

required

id of user role

Example:

Body Parameters

user_role_id

integer

required

Example:

Auth

Bearer

Headers

Query Parameters

Body

{ "user_role_id": 16 }

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/baseOption/basicOptions/superAdministrator?user_role_id=1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_role_id\": 16
}"

Example response :

{
    "data": {
        "super_admin_id": 1,
        "languages": [],
        "questionnaire_designs": [],
        "report_designs": [],
        "email_designs": [],
        "sender_name": null,
        "sender_email": null,
        "cc_email": []
    }
}

SuperAdmin | Update Basic Config

POST

http://localhost:8000

/api/v1/baseOption/basicOptions/superAdministrator

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

user_role_id

integer

required

The id of an existing record in the user_roles table.

Example:

languages

integer[]

The id of an existing record in the languages table.

Example:

[16]

questionnaire_designs

integer[]

The id of an existing record in the questionnaire_designs table.

Example:

[16]

report_designs

integer[]

The id of an existing record in the report_designs table.

Example:

[16]

email_designs

integer[]

The id of an existing record in the email_designs table.

Example:

[16]

sender_name

string

required

Example:

architecto

sending_email

string

required

Must be a valid email address.

Example:

zbailey@example.net

cc_email

string[]

Must be a valid email address.

Example:

["gulgowski.asia@example.com"]

Auth

Bearer

Headers

Body

{ "user_role_id": 16, "languages": [ 16 ], "questionnaire_designs": [ 16 ], "report_designs": [ 16 ], "email_designs": [ 16 ], "sender_name": "architecto", "sending_email": "zbailey@example.net", "cc_email": [ "gulgowski.asia@example.com" ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/baseOption/basicOptions/superAdministrator" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_role_id\": 16,
    \"languages\": [
        16
    ],
    \"questionnaire_designs\": [
        16
    ],
    \"report_designs\": [
        16
    ],
    \"email_designs\": [
        16
    ],
    \"sender_name\": \"architecto\",
    \"sending_email\": \"zbailey@example.net\",
    \"cc_email\": [
        \"gulgowski.asia@example.com\"
    ]
}"

Example response :

{
    "message": "success",
    "status": 200
}

Company | GET Basic Config

GET

http://localhost:8000

/api/v1/baseOption/basicOptions/company/{companyId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

companyId

integer

required

id of company

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/baseOption/basicOptions/company/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "company_id": 1
        },
        {
            "company_id": 1
        }
    ]
}

Company | Update Basic Config

POST

http://localhost:8000

/api/v1/baseOption/basicOptions/company

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

company_id

integer

required

The id of an existing record in the companies table.

Example:

languages

integer[]

The id of an existing record in the languages table.

Example:

[16]

questionnaire_designs

integer[]

The id of an existing record in the questionnaire_designs table.

Example:

[16]

report_designs

integer[]

The id of an existing record in the report_designs table.

Example:

[16]

email_designs

integer[]

The id of an existing record in the email_designs table.

Example:

[16]

Auth

Bearer

Headers

Body

{ "company_id": 16, "languages": [ 16 ], "questionnaire_designs": [ 16 ], "report_designs": [ 16 ], "email_designs": [ 16 ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/baseOption/basicOptions/company" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_id\": 16,
    \"languages\": [
        16
    ],
    \"questionnaire_designs\": [
        16
    ],
    \"report_designs\": [
        16
    ],
    \"email_designs\": [
        16
    ]
}"

Example response :

{
    "message": "Created successfully"
}

SimpleAdmin | Get Basic Config

GET

http://localhost:8000

/api/v1/baseOption/basicOptions/administrator

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

user_role_id

integer

required

id of user role corresponding to this simple admin

Example:

Auth

Bearer

Headers

Body

{ "user_role_id": 1 }

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/baseOption/basicOptions/administrator" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_role_id\": 1
}"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

SimpleAdmin | Update Basic Config

POST

http://localhost:8000

/api/v1/baseOption/basicOptions/administrator

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

user_role_id

integer

required

The id of an existing record in the user_roles table.

Example:

languages

integer[]

The id of an existing record in the languages table.

Example:

[16]

questionnaire_designs

integer[]

The id of an existing record in the questionnaire_designs table.

Example:

[16]

report_designs

integer[]

The id of an existing record in the report_designs table.

Example:

[16]

email_designs

integer[]

The id of an existing record in the email_designs table.

Example:

[16]

Auth

Bearer

Headers

Body

{ "user_role_id": 16, "languages": [ 16 ], "questionnaire_designs": [ 16 ], "report_designs": [ 16 ], "email_designs": [ 16 ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/baseOption/basicOptions/administrator" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_role_id\": 16,
    \"languages\": [
        16
    ],
    \"questionnaire_designs\": [
        16
    ],
    \"report_designs\": [
        16
    ],
    \"email_designs\": [
        16
    ]
}"

Subscription

Subscription | Is valid

GET

http://localhost:8000

/api/v1/baseOption/basicOptions/superAdministrator/subscription/isValid

requires authentication

Check if a super administrator has a valid subscription

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/baseOption/basicOptions/superAdministrator/subscription/isValid" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "valid": false
    }
}

Subscription | List

GET

http://localhost:8000

/api/v1/baseOption/subscriptions/index

requires authentication

Get tbe list of all subscriptions

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/baseOption/subscriptions/index" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

SuperAdmin | Get subscriptions

GET

http://localhost:8000

/api/v1/baseOption/subscriptions/{subscriptionType}/superAdministrator

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

subscriptionType

string

required

type of subscription

Must be one of:

normal
unlimited

Example:

normal

Query Parameters

user_role_id

integer

required

id of super admin

Example:

Body Parameters

user_role_id

integer

Example:

Auth

Bearer

Headers

URL Parameters

Query Parameters

Body

{ "user_role_id": 16 }

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/baseOption/subscriptions/normal/superAdministrator?user_role_id=16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_role_id\": 16
}"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

SuperAdmin | Detail Subscription.

GET

http://localhost:8000

/api/v1/baseOption/subscriptions/{subscriptionType}/superAdministrator/{superAdministratorId}/details

requires authentication

Details des souscriptions d'un super administrateur

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

subscriptionType

string

required

type of subscription

Must be one of:

normal
unlimited

Example:

normal

superAdministratorId

integer

required

id of super administrator

Example:

Query Parameters

product_id

integer

the id of product

Example:

Response Fields

integer

required

id of the subscription

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/baseOption/subscriptions/normal/superAdministrator/2/details?product_id=1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 2,
            "status_id": 7,
            "user_role_id": 1,
            "properties": {
                "questionnaireNumber": null,
                "expirationDate": null,
                "startDate": null,
                "subscriptionType": "normal",
                "timezone": "UTC"
            },
            "subscription_type_id": 1,
            "subscription_type": {
                "id": 1,
                "name": "normal",
                "created_at": "2026-01-07T13:21:05.000000Z"
            },
            "updated_at": "2026-01-08T21:24:56.000000Z",
            "created_at": "2026-01-08T21:24:56.000000Z"
        },
        {
            "id": 2,
            "status_id": 7,
            "user_role_id": 1,
            "properties": {
                "questionnaireNumber": null,
                "expirationDate": null,
                "startDate": null,
                "subscriptionType": "normal",
                "timezone": "UTC"
            },
            "subscription_type_id": 1,
            "subscription_type": {
                "id": 1,
                "name": "normal",
                "created_at": "2026-01-07T13:21:05.000000Z"
            },
            "updated_at": "2026-01-08T21:24:56.000000Z",
            "created_at": "2026-01-08T21:24:56.000000Z"
        }
    ]
}

Subscription | Destroy

DELETE

http://localhost:8000

/api/v1/baseOption/subscriptions/{subscriptionId}/delete

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/baseOption/subscriptions/{subscriptionId}/delete" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Subscription | Activate

POST

http://localhost:8000

/api/v1/baseOption/subscriptions/{subscriptionId}/activate

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/baseOption/subscriptions/{subscriptionId}/activate" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

SuperAdmin | Upsert subscriptions

POST

http://localhost:8000

/api/v1/baseOption/subscriptions/{subscriptionType}/superAdministrator

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

subscriptionType

string

required

type of subscription

Must be one of:

normal
unlimited

Example:

normal

Body Parameters

user_role_id

integer

required

id of user_role to give the subscription. The id of an existing record in the user_roles table.

Example:

subscriptions

object[]

required

a subscription item witch is a array of <property,value>].

product_id

integer

required

id of product to give subscription to. The id of an existing record in the products table.

Example:

questionnaire_number

integer

required

Number of questionnaire. Must be at least 0.

Example:

start_date

string

date when subscription start. Must be a valid date.

Example:

2026-01-08T21:24:57

expiration_date

string

date when subscription end. Must be a valid date. Must be a date after or equal to start_date.

Example:

2092-07-08

Auth

Bearer

Headers

URL Parameters

Body

{ "user_role_id": 16, "subscriptions": [ { "product_id": 16, "questionnaire_number": 39, "start_date": "2026-01-08T21:24:57", "expiration_date": "2092-07-08" } ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/baseOption/subscriptions/normal/superAdministrator" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_role_id\": 16,
    \"subscriptions\": [
        {
            \"product_id\": 16,
            \"questionnaire_number\": 39,
            \"start_date\": \"2026-01-08T21:24:57\",
            \"expiration_date\": \"2092-07-08\"
        }
    ]
}"

History

History | Super Admin

GET

http://localhost:8000

/api/v1/baseOption/subscriptions/histories/superAdministrators

requires authentication

List of espace cloisoned

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/baseOption/subscriptions/histories/superAdministrators" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "user": {
                "id": 1,
                "name": "yvan",
                "email": "ynguetse@gmail.com",
                "email_verified_at": "2026-01-07T13:21:06.000000Z",
                "surname": "Schneider",
                "address": "42, boulevard de Duhamel\n64544 Guibert",
                "city": "Lesage",
                "country": "VA",
                "po_box": "95141",
                "fix_phone": "04 08 58 96 89",
                "mobile_phone": "06 98 35 74 11",
                "fax": "+33 (0)1 68 97 72 78",
                "date_of_birth": null,
                "speciality": "Opérateur piquage",
                "society": "Hubert",
                "generic_language_id": null,
                "other_information": null,
                "created_at": "2026-01-07T13:21:06.000000Z",
                "updated_at": "2026-01-07T13:21:06.000000Z"
            },
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "emails": [],
            "languages": [],
            "questionnaire_designs": []
        },
        {
            "id": 1,
            "user": {
                "id": 1,
                "name": "yvan",
                "email": "ynguetse@gmail.com",
                "email_verified_at": "2026-01-07T13:21:06.000000Z",
                "surname": "Schneider",
                "address": "42, boulevard de Duhamel\n64544 Guibert",
                "city": "Lesage",
                "country": "VA",
                "po_box": "95141",
                "fix_phone": "04 08 58 96 89",
                "mobile_phone": "06 98 35 74 11",
                "fax": "+33 (0)1 68 97 72 78",
                "date_of_birth": null,
                "speciality": "Opérateur piquage",
                "society": "Hubert",
                "generic_language_id": null,
                "other_information": null,
                "created_at": "2026-01-07T13:21:06.000000Z",
                "updated_at": "2026-01-07T13:21:06.000000Z"
            },
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "emails": [],
            "languages": [],
            "questionnaire_designs": []
        }
    ]
}

History | Update Subscription

PUT

http://localhost:8000

/api/v1/baseOption/subscriptions/histories/{subscriptionType}/subscriptions/{subscriptionId}/update

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

subscriptionType

string

required

type of subscription

Must be one of:

normal
unlimited

Example:

unlimited

subscriptionId

integer

required

id of subscription to be updated

Example:

Body Parameters

questionnaire_number

integer

required

Must be at least 0.

Example:

start_date

string

Must be a valid date.

Example:

2026-01-08T21:24:57

expiration_date

string

Must be a valid date.

Example:

2026-01-08T21:24:57

Auth

Bearer

Headers

URL Parameters

Body

{ "questionnaire_number": 27, "start_date": "2026-01-08T21:24:57", "expiration_date": "2026-01-08T21:24:57" }

Received response

Example request:

curl --request PUT \
    "http://localhost:8000/api/v1/baseOption/subscriptions/histories/unlimited/subscriptions/1/update" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"questionnaire_number\": 27,
    \"start_date\": \"2026-01-08T21:24:57\",
    \"expiration_date\": \"2026-01-08T21:24:57\"
}"

Export

Export | Subscription

GET

http://localhost:8000

/api/v1/baseOption/subscriptions/histories/subscriptions/export

requires authentication

Export in a (CSV|XLSX) format the list of subscription

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

format

string

required

Must be one of:

csv
xlsx

Example:

csv

exportLanguage

string

required

Specified the language of witch the export will be done

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

French

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/baseOption/subscriptions/histories/subscriptions/export?format=csv&exportLanguage=French" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

<binary>

Export | Super Admin

GET

http://localhost:8000

/api/v1/baseOption/subscriptions/histories/superAdministrators/export

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

format

string

required

Must be one of:

csv
xlsx

Example:

csv

string

required

specified the timezone for date

Example:

Europe/Paris

exportLanguage

string

required

the export language

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

French

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/baseOption/subscriptions/histories/superAdministrators/export?format=csv&tz=Europe%2FParis&exportLanguage=French" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

Contributor Group

Manage Contributor group operations

Contributor List

GET

http://localhost:8000

/api/v1/contributorGroup

requires authentication

Contributor List

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/contributorGroup" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 4,
            "company_id": 11,
            "name": "Riviere",
            "email": "berger.aurore@dias.fr",
            "created_at": "2026-01-08T21:24:55.000000Z",
            "updated_at": "2026-01-08T21:24:55.000000Z"
        },
        {
            "id": 4,
            "company_id": 11,
            "name": "Riviere",
            "email": "berger.aurore@dias.fr",
            "created_at": "2026-01-08T21:24:55.000000Z",
            "updated_at": "2026-01-08T21:24:55.000000Z"
        }
    ]
}

Create Contributor Group

POST

http://localhost:8000

/api/v1/contributorGroup

requires authentication

Create Contributor Group

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

company_id

integer

required

The id of an existing record in the companies table.

Example:

name

string

required

Example:

architecto

string

Must be a valid email address. Must not be greater than 254 characters.

Example:

zbailey@example.net

admins

integer[]

The id of an existing record in the user_roles table.

Example:

[16]

Auth

Bearer

Headers

Body

{ "company_id": 16, "name": "architecto", "email": "zbailey@example.net", "admins": [ 16 ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/contributorGroup" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_id\": 16,
    \"name\": \"architecto\",
    \"email\": \"zbailey@example.net\",
    \"admins\": [
        16
    ]
}"

Example response :

{
    "message": "successfully created"
}

Show Contributor Group

GET

http://localhost:8000

/api/v1/contributorGroup/{contributorGroupId}

requires authentication

Show Contributor Group

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contributorGroupId

integer

required

id of contributor group

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/contributorGroup/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": 6,
        "company_id": 13,
        "name": "Riviere",
        "email": "berger.aurore@dias.fr",
        "created_at": "2026-01-08T21:24:55.000000Z",
        "updated_at": "2026-01-08T21:24:55.000000Z"
    }
}

Update Contributor Group

PUT

PATCH

http://localhost:8000

/api/v1/contributorGroup/{contributorGroupId}

requires authentication

Update Contributor Group

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contributorGroupId

integer

required

id of contributor group

Example:

Body Parameters

company_id

integer

required

The id of an existing record in the companies table.

Example:

name

string

required

Example:

architecto

string

Must be a valid email address. Must not be greater than 254 characters.

Example:

zbailey@example.net

admins

integer[]

The id of an existing record in the user_roles table.

Example:

[16]

Auth

Bearer

Headers

URL Parameters

Body

{ "company_id": 16, "name": "architecto", "email": "zbailey@example.net", "admins": [ 16 ] }

Received response

Example request:

curl --request PUT \
    "http://localhost:8000/api/v1/contributorGroup/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_id\": 16,
    \"name\": \"architecto\",
    \"email\": \"zbailey@example.net\",
    \"admins\": [
        16
    ]
}"

Example response :

{
    "message": "update Success"
}

Delete Contributor Group

DELETE

http://localhost:8000

/api/v1/contributorGroup/{contributorGroupId}

requires authentication

Delete Contributor Group

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contributorGroupId

integer

required

id of contributor group

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/contributorGroup/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "Deleted success!"
}

Dashboard

Slices

GET

http://localhost:8000

/api/v1/products/{productCode}/slices

Get Slices defined

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

productCode

string

required

Must be one of:

survey
360
quiz
bio
isiTest

Example:

survey

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/products/survey/slices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "none"
        },
        {
            "id": 1,
            "name": "none"
        }
    ]
}

Phases

GET

http://localhost:8000

/api/v1/phases

Get phases defined

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/phases" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "creation"
        },
        {
            "id": 1,
            "name": "creation"
        }
    ]
}

Products

GET

http://localhost:8000

/api/v1/products

Get all products defined

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "survey",
            "image_url": null,
            "description": "sondage description"
        },
        {
            "id": 1,
            "name": "survey",
            "image_url": null,
            "description": "sondage description"
        }
    ]
}

Numeric scale

GET

http://localhost:8000

/api/v1/numericScale

Get numeric scales defined

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/numericScale" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "start": 0,
            "end": 3,
            "formated_scale": "0-3"
        },
        {
            "id": 1,
            "start": 0,
            "end": 3,
            "formated_scale": "0-3"
        }
    ]
}

Languages

GET

http://localhost:8000

/api/v1/languages

Get all languages defined

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/languages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "French",
            "acronym": "fr"
        },
        {
            "id": 1,
            "name": "French",
            "acronym": "fr"
        }
    ]
}

UserRole

My languages

GET

http://localhost:8000

/api/v1/dashboard/userRole/languages

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/dashboard/userRole/languages" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

My report design

GET

http://localhost:8000

/api/v1/dashboard/userRole/reportDesigns

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/dashboard/userRole/reportDesigns" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

My email design

GET

http://localhost:8000

/api/v1/dashboard/userRole/emailDesigns

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/dashboard/userRole/emailDesigns" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

My questionnaire design

GET

http://localhost:8000

/api/v1/dashboard/userRole/questionnaireDesigns

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/dashboard/userRole/questionnaireDesigns" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

My super admin

GET

http://localhost:8000

/api/v1/dashboard/userRole/superAdministrators

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/dashboard/userRole/superAdministrators" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

My Company

GET

http://localhost:8000

/api/v1/dashboard/userRole/company

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/dashboard/userRole/company" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

My Simple Admin

GET

http://localhost:8000

/api/v1/dashboard/userRole/simpleAdministrators

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/dashboard/userRole/simpleAdministrators" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

Company

My languages

GET

http://localhost:8000

/api/v1/dashboard/companies/{companyId}/languages

requires authentication

List all languages for a company

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

companyId

integer

required

Id of the company

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/dashboard/companies/1/languages" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "French",
            "acronym": "fr"
        },
        {
            "id": 1,
            "name": "French",
            "acronym": "fr"
        }
    ]
}

My Partitioned Languages

GET

http://localhost:8000

/api/v1/dashboard/visu/currentPartitionedLanguages

requires authentication

List all languages for a company

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/dashboard/visu/currentPartitionedLanguages" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "French",
            "acronym": "fr"
        },
        {
            "id": 1,
            "name": "French",
            "acronym": "fr"
        }
    ]
}

Voter

Endpoint for voter group

Account | Delete my account

DELETE

http://localhost:8000

/api/v1/dashboard/voters/account/delete

requires authentication

Delete my account personally

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/dashboard/voters/account/delete" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

GET api/v1/dashboard/voters/questionnaires

GET

http://localhost:8000

/api/v1/dashboard/voters/questionnaires

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/dashboard/voters/questionnaires" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

Remove me from questionnaire

DELETE

http://localhost:8000

/api/v1/dashboard/voters/voterQuestionnaires/{voterQuestionnaireId}/delete

requires authentication

As a voter remove me from a questionnaire

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/dashboard/voters/voterQuestionnaires/{voterQuestionnaireId}/delete" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Undo deletion by voter

POST

http://localhost:8000

/api/v1/dashboard/voters/actions/delete/{token}/undo/by-voter

This endpoint undo deletion of endpoint make by the voter

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

Token Obtained after requesting deletion for the first 24 hours

Example:

$eyvjde93939399494kjndqeiudoqeduqe030

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/dashboard/voters/actions/delete/$eyvjde93939399494kjndqeiudoqeduqe030/undo/by-voter" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Documentation

Elements

Element is both a Theme or a Section.

Element | Show

GET

http://localhost:8000

/api/v1/documentation/elements/docElements/{languageId}/{docElementId}

requires authentication

Show a specific element

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

id of language. by default is french

Example:

docElementId

integer

required

represent de id of the current doc element

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/documentation/elements/docElements/1/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": null,
        "order": null,
        "created_at": null,
        "updated_at": null,
        "parent_id": null
    }
}

Elements | Create element

POST

http://localhost:8000

/api/v1/documentation/elements/docElements

requires authentication

Create a new element

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

id of language.

Example:

Body Parameters

doc_element_type

string

required

Must be one of:

theme
section
page

Example:

architecto

parent_id

string

The id of an existing record in the doc_elements table.

elements

object[]

required

Auth

Bearer

Headers

URL Parameters

Body

{ "doc_element_type": "architecto", "parent_id": null, "elements": [ { "language_id": 16, "name": "architecto" } ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/documentation/elements/docElements" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"doc_element_type\": \"architecto\",
    \"elements\": [
        {
            \"language_id\": 16,
            \"name\": \"architecto\"
        }
    ]
}"

Example response :

{
    "message": "success",
    "status": 200
}

Element | Update element

PUT

PATCH

http://localhost:8000

/api/v1/documentation/elements/docElements/{languageId}/{docElementId}

requires authentication

Update a doc element

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

docElementId

integer

required

element id

Example:

languageId

integer

required

id of language.

Example:

Body Parameters

name

string

the new name.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "architecto" }

Received response

Example request:

curl --request PUT \
    "http://localhost:8000/api/v1/documentation/elements/docElements/1/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\"
}"

Example response :

{
    "message": "success",
    "status": 200
}

Element | Destroy

DELETE

http://localhost:8000

/api/v1/documentation/elements/docElements/{languageId}/{docElementId}

requires authentication

delete an element of documentation

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

docElementId

integer

required

id of element

Example:

languageId

integer

required

id of language.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/documentation/elements/docElements/1/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Elements | List elements

GET

http://localhost:8000

/api/v1/documentation/elements/docElements/{languageId}

requires authentication

List all the elements

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

id of language. by default is french

Example:

Query Parameters

elementType

string

filter by element type

Must be one of:

theme
section
page

Example:

theme

parentId

integer

filter by parent

Example:

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/documentation/elements/docElements/1?elementType=theme&parentId=1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": null,
        "order": null,
        "created_at": null,
        "updated_at": null,
        "parent_id": null
    }
}

Elements | Get children

GET

http://localhost:8000

/api/v1/documentation/elements/docElements/{languageId}/{docElementId}/children

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

the language id

Example:

docElementId

integer

required

the doc element id

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/documentation/elements/docElements/1/1/children" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": null,
            "user_role_id": null,
            "name": null,
            "created_at": null,
            "updated_at": null,
            "doc_element_id": null,
            "language_id": null
        },
        {
            "id": null,
            "user_role_id": null,
            "name": null,
            "created_at": null,
            "updated_at": null,
            "doc_element_id": null,
            "language_id": null
        }
    ]
}

Elements | Move

POST

http://localhost:8000

/api/v1/documentation/elements/docElements/{docElementId}/move/{newParentId}

requires authentication

Move an element to a specific parent

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

docElementId

integer

required

id of doc element

Example:

newParentId

integer

required

id of the where to be moved

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/documentation/elements/docElements/1/move/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "element moved."
}

GET

http://localhost:8000

/api/v1/documentation/{languageId}/menu

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

id of language

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/documentation/1/menu" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 2,
            "order": 90991849,
            "created_at": "2026-01-08T21:24:58.000000Z",
            "updated_at": "2026-01-08T21:24:58.000000Z",
            "parent_id": null
        },
        {
            "id": 2,
            "order": 90991849,
            "created_at": "2026-01-08T21:24:58.000000Z",
            "updated_at": "2026-01-08T21:24:58.000000Z",
            "parent_id": null
        }
    ]
}

Documentation | List Tags (summary)

GET

http://localhost:8000

/api/v1/documentation/pages/summary

requires authentication

Get all the tags defined in application

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

status

string

required

Define the status

Must be one of:

used
not_used
all

Example:

used

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/documentation/pages/summary?status=used" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "APDOC",
            "created_at": "2026-01-07T13:21:07.000000Z",
            "updated_at": "2026-01-07T13:21:07.000000Z"
        },
        {
            "id": 1,
            "name": "APDOC",
            "created_at": "2026-01-07T13:21:07.000000Z",
            "updated_at": "2026-01-07T13:21:07.000000Z"
        }
    ]
}

Order

Element | Order Up

POST

http://localhost:8000

/api/v1/documentation/elements/docElements/{docElementId}/order/up

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

docElementId

integer

required

the doc element id

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/documentation/elements/docElements/1/order/up" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "order up"
}

Element | Order Down

POST

http://localhost:8000

/api/v1/documentation/elements/docElements/{docElementId}/order/down

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

docElementId

integer

required

the doc element id

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/documentation/elements/docElements/1/order/down" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "order down"
}

Pages | List Doc Pages

GET

http://localhost:8000

/api/v1/documentation/pages/{languageId}/details

requires authentication

Get all the doc pages defined in our application

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

the language id

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/documentation/pages/1/details" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": null,
            "menu": null,
            "content": null,
            "name": null,
            "alias": null,
            "draft_content": null,
            "draft_published": null,
            "doc_page_id": null,
            "language_id": null,
            "created_at": null,
            "updated_at": null
        },
        {
            "id": null,
            "menu": null,
            "content": null,
            "name": null,
            "alias": null,
            "draft_content": null,
            "draft_published": null,
            "doc_page_id": null,
            "language_id": null,
            "created_at": null,
            "updated_at": null
        }
    ]
}

Pages | Update Doc Page

POST

http://localhost:8000

/api/v1/documentation/pages/{languageId}/{docPageCode}/pages

requires authentication

Update a doc page

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

id of language

Example:

docPageCode

string

required

code for doc page

Must be one of:

ABOUT_DOCUMENTATION
ADMIN_QUESTIONNAIRE
SUPER_ADMIN_LIST
SUPER_ADMIN_ACTIVATION
SUPER_ADMIN_DETAILS
SUPER_ADMIN_EDIT
COMPANY_LIST
COMPANY_CREATE
COMPANY_ACTIVATION
COMPANY_DETAILS
COMPANY_EDIT
ADMIN_LIST
ADMIN_ACTIVATION
ADMIN_DETAILS
ADMIN_EDIT
CONTRIBUTOR_GROUP_LIST
CONTRIBUTOR_GROUP_DETAILS
CONTRIBUTOR_GROUP_EDIT
LIBRARY_LIST
LIBRARY_CONFIGURATION
LIBRARY_DETAILS
QUESTIONNAIRE_LIST
SURVEY_CREATE
SURVEY_EDIT
_360_EDIT
_360_CREATE
ISITEST_CREATE
ISITEST_EDIT
QUIZ_CREATE
QUIZ_EDIT
BIO_EDIT
BIO_CREATE
BASE_OPTION
PERMISSIONS
DOCUMENTATION
DOCUMENTATION_THEME
DOCUMENTATION_SECTION
LOG
CONFIGURATIONS
QUESTIONNAIRE_DESIGN_LIST
QUESTIONNAIRE_DESIGN_CREATE
QUESTIONNAIRE_DESIGN_EDIT
QUESTIONNAIRE_DESIGN_DETAILS
EMAIL_DESIGN_LIST
EMAIL_DESIGN_EDIT
REPORT_DESIGN_LIST
REPORT_DESIGN_CREATE
REPORT_DESIGN_EDIT
REPORT_DESIGN_DETAILS
TRACK_SCREEN
TRACK_COACH_INDIVIDUAL
TRACK_COACH_GLOBAL
VISU_LIST
VISU_SURVEY_DETAIL
VISU_360_DETAIL
VISU_ISITEST_DETAIL
VISU_QUIZ_DETAIL
VISU_BIO_DETAIL
PRINT_PARAMETER
REPORT
MESSAGE_LIST
RECEIVED_MESSAGE

Example:

SUPER_ADMIN_EDIT

Body Parameters

string

Example:

architecto

parent_id

integer

The id of an existing record in the doc_elements table.

Example:

name

string

required

Example:

architecto

content

string

Example:

architecto

alias

string

required

Example:

architecto

is_published

boolean

required

is_draft_published

boolean

draft_content

string

Example:

architecto

contextual_tags

object[]

Auth

Bearer

Headers

URL Parameters

Body

{ "menu": "architecto", "parent_id": 16, "name": "architecto", "content": "architecto", "alias": "architecto", "is_published": false, "is_draft_published": false, "draft_content": "architecto", "contextual_tags": [ { "order": 16, "name": "architecto", "content": "architecto", "activated_link": false } ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/documentation/pages/1/SUPER_ADMIN_EDIT/pages" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"menu\": \"architecto\",
    \"parent_id\": 16,
    \"name\": \"architecto\",
    \"content\": \"architecto\",
    \"alias\": \"architecto\",
    \"is_published\": false,
    \"is_draft_published\": false,
    \"draft_content\": \"architecto\",
    \"contextual_tags\": [
        {
            \"order\": 16,
            \"name\": \"architecto\",
            \"content\": \"architecto\",
            \"activated_link\": false
        }
    ]
}"

Basic Create Page

POST

http://localhost:8000

/api/v1/documentation/pages/basicCreate

requires authentication

First page for create a page in documentation module

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

tag_id

integer

required

Example:

items

object[]

required

Must have at least 2 items.

parent_id

integer

required

The id of an existing record in the doc_elements table.

Example:

Auth

Bearer

Headers

Body

{ "tag_id": 16, "items": [ { "menu": "architecto", "title": "architecto", "language_id": 16 } ], "parent_id": 16 }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/documentation/pages/basicCreate" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"tag_id\": 16,
    \"items\": [
        {
            \"menu\": \"architecto\",
            \"title\": \"architecto\",
            \"language_id\": 16
        }
    ],
    \"parent_id\": 16
}"

Example response :

{
    "message": "success",
    "status": 200
}

Basic Create Page

POST

http://localhost:8000

/api/v1/documentation/pages/{docPageId}/basicUpdate

requires authentication

First page for create a page in documentation module

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

docPageId

integer

required

id of doc page

Example:

Body Parameters

tag_id

integer

required

Example:

language_id

integer

required

The id of an existing record in the languages table.

Example:

string

required

Example:

architecto

title

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "tag_id": 16, "language_id": 16, "menu": "architecto", "title": "architecto" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/documentation/pages/1/basicUpdate" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"tag_id\": 16,
    \"language_id\": 16,
    \"menu\": \"architecto\",
    \"title\": \"architecto\"
}"

Example response :

{
    "message": "success",
    "status": 200
}

Pages | Pages details (List)

GET

http://localhost:8000

/api/v1/documentation/pages/{languageId}/{alias}/aliasDetails

requires authentication

Get doc page Detail

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

the language id

Example:

alias

string

required

alias for doc page

Example:

alias test

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/documentation/pages/1/alias test/aliasDetails" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": null,
            "order": null,
            "created_at": null,
            "updated_at": null,
            "parent_id": null
        },
        {
            "id": null,
            "order": null,
            "created_at": null,
            "updated_at": null,
            "parent_id": null
        }
    ]
}

Elements | Change Parent

POST

http://localhost:8000

/api/v1/documentation/pages/{docPageCode}/parent

requires authentication

Change a parent for a specific page

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

docPageCode

string

required

code of the page

Example:

Body Parameters

theme_id

integer

Example:

section_id

integer

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "theme_id": 16, "section_id": 16 }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/documentation/pages/1/parent" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"theme_id\": 16,
    \"section_id\": 16
}"

Example response :

{
    "message": "Parent changed successfully."
}

Pages | Doc pages details (Single)

GET

http://localhost:8000

/api/v1/documentation/pages/{languageId}/{docPageCode}/details

requires authentication

Get doc page Detail

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

the language id

Example:

docPageCode

string

required

code for doc page

Must be one of:

ABOUT_DOCUMENTATION
ADMIN_QUESTIONNAIRE
SUPER_ADMIN_LIST
SUPER_ADMIN_ACTIVATION
SUPER_ADMIN_DETAILS
SUPER_ADMIN_EDIT
COMPANY_LIST
COMPANY_CREATE
COMPANY_ACTIVATION
COMPANY_DETAILS
COMPANY_EDIT
ADMIN_LIST
ADMIN_ACTIVATION
ADMIN_DETAILS
ADMIN_EDIT
CONTRIBUTOR_GROUP_LIST
CONTRIBUTOR_GROUP_DETAILS
CONTRIBUTOR_GROUP_EDIT
LIBRARY_LIST
LIBRARY_CONFIGURATION
LIBRARY_DETAILS
QUESTIONNAIRE_LIST
SURVEY_CREATE
SURVEY_EDIT
_360_EDIT
_360_CREATE
ISITEST_CREATE
ISITEST_EDIT
QUIZ_CREATE
QUIZ_EDIT
BIO_EDIT
BIO_CREATE
BASE_OPTION
PERMISSIONS
DOCUMENTATION
DOCUMENTATION_THEME
DOCUMENTATION_SECTION
LOG
CONFIGURATIONS
QUESTIONNAIRE_DESIGN_LIST
QUESTIONNAIRE_DESIGN_CREATE
QUESTIONNAIRE_DESIGN_EDIT
QUESTIONNAIRE_DESIGN_DETAILS
EMAIL_DESIGN_LIST
EMAIL_DESIGN_EDIT
REPORT_DESIGN_LIST
REPORT_DESIGN_CREATE
REPORT_DESIGN_EDIT
REPORT_DESIGN_DETAILS
TRACK_SCREEN
TRACK_COACH_INDIVIDUAL
TRACK_COACH_GLOBAL
VISU_LIST
VISU_SURVEY_DETAIL
VISU_360_DETAIL
VISU_ISITEST_DETAIL
VISU_QUIZ_DETAIL
VISU_BIO_DETAIL
PRINT_PARAMETER
REPORT
MESSAGE_LIST
RECEIVED_MESSAGE

Example:

SUPER_ADMIN_EDIT

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/documentation/pages/1/SUPER_ADMIN_EDIT/details" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": null,
            "order": null,
            "created_at": null,
            "updated_at": null,
            "parent_id": null
        },
        {
            "id": null,
            "order": null,
            "created_at": null,
            "updated_at": null,
            "parent_id": null
        }
    ]
}

Contextual Tag

Pages | List Contextual Tags

GET

http://localhost:8000

/api/v1/documentation/page/{languageId}/{docPageCode}/contextualTags

requires authentication

Get all the contextual tag defined in our application

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

the language id

Example:

docPageCode

string

required

the enum value represent code of the page

Example:

ADMIN_QUESTIONNAIRE

Response Fields

integer

required

id of the contextual tag translation

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/documentation/page/1/ADMIN_QUESTIONNAIRE/contextualTags" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": null,
            "content": null,
            "name": null,
            "contextual_tag_id": null,
            "language_id": null,
            "created_at": null,
            "updated_at": null
        },
        {
            "id": null,
            "content": null,
            "name": null,
            "contextual_tag_id": null,
            "language_id": null,
            "created_at": null,
            "updated_at": null
        }
    ]
}

Contextual Tag | Update

POST

http://localhost:8000

/api/v1/documentation/page/{languageId}/{docPageCode}/{order}/contextualTags

requires authentication

Update an existing contextual tag in a language or create it in this language

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

the language id

Example:

docPageCode

string

required

the enum value represent code of the page

Example:

ADMIN_QUESTIONNAIRE

order

integer

required

The number of contextual tag

Example:

Body Parameters

name

string

required

Example:

architecto

content

string

Example:

architecto

is_active

boolean

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "architecto", "content": "architecto", "is_active": true }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/documentation/page/1/ADMIN_QUESTIONNAIRE/1/contextualTags" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"content\": \"architecto\",
    \"is_active\": true
}"

Example response :

{
    "message": "updated success"
}

Email

Design

List Designs.

GET

http://localhost:8000

/api/v1/mail/emailDesigns

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/mail/emailDesigns" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "Classique",
            "image": "emailDesigns/1",
            "is_classic": true,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "image_link": "http://localhost:8000/storage/emailDesigns/1",
            "all_content_loaded": true
        },
        {
            "id": 1,
            "name": "Classique",
            "image": "emailDesigns/1",
            "is_classic": true,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "image_link": "http://localhost:8000/storage/emailDesigns/1",
            "all_content_loaded": true
        }
    ]
}

Create Design.

POST

http://localhost:8000

/api/v1/mail/emailDesigns

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

name

string

required

Example:

architecto

image

file

Must be an image.

Example:

/tmp/phpNRBbcq

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/mail/emailDesigns" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=architecto"\
    --form "image=@/tmp/phpNRBbcq"

Example response :

{
    "message": "success",
    "status": 200
}

Show Design.

GET

http://localhost:8000

/api/v1/mail/emailDesigns/{emailDesignId}

requires authentication

Get a specific email design

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

emailDesignId

integer

required

The ID of the email design

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/mail/emailDesigns/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": 1,
        "name": "Classique",
        "image": "emailDesigns/1",
        "is_classic": true,
        "created_at": "2026-01-07T13:21:06.000000Z",
        "image_link": "http://localhost:8000/storage/emailDesigns/1",
        "all_content_loaded": true
    }
}

Show Design.

PUT

PATCH

http://localhost:8000

/api/v1/mail/emailDesigns/{emailDesignId}

requires authentication

Get a specific email design

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

emailDesignId

integer

required

The ID of the email design

Example:

Body Parameters

name

string

required

Example:

architecto

image

file

Must be an image.

Example:

/tmp/phpAKCoOE

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request PUT \
    "http://localhost:8000/api/v1/mail/emailDesigns/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=architecto"\
    --form "image=@/tmp/phpAKCoOE"

Example response :

{
    "message": "success",
    "status": 200
}

Delete Design.

DELETE

http://localhost:8000

/api/v1/mail/emailDesigns/{emailDesignId}

requires authentication

Delete a specific email design

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

emailDesignId

integer

required

The ID of the email design

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/mail/emailDesigns/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Copy Email design

POST

http://localhost:8000

/api/v1/mail/emailDesigns/{emailDesignId}/copy

requires authentication

Copy a new email design to an existing

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

emailDesignId

integer

required

id of email design

Example:

Body Parameters

name

string

required

Example:

architecto

image

file

Must be an image. Must not be greater than 1024 kilobytes.

Example:

/tmp/phpZW9jqG

is_default_logo

boolean

Example:

remove_logo

boolean

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/mail/emailDesigns/1/copy" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=architecto"\
    --form "is_default_logo=1"\
    --form "remove_logo="\
    --form "image=@/tmp/phpZW9jqG"

Example response :

{
    "message": "success",
    "success": true
}

Generic

List parameters

GET

http://localhost:8000

/api/v1/mail/generic/components/{languageId}/{emailTypeCode}

requires authentication

Get details attached to an specific type of generic email
return default subject , default description

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

string

required

id of language

Example:

emailTypeCode

string

required

code for email type

Must be one of:

TYPE_CREATE_USER_ROLE_ACCOUNT
TYPE_CONFIRM_USER_ROLE_CREATION_ACCOUNT
TYPE_ADD_USER_ROLE_TO_PARTITIONED_SPACE
TYPE_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT
TYPE_CONFIRM_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT
TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR
TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER
TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR
TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER
TYPE_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE
TYPE_CONFIRM_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE
TYPE_CREATE_USER_ACCOUNT
TYPE_CONFIRM_CREATE_USER_ACCOUNT
TYPE_DELETE_COMPANY_ALT_SUPER_ADMIN
TYPE_DELETE_COMPANY_ALT_USER_ACCOUNT
TYPE_CONFIRM_DELETE_COMPANY_ALT_SUPER_ADMIN
TYPE_CONFIRM_DELETE_COMPANY_ALT_USER_ACCOUNT
TYPE_CREATION_OF_VOTER_ACCOUNT
TYPE_CONFIRM_CREATION_OF_VOTER_ACCOUNT
TYPE_ADD_VOTER_ACCOUNT_TO_COMPANY
TYPE_CONFIRM_ADD_VOTER_ACCOUNT_TO_COMPANY
TYPE_DELETE_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT
TYPE_CONFIRM_DELETION_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT
TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_USER_ROLE_OF_WALLET
TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_VOTER
TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_USER_ROLE
TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_VOTER
TYPE_VOTING_PASSWORD_RESET
TYPE_USER_ROLE_PASSWORD_RESET
TYPE_USER_ACCOUNT_PASSWORD_RESET

Example:

TYPE_CREATE_USER_ROLE_ACCOUNT

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/mail/generic/components/1/TYPE_CREATE_USER_ROLE_ACCOUNT" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

Generic | List Emails

GET

http://localhost:8000

/api/v1/mail/generic/contents/{languageId}/{emailDesignId}/defaultEmailContent

requires authentication

List of all generic email in the application

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

the language of witch email should be retrieved

Example:

emailDesignId

integer

required

id of email design parent

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/mail/generic/contents/1/1/defaultEmailContent" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

Generic | Update

PUT

PATCH

http://localhost:8000

/api/v1/mail/generic/contents/{languageId}/{emailDesignId}/defaultEmailContent

requires authentication

Endpoint to update all generic email in the application

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

the language of witch email should be retrieved

Example:

emailDesignId

integer

required

id of email design parent

Example:

Body Parameters

TYPE_CREATE_USER_ROLE_ACCOUNT

object

required

TYPE_CONFIRM_USER_ROLE_CREATION_ACCOUNT

object

required

TYPE_ADD_USER_ROLE_TO_PARTITIONED_SPACE

object

required

TYPE_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT

object

required

TYPE_CONFIRM_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT

object

required

TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR

object

required

TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER

object

required

TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR

object

required

TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER

object

required

TYPE_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE

object

required

TYPE_CONFIRM_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE

object

required

TYPE_CREATE_USER_ACCOUNT

object

required

TYPE_CONFIRM_CREATE_USER_ACCOUNT

object

required

TYPE_DELETE_COMPANY_ALT_SUPER_ADMIN

object

required

TYPE_DELETE_COMPANY_ALT_USER_ACCOUNT

object

required

TYPE_CONFIRM_DELETE_COMPANY_ALT_SUPER_ADMIN

object

required

TYPE_CONFIRM_DELETE_COMPANY_ALT_USER_ACCOUNT

object

required

TYPE_CREATION_OF_VOTER_ACCOUNT

object

required

TYPE_CONFIRM_CREATION_OF_VOTER_ACCOUNT

object

required

TYPE_ADD_VOTER_ACCOUNT_TO_COMPANY

object

required

TYPE_CONFIRM_ADD_VOTER_ACCOUNT_TO_COMPANY

object

required

TYPE_DELETE_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT

object

required

TYPE_CONFIRM_DELETION_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT

object

required

TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_USER_ROLE_OF_WALLET

object

required

TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_VOTER

object

required

TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_USER_ROLE

object

required

TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_VOTER

object

required

TYPE_VOTING_PASSWORD_RESET

object

required

TYPE_USER_ROLE_PASSWORD_RESET

object

required

TYPE_USER_ACCOUNT_PASSWORD_RESET

object

required

Auth

Bearer

Headers

URL Parameters

Body

{ "TYPE_CREATE_USER_ROLE_ACCOUNT": { "content": "architecto", "subject": "architecto" }, "TYPE_CONFIRM_USER_ROLE_CREATION_ACCOUNT": { "content": "architecto", "subject": "architecto" }, "TYPE_ADD_USER_ROLE_TO_PARTITIONED_SPACE": { "content": "architecto", "subject": "architecto" }, "TYPE_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT": { "content": "architecto", "subject": "architecto" }, "TYPE_CONFIRM_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT": { "content": "architecto", "subject": "architecto" }, "TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR": { "content": "architecto", "subject": "architecto" }, "TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER": { "content": "architecto", "subject": "architecto" }, "TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR": { "content": "architecto", "subject": "architecto" }, "TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER": { "content": "architecto", "subject": "architecto" }, "TYPE_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE": { "content": "architecto", "subject": "architecto" }, "TYPE_CONFIRM_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE": { "content": "architecto", "subject": "architecto" }, "TYPE_CREATE_USER_ACCOUNT": { "content": "architecto", "subject": "architecto" }, "TYPE_CONFIRM_CREATE_USER_ACCOUNT": { "content": "architecto", "subject": "architecto" }, "TYPE_DELETE_COMPANY_ALT_SUPER_ADMIN": { "content": "architecto", "subject": "architecto" }, "TYPE_DELETE_COMPANY_ALT_USER_ACCOUNT": { "content": "architecto", "subject": "architecto" }, "TYPE_CONFIRM_DELETE_COMPANY_ALT_SUPER_ADMIN": { "content": "architecto", "subject": "architecto" }, "TYPE_CONFIRM_DELETE_COMPANY_ALT_USER_ACCOUNT": { "content": "architecto", "subject": "architecto" }, "TYPE_CREATION_OF_VOTER_ACCOUNT": { "content": "architecto", "subject": "architecto" }, "TYPE_CONFIRM_CREATION_OF_VOTER_ACCOUNT": { "content": "architecto", "subject": "architecto" }, "TYPE_ADD_VOTER_ACCOUNT_TO_COMPANY": { "content": "architecto", "subject": "architecto" }, "TYPE_CONFIRM_ADD_VOTER_ACCOUNT_TO_COMPANY": { "content": "architecto", "subject": "architecto" }, "TYPE_DELETE_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT": { "content": "architecto", "subject": "architecto" }, "TYPE_CONFIRM_DELETION_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT": { "content": "architecto", "subject": "architecto" }, "TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_USER_ROLE_OF_WALLET": { "content": "architecto", "subject": "architecto" }, "TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_VOTER": { "content": "architecto", "subject": "architecto" }, "TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_USER_ROLE": { "content": "architecto", "subject": "architecto" }, "TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_VOTER": { "content": "architecto", "subject": "architecto" }, "TYPE_VOTING_PASSWORD_RESET": { "content": "architecto", "subject": "architecto" }, "TYPE_USER_ROLE_PASSWORD_RESET": { "content": "architecto", "subject": "architecto" }, "TYPE_USER_ACCOUNT_PASSWORD_RESET": { "content": "architecto", "subject": "architecto" } }

Received response

Example request:

curl --request PUT \
    "http://localhost:8000/api/v1/mail/generic/contents/1/1/defaultEmailContent" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"TYPE_CREATE_USER_ROLE_ACCOUNT\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CONFIRM_USER_ROLE_CREATION_ACCOUNT\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_ADD_USER_ROLE_TO_PARTITIONED_SPACE\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CONFIRM_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CONFIRM_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CREATE_USER_ACCOUNT\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CONFIRM_CREATE_USER_ACCOUNT\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_DELETE_COMPANY_ALT_SUPER_ADMIN\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_DELETE_COMPANY_ALT_USER_ACCOUNT\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CONFIRM_DELETE_COMPANY_ALT_SUPER_ADMIN\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CONFIRM_DELETE_COMPANY_ALT_USER_ACCOUNT\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CREATION_OF_VOTER_ACCOUNT\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CONFIRM_CREATION_OF_VOTER_ACCOUNT\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_ADD_VOTER_ACCOUNT_TO_COMPANY\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CONFIRM_ADD_VOTER_ACCOUNT_TO_COMPANY\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_DELETE_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CONFIRM_DELETION_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_USER_ROLE_OF_WALLET\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_VOTER\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_USER_ROLE\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_VOTER\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_VOTING_PASSWORD_RESET\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_USER_ROLE_PASSWORD_RESET\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    },
    \"TYPE_USER_ACCOUNT_PASSWORD_RESET\": {
        \"content\": \"architecto\",
        \"subject\": \"architecto\"
    }
}"

const url = new URL(
    "http://localhost:8000/api/v1/mail/generic/contents/1/1/defaultEmailContent"
);

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

let body = {
    "TYPE_CREATE_USER_ROLE_ACCOUNT": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CONFIRM_USER_ROLE_CREATION_ACCOUNT": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_ADD_USER_ROLE_TO_PARTITIONED_SPACE": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CONFIRM_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CONFIRM_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CREATE_USER_ACCOUNT": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CONFIRM_CREATE_USER_ACCOUNT": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_DELETE_COMPANY_ALT_SUPER_ADMIN": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_DELETE_COMPANY_ALT_USER_ACCOUNT": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CONFIRM_DELETE_COMPANY_ALT_SUPER_ADMIN": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CONFIRM_DELETE_COMPANY_ALT_USER_ACCOUNT": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CREATION_OF_VOTER_ACCOUNT": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CONFIRM_CREATION_OF_VOTER_ACCOUNT": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_ADD_VOTER_ACCOUNT_TO_COMPANY": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CONFIRM_ADD_VOTER_ACCOUNT_TO_COMPANY": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_DELETE_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CONFIRM_DELETION_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_USER_ROLE_OF_WALLET": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_VOTER": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_USER_ROLE": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_VOTER": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_VOTING_PASSWORD_RESET": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_USER_ROLE_PASSWORD_RESET": {
        "content": "architecto",
        "subject": "architecto"
    },
    "TYPE_USER_ACCOUNT_PASSWORD_RESET": {
        "content": "architecto",
        "subject": "architecto"
    }
};

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

Example response :

{
    "message": "success",
    "status": 200
}

{
    "success": false,
    "type": "VALIDATION_EXCEPTION",
    "message": "the ACCOUNT_TYPE is missing in TYPE_CREATE_USER_ROLE_ACCOUNT (and 56 more errors)",
    "errors": {
        "TYPE_CREATE_USER_ROLE_ACCOUNT.content": [
            "the ACCOUNT_TYPE is missing in TYPE_CREATE_USER_ROLE_ACCOUNT",
            "the CONFIRM_BUTTON is missing in TYPE_CREATE_USER_ROLE_ACCOUNT",
            "the LINK is missing in TYPE_CREATE_USER_ROLE_ACCOUNT"
        ],
        "TYPE_CONFIRM_USER_ROLE_CREATION_ACCOUNT.content": [
            "the ACCOUNT_TYPE is missing in TYPE_CONFIRM_USER_ROLE_CREATION_ACCOUNT"
        ],
        "TYPE_ADD_USER_ROLE_TO_PARTITIONED_SPACE.content": [
            "the ACCOUNT_TYPE is missing in TYPE_ADD_USER_ROLE_TO_PARTITIONED_SPACE",
            "the FIRST_NAME is missing in TYPE_ADD_USER_ROLE_TO_PARTITIONED_SPACE",
            "the LAST_NAME is missing in TYPE_ADD_USER_ROLE_TO_PARTITIONED_SPACE",
            "the VALIDATE_BUTTON is missing in TYPE_ADD_USER_ROLE_TO_PARTITIONED_SPACE",
            "the LINK is missing in TYPE_ADD_USER_ROLE_TO_PARTITIONED_SPACE"
        ],
        "TYPE_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT.content": [
            "the ACCOUNT_TYPE is missing in TYPE_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT",
            "the FIRST_NAME is missing in TYPE_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT",
            "the CANCEL_BUTTON is missing in TYPE_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT",
            "the LINK is missing in TYPE_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT"
        ],
        "TYPE_CONFIRM_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT.content": [
            "the ACCOUNT_TYPE is missing in TYPE_CONFIRM_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT",
            "the FIRST_NAME is missing in TYPE_CONFIRM_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT"
        ],
        "TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR.content": [
            "the ACCOUNT_TYPE is missing in TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR",
            "the INITIATOR_FIRST_NAME is missing in TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR",
            "the FIRST_NAME is missing in TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR",
            "the LAST_NAME is missing in TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR",
            "the CANCEL_BUTTON is missing in TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR"
        ],
        "TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER.content": [
            "the ACCOUNT_TYPE is missing in TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER",
            "the FIRST_NAME is missing in TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER"
        ],
        "TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR.content": [
            "the ACCOUNT_TYPE is missing in TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR",
            "the FIRST_NAME is missing in TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR",
            "the LAST_NAME is missing in TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR"
        ],
        "TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER.content": [
            "the ACCOUNT_TYPE is missing in TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER",
            "the FIRST_NAME is missing in TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER"
        ],
        "TYPE_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE.content": [
            "the LAST_NAME is missing in TYPE_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE",
            "the FIRST_NAME is missing in TYPE_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE",
            "the VALIDATE_BUTTON is missing in TYPE_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE",
            "the LINK is missing in TYPE_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE"
        ],
        "TYPE_CONFIRM_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE.content": [
            "the LAST_NAME is missing in TYPE_CONFIRM_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE",
            "the FIRST_NAME is missing in TYPE_CONFIRM_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE"
        ],
        "TYPE_CREATE_USER_ACCOUNT.content": [
            "the CONFIRM_BUTTON is missing in TYPE_CREATE_USER_ACCOUNT",
            "the LINK is missing in TYPE_CREATE_USER_ACCOUNT"
        ],
        "TYPE_DELETE_COMPANY_ALT_SUPER_ADMIN.content": [
            "the FIRST_NAME is missing in TYPE_DELETE_COMPANY_ALT_SUPER_ADMIN",
            "the CANCEL_BUTTON is missing in TYPE_DELETE_COMPANY_ALT_SUPER_ADMIN",
            "the USER_ACCOUNT is missing in TYPE_DELETE_COMPANY_ALT_SUPER_ADMIN"
        ],
        "TYPE_CONFIRM_DELETE_COMPANY_ALT_SUPER_ADMIN.content": [
            "the FIRST_NAME is missing in TYPE_CONFIRM_DELETE_COMPANY_ALT_SUPER_ADMIN",
            "the USER_ACCOUNT is missing in TYPE_CONFIRM_DELETE_COMPANY_ALT_SUPER_ADMIN"
        ],
        "TYPE_CREATION_OF_VOTER_ACCOUNT.content": [
            "the USER_ACCOUNT is missing in TYPE_CREATION_OF_VOTER_ACCOUNT",
            "the CONFIRM_BUTTON is missing in TYPE_CREATION_OF_VOTER_ACCOUNT",
            "the LINK is missing in TYPE_CREATION_OF_VOTER_ACCOUNT"
        ],
        "TYPE_DELETE_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT.content": [
            "the CANCEL_BUTTON is missing in TYPE_DELETE_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT",
            "the LINK is missing in TYPE_DELETE_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT"
        ],
        "TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET.content": [
            "the FIRST_NAME is missing in TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET",
            "the LAST_NAME is missing in TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET",
            "the CANCEL_BUTTON is missing in TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET"
        ],
        "TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET.content": [
            "the FIRST_NAME is missing in TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET",
            "the LAST_NAME is missing in TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET"
        ],
        "TYPE_VOTING_PASSWORD_RESET.content": [
            "the RESET_BUTTON is missing in TYPE_VOTING_PASSWORD_RESET",
            "the LINK is missing in TYPE_VOTING_PASSWORD_RESET"
        ],
        "TYPE_USER_ROLE_PASSWORD_RESET.content": [
            "the RESET_URL is missing in TYPE_USER_ROLE_PASSWORD_RESET",
            "the RESET_BUTTON is missing in TYPE_USER_ROLE_PASSWORD_RESET",
            "the FIRST_NAME is missing in TYPE_USER_ROLE_PASSWORD_RESET"
        ],
        "TYPE_USER_ACCOUNT_PASSWORD_RESET.content": [
            "the RESET_URL is missing in TYPE_USER_ACCOUNT_PASSWORD_RESET",
            "the RESET_BUTTON is missing in TYPE_USER_ACCOUNT_PASSWORD_RESET"
        ]
    },
    "bag": "default"
}

Generic | Reset All

POST

http://localhost:8000

/api/v1/mail/generic/contents/{languageId}/{emailDesignId}/defaultEmailContent/reset

requires authentication

Reset All generic email for a specific language

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

the language of witch email should be retrieved

Example:

emailDesignId

integer

required

id of email design parent

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/mail/generic/contents/1/1/defaultEmailContent/reset" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Generic | Get Reset Content

GET

http://localhost:8000

/api/v1/mail/generic/contents/{languageId}/{emailDesignId}/defaultEmailContent/{emailTypeCode}/originalContent

requires authentication

Get the reset generic email for a specific language

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

languageId

integer

required

the language of witch email should be retrieved

Example:

emailDesignId

integer

required

id of email design parent

Example:

emailTypeCode

string

required

code of mail to be reset

Must be one of:

TYPE_CREATE_USER_ROLE_ACCOUNT
TYPE_CONFIRM_USER_ROLE_CREATION_ACCOUNT
TYPE_ADD_USER_ROLE_TO_PARTITIONED_SPACE
TYPE_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT
TYPE_CONFIRM_DELETE_USER_ROLE_BY_PERSON_WHO_HOLDS_ACCOUNT
TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR
TYPE_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER
TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_INITIATOR
TYPE_CONFIRM_DELETE_USER_ROLE_BY_ADMIN_WITH_HIGHER_AUTHORIZATIONS_TO_OWNER
TYPE_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE
TYPE_CONFIRM_ADD_SIMPLE_ADMIN_TO_OTHER_PARTITIONED_SPACE
TYPE_CREATE_USER_ACCOUNT
TYPE_CONFIRM_CREATE_USER_ACCOUNT
TYPE_DELETE_COMPANY_ALT_SUPER_ADMIN
TYPE_DELETE_COMPANY_ALT_USER_ACCOUNT
TYPE_CONFIRM_DELETE_COMPANY_ALT_SUPER_ADMIN
TYPE_CONFIRM_DELETE_COMPANY_ALT_USER_ACCOUNT
TYPE_CREATION_OF_VOTER_ACCOUNT
TYPE_CONFIRM_CREATION_OF_VOTER_ACCOUNT
TYPE_ADD_VOTER_ACCOUNT_TO_COMPANY
TYPE_CONFIRM_ADD_VOTER_ACCOUNT_TO_COMPANY
TYPE_DELETE_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT
TYPE_CONFIRM_DELETION_VOTER_ACCOUNT_BY_PERSON_WHO_HOLDS_ACCOUNT
TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_USER_ROLE_OF_WALLET
TYPE_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_VOTER
TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_USER_ROLE
TYPE_CONFIRM_DELETE_VOTER_ACCOUNT_BY_USER_ROLE_OF_WALLET_INFORM_VOTER
TYPE_VOTING_PASSWORD_RESET
TYPE_USER_ROLE_PASSWORD_RESET
TYPE_USER_ACCOUNT_PASSWORD_RESET

Example:

TYPE_CREATE_USER_ROLE_ACCOUNT

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/mail/generic/contents/1/1/defaultEmailContent/TYPE_CREATE_USER_ROLE_ACCOUNT/originalContent" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "content": "",
        "subject": "",
        "language_id": -1,
        "subject_parameters": [],
        "parameters": [],
        "description": "",
        "type": "",
        "code": ""
    }
}

Endpoints

POST

http://localhost:8000

/api/v1/login/userRole/directAccess/{token}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/login/userRole/directAccess/{token}" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET api/v1/reportDesign/{reportDesignId}/previewPdf

GET

http://localhost:8000

/api/v1/reportDesign/{reportDesignId}/previewPdf

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/reportDesign/{reportDesignId}/previewPdf" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "App\\Http\\Controllers\\V1\\ReportDesign\\ReportDesignPreviewController::__invoke(): Argument #2 ($reportDesignId) must be of type int, string given, called in /var/www/html/vendor/laravel/framework/src/Illuminate/Routing/ControllerDispatcher.php on line 46",
    "exception": "TypeError",
    "file": "/var/www/html/app/Http/Controllers/V1/ReportDesign/ReportDesignPreviewController.php",
    "line": 18,
    "trace": [
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/ControllerDispatcher.php",
            "line": 46,
            "function": "__invoke",
            "class": "App\\Http\\Controllers\\V1\\ReportDesign\\ReportDesignPreviewController",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 265,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\ControllerDispatcher",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 211,
            "function": "runController",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 822,
            "function": "run",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "Illuminate\\Routing\\{closure}",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Middleware/SubstituteBindings.php",
            "line": 50,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\SubstituteBindings",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/sanctum/src/Http/Middleware/EnsureFrontendRequestsAreStateful.php",
            "line": 26,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "Laravel\\Sanctum\\Http\\Middleware\\{closure}",
            "class": "Laravel\\Sanctum\\Http\\Middleware\\EnsureFrontendRequestsAreStateful",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 137,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/sanctum/src/Http/Middleware/EnsureFrontendRequestsAreStateful.php",
            "line": 25,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Laravel\\Sanctum\\Http\\Middleware\\EnsureFrontendRequestsAreStateful",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 137,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 821,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 800,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 764,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 753,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 200,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "Illuminate\\Foundation\\Http\\{closure}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/livewire/livewire/src/Features/SupportDisablingBackButtonCache/DisableBackButtonCacheMiddleware.php",
            "line": 19,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Livewire\\Features\\SupportDisablingBackButtonCache\\DisableBackButtonCacheMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
            "line": 51,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Http/Middleware/ValidatePostSize.php",
            "line": 27,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
            "line": 109,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Http/Middleware/HandleCors.php",
            "line": 61,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\HandleCors",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
            "line": 58,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\TrustProxies",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/InvokeDeferredCallbacks.php",
            "line": 22,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\InvokeDeferredCallbacks",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Http/Middleware/ValidatePathEncoding.php",
            "line": 26,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\ValidatePathEncoding",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 137,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 175,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 144,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 256,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 249,
            "function": "callLaravelRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 86,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 39,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 240,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 165,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 97,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 125,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 72,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 50,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/Util.php",
            "line": 43,
            "function": "Illuminate\\Container\\{closure}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 96,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 35,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 799,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 211,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/symfony/console/Command/Command.php",
            "line": 341,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 180,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/symfony/console/Application.php",
            "line": 1102,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/symfony/console/Application.php",
            "line": 356,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/symfony/console/Application.php",
            "line": 195,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
            "line": 198,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 1235,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/html/artisan",
            "line": 13,
            "function": "handleCommand",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        }
    ]
}

GET api/v1/dashboard/vote/authenticated

GET

http://localhost:8000

/api/v1/dashboard/vote/authenticated

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/dashboard/vote/authenticated" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

Generate Access | All voters

POST

http://localhost:8000

/api/v1/voters/questionnaires/{questionnaireId}/generateAccess

requires authentication

Generate All access for voters

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

string

required

The ID of the questionnaire

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/voters/questionnaires/1/generateAccess" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Export

The export module supports different file formats such as 'csv', 'excel', and 'html', with 'csv' being the default. This flexibility is managed by the UserExportTypeEnum enum, which handles the different file formats for exporting and provides the extension and writer type for each format.

SuperAdmin

Export Super Admin Account

GET

http://localhost:8000

/api/v1/export/account/superAdmin/{format}

requires authentication

Export super admin data in to different predefined format

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

format

string

required

The format of the file to export. Can be 'csv' or 'excel'. the default is 'csv'

Must be one of:

csv
xlsx

Example:

xlsx

Query Parameters

status

string

The state for account to be exported

Must be one of:

inactive
active

Example:

active

exportLanguage

string

required

the export language

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

French

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/export/account/superAdmin/xlsx?status=active&exportLanguage=French" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

[Binary data] -

Admin

Export Simple Admin Account

GET

http://localhost:8000

/api/v1/export/account/admin/{format}

requires authentication

Export simple admin data in to different predefined format

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

format

string

required

The format of the file to export. Can be 'csv' or 'excel'. the default is 'csv'

Must be one of:

csv
xlsx

Example:

xlsx

Query Parameters

status

string

The state for account to be exported

Must be one of:

inactive
active

Example:

active

exportLanguage

string

required

the export language

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

French

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/export/account/admin/xlsx?status=active&exportLanguage=French" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

[Binary data] -

Company

Export Companies

GET

http://localhost:8000

/api/v1/export/account/company/{format}

requires authentication

Export company data in to different predefined format

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

format

string

required

The format of the file to export. Can be 'csv' or 'excel'. the default is 'csv'

Must be one of:

csv
xlsx

Example:

xlsx

Query Parameters

status

string

The state for account to be exported

Must be one of:

inactive
active

Example:

active

exportLanguage

string

required

the export language

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

French

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/export/account/company/xlsx?status=active&exportLanguage=French" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

[Binary data] -

Import

The Import module supports different file formats such as 'csv', 'excel', and 'html', with 'csv' being the default.

This flexibility is managed by the UserImportTypeEnum enum, which handles the different file formats for importing and provides the extension and writer type for each format.

SuperAdmin

Import Super Admin Account

POST

http://localhost:8000

/api/v1/import/account/superAdmin

requires authentication

Import super admin data as different predefined format

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

file

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "file": "architecto" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/import/account/superAdmin" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file\": \"architecto\"
}"

Example response :

{
    "message": "Imported successfully",
    "0": 200,
    "1": "success"
}

Admin

Import Simple Admin Account

POST

http://localhost:8000

/api/v1/import/account/admin

requires authentication

Import simple admin data as different predefined format

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

file

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "file": "architecto" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/import/account/admin" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file\": \"architecto\"
}"

Example response :

{
    "message": "Imported successfully",
    "0": 200,
    "1": "When successfully generated"
}

Import Company

POST

http://localhost:8000

/api/v1/import/account/company

requires authentication

Import company account

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

file

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "file": "architecto" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/import/account/company" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file\": \"architecto\"
}"

Example response :

{
    "message": "Imported successfully",
    "0": 200,
    "1": "When successfully generated"
}

Library

Questionnaires

Questionnaire | Append

POST

http://localhost:8000

/api/v1/library/questionnaires/{questionnaireId}/store

requires authentication

Add a new questionnaire to library

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/library/questionnaires/1/store" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "questionnaire added to library"
}

Questionnaire | Remove

POST

http://localhost:8000

/api/v1/library/questionnaires/{questionnaireId}/delete

requires authentication

Remove a specific questionnaire to library

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/library/questionnaires/1/delete" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "questionnaire removed to library"
}

Visualisation

GET

http://localhost:8000

/api/v1/library/products/{productId}/visualize

requires authentication

Returns all information on the questionnaires associated with the libraries
the token provided mu be a user_roles token

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

productId

string

required

Provide the id of the product

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/library/products/1/visualize" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": 3,
        "updated_at": "2026-01-08T21:24:57.000000Z",
        "questionnaire_id": 24,
        "details": [],
        "components": []
    }
}

Questionnaire | List

GET

http://localhost:8000

/api/v1/library/products/{productId}/index

requires authentication

Returns all information on the questionnaires associated with the libraries

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

productId

string

required

Provide the id of the product

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/library/products/1/index" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": 4,
        "updated_at": "2026-01-08T21:24:57.000000Z",
        "questionnaire_id": 25,
        "details": [],
        "components": []
    }
}

Library Details

Details | Update details.

POST

http://localhost:8000

/api/v1/library/questionnaireLibrary/{questionnaireLibraryId}/details

requires authentication

Append a fresh questionnaire to library store.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireLibraryId

integer

required

id of questionnaireLibrary

Example:

Body Parameters

duration

integer

required

Example:

details

object[]

required

language_id

integer

required

The id of an existing record in the languages table.

Example:

pdf

string

slogan

string

required

Must not be greater than 244 characters.

Example:

description

string

required

Must not be greater than 244 characters.

Example:

Animi quos velit et fugiat.

components

object

required

Auth

Bearer

Headers

URL Parameters

Body

{ "duration": 16, "details": [ { "language_id": 16, "pdf": null, "slogan": "n", "description": "Animi quos velit et fugiat.", "components": { "detail": [ "architecto" ], "key_point": [ "architecto" ] } } ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/library/questionnaireLibrary/1/details" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"duration\": 16,
    \"details\": [
        {
            \"language_id\": 16,
            \"slogan\": \"n\",
            \"description\": \"Animi quos velit et fugiat.\",
            \"components\": {
                \"detail\": [
                    \"architecto\"
                ],
                \"key_point\": [
                    \"architecto\"
                ]
            }
        }
    ]
}"

Example response :

{
    "message": "update success"
}

Codes

Code | Update

POST

http://localhost:8000

/api/v1/library/codes

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

code

string

Example:

architecto

column_number

integer

required

Example:

products

integer[]

required

The id of an existing record in the products table.

Example:

[16]

Auth

Bearer

Headers

Body

{ "code": "architecto", "column_number": 16, "products": [ 16 ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/library/codes" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"architecto\",
    \"column_number\": 16,
    \"products\": [
        16
    ]
}"

Example response :

{
    "message": "code created"
}

Code Exists

POST

http://localhost:8000

/api/v1/library/codes/{code}/exists

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

code

string

Example:

architecto

Auth

Bearer

Headers

Body

{ "code": "architecto" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/library/codes/{code}/exists" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"architecto\"
}"

Example response :

{
    "data": {
        "code_exits": false
    }
}

Code Products

GET

http://localhost:8000

/api/v1/library/code/{code}/products

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/library/code/{code}/products" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Attempt to read property \"products\" on null",
    "exception": "ErrorException",
    "file": "/var/www/html/app/Http/Controllers/V1/Library/LibraryCodeProductController.php",
    "line": 24,
    "trace": [
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Bootstrap/HandleExceptions.php",
            "line": 258,
            "function": "handleError",
            "class": "Illuminate\\Foundation\\Bootstrap\\HandleExceptions",
            "type": "->"
        },
        {
            "file": "/var/www/html/app/Http/Controllers/V1/Library/LibraryCodeProductController.php",
            "line": 24,
            "function": "Illuminate\\Foundation\\Bootstrap\\{closure}",
            "class": "Illuminate\\Foundation\\Bootstrap\\HandleExceptions",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/ControllerDispatcher.php",
            "line": 46,
            "function": "__invoke",
            "class": "App\\Http\\Controllers\\V1\\Library\\LibraryCodeProductController",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 265,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\ControllerDispatcher",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 211,
            "function": "runController",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 822,
            "function": "run",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "Illuminate\\Routing\\{closure}",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Middleware/SubstituteBindings.php",
            "line": 50,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\SubstituteBindings",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/sanctum/src/Http/Middleware/EnsureFrontendRequestsAreStateful.php",
            "line": 26,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "Laravel\\Sanctum\\Http\\Middleware\\{closure}",
            "class": "Laravel\\Sanctum\\Http\\Middleware\\EnsureFrontendRequestsAreStateful",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 137,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/sanctum/src/Http/Middleware/EnsureFrontendRequestsAreStateful.php",
            "line": 25,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Laravel\\Sanctum\\Http\\Middleware\\EnsureFrontendRequestsAreStateful",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 137,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 821,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 800,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 764,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 753,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 200,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "Illuminate\\Foundation\\Http\\{closure}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/livewire/livewire/src/Features/SupportDisablingBackButtonCache/DisableBackButtonCacheMiddleware.php",
            "line": 19,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Livewire\\Features\\SupportDisablingBackButtonCache\\DisableBackButtonCacheMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
            "line": 51,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Http/Middleware/ValidatePostSize.php",
            "line": 27,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
            "line": 109,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Http/Middleware/HandleCors.php",
            "line": 61,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\HandleCors",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
            "line": 58,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\TrustProxies",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/InvokeDeferredCallbacks.php",
            "line": 22,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\InvokeDeferredCallbacks",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Http/Middleware/ValidatePathEncoding.php",
            "line": 26,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\ValidatePathEncoding",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 137,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 175,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 144,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 256,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 249,
            "function": "callLaravelRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 86,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 39,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 240,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 165,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 97,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 125,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 72,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 50,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/Util.php",
            "line": 43,
            "function": "Illuminate\\Container\\{closure}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 96,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 35,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 799,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 211,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/symfony/console/Command/Command.php",
            "line": 341,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 180,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/symfony/console/Application.php",
            "line": 1102,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/symfony/console/Application.php",
            "line": 356,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/symfony/console/Application.php",
            "line": 195,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
            "line": 198,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 1235,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/html/artisan",
            "line": 13,
            "function": "handleCommand",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        }
    ]
}

Configuration

Configuration | Update

POST

http://localhost:8000

/api/v1/library/configurations

requires authentication

Update the current configuration

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

is_secure

boolean

required

has_general_design

boolean

required

column_number

integer

This field is required when has_general_design is true.

Example:

Auth

Bearer

Headers

Body

{ "is_secure": false, "has_general_design": false, "column_number": 16 }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/library/configurations" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"is_secure\": false,
    \"has_general_design\": false,
    \"column_number\": 16
}"

Configuration | List

GET

http://localhost:8000

/api/v1/library/configurations

requires authentication

List of current option

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

code

string

query parameter for get config for code

Example:

xdf

Response Fields

is_secure

boolean

required

determine if the library access must be secured

column_number

integer

required

the default number of column

url

string

required

url for access to library

has_general_design

boolean

required

determine if library must be a specific or generic design.

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/library/configurations?code=xdf" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "is_secure": false,
        "column_number": 2,
        "url": "https://backend.test/library/commerciale",
        "has_general_design": true
    }
}

Profiles

Delete Product code

DELETE

http://localhost:8000

/api/v1/library/libraryAccessCode/{libraryAccessCodeId}

requires authentication

delete a code with all device attached to them in the application

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

libraryAccessCodeProductId

integer

required

Library access code product id

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/library/libraryAccessCode/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "code deleted!"
}

List Product Profiles

GET

http://localhost:8000

/api/v1/library/libraryAccessCode/profiles

requires authentication

List all the profiles and devices connected with their respective code in application

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

product

integer

Product id

Example:

Body Parameters

product

integer

Example:

Auth

Bearer

Headers

Query Parameters

Body

{ "product": 16 }

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/library/libraryAccessCode/profiles?product=1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"product\": 16
}"

Example response :

{
    "data": [
        {
            "id": 1,
            "code": "xde04",
            "ip_address_count": 2,
            "device_count": 4
        },
        {
            "id": 2,
            "code": "xfrde04",
            "ip_address_count": 20,
            "device_count": 42
        },
        {
            "id": 3,
            "code": "xfrde05",
            "ip_address_count": 20,
            "device_count": 42
        },
        {
            "id": 4,
            "code": "xfrde06",
            "ip_address_count": 20,
            "device_count": 42
        },
        {
            "id": 5,
            "code": "fade07",
            "ip_address_count": 20,
            "device_count": 42
        },
        {
            "id": 6,
            "code": "fade08",
            "ip_address_count": 20,
            "device_count": 42
        },
        {
            "id": 7,
            "code": "34XFDEDEFD",
            "ip_address_count": 20,
            "device_count": 42
        },
        {
            "id": 8,
            "code": "xfrde10",
            "ip_address_count": 20,
            "device_count": 42
        },
        {
            "id": 9,
            "code": "xfrde11",
            "ip_address_count": 20,
            "device_count": 42
        },
        {
            "id": 10,
            "code": "xfrde12",
            "ip_address_count": 20,
            "device_count": 42
        },
        {
            "id": 11,
            "code": "xfrde13",
            "ip_address_count": 20,
            "device_count": 42
        },
        {
            "id": 12,
            "code": "xfrde14",
            "ip_address_count": 20,
            "device_count": 42
        },
        {
            "id": 13,
            "code": "xfrde15",
            "ip_address_count": 20,
            "device_count": 42
        },
        {
            "id": 14,
            "code": "xfrde16",
            "ip_address_count": 20,
            "device_count": 42
        },
        {
            "id": 15,
            "code": "xfrde17",
            "ip_address_count": 20,
            "device_count": 42
        },

    ]
}

Access

Access Link

GET

http://localhost:8000

/api/v1/library/access

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/library/access" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


                                                                                                            content-type
                                                        : text/html; charset=utf-8
                                                                                                            cache-control
                                                        : no-cache, private
                                                                                                            vary
                                                        : Origin

Message

Manage the Message in our apps

Store Message

POST

http://localhost:8000

/api/v1/vote/message/store

requires authentication

Store a new message. (You must be authenticated as a voter)

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

sender_email

string

The email address of the contact person. Must be a valid email address.

Example:

contact@example.com

subject

string

required

The subject of the message.

Example:

Survey Feedback

message

string

required

The content of the message.

Example:

This is a feedback message for the survey.

Auth

Bearer

Headers

Body

{ "sender_email": "contact@example.com", "subject": "Survey Feedback", "message": "This is a feedback message for the survey." }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/vote/message/store" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"sender_email\": \"contact@example.com\",
    \"subject\": \"Survey Feedback\",
    \"message\": \"This is a feedback message for the survey.\"
}"

Example response :

{
    "message": "success",
    "status": 200
}

Permission

Permission role

Role | Get Permissions

GET

http://localhost:8000

/api/v1/permissions/roles/{guardName}/permissions

requires authentication

Get all the permissions assigned to a role

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

guardName

string

required

the guard name

Must be one of:

global_admin
super_admin
simple_admin

Example:

global_admin

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/permissions/roles/global_admin/permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "Liste des Administrateurs",
            "code": "ADMIN_LIST",
            "checked": false,
            "created_at": "2026-01-07T13:21:04.000000Z",
            "updated_at": "2026-01-07T13:21:04.000000Z"
        },
        {
            "id": 1,
            "name": "Liste des Administrateurs",
            "code": "ADMIN_LIST",
            "checked": false,
            "created_at": "2026-01-07T13:21:04.000000Z",
            "updated_at": "2026-01-07T13:21:04.000000Z"
        }
    ]
}

Role | Update Permissions

POST

http://localhost:8000

/api/v1/permissions/roles/{guardName}/permissions

requires authentication

Update permission for a specific role

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

guardName

enum

required

the specified role

Must be one of:

global_admin
super_admin
simple_admin

Example:

global_admin

Body Parameters

permissions

object[]

A permission item witch is an array of <code,value> items.

Auth

Bearer

Headers

URL Parameters

Body

{ "permissions": [ { "code": "REPORT_DESIGN_MANAGE", "value": false } ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/permissions/roles/global_admin/permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"permissions\": [
        {
            \"code\": \"REPORT_DESIGN_MANAGE\",
            \"value\": false
        }
    ]
}"

Example response :

{
    "message": "updated success",
    "status": 200
}

UserRole

UserRole | Get Permissions

GET

http://localhost:8000

/api/v1/permissions/userRole/{userRoleId}/permissions

requires authentication

Get all the permissions assigned to a user

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

userRoleId

integer

required

the id of user role

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/permissions/userRole/16/permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "Liste des Administrateurs",
            "code": "ADMIN_LIST",
            "checked": false,
            "created_at": "2026-01-07T13:21:04.000000Z",
            "updated_at": "2026-01-07T13:21:04.000000Z"
        },
        {
            "id": 1,
            "name": "Liste des Administrateurs",
            "code": "ADMIN_LIST",
            "checked": false,
            "created_at": "2026-01-07T13:21:04.000000Z",
            "updated_at": "2026-01-07T13:21:04.000000Z"
        }
    ]
}

UserRole | Update Permissions

POST

http://localhost:8000

/api/v1/permissions/userRole/{userRoleId}/permissions

requires authentication

assigns all the permissions assigned to a user

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

userRoleId

integer

required

the id of user role

Example:

Body Parameters

permissions

object[]

A permission item witch is an array of <code,value> items.

Auth

Bearer

Headers

URL Parameters

Body

{ "permissions": [ { "code": "SUBSCRIPTION_CREATE", "value": false } ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/permissions/userRole/16/permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"permissions\": [
        {
            \"code\": \"SUBSCRIPTION_CREATE\",
            \"value\": false
        }
    ]
}"

Example response :

{
    "status": 200,
    "message": "updated successfully"
}

Questionnaire

Mise en place de la gestion des questionnaires

Theme

Themes List

GET

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/themes

requires authentication

Questionnaires' themes list

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

The id of the questionnaire

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaires/16/themes" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": null,
            "questionnaire_id": null,
            "order": null,
            "is_deletable": true,
            "created_at": null,
            "translations": null
        }
    ],
    "links": {
        "first": "/?page=1",
        "last": "/?page=2",
        "prev": null,
        "next": "/?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 2,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "page": null,
                "active": false
            },
            {
                "url": "/?page=1",
                "label": "1",
                "page": 1,
                "active": true
            },
            {
                "url": "/?page=2",
                "label": "2",
                "page": 2,
                "active": false
            },
            {
                "url": "/?page=2",
                "label": "Next &raquo;",
                "page": 2,
                "active": false
            }
        ],
        "path": "/",
        "per_page": 1,
        "to": 1,
        "total": 2
    }
}

Show a Theme

GET

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/themes/{themeId}

requires authentication

show a theme with all it's translations

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

themeId

integer

required

the id of the theme to be showned

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaires/1/themes/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": null,
        "questionnaire_id": null,
        "order": null,
        "is_deletable": true,
        "created_at": null,
        "translations": null
    }
}

Delete Theme

DELETE

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}themes/{themeId}

requires authentication

Delete a Theme

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

themeId

integer

required

The id of the theme

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/questionnaires/1themes/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "Theme deleted!"
}

Store Theme

POST

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/theme

requires authentication

Store a new theme and it's translations

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

Questionnaire id, must exist in the database

Example:

Body Parameters

theme_translations

object[]

required

Auth

Bearer

Headers

URL Parameters

Body

{ "theme_translations": [ { "language_id": 16, "content": "architecto" } ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/questionnaires/11/theme" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"theme_translations\": [
        {
            \"language_id\": 16,
            \"content\": \"architecto\"
        }
    ]
}"

Example response :

{
    "message": "Theme created!"
}

Update Theme

PUT

PATCH

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/themes/{themeId}

requires authentication

Update a theme translations

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

themeId

integer

required

Id of the theme to be updated , must exist in the database

Example:

Body Parameters

theme_translations

object[]

required

Auth

Bearer

Headers

URL Parameters

Body

{ "theme_translations": [ { "language_id": 16, "content": "architecto" } ] }

Received response

Example request:

curl --request PUT \
    "http://localhost:8000/api/v1/questionnaires/1/themes/7" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"theme_translations\": [
        {
            \"language_id\": 16,
            \"content\": \"architecto\"
        }
    ]
}"

Example response :

{
    "message": "Theme updated!"
}

Order Up

POST

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/themes/{themeId}/up

requires authentication

Order up a theme

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

the id of questionnaire

Example:

themeId

string

required

the id of theme

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/questionnaires/1/themes/1/up" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Order Down

POST

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/themes/{themeId}/down

requires authentication

Order up a theme

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

the id of questionnaire

Example:

themeId

string

required

the id of theme

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/questionnaires/1/themes/1/down" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Sub Theme

Sub Theme |

List of Sub Theme

GET

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/themes/{themeId}/subThemes

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

themeId

integer

required

id of questionnaire

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaires/1/themes/1/subThemes" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "organization is not theme and sub theme",
    "status": 400
}

Create Sub theme

POST

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/themes/{themeId}/subThemes

requires authentication

Create a new sub theme

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

themeId

integer

required

id of questionnaire

Example:

Body Parameters

items

object[]

required

Auth

Bearer

Headers

URL Parameters

Body

{ "items": [ { "language_id": 16, "name": "n" } ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/questionnaires/1/themes/1/subThemes" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": [
        {
            \"language_id\": 16,
            \"name\": \"n\"
        }
    ]
}"

Update a sub theme

PUT

PATCH

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/themes/{themeId}/subThemes/{subThemeId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

themeId

integer

required

id of questionnaire

Example:

subThemeId

integer

required

id of questionnaire

Example:

Body Parameters

items

object[]

required

Auth

Bearer

Headers

URL Parameters

Body

{ "items": [ { "language_id": 16, "name": "n" } ] }

Received response

Example request:

curl --request PUT \
    "http://localhost:8000/api/v1/questionnaires/1/themes/1/subThemes/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": [
        {
            \"language_id\": 16,
            \"name\": \"n\"
        }
    ]
}"

Delete a Subtheme

DELETE

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/themes/{themeId}/subThemes/{subThemeId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

themeId

integer

required

id of questionnaire

Example:

subThemeId

integer

required

id of questionnaire

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/questionnaires/1/themes/1/subThemes/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Move UP

POST

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/themes/{themeId}/subThemes/{subThemeId}/up

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

string

required

the id of questionnaire

Example:

themeId

string

required

the id of theme

Example:

subThemeId

string

required

the id of sub theme

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/questionnaires/1/themes/1/subThemes/1/up" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Move Down

POST

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/themes/{themeId}/subThemes/{subThemeId}/down

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

string

required

the id of questionnaire

Example:

themeId

string

required

the id of theme

Example:

subThemeId

string

required

the id of sub theme

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/questionnaires/1/themes/1/subThemes/1/down" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Questionnaire Design

List questionnaire designs

GET

http://localhost:8000

/api/v1/questionnaireDesign

requires authentication

list of all questionnaire designs in application

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaireDesign" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "Classique",
            "is_classic": true,
            "title_color": "#6777ef",
            "logo": "questionnaireDesign/2CZt0uL1sFoqJxwnW5CL888i8H68GT1C0FEfv3Wk.png",
            "logo_url": "http://localhost:8000/storage/questionnaireDesign/2CZt0uL1sFoqJxwnW5CL888i8H68GT1C0FEfv3Wk.png",
            "background_value": "http://localhost:8000/storage/#f4f6f9",
            "original_background_value": "#f4f6f9",
            "main_button_color": "#6777ef",
            "main_button_text_color": "#ffffff",
            "secondary_button_color": "#fc544b",
            "secondary_button_text_color": "#ffffff",
            "container_color": "#001e7c",
            "progression_bar_free_space_color": "#e9ecef",
            "progression_bar_filled_space_color": "#31bfbf",
            "progression_bar_text_color": "#000000",
            "single_choice_free_space_color": "#e9ecef",
            "single_choice_filled_space_color": "#6777ef",
            "previous_next_button_color": "#31bfbf",
            "previous_next_button_text_color": "#ffffff",
            "container_background_color": "#ffffff",
            "container_opacity": 100,
            "logo_has_border_radius": true,
            "logo_has_border": true,
            "theme_color": "#6777ef",
            "question_text_color": "#34395e",
            "answer_option_color": "#495057",
            "comment_color": "#e83e8c",
            "closing_text_color": "#001e7c",
            "copyright_text": "Copyright © isiQuest 2023",
            "copyright_text_color": "#34395e",
            "vote_end_texts": {
                "1": "Vote terminé<br>Merci de votre participation",
                "2": "Vote ended<br>Thanks for participating",
                "3": "Votación terminada<br>Gracias por participar",
                "4": "Abstimmung beendet<br>Danke für die Teilnahme",
                "5": "Votação encerrada<br>Obrigado por participar",
                "6": "投票结束<br>感谢您的参与",
                "7": "投票が終了しました<br>ご参加いただきありがとうございます",
                "8": "Voto terminato<br>Grazie per aver partecipato",
                "9": "Голосование завершено<br>Спасибо за участие",
                "10": "Stemmen beëindigd<br>Bedankt voor uw deelname"
            },
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "status_id": 1,
            "questionnaire_background_type": {
                "id": 1,
                "name": "image",
                "created_at": "2026-01-07T13:21:05.000000Z"
            }
        },
        {
            "id": 1,
            "name": "Classique",
            "is_classic": true,
            "title_color": "#6777ef",
            "logo": "questionnaireDesign/2CZt0uL1sFoqJxwnW5CL888i8H68GT1C0FEfv3Wk.png",
            "logo_url": "http://localhost:8000/storage/questionnaireDesign/2CZt0uL1sFoqJxwnW5CL888i8H68GT1C0FEfv3Wk.png",
            "background_value": "http://localhost:8000/storage/#f4f6f9",
            "original_background_value": "#f4f6f9",
            "main_button_color": "#6777ef",
            "main_button_text_color": "#ffffff",
            "secondary_button_color": "#fc544b",
            "secondary_button_text_color": "#ffffff",
            "container_color": "#001e7c",
            "progression_bar_free_space_color": "#e9ecef",
            "progression_bar_filled_space_color": "#31bfbf",
            "progression_bar_text_color": "#000000",
            "single_choice_free_space_color": "#e9ecef",
            "single_choice_filled_space_color": "#6777ef",
            "previous_next_button_color": "#31bfbf",
            "previous_next_button_text_color": "#ffffff",
            "container_background_color": "#ffffff",
            "container_opacity": 100,
            "logo_has_border_radius": true,
            "logo_has_border": true,
            "theme_color": "#6777ef",
            "question_text_color": "#34395e",
            "answer_option_color": "#495057",
            "comment_color": "#e83e8c",
            "closing_text_color": "#001e7c",
            "copyright_text": "Copyright © isiQuest 2023",
            "copyright_text_color": "#34395e",
            "vote_end_texts": {
                "1": "Vote terminé<br>Merci de votre participation",
                "2": "Vote ended<br>Thanks for participating",
                "3": "Votación terminada<br>Gracias por participar",
                "4": "Abstimmung beendet<br>Danke für die Teilnahme",
                "5": "Votação encerrada<br>Obrigado por participar",
                "6": "投票结束<br>感谢您的参与",
                "7": "投票が終了しました<br>ご参加いただきありがとうございます",
                "8": "Voto terminato<br>Grazie per aver partecipato",
                "9": "Голосование завершено<br>Спасибо за участие",
                "10": "Stemmen beëindigd<br>Bedankt voor uw deelname"
            },
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "status_id": 1,
            "questionnaire_background_type": {
                "id": 1,
                "name": "image",
                "created_at": "2026-01-07T13:21:05.000000Z"
            }
        }
    ]
}

Create a new questionnaire design

POST

http://localhost:8000

/api/v1/questionnaireDesign

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

name

string

required

The name of the questionnaire designs | should be unique.

title_color

string

required

color for title of questions. Must not be greater than 244 characters.

Example:

#ccc

logo

file

the logo of designs as image . Must be an image. Must not be greater than 1024 kilobytes.

Example:

/tmp/phpoqJIwc

is_background_image

boolean

required

Determine if it is a background image or background color.

background_image

file

The background image. This field is required when is_background_image is true. Must be an image. Must not be greater than 2048 kilobytes.

Example:

/tmp/phpkCrR21

background_color

string

The background color. This field is required when is_background_image is false.

Example:

#ccc

main_button_color

string

required

color of main button.

Example:

#ccc

main_button_text_color

string

required

color for text main button.

Example:

#ccc

secondary_button_color

string

required

color for secondary button.

Example:

#ccc

secondary_button_text_color

string

required

color for text for secondary button.

Example:

#ccc

container_color

string

required

color for container.

Example:

#ccc

progression_bar_free_space_color

string

required

free space color for remaining percentage.

Example:

#ccc

progression_bar_filled_space_color

string

required

color for filled space percentage.

Example:

#ccc

progression_bar_text_color

string

required

color for text percentage progress bar.

Example:

#ccc

single_choice_free_space_color

string

required

single choice free space color.

Example:

#ccc

single_choice_filled_space_color

string

required

single choice filled space color.

Example:

#ccc

previous_next_button_color

string

required

color for next and previous color.

Example:

#ccc

previous_next_button_text_color

string

required

color for text for previous-next button color.

Example:

#ccc

container_background_color

string

required

container background color.

Example:

#ccc

container_opacity

number

required

opacity for container. Must be between 0 and 100.

Example:

logo_has_border_radius

boolean

required

border radius.

Example:

logo_has_border

boolean

required

logo border.

Example:

theme_color

string

required

theme color.

Example:

#ccc

question_text_color

string

required

color text question.

Example:

#ccc

closing_text_color

string

required

closing text color.

Example:

#ccc

answer_option_color

string

required

color answer question.

Example:

#ccc

comment_color

string

required

comment color.

Example:

#ccc

copyright_text

string

Example:

#ccc

copyright_text_color

string

required

color for copyright text.

Example:

#ccc

vote_end_texts

object[]

required

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/questionnaireDesign" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name="\
    --form "title_color=#ccc"\
    --form "is_background_image="\
    --form "background_color=#ccc"\
    --form "main_button_color=#ccc"\
    --form "main_button_text_color=#ccc"\
    --form "secondary_button_color=#ccc"\
    --form "secondary_button_text_color=#ccc"\
    --form "container_color=#ccc"\
    --form "progression_bar_free_space_color=#ccc"\
    --form "progression_bar_filled_space_color=#ccc"\
    --form "progression_bar_text_color=#ccc"\
    --form "single_choice_free_space_color=#ccc"\
    --form "single_choice_filled_space_color=#ccc"\
    --form "previous_next_button_color=#ccc"\
    --form "previous_next_button_text_color=#ccc"\
    --form "container_background_color=#ccc"\
    --form "container_opacity=2"\
    --form "logo_has_border_radius=1"\
    --form "logo_has_border=1"\
    --form "theme_color=#ccc"\
    --form "question_text_color=#ccc"\
    --form "closing_text_color=#ccc"\
    --form "answer_option_color=#ccc"\
    --form "comment_color=#ccc"\
    --form "copyright_text=#ccc"\
    --form "copyright_text_color=#ccc"\
    --form "vote_end_texts[][language_id]=16"\
    --form "vote_end_texts[][text]=architecto"\
    --form "logo=@/tmp/phpoqJIwc" \
    --form "background_image=@/tmp/phpkCrR21"

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

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

const body = new FormData();
body.append('name', '');
body.append('title_color', '#ccc');
body.append('is_background_image', '');
body.append('background_color', '#ccc');
body.append('main_button_color', '#ccc');
body.append('main_button_text_color', '#ccc');
body.append('secondary_button_color', '#ccc');
body.append('secondary_button_text_color', '#ccc');
body.append('container_color', '#ccc');
body.append('progression_bar_free_space_color', '#ccc');
body.append('progression_bar_filled_space_color', '#ccc');
body.append('progression_bar_text_color', '#ccc');
body.append('single_choice_free_space_color', '#ccc');
body.append('single_choice_filled_space_color', '#ccc');
body.append('previous_next_button_color', '#ccc');
body.append('previous_next_button_text_color', '#ccc');
body.append('container_background_color', '#ccc');
body.append('container_opacity', '2');
body.append('logo_has_border_radius', '1');
body.append('logo_has_border', '1');
body.append('theme_color', '#ccc');
body.append('question_text_color', '#ccc');
body.append('closing_text_color', '#ccc');
body.append('answer_option_color', '#ccc');
body.append('comment_color', '#ccc');
body.append('copyright_text', '#ccc');
body.append('copyright_text_color', '#ccc');
body.append('vote_end_texts[][language_id]', '16');
body.append('vote_end_texts[][text]', 'architecto');
body.append('logo', document.querySelector('input[name="logo"]').files[0]);
body.append('background_image', document.querySelector('input[name="background_image"]').files[0]);

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

Detail of a questionnaire design

GET

http://localhost:8000

/api/v1/questionnaireDesign/{questionnaireDesignId}

requires authentication

Get a detail for a specific questionnaire design

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireDesignId

integer

required

id of questionnaire design

Example:

Body Parameters

questionnaire_id

integer

required

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "questionnaire_id": 16 }

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaireDesign/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"questionnaire_id\": 16
}"

Example response :

{
    "data": {
        "id": 1,
        "name": "Classique",
        "is_classic": true,
        "title_color": "#6777ef",
        "logo": "questionnaireDesign/2CZt0uL1sFoqJxwnW5CL888i8H68GT1C0FEfv3Wk.png",
        "logo_url": "http://localhost:8000/storage/questionnaireDesign/2CZt0uL1sFoqJxwnW5CL888i8H68GT1C0FEfv3Wk.png",
        "background_value": "http://localhost:8000/storage/#f4f6f9",
        "original_background_value": "#f4f6f9",
        "main_button_color": "#6777ef",
        "main_button_text_color": "#ffffff",
        "secondary_button_color": "#fc544b",
        "secondary_button_text_color": "#ffffff",
        "container_color": "#001e7c",
        "progression_bar_free_space_color": "#e9ecef",
        "progression_bar_filled_space_color": "#31bfbf",
        "progression_bar_text_color": "#000000",
        "single_choice_free_space_color": "#e9ecef",
        "single_choice_filled_space_color": "#6777ef",
        "previous_next_button_color": "#31bfbf",
        "previous_next_button_text_color": "#ffffff",
        "container_background_color": "#ffffff",
        "container_opacity": 100,
        "logo_has_border_radius": true,
        "logo_has_border": true,
        "theme_color": "#6777ef",
        "question_text_color": "#34395e",
        "answer_option_color": "#495057",
        "comment_color": "#e83e8c",
        "closing_text_color": "#001e7c",
        "copyright_text": "Copyright © isiQuest 2023",
        "copyright_text_color": "#34395e",
        "vote_end_texts": {
            "1": "Vote terminé<br>Merci de votre participation",
            "2": "Vote ended<br>Thanks for participating",
            "3": "Votación terminada<br>Gracias por participar",
            "4": "Abstimmung beendet<br>Danke für die Teilnahme",
            "5": "Votação encerrada<br>Obrigado por participar",
            "6": "投票结束<br>感谢您的参与",
            "7": "投票が終了しました<br>ご参加いただきありがとうございます",
            "8": "Voto terminato<br>Grazie per aver partecipato",
            "9": "Голосование завершено<br>Спасибо за участие",
            "10": "Stemmen beëindigd<br>Bedankt voor uw deelname"
        },
        "created_at": "2026-01-07T13:21:06.000000Z",
        "updated_at": "2026-01-07T13:21:06.000000Z",
        "status_id": 1,
        "questionnaire_background_type": {
            "id": 1,
            "name": "image",
            "created_at": "2026-01-07T13:21:05.000000Z"
        }
    }
}

Update a questionnaire Design

PUT

PATCH

http://localhost:8000

/api/v1/questionnaireDesign/{questionnaireDesignId}

requires authentication

Update a questionnaire design

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireDesignId

integer

required

id of questionnaire design

Example:

Body Parameters

name

string

required

The name of the questionnaire designs | should be unique.

Example:

dedede

title_color

string

required

color for title of questions. Must not be greater than 244 characters.

Example:

#ccc

logo

string

the logo of designs as image .

is_background_image

boolean

required

Determine if it is a background image or background color.

background_image

string

The background image.

background_color

string

The background color. This field is required when is_background_image is false.

Example:

#ccc

main_button_color

string

required

color of main button.

Example:

#ccc

main_button_text_color

string

required

color for text main button.

Example:

#ccc

secondary_button_color

string

required

color for secondary button.

Example:

#ccc

secondary_button_text_color

string

required

color for text for secondary button.

Example:

#ccc

container_color

string

required

color for container.

Example:

#ccc

progression_bar_free_space_color

string

required

free space color for remaining percentage.

Example:

#ccc

progression_bar_filled_space_color

string

required

color for filled space percentage.

Example:

#ccc

progression_bar_text_color

string

required

color for text percentage progress bar.

Example:

#ccc

single_choice_free_space_color

string

required

single choice free space color.

Example:

#ccc

single_choice_filled_space_color

string

required

single choice filled space color.

Example:

#ccc

previous_next_button_color

string

required

color for next and previous color.

Example:

#ccc

previous_next_button_text_color

string

required

color for text for previous-next button color.

Example:

#ccc

container_background_color

string

required

container background color.

Example:

#ccc

container_opacity

number

required

opacity for container. Must be between 0 and 100.

Example:

logo_has_border_radius

boolean

required

border radius.

Example:

logo_has_border

boolean

required

logo border.

Example:

theme_color

string

required

theme color.

Example:

#ccc

question_text_color

string

required

color text question.

Example:

#ccc

closing_text_color

string

required

closing text color.

Example:

#ccc

answer_option_color

string

required

color answer question.

Example:

#ccc

comment_color

string

required

comment color.

Example:

#ccc

copyright_text

string

Example:

#ccc

copyright_text_color

string

required

color for copyright text.

Example:

#ccc

vote_end_texts

object[]

required

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "dedede", "title_color": "#ccc", "logo": null, "is_background_image": false, "background_image": null, "background_color": "#ccc", "main_button_color": "#ccc", "main_button_text_color": "#ccc", "secondary_button_color": "#ccc", "secondary_button_text_color": "#ccc", "container_color": "#ccc", "progression_bar_free_space_color": "#ccc", "progression_bar_filled_space_color": "#ccc", "progression_bar_text_color": "#ccc", "single_choice_free_space_color": "#ccc", "single_choice_filled_space_color": "#ccc", "previous_next_button_color": "#ccc", "previous_next_button_text_color": "#ccc", "container_background_color": "#ccc", "container_opacity": 2, "logo_has_border_radius": true, "logo_has_border": true, "theme_color": "#ccc", "question_text_color": "#ccc", "closing_text_color": "#ccc", "answer_option_color": "#ccc", "comment_color": "#ccc", "copyright_text": "#ccc", "copyright_text_color": "#ccc", "vote_end_texts": [ { "language_id": 16, "text": "architecto" } ] }

Received response

Example request:

curl --request PUT \
    "http://localhost:8000/api/v1/questionnaireDesign/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"dedede\",
    \"title_color\": \"#ccc\",
    \"is_background_image\": false,
    \"background_color\": \"#ccc\",
    \"main_button_color\": \"#ccc\",
    \"main_button_text_color\": \"#ccc\",
    \"secondary_button_color\": \"#ccc\",
    \"secondary_button_text_color\": \"#ccc\",
    \"container_color\": \"#ccc\",
    \"progression_bar_free_space_color\": \"#ccc\",
    \"progression_bar_filled_space_color\": \"#ccc\",
    \"progression_bar_text_color\": \"#ccc\",
    \"single_choice_free_space_color\": \"#ccc\",
    \"single_choice_filled_space_color\": \"#ccc\",
    \"previous_next_button_color\": \"#ccc\",
    \"previous_next_button_text_color\": \"#ccc\",
    \"container_background_color\": \"#ccc\",
    \"container_opacity\": 2,
    \"logo_has_border_radius\": true,
    \"logo_has_border\": true,
    \"theme_color\": \"#ccc\",
    \"question_text_color\": \"#ccc\",
    \"closing_text_color\": \"#ccc\",
    \"answer_option_color\": \"#ccc\",
    \"comment_color\": \"#ccc\",
    \"copyright_text\": \"#ccc\",
    \"copyright_text_color\": \"#ccc\",
    \"vote_end_texts\": [
        {
            \"language_id\": 16,
            \"text\": \"architecto\"
        }
    ]
}"

Example response :

{
    "message": "questionnaire design updated!"
}

Destroy a questionnaire design

DELETE

http://localhost:8000

/api/v1/questionnaireDesign/{questionnaireDesignId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireDesign

integer

required

id of questionnaire design

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/questionnaireDesign/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "design deleted!"
}

Get vote end texts

GET

http://localhost:8000

/api/v1/questionnaireDesign/voteEndTexts

requires authentication

Get vote end texts for all languages

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaireDesign/voteEndTexts" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "1": "Questionnaire terminer <br> merci de votre participation",
        "2": "Questionnaire end <br> thank you for your participation",
        "3": "cuestionario terminado <br> gracias por su participación",
        "4": "Fragebogen beendet <br> danke für ihre teilnahme",
        "5": "questionário terminado <br> obrigado por sua participação",
        "6": "问卷结束 <br> 感谢您的参与",
        "7": "アンケート終了 <br> ご参加ありがとうございました",
        "8": "questionario terminato <br> grazie per la tua participation",
        "9": "опрос завершен <br> спасибо за ваше участие",
        "10": "vragenlijst beëindigd <br> bedankt voor uw deelname"
    }
}

Copy

Copy Design

POST

http://localhost:8000

/api/v1/questionnaireDesign/{questionnaireDesignId}/copy

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireDesignId

integer

required

id of design

Example:

Body Parameters

name

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "architecto" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/questionnaireDesign/16/copy" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\"
}"

Example response :

{
    "message": "copied"
}

Report Design

List all report design

GET

http://localhost:8000

/api/v1/reportDesign

requires authentication

List of report designs in application

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

scope

string

Filter the design by is scope

Must be one of:

generic
specific

Example:

generic

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/reportDesign?scope=generic" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "Classique",
            "color_graph": [
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF"
            ],
            "is_classic": true,
            "color_title_cover": "#000000",
            "color_title_section": "#001E7C",
            "color_title_subtitle1": "#000000",
            "color_title_subtitle2": "#000000",
            "color_title_subtitle3": "#000000",
            "color_title_footer_text": "#FFFFFF",
            "color_title_footer_bg": "#6777EF",
            "color_vote_percent_donut_chart": "#FFFFFF",
            "open_question_odd_line_color": "#E9ECEF",
            "open_question_odd_line_text_color": "#000000",
            "open_question_even_line_color": "#FFFFFF",
            "open_question_even_line_text_color": "#000000",
            "prioritization_header_color": "#6777EF",
            "prioritization_header_text_color": "#FFFFFF",
            "prioritization_odd_line_color": "#E9ECEF",
            "prioritization_odd_line_text_color": "#000000",
            "prioritization_even_line_color": "#FFFFFF",
            "prioritization_even_line_text_color": "#000000",
            "color_question_title": "#001E7C",
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "report_design_scope_id": 1,
            "report_preview_url": "http://localhost:8000/api/v1/reportDesign/1/previewPdf"
        },
        {
            "id": 1,
            "name": "Classique",
            "color_graph": [
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF"
            ],
            "is_classic": true,
            "color_title_cover": "#000000",
            "color_title_section": "#001E7C",
            "color_title_subtitle1": "#000000",
            "color_title_subtitle2": "#000000",
            "color_title_subtitle3": "#000000",
            "color_title_footer_text": "#FFFFFF",
            "color_title_footer_bg": "#6777EF",
            "color_vote_percent_donut_chart": "#FFFFFF",
            "open_question_odd_line_color": "#E9ECEF",
            "open_question_odd_line_text_color": "#000000",
            "open_question_even_line_color": "#FFFFFF",
            "open_question_even_line_text_color": "#000000",
            "prioritization_header_color": "#6777EF",
            "prioritization_header_text_color": "#FFFFFF",
            "prioritization_odd_line_color": "#E9ECEF",
            "prioritization_odd_line_text_color": "#000000",
            "prioritization_even_line_color": "#FFFFFF",
            "prioritization_even_line_text_color": "#000000",
            "color_question_title": "#001E7C",
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "report_design_scope_id": 1,
            "report_preview_url": "http://localhost:8000/api/v1/reportDesign/1/previewPdf"
        }
    ]
}

Create new report design

POST

http://localhost:8000

/api/v1/reportDesign

requires authentication

Store a report design

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

color_name

string

required

Example:

architecto

color_title_cover

string

required

Example:

architecto

color_title_footer_bg

string

required

Example:

architecto

color_title_footer_text

string

required

Example:

architecto

color_title_section

string

required

Example:

architecto

color_title_subtitle1

string

required

Example:

architecto

color_title_subtitle2

string

required

Example:

architecto

color_title_subtitle3

string

required

Example:

architecto

color_vote_percent_donut_chart

string

required

Example:

architecto

color_graph

string[]

required

Example:

["architecto"]

is_generic

boolean

required

open_questions_odd_line_color

string

required

Example:

architecto

open_questions_odd_line_text_color

string

required

Example:

architecto

open_questions_even_line_color

string

required

Example:

architecto

open_questions_even_line_text_color

string

required

Example:

architecto

prioritization_header_color

string

required

Example:

architecto

prioritization_header_text_color

string

required

Example:

architecto

prioritization_odd_line_color

string

required

Example:

architecto

prioritization_odd_line_text_color

string

required

Example:

architecto

prioritization_even_line_color

string

required

Example:

architecto

prioritization_even_line_text_color

string

required

Example:

architecto

color_questions_title

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "color_name": "architecto", "color_title_cover": "architecto", "color_title_footer_bg": "architecto", "color_title_footer_text": "architecto", "color_title_section": "architecto", "color_title_subtitle1": "architecto", "color_title_subtitle2": "architecto", "color_title_subtitle3": "architecto", "color_vote_percent_donut_chart": "architecto", "color_graph": [ "architecto" ], "is_generic": false, "open_questions_odd_line_color": "architecto", "open_questions_odd_line_text_color": "architecto", "open_questions_even_line_color": "architecto", "open_questions_even_line_text_color": "architecto", "prioritization_header_color": "architecto", "prioritization_header_text_color": "architecto", "prioritization_odd_line_color": "architecto", "prioritization_odd_line_text_color": "architecto", "prioritization_even_line_color": "architecto", "prioritization_even_line_text_color": "architecto", "color_questions_title": "architecto" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/reportDesign" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"color_name\": \"architecto\",
    \"color_title_cover\": \"architecto\",
    \"color_title_footer_bg\": \"architecto\",
    \"color_title_footer_text\": \"architecto\",
    \"color_title_section\": \"architecto\",
    \"color_title_subtitle1\": \"architecto\",
    \"color_title_subtitle2\": \"architecto\",
    \"color_title_subtitle3\": \"architecto\",
    \"color_vote_percent_donut_chart\": \"architecto\",
    \"color_graph\": [
        \"architecto\"
    ],
    \"is_generic\": false,
    \"open_questions_odd_line_color\": \"architecto\",
    \"open_questions_odd_line_text_color\": \"architecto\",
    \"open_questions_even_line_color\": \"architecto\",
    \"open_questions_even_line_text_color\": \"architecto\",
    \"prioritization_header_color\": \"architecto\",
    \"prioritization_header_text_color\": \"architecto\",
    \"prioritization_odd_line_color\": \"architecto\",
    \"prioritization_odd_line_text_color\": \"architecto\",
    \"prioritization_even_line_color\": \"architecto\",
    \"prioritization_even_line_text_color\": \"architecto\",
    \"color_questions_title\": \"architecto\"
}"

Example response :

{
    "message": "design created"
}

{
    "data": [
        {
            "id": 1,
            "name": "Classique",
            "color_graph": [
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF"
            ],
            "is_classic": true,
            "color_title_cover": "#000000",
            "color_title_section": "#001E7C",
            "color_title_subtitle1": "#000000",
            "color_title_subtitle2": "#000000",
            "color_title_subtitle3": "#000000",
            "color_title_footer_text": "#FFFFFF",
            "color_title_footer_bg": "#6777EF",
            "color_vote_percent_donut_chart": "#FFFFFF",
            "open_question_odd_line_color": "#E9ECEF",
            "open_question_odd_line_text_color": "#000000",
            "open_question_even_line_color": "#FFFFFF",
            "open_question_even_line_text_color": "#000000",
            "prioritization_header_color": "#6777EF",
            "prioritization_header_text_color": "#FFFFFF",
            "prioritization_odd_line_color": "#E9ECEF",
            "prioritization_odd_line_text_color": "#000000",
            "prioritization_even_line_color": "#FFFFFF",
            "prioritization_even_line_text_color": "#000000",
            "color_question_title": "#001E7C",
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "report_design_scope_id": 1,
            "report_preview_url": "http://localhost:8000/api/v1/reportDesign/1/previewPdf"
        },
        {
            "id": 1,
            "name": "Classique",
            "color_graph": [
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF",
                "#6777EF"
            ],
            "is_classic": true,
            "color_title_cover": "#000000",
            "color_title_section": "#001E7C",
            "color_title_subtitle1": "#000000",
            "color_title_subtitle2": "#000000",
            "color_title_subtitle3": "#000000",
            "color_title_footer_text": "#FFFFFF",
            "color_title_footer_bg": "#6777EF",
            "color_vote_percent_donut_chart": "#FFFFFF",
            "open_question_odd_line_color": "#E9ECEF",
            "open_question_odd_line_text_color": "#000000",
            "open_question_even_line_color": "#FFFFFF",
            "open_question_even_line_text_color": "#000000",
            "prioritization_header_color": "#6777EF",
            "prioritization_header_text_color": "#FFFFFF",
            "prioritization_odd_line_color": "#E9ECEF",
            "prioritization_odd_line_text_color": "#000000",
            "prioritization_even_line_color": "#FFFFFF",
            "prioritization_even_line_text_color": "#000000",
            "color_question_title": "#001E7C",
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "report_design_scope_id": 1,
            "report_preview_url": "http://localhost:8000/api/v1/reportDesign/1/previewPdf"
        }
    ]
}

Detail of one report

GET

http://localhost:8000

/api/v1/reportDesign/{reportDesignId}

requires authentication

Get a detail for a specific report design

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reportDesignId

integer

required

Id of report design

Example:

Body Parameters

integer

required

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "id": 16 }

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/reportDesign/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 16
}"

Example response :

{
    "data": {
        "id": 1,
        "name": "Classique",
        "color_graph": [
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF",
            "#6777EF"
        ],
        "is_classic": true,
        "color_title_cover": "#000000",
        "color_title_section": "#001E7C",
        "color_title_subtitle1": "#000000",
        "color_title_subtitle2": "#000000",
        "color_title_subtitle3": "#000000",
        "color_title_footer_text": "#FFFFFF",
        "color_title_footer_bg": "#6777EF",
        "color_vote_percent_donut_chart": "#FFFFFF",
        "open_question_odd_line_color": "#E9ECEF",
        "open_question_odd_line_text_color": "#000000",
        "open_question_even_line_color": "#FFFFFF",
        "open_question_even_line_text_color": "#000000",
        "prioritization_header_color": "#6777EF",
        "prioritization_header_text_color": "#FFFFFF",
        "prioritization_odd_line_color": "#E9ECEF",
        "prioritization_odd_line_text_color": "#000000",
        "prioritization_even_line_color": "#FFFFFF",
        "prioritization_even_line_text_color": "#000000",
        "color_question_title": "#001E7C",
        "created_at": "2026-01-07T13:21:06.000000Z",
        "updated_at": "2026-01-07T13:21:06.000000Z",
        "report_design_scope_id": 1,
        "report_preview_url": "http://localhost:8000/api/v1/reportDesign/1/previewPdf"
    }
}

Update report design

PUT

PATCH

http://localhost:8000

/api/v1/reportDesign/{reportDesignId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reportDesignId

integer

required

id of report design

Example:

Body Parameters

color_name

string

required

Example:

architecto

color_title_cover

string

required

Example:

architecto

color_title_footer_bg

string

required

Example:

architecto

color_title_footer_text

string

required

Example:

architecto

color_title_section

string

required

Example:

architecto

color_title_subtitle1

string

required

Example:

architecto

color_title_subtitle2

string

required

Example:

architecto

color_title_subtitle3

string

required

Example:

architecto

color_vote_percent_donut_chart

string

required

Example:

architecto

color_graph

string[]

required

Example:

["architecto"]

is_generic

boolean

open_questions_odd_line_color

string

required

Example:

architecto

open_questions_odd_line_text_color

string

required

Example:

architecto

open_questions_even_line_color

string

required

Example:

architecto

open_questions_even_line_text_color

string

required

Example:

architecto

prioritization_header_color

string

required

Example:

architecto

prioritization_header_text_color

string

required

Example:

architecto

prioritization_odd_line_color

string

required

Example:

architecto

prioritization_odd_line_text_color

string

required

Example:

architecto

prioritization_even_line_color

string

required

Example:

architecto

prioritization_even_line_text_color

string

required

Example:

architecto

color_questions_title

string

required

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request PUT \
    "http://localhost:8000/api/v1/reportDesign/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"color_name\": \"architecto\",
    \"color_title_cover\": \"architecto\",
    \"color_title_footer_bg\": \"architecto\",
    \"color_title_footer_text\": \"architecto\",
    \"color_title_section\": \"architecto\",
    \"color_title_subtitle1\": \"architecto\",
    \"color_title_subtitle2\": \"architecto\",
    \"color_title_subtitle3\": \"architecto\",
    \"color_vote_percent_donut_chart\": \"architecto\",
    \"color_graph\": [
        \"architecto\"
    ],
    \"is_generic\": false,
    \"open_questions_odd_line_color\": \"architecto\",
    \"open_questions_odd_line_text_color\": \"architecto\",
    \"open_questions_even_line_color\": \"architecto\",
    \"open_questions_even_line_text_color\": \"architecto\",
    \"prioritization_header_color\": \"architecto\",
    \"prioritization_header_text_color\": \"architecto\",
    \"prioritization_odd_line_color\": \"architecto\",
    \"prioritization_odd_line_text_color\": \"architecto\",
    \"prioritization_even_line_color\": \"architecto\",
    \"prioritization_even_line_text_color\": \"architecto\",
    \"color_questions_title\": \"architecto\"
}"

Example response :

{
    "message": "design updated!"
}

Delete report design

DELETE

http://localhost:8000

/api/v1/reportDesign/{reportDesignId}

requires authentication

Delete a specific report design

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reportDesignId

integer

required

id of report design

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/reportDesign/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "design deleted!"
}

Copy report design

POST

http://localhost:8000

/api/v1/reportDesign/{reportDesign}/copy

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reportDesign

integer

required

id of report design

Example:

Body Parameters

name

string

required

Example:

architecto

is_generic

boolean

required

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "architecto", "is_generic": false }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/reportDesign/1/copy" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"is_generic\": false
}"

Example response :

{
    "message": "copied"
}

Statistic Data

GET

http://localhost:8000

/api/v1/reportDesign/{reportDesign}/statisticData

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

reportDesign

integer

required

id of report design

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/reportDesign/1/statisticData" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "copied"
}

Sondage

Voter

endpoint for voter

POST

http://localhost:8000

/api/v1/login/anonymous/{token}/access

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

token

Example:

$394dqendiqenidqe

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/login/anonymous/4dqendiqenidqe/access" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "auth": [],
        "token": "token29933"
    }
}

POST

http://localhost:8000

/api/v1/login/nominative/{token}/access

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

token

Example:

$394dqendiqenidqe

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/login/nominative/4dqendiqenidqe/access" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "auth": [],
        "token": "token29933"
    }
}

POST

http://localhost:8000

/api/v1/login/nominative/{token}/accessRefusal

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

Jeton encodé pour identifiant votant nominatif

Example:

c29tZS10b2tlbg==

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/login/nominative/c29tZS10b2tlbg==/accessRefusal" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "auth": [],
        "token": "token29933"
    }
}

POST

http://localhost:8000

/api/v1/login/anonymous/{token}/accessRefusal

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

token

Example:

$394dqendiqenidqe

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/login/anonymous/4dqendiqenidqe/accessRefusal" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "auth": [],
        "token": "token29933"
    }
}

POST

http://localhost:8000

/api/v1/login/questionnaires/{token}/access

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

token

Example:

$394dqendiqenidqe

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/login/questionnaires/4dqendiqenidqe/access" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "auth": [],
        "token": "token29933"
    }
}

Update profile

POST

PUT

http://localhost:8000

/api/v1/dashboard/voters/profile/update

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

Must not be greater than 244 characters.

Example:

surname

string

Must not be greater than 244 characters.

Example:

password

string

if password is null then it is not consider otherwise you will fill password and password_confirmation
to update current password to value provided.

password_confirmation

string

generic_language_id

string

required

The id of an existing record in the languages table.

Example:

architecto

Auth

Bearer

Headers

Body

{ "name": "b", "surname": "n", "password": null, "password_confirmation": null, "generic_language_id": "architecto" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/dashboard/voters/profile/update" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"surname\": \"n\",
    \"generic_language_id\": \"architecto\"
}"

Example response :

{
    "message": "success",
    "status": 200
}

Regenerate vote

POST

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/access/{voterQuestionnaireId}/regenerate

requires authentication

Reset voter answers

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/questionnaires/1/access/1/regenerate" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

list all

GET

http://localhost:8000

/api/v1/voters/questionnaires/{questionnaireId}/voters

requires authentication

endpoint for voter list

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

companyId

integer

required

id of company

Example:

questionnaireId

integer

required

id of questionnaire

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/voters/questionnaires/1/voters" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": null,
            "email": null,
            "access_type_id": null,
            "status_id": null,
            "company_id": null,
            "created_at": null,
            "properties": [],
            "generic_language_id": null,
            "revert_deletion_type": null
        },
        {
            "id": null,
            "email": null,
            "access_type_id": null,
            "status_id": null,
            "company_id": null,
            "created_at": null,
            "properties": [],
            "generic_language_id": null,
            "revert_deletion_type": null
        }
    ]
}

create a new voter

POST

http://localhost:8000

/api/v1/voters/questionnaire/{questionnaireId}/store

requires authentication

endpoint for create new voter

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

accessType

string

required

type of access

Must be one of:

nominative
anonymous_auto_generated

Example:

nominative

Query Parameters

emailLang

string

required

lang of email

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

French

Body Parameters

string

required

Must be a valid email address. Must not be greater than 244 characters.

Example:

gbailey@example.net

questionnaire_id

string

required

The id of an existing record in the questionnaires table.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Query Parameters

Body

{ "email": "gbailey@example.net", "questionnaire_id": "architecto" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/voters/questionnaire/1/store?emailLang=French" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"gbailey@example.net\",
    \"questionnaire_id\": \"architecto\"
}"

Example response :

{
    "message": "success"
}

Append voter

POST

http://localhost:8000

/api/v1/voters/{voterId}/questionnaires/{questionnaireId}/append

requires authentication

append voter to add questionnaire

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

voterId

integer

required

id of the voter

Example:

questionnaireId

integer

required

id of questionnaire to add to

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/voters/1/questionnaires/1/append" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Remove voter

POST

http://localhost:8000

/api/v1/voters/questionnaires/{voterQuestionnaireId}/remove

requires authentication

remove voter from questionnaire

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

voterId

integer

required

id of the voter

Example:

questionnaireId

integer

required

id of questionnaire to add to

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/voters/questionnaires/1/remove" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Deactivate voter

POST

http://localhost:8000

/api/v1/voters/questionnaires/{voterQuestionnaireId}/deactivate

requires authentication

Deactivate a voter questionnaire

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

voterQuestionnaireId

integer

required

id of the voter questionnaire

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/voters/questionnaires/1/deactivate" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

delete voter

DELETE

http://localhost:8000

/api/v1/voters/questionnaires/voters/{voterQuestionnaireId}/delete

requires authentication

endpoint for delete voter

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

voterQuestionnaireId

integer

required

id of the voterQuestionnaireId

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/voters/questionnaires/voters/1/delete" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Join request | Delete voter

DELETE

http://localhost:8000

/api/v1/voters/joinedRequests/{voterJoinRequestId}/delete

requires authentication

Voter join request delete

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

voterJoinRequestId

integer

required

id of the joined request

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/voters/joinedRequests/1/delete" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Actions | Reactivate Vote Account

POST

http://localhost:8000

/api/v1/voters/{voterId}/{companyId}/reactivate

requires authentication

Reactivate a disabled voter account

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

voterId

integer

required

id of the voter

Example:

companyId

integer

required

id of the company

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/voters/1/10/reactivate" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Actions | Reactivate Vote Account

POST

http://localhost:8000

/api/v1/voters/requests/{voterJoinRequestId}/cannotRevertDeletion/restore

requires authentication

Reactivate a disabled voter account

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

voterId

integer

required

id of the voter

Example:

companyId

integer

required

id of the company

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/voters/requests/1/cannotRevertDeletion/restore" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Generate Access | Single voter

POST

http://localhost:8000

/api/v1/voters/questionnaires/{questionnaireId}/{voterQuestionnaireId}/generateAccess

requires authentication

Generate single access for a voter

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

string

required

The ID of the questionnaire

Example:

voterQuestionnaireId

string

required

The ID of the voter questionnaire

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/voters/questionnaires/1/1/generateAccess" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Voter | Store Validate Creation

POST

http://localhost:8000

/api/v1/voters/actions/creation/{token}/validate

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

token

string

required

the token received.

Example:

c8f2c08f-8337-3956-96b6-0f682f49fb6f

name

string

required

The name of the voter to be updated.

Example:

Danielle

generic_language

string

required

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

architecto

surname

string

required

Example:

architecto

privacy_policy

boolean

required

Must be accepted.

Example:

string

required

The email of the voter to be updated. The email of an existing record in the voters table.

Example:

blin.jeannine@example.org

password

string

required

The password of voter.

Example:

password

password_confirmation

string

Example:

password

Headers

Body

{ "token": "c8f2c08f-8337-3956-96b6-0f682f49fb6f", "name": "Danielle", "generic_language": "architecto", "surname": "architecto", "privacy_policy": true, "email": "blin.jeannine@example.org", "password": "password", "password_confirmation": "password" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/voters/actions/creation/{token}/validate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"c8f2c08f-8337-3956-96b6-0f682f49fb6f\",
    \"name\": \"Danielle\",
    \"generic_language\": \"architecto\",
    \"surname\": \"architecto\",
    \"privacy_policy\": true,
    \"email\": \"blin.jeannine@example.org\",
    \"password\": \"password\",
    \"password_confirmation\": \"password\"
}"

Example response :

{
    "message": "success",
    "status": 200
}

Voter Creation | Token Get data

GET

http://localhost:8000

/api/v1/voters/actions/creation/{token}/validate

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

token received in email creation for the voter

Example:

$eyIdkk030495fjxf940

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/voters/actions/creation/$eyIdkk030495fjxf940/validate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Voter Append | Token Get data

POST

http://localhost:8000

/api/v1/voters/actions/append/{token}/validate

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

token received in email creation for the voter

Example:

xjdejde

Body Parameters

token

string

required

the token received.

Example:

a4855dc5-0acb-33c3-b921-f4291f719ca0

name

string

required

The name of the voter to be updated.

Example:

Susanne

surname

string

required

Example:

architecto

string

required

The email of the voter to be updated.

Example:

desousa.gabrielle@example.com

password

string

required

The password of voter.

Example:

password

password_confirmation

string

Example:

password

generic_language

string

required

Must be one of:

French
English
Spanish
German
Portuguese
Chinese
Japanese
Italy
Russian
Dutch

Example:

Italy

Headers

URL Parameters

Body

{ "token": "a4855dc5-0acb-33c3-b921-f4291f719ca0", "name": "Susanne", "surname": "architecto", "email": "desousa.gabrielle@example.com", "password": "password", "password_confirmation": "password", "generic_language": "Italy" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/voters/actions/append/xjdejde/validate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"a4855dc5-0acb-33c3-b921-f4291f719ca0\",
    \"name\": \"Susanne\",
    \"surname\": \"architecto\",
    \"email\": \"desousa.gabrielle@example.com\",
    \"password\": \"password\",
    \"password_confirmation\": \"password\",
    \"generic_language\": \"Italy\"
}"

Example response :

{
    "message": "success",
    "status": 200
}

Actions | Token Get data

GET

http://localhost:8000

/api/v1/voters/actions/append/{token}/validate

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

token received in email creation for the voter

Example:

xjdejde

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/voters/actions/append/xjdejde/validate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Undo deletion by admin

POST

http://localhost:8000

/api/v1/voters/actions/delete/{token}/undo/by-admin

This endpoint undo deletion of endpoint make by the admin

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

string

required

Token Obtained after requesting deletion for the first 24 hours

Example:

$eyvjde93939399494kjndqeiudoqeduqe030

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/voters/actions/delete/$eyvjde93939399494kjndqeiudoqeduqe030/undo/by-admin" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Sondage | Vote

endpoint for vote

Vote | Get list of questions by page

GET

http://localhost:8000

/api/v1/vote/{pageNumber}

requires authentication

get list of questions

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

pageNumber

integer

required

page number of pagination

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/vote/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "questions": [],
        "metadata": {
            "current_page": 1,
            "last_page": 1,
            "per_page": 10,
            "total": 10
        }
    }
}

Create Vote answer

POST

http://localhost:8000

/api/v1/vote/{pageNumber}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

pageNumber

integer

required

page number of pagination

Example:

Body Parameters

items

object[]

question_item_id

integer

Example:

response_item_text

string

Must not be greater than 255 characters.

Example:

responses

object[]

response_item_type

string

Must be one of:

component
property

Example:

architecto

sub_questions

object[]

language

string

Must be one of:

fr
en
es
de
pt
cn
jp
it
ru
nl

Example:

architecto

navigation_direction

string

Must be one of:

next
prev

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "items": [ { "question_item_id": 16, "response_item_text": "n", "responses": [ { "response_item_id": 16, "response_item_value": 16, "response_item_order": 16 } ], "response_item_type": "architecto", "sub_questions": [ { "response_item_id": 16, "response_item_value": 16 } ] } ], "language": "architecto", "navigation_direction": "architecto" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/vote/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"language\": \"architecto\",
    \"navigation_direction\": \"architecto\",
    \"items\": [
        {
            \"question_item_id\": 16,
            \"response_item_text\": \"n\",
            \"responses\": [
                {
                    \"response_item_id\": 16,
                    \"response_item_value\": 16,
                    \"response_item_order\": 16
                }
            ],
            \"response_item_type\": \"architecto\",
            \"sub_questions\": [
                {
                    \"response_item_id\": 16,
                    \"response_item_value\": 16
                }
            ]
        }
    ]
}"

Example response :

{
    "message": "success",
    "status": 200
}

Decline Vote

POST

http://localhost:8000

/api/v1/vote/actions/deny

requires authentication

Decline a vote

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/vote/actions/deny" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Start Vote

POST

http://localhost:8000

/api/v1/vote/actions/startVote

requires authentication

Start a vote

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

language

string

Must be one of:

fr
en
es
de
pt
cn
jp
it
ru
nl

Example:

architecto

Auth

Bearer

Headers

Body

{ "language": "architecto" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/vote/actions/startVote" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"language\": \"architecto\"
}"

Example response :

{
    "message": "success",
    "status": 200
}

Vote | get all questions

GET

http://localhost:8000

/api/v1/vote/response/all

requires authentication

get list of questions

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/vote/response/all" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "questions": []
    }
}

Get One Link Resume Info

GET

http://localhost:8000

/api/v1/vote/oneLink/resume/{questionnaireToken}

requires authentication

Get One Link Resume Info

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireToken

string

required

Example:

architecto

Query Parameters

voter_questionnaire_id

integer

required

Example:

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/vote/oneLink/resume/architecto?voter_questionnaire_id=1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "questionnaire": {
            "id": 1,
            "title": "questionnaire title"
        },
        "auth": {
            "id": 1,
            "questionnaire": []
        }
    }
}

Manage Message

List all messages

GET

http://localhost:8000

/api/v1/dashboard/userRole/voters/voterMessages

requires authentication

Retrieve a list of all messages.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/dashboard/userRole/voters/voterMessages" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": null,
            "questionnaire_id": null,
            "sender_email": null,
            "subject": null,
            "message": null,
            "created_at": null,
            "updated_at": null,
            "is_read": false
        },
        {
            "id": null,
            "questionnaire_id": null,
            "sender_email": null,
            "subject": null,
            "message": null,
            "created_at": null,
            "updated_at": null,
            "is_read": false
        }
    ]
}

Show Message

GET

http://localhost:8000

/api/v1/dashboard/userRole/voters/voterMessages/{voterMessageId}

requires authentication

Show a specific message by ID

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

voterMessageId

integer

required

The ID of the voter message

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/dashboard/userRole/voters/voterMessages/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": null,
        "questionnaire_id": null,
        "sender_email": null,
        "subject": null,
        "message": null,
        "created_at": null,
        "updated_at": null,
        "is_read": false
    },
    "nextId": 1,
    "prevId": 2
}

Destroy Message

DELETE

http://localhost:8000

/api/v1/dashboard/userRole/voters/voterMessages/{voterMessageId}

requires authentication

Delete a specific message by ID

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

voterMessageId

integer

required

The ID of the voter message

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/dashboard/userRole/voters/voterMessages/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Count Messages

GET

http://localhost:8000

/api/v1/dashboard/userRole/voters/voterMessageCount

requires authentication

Count the number of messages.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/dashboard/userRole/voters/voterMessageCount" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "voter_messages_total_count": 3,
        "voter_messages_unread_count": 1
    }
}

Introductory Text

Introductory text sub groups

Upsert

POST

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/introductoryTexts

requires authentication

Store introductory texts

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

Body Parameters

items

object[]

required

content

string

Example:

architecto

is_visible

boolean

Example:

language_id

integer

required

The id of an existing record in the languages table.

Example:

type

string

required

Must be one of:

introduction
result
conclusion
method_concept
method_admin
general_informations
strengths_section
improvement_points
open_questions
development_plan

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Body

{ "items": [ { "content": "architecto", "is_visible": true, "language_id": 16, "type": "architecto" } ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/questionnaires/16/introductoryTexts" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": [
        {
            \"content\": \"architecto\",
            \"is_visible\": true,
            \"language_id\": 16,
            \"type\": \"architecto\"
        }
    ]
}"

Example response :

{
    "message": "success",
    "status": 200
}

Show

GET

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/introductoryTexts/{introductoryTextType}/translation/{languageId}

requires authentication

detail

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

introductoryTextType

string

required

Type of introductory text

Must be one of:

introduction
result
conclusion
method_concept
method_admin
general_informations
strengths_section
improvement_points
open_questions
development_plan

Example:

introduction

languageId

integer

required

id of language

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaires/16/introductoryTexts/introduction/translation/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": 1,
        "is_visible": true,
        "introductory_text_type_id": 6,
        "created_at": "2026-01-07T13:22:48.000000Z",
        "updated_at": "2026-01-07T13:22:48.000000Z",
        "introductory_type": {
            "id": 6,
            "label": "general_informations",
            "created_at": "2026-01-07T13:21:17.000000Z",
            "updated_at": "2026-01-07T13:21:17.000000Z"
        },
        "translation": {
            "id": 1,
            "language_id": 1,
            "value": "                   <p dir=\"ltr\" style=\"line-height:1.38;text-align: justify;background-color:#ffffff;margin-top:12pt;margin-bottom:0pt;padding:0pt 0pt 12pt 0pt;\"><span style=\"font-size:13.999999999999998pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:700;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\">Définition théorique du 360</span></p>\n    <p dir=\"ltr\" style=\"line-height:1.38;text-align: justify;background-color:#ffffff;margin-top:0pt;margin-bottom:12pt;\"><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\">L'évaluation 360° est un processus d'évaluation qui recueille des feedbacks de multiples sources dans votre entourage professionnel (par exemple : vos collègues, vos supérieurs, vos subordonnés, etc). Cette approche vous offre une vue d'ensemble de vos compétences et de votre comportement, en tenant compte de diverses perspectives. Voici comment l'évaluation 360° peut vous apporter une réelle valeur ajoutée :</span></p>\n    <ul style=\"margin-top:0;margin-bottom:0;padding-inline-start:48px;\">\n        <li dir=\"ltr\" style=\"list-style-type:disc;font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;\" aria-level=\"1\">\n            <p dir=\"ltr\" style=\"line-height:1.38;text-align: justify;background-color:#ffffff;margin-top:12pt;margin-bottom:0pt;\" role=\"presentation\"><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:700;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\">Une vision globale et équilibrée</span><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\"> : Vous recevez des retours variés qui vous permettent de mieux comprendre votre impact sur l'ensemble de votre environnement professionnel.</span></p>\n        </li>\n        <li dir=\"ltr\" style=\"list-style-type:disc;font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;\" aria-level=\"1\">\n            <p dir=\"ltr\" style=\"line-height:1.38;text-align: justify;background-color:#ffffff;margin-top:0pt;margin-bottom:0pt;\" role=\"presentation\"><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:700;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\">La reconnaissance de vos forces</span><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\"> : Les feedbacks que vous recevez vous permettent de prendre conscience de vos points forts et de les utiliser encore plus efficacement dans votre travail.</span></p>\n        </li>\n        <li dir=\"ltr\" style=\"list-style-type:disc;font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;\" aria-level=\"1\">\n            <p dir=\"ltr\" style=\"line-height:1.38;text-align: justify;background-color:#ffffff;margin-top:0pt;margin-bottom:0pt;\" role=\"presentation\"><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:700;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\">L’identification de vos axes d'amélioration</span><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\"> : Grâce aux observations constructives de vos collègues et collaborateurs, vous identifiez clairement les domaines où vous pouvez progresser.</span></p>\n        </li>\n        <li dir=\"ltr\" style=\"list-style-type:disc;font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;\" aria-level=\"1\">\n            <p dir=\"ltr\" style=\"line-height:1.38;text-align: justify;background-color:#ffffff;margin-top:0pt;margin-bottom:0pt;\" role=\"presentation\"><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:700;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\">L'amélioration de vos relations de travail</span><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\"> : Vous comprenez mieux l’effet de vos interactions sur les autres, ce qui vous permet d’ajuster votre approche pour renforcer la collaboration.</span></p>\n        </li>\n        <li dir=\"ltr\" style=\"list-style-type:disc;font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;\" aria-level=\"1\">\n            <p dir=\"ltr\" style=\"line-height:1.38;text-align: justify;background-color:#ffffff;margin-top:0pt;margin-bottom:0pt;\" role=\"presentation\"><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:700;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\">Un encouragement au développement personnel</span><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\"> : Ces retours vous permettent de définir des objectifs concrets pour votre développement, en vous appuyant sur des feedbacks précis.</span></p>\n        </li>\n        <li dir=\"ltr\" style=\"list-style-type:disc;font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;\" aria-level=\"1\">\n            <p dir=\"ltr\" style=\"line-height:1.38;text-align: justify;background-color:#ffffff;margin-top:0pt;margin-bottom:0pt;\" role=\"presentation\"><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:700;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\">Un alignement avec les attentes organisationnelles</span><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\"> : Vous adaptez votre performance et votre comportement pour mieux répondre aux attentes de votre équipe et de votre entreprise.</span></p>\n        </li>\n        <li dir=\"ltr\" style=\"list-style-type:disc;font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;\" aria-level=\"1\">\n            <p dir=\"ltr\" style=\"line-height:1.38;text-align: justify;background-color:#ffffff;margin-top:0pt;margin-bottom:0pt;padding:0pt 0pt 12pt 0pt;\" role=\"presentation\"><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:700;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\">Un renforcement de la transparence et de la confiance</span><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\"> : En participant à ce processus, vous contribuez à instaurer une culture de feedback continu et à renforcer la confiance au sein de votre organisation.</span></p>\n        </li>\n    </ul><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:700;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\">Un outil pour renforcer votre leadership</span><span style=\"font-size:11pt;font-family:Arial,sans-serif;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;\"> : Si vous êtes manager, l'évaluation 360° vous permet de comprendre comment votre leadership est perçu et de l'améliorer pour être encore plus efficace.</span>\n</strong></p>",
            "created_at": "2026-01-07T13:22:48.000000Z",
            "updated_at": "2026-01-07T13:22:48.000000Z"
        }
    }
}

Conditions

List

GET

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/conditions

requires authentication

Get introductory texts

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

Response Fields

integer

required

Unique identifier for the item.

required

boolean

required

Indicates if the question item is required.

questionnaire_id

integer

required

The ID of the associated questionnaire.

question_type_id

integer

required

The ID of the question type.

translations

array|null

required

Array of translations for the question item, or null if no translations are available.

question_type

object

theme

string|null

required

Theme of the question item, or null if none.

order

integer

required

Order of the question item.

manual_sliced

boolean

required

Indicates if the question item is manually sliced.

properties

object

components

object

updated_at

string

required

Timestamp of when the item was last updated, in ISO 8601 format.

target_conditions

string[]

required

Array of target conditions related to the question item.

target_condition_count

integer

required

Count of target conditions associated with the question item.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaires/16/conditions" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 2,
            "required": true,
            "questionnaire_id": 10,
            "question_type_id": 7,
            "translations": null,
            "translation": {
                "id": 1,
                "question_item_id": 2,
                "language_id": 1,
                "comment": null,
                "label": "Nom",
                "updated_at": "2026-01-07T13:21:18.000000Z"
            },
            "question_type": {
                "id": 7,
                "label": "open_question",
                "created_at": "2026-01-07T13:21:06.000000Z"
            },
            "theme": null,
            "order": 2,
            "manual_sliced": false,
            "updated_at": "2026-01-07T13:21:18.000000Z",
            "properties": [],
            "components": [],
            "target_condition_count": null,
            "source_condition_count": null,
            "question_answers_count": null
        },
        {
            "id": 2,
            "required": true,
            "questionnaire_id": 10,
            "question_type_id": 7,
            "translations": null,
            "translation": {
                "id": 1,
                "question_item_id": 2,
                "language_id": 1,
                "comment": null,
                "label": "Nom",
                "updated_at": "2026-01-07T13:21:18.000000Z"
            },
            "question_type": {
                "id": 7,
                "label": "open_question",
                "created_at": "2026-01-07T13:21:06.000000Z"
            },
            "theme": null,
            "order": 2,
            "manual_sliced": false,
            "updated_at": "2026-01-07T13:21:18.000000Z",
            "properties": [],
            "components": [],
            "target_condition_count": null,
            "source_condition_count": null,
            "question_answers_count": null
        }
    ]
}

Email Generated

description

Email Generated | List Email

GET

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/generatedEmails

requires authentication

Get all list email for a specific questionnaire in lastest saving language

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaires/1/generatedEmails" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "available_scopes": [
        "END_VOTE",
        "START_VOTE",
        "REMINDER_VOTE",
        "REFUSE_VOTE",
        "INACTIVE_VOTE"
    ],
    "emails": {
        "END_VOTE": {
            "subject": "Accès au rapport du Sondage isiQuest",
            "content": "...",
            "recipients": [],
            "language_id": 1,
            "description": "Cet email est déclenché par le passage d'un questionnaire en phase \"résultat\". Il est envoyé à l'administrateur du questionnaire ainsi qu'aux personnes renseignées par ce dernier.",
            "content_parameters": [
                "[TITRE]",
                "[URL]",
                "[CODE ACCESS]"
            ],
            "subject_parameters": []
        },
        "START_VOTE": {
            "subject": "subjet en",
            "content": "...",
            "recipients": [
                "lucchuala@gmail.com",
                "test@gmail.come"
            ],
            "language_id": 2,
            "description": "This email is triggered when a questionnaire enters the \"voting\" phase. It is sent to voters. Access Mode : \"Anonymous- Self-generated\", regardless of the e-mail generation configuration.",
            "content_parameters": [
                "[TITLE]",
                "[USER ACCOUNT]",
                "[DIRECT ACCESS URL BUTTON]",
                "[DECLINE VOTE BUTTON]",
                "[VOTING END DATE]"
            ],
            "subject_parameters": []
        },
        "REMINDER_VOTE": {
            "subject": "Relance participation à un Sondage isiQuest",
            "content": "...",
            "recipients": [],
            "language_id": 1,
            "description": "Cet email est déclenché par le passage à une des dates de relance d'un questionnaire. Il est envoyé aux votants. Modalité d'accès : \"Anonyme - Autogénéré\", peu importe la configuration de Génération d'email auto.",
            "content_parameters": [
                "[TITRE]",
                "[Compte Utilisateur]",
                "[DATE DE FIN DE VOTE]",
                "[BOUTON REFUS DE VOTE]",
                "[BOUTON URL ACCES DIRECT]"
            ],
            "subject_parameters": []
        },
        "REFUSE_VOTE": {
            "subject": "Refus de vote sondage isiQuest",
            "content": "...",
            "recipients": [],
            "language_id": 1,
            "description": "Cet email est déclenché par un refus de vote. Il est envoyé aux votants. Modalité d'accès : \"Nominatif - Autogénéré\" ou \"Anonyme - Autogénéré\", peu importe la configuration de Génération d'email auto.",
            "content_parameters": [
                "[TITRE]",
                "[Compte Utilisateur]"
            ],
            "subject_parameters": []
        },
        "INACTIVE_VOTE": {
            "subject": "Réactivation du Sondage isiQuest",
            "content": "...",
            "recipients": [],
            "language_id": 1,
            "description": "Cet email est déclenché par le passage d'un questionnaire en phase \"vote\" après avoir été en phase d'inactivité. Il est envoyé aux votants. Modalité d'accès : \"Anonyme Autogénéré\", peu importe la configuration de Génération d'email auto.",
            "content_parameters": [
                "[TITRE]",
                "[BOUTON URL ACCES DIRECT]",
                "[BOUTON REFUS DE VOTE]",
                "[DATE DE FIN DE VOTE]"
            ],
            "subject_parameters": []
        }
    },
    "questionnaire_id": 23
}

Email Generated | Update

POST

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/generatedEmails

requires authentication

Update all generated email for a questionnaire

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

Body Parameters

email_administration_language_id

integer

required

Example:

emails

object[]

required

scope

string

required

Must be one of:

START_VOTE
REFUSE_VOTE
INACTIVE_VOTE
REMINDER_VOTE
END_VOTE

Example:

architecto

language_id

integer

required

Example:

content

string

required

Example:

architecto

subject

string

required

Example:

architecto

recipients

string[]

Must be a valid email address.

Example:

["zbailey@example.net"]

Auth

Bearer

Headers

URL Parameters

Body

{ "email_administration_language_id": 16, "emails": [ { "scope": "architecto", "language_id": 16, "content": "architecto", "subject": "architecto", "recipients": [ "zbailey@example.net" ] } ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/questionnaires/1/generatedEmails" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email_administration_language_id\": 16,
    \"emails\": [
        {
            \"scope\": \"architecto\",
            \"language_id\": 16,
            \"content\": \"architecto\",
            \"subject\": \"architecto\",
            \"recipients\": [
                \"zbailey@example.net\"
            ]
        }
    ]
}"

Example response :

{
    "message": "success",
    "status": 200
}

Email Generated | Detail

GET

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/generatedEmails/{scope}/language/{languageId}/details

requires authentication

Get data about one specific generated email

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

languageId

integer

required

id of language

Example:

scope

string

required

Represent the scope of the email

Must be one of:

START_VOTE
REFUSE_VOTE
INACTIVE_VOTE
REMINDER_VOTE
END_VOTE

Example:

START_VOTE

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaires/1/generatedEmails/START_VOTE/language/1/details" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "subject": "subjet fr",
        "recipients": [
            "lucchuala@gmail.com",
            "test@gmail.come"
        ],
        "language_id": 1,
        "content": "content fr",
        "description": "Cet email est déclenché par le passage d'un questionnaire en phase \"vote\". Il est envoyé aux votants. Modalité d'accès : \"Anonyme - Autogénéré\", peu importe la configuration de Génération d'email auto.",
        "content_parameters": [
            "[TITRE]",
            "[Compte Utilisateur]",
            "[BOUTON URL ACCES DIRECT]",
            "[BOUTON REFUS DE VOTE]",
            "[DATE DE FIN DE VOTE]"
        ],
        "subject_parameters": []
    }
}

List Email Generated | Reset data

GET

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/generatedEmails/{scope}/language/{languageId}/defaultContent

requires authentication

Get default data email for a generated email

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

languageId

integer

required

id of language

Example:

scope

string

required

Represent the scope of the email

Must be one of:

START_VOTE
REFUSE_VOTE
INACTIVE_VOTE
REMINDER_VOTE
END_VOTE

Example:

START_VOTE

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaires/1/generatedEmails/START_VOTE/language/1/defaultContent" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

Email Generated | List email design

GET

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/emailDesigns

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

List questionnaire email designs

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaires/16/emailDesigns" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "name": "Classique",
            "image": "emailDesigns/1",
            "is_classic": true,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "image_link": "http://localhost:8000/storage/emailDesigns/1",
            "all_content_loaded": true
        },
        {
            "id": 1,
            "name": "Classique",
            "image": "emailDesigns/1",
            "is_classic": true,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "image_link": "http://localhost:8000/storage/emailDesigns/1",
            "all_content_loaded": true
        }
    ]
}

Email Generated | Store email design

POST

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/emailDesigns

requires authentication

Store questionnaire email design

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

Body Parameters

email_design_id

integer

required

The id of an existing record in the email_designs table.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "email_design_id": 16 }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/questionnaires/1/emailDesigns" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email_design_id\": 16
}"

Example response :

{
    "message": "success",
    "status": 200
}

Access

list all

GET

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/access/voters

requires authentication

endpoint for voter list

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

id of questionnaire

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaires/1/access/voters" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": null,
            "questionnaire_id": null,
            "voter_id": null,
            "status_id": null,
            "vote_status_id": null,
            "generate_email_at": null,
            "has_try_inactive": null,
            "start_vote_at": null,
            "created_at": null,
            "nominative_access_link": "",
            "updated_at": null,
            "access_link": "",
            "question_answers_count": null
        },
        {
            "id": null,
            "questionnaire_id": null,
            "voter_id": null,
            "status_id": null,
            "vote_status_id": null,
            "generate_email_at": null,
            "has_try_inactive": null,
            "start_vote_at": null,
            "created_at": null,
            "nominative_access_link": "",
            "updated_at": null,
            "access_link": "",
            "question_answers_count": null
        }
    ]
}

Text Scale

Text Scales operations here.

Text scales list

GET

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/textScales

requires authentication

The list of all text scales belonging to a user, plus the others where field PRIVATE=0, all with their translated components

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

paginate

integer

If pagination is needed, enter the number of elements per page

Example:

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaires/{questionnaireId}/textScales?paginate=1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "text_scales": [],
        "numeric_scales": []
    }
}

Show a Text scale

GET

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/textScales/{textScaleId}

requires authentication

Show a text scale with all it's compents' translations

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

textScaleId

integer

required

The id of the text scale to be showned

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaires/1/textScales/1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": {
        "id": 1,
        "is_private": false,
        "user_role_id": 1,
        "no_opinion": false,
        "is_active": true,
        "text_scale_items": [
            {
                "id": 1,
                "text_scale_id": 1,
                "order": 1,
                "text_scale_item_translations": [
                    {
                        "id": 1,
                        "text_scale_item_id": 1,
                        "language": {
                            "id": 1,
                            "name": "French",
                            "acronym": "fr"
                        },
                        "label": "OUI"
                    },
                    {
                        "id": 2,
                        "text_scale_item_id": 1,
                        "language": {
                            "id": 2,
                            "name": "English",
                            "acronym": "en"
                        },
                        "label": "YES"
                    },
                    {
                        "id": 3,
                        "text_scale_item_id": 1,
                        "language": {
                            "id": 3,
                            "name": "Spanish",
                            "acronym": "es"
                        },
                        "label": "OUI"
                    },
                    {
                        "id": 4,
                        "text_scale_item_id": 1,
                        "language": {
                            "id": 4,
                            "name": "German",
                            "acronym": "de"
                        },
                        "label": "OUI"
                    },
                    {
                        "id": 5,
                        "text_scale_item_id": 1,
                        "language": {
                            "id": 5,
                            "name": "Portuguese",
                            "acronym": "pt"
                        },
                        "label": "OUI"
                    },
                    {
                        "id": 6,
                        "text_scale_item_id": 1,
                        "language": {
                            "id": 6,
                            "name": "Chinese",
                            "acronym": "cn"
                        },
                        "label": "OUI"
                    },
                    {
                        "id": 7,
                        "text_scale_item_id": 1,
                        "language": {
                            "id": 7,
                            "name": "Japanese",
                            "acronym": "jp"
                        },
                        "label": "OUI"
                    },
                    {
                        "id": 8,
                        "text_scale_item_id": 1,
                        "language": {
                            "id": 8,
                            "name": "Italy",
                            "acronym": "it"
                        },
                        "label": "OUI"
                    },
                    {
                        "id": 9,
                        "text_scale_item_id": 1,
                        "language": {
                            "id": 9,
                            "name": "Russian",
                            "acronym": "ru"
                        },
                        "label": "OUI"
                    },
                    {
                        "id": 10,
                        "text_scale_item_id": 1,
                        "language": {
                            "id": 10,
                            "name": "Dutch",
                            "acronym": "nl"
                        },
                        "label": "OUI"
                    }
                ]
            },
            {
                "id": 2,
                "text_scale_id": 1,
                "order": 2,
                "text_scale_item_translations": [
                    {
                        "id": 16,
                        "text_scale_item_id": 2,
                        "language": {
                            "id": 1,
                            "name": "French",
                            "acronym": "fr"
                        },
                        "label": "NON"
                    },
                    {
                        "id": 17,
                        "text_scale_item_id": 2,
                        "language": {
                            "id": 2,
                            "name": "English",
                            "acronym": "en"
                        },
                        "label": "NO"
                    },
                    {
                        "id": 18,
                        "text_scale_item_id": 2,
                        "language": {
                            "id": 3,
                            "name": "Spanish",
                            "acronym": "es"
                        },
                        "label": "NON"
                    },
                    {
                        "id": 19,
                        "text_scale_item_id": 2,
                        "language": {
                            "id": 4,
                            "name": "German",
                            "acronym": "de"
                        },
                        "label": "NON"
                    },
                    {
                        "id": 20,
                        "text_scale_item_id": 2,
                        "language": {
                            "id": 5,
                            "name": "Portuguese",
                            "acronym": "pt"
                        },
                        "label": "NON"
                    },
                    {
                        "id": 21,
                        "text_scale_item_id": 2,
                        "language": {
                            "id": 6,
                            "name": "Chinese",
                            "acronym": "cn"
                        },
                        "label": "NON"
                    },
                    {
                        "id": 22,
                        "text_scale_item_id": 2,
                        "language": {
                            "id": 7,
                            "name": "Japanese",
                            "acronym": "jp"
                        },
                        "label": "NON"
                    },
                    {
                        "id": 23,
                        "text_scale_item_id": 2,
                        "language": {
                            "id": 8,
                            "name": "Italy",
                            "acronym": "it"
                        },
                        "label": "NON"
                    },
                    {
                        "id": 24,
                        "text_scale_item_id": 2,
                        "language": {
                            "id": 9,
                            "name": "Russian",
                            "acronym": "ru"
                        },
                        "label": "NON"
                    },
                    {
                        "id": 25,
                        "text_scale_item_id": 2,
                        "language": {
                            "id": 10,
                            "name": "Dutch",
                            "acronym": "nl"
                        },
                        "label": "NON"
                    }
                ]
            },
            {
                "id": 3,
                "text_scale_id": 1,
                "order": 3,
                "text_scale_item_translations": [
                    {
                        "id": 31,
                        "text_scale_item_id": 3,
                        "language": {
                            "id": 1,
                            "name": "French",
                            "acronym": "fr"
                        },
                        "label": "PEUT-ETRE"
                    },
                    {
                        "id": 32,
                        "text_scale_item_id": 3,
                        "language": {
                            "id": 2,
                            "name": "English",
                            "acronym": "en"
                        },
                        "label": "MAYBE"
                    },
                    {
                        "id": 33,
                        "text_scale_item_id": 3,
                        "language": {
                            "id": 3,
                            "name": "Spanish",
                            "acronym": "es"
                        },
                        "label": "PEUT-ETRE"
                    },
                    {
                        "id": 34,
                        "text_scale_item_id": 3,
                        "language": {
                            "id": 4,
                            "name": "German",
                            "acronym": "de"
                        },
                        "label": "PEUT-ETRE"
                    },
                    {
                        "id": 35,
                        "text_scale_item_id": 3,
                        "language": {
                            "id": 5,
                            "name": "Portuguese",
                            "acronym": "pt"
                        },
                        "label": "PEUT-ETRE"
                    },
                    {
                        "id": 36,
                        "text_scale_item_id": 3,
                        "language": {
                            "id": 6,
                            "name": "Chinese",
                            "acronym": "cn"
                        },
                        "label": "PEUT-ETRE"
                    },
                    {
                        "id": 37,
                        "text_scale_item_id": 3,
                        "language": {
                            "id": 7,
                            "name": "Japanese",
                            "acronym": "jp"
                        },
                        "label": "PEUT-ETRE"
                    },
                    {
                        "id": 38,
                        "text_scale_item_id": 3,
                        "language": {
                            "id": 8,
                            "name": "Italy",
                            "acronym": "it"
                        },
                        "label": "PEUT-ETRE"
                    },
                    {
                        "id": 39,
                        "text_scale_item_id": 3,
                        "language": {
                            "id": 9,
                            "name": "Russian",
                            "acronym": "ru"
                        },
                        "label": "PEUT-ETRE"
                    },
                    {
                        "id": 40,
                        "text_scale_item_id": 3,
                        "language": {
                            "id": 10,
                            "name": "Dutch",
                            "acronym": "nl"
                        },
                        "label": "PEUT-ETRE"
                    }
                ]
            }
        ]
    }
}

Store a Text scale

POST

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/textScales

requires authentication

Store a new text scale and it's translations

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

is_private

boolean

required

Example:

no_opinion

boolean

required

items

object[]

required

order

integer

required

Example:

translations

object[]

required

Auth

Bearer

Headers

Body

{ "is_private": true, "no_opinion": false, "items": [ { "order": 16, "translations": [ { "language_id": 16, "content": "architecto" } ] } ] }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/questionnaires/{questionnaireId}/textScales" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"is_private\": true,
    \"no_opinion\": false,
    \"items\": [
        {
            \"order\": 16,
            \"translations\": [
                {
                    \"language_id\": 16,
                    \"content\": \"architecto\"
                }
            ]
        }
    ]
}"

Example response :

{
    "message": "TextScale created!"
}

Update a Text scale

PUT

PATCH

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/textScales/{textScaleId}

requires authentication

Update a text scale in a single language

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

textScaleId

integer

required

Id of the text scale to be updated , must exist in the database

Example:

Body Parameters

is_private

boolean

required

no_opinion

boolean

required

Example:

language_id

integer

required

The id of an existing record in the languages table.

Example:

items

object[]

required

Auth

Bearer

Headers

URL Parameters

Body

{ "is_private": false, "no_opinion": true, "language_id": 16, "items": [ { "item_id": 16, "content": "architecto" } ] }

Received response

Example request:

curl --request PUT \
    "http://localhost:8000/api/v1/questionnaires/1/textScales/7" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"is_private\": false,
    \"no_opinion\": true,
    \"language_id\": 16,
    \"items\": [
        {
            \"item_id\": 16,
            \"content\": \"architecto\"
        }
    ]
}"

Example response :

{
    "message": "success",
    "status": 200
}

Delete a Text scale

DELETE

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/textScales/{textScaleId}

requires authentication

Delete a text scale and it's translations.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

textScaleId

integer

required

The id of the Text Scale to be deleted.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://localhost:8000/api/v1/questionnaires/1/textScales/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "message": "success",
    "status": 200
}

Export Text scales list

GET

http://localhost:8000

/api/v1/questionnaires/{questionnaireId}/textScales/export/{format}/{languageAcronym}

requires authentication

Export user textScales

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

format

string

required

The format of the file to export. Can be 'csv' or 'excel'. the default is 'csv'

Must be one of:

csv
xlsx

Example:

xlsx

languageAcronym

string

required

The platform language . Can be 'en' or 'fr'. the default is 'fr'

Must be one of:

csv
xlsx

Example:

xlsx

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/questionnaires/1/textScales/export/xlsx/xlsx" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

[Binary data] -

Visu

Module visu

Home

Visu | List of questionnaires

GET

http://localhost:8000

/api/v1/visu/home/questionnaires

requires authentication

List all questionnaires of the authenticated visu

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/visu/home/questionnaires" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 10,
            "start_date": "2026-01-07T13:21:18.000000Z",
            "end_date": "2026-01-08T13:21:18.000000Z",
            "phase_changed_at": null,
            "created_at": "2026-01-07T13:21:18.000000Z",
            "updated_at": "2026-01-07T13:21:18.000000Z",
            "email_administration_language_id": 1,
            "email_design_id": null,
            "language_id": 1,
            "last_slice_id": null,
            "phase_id": 2,
            "questionnaire_design_id": null,
            "slice_id": 1,
            "properties": {
                "max_voters": 500,
                "access_type_id": 1,
                "has_generated_email": false
            },
            "title": "Webinaire (Default)",
            "parsed_contents": {
                "title": {
                    "1": "Webinaire (Default)"
                }
            },
            "product": {
                "id": 1,
                "name": "survey",
                "image_url": null,
                "description": "sondage description"
            },
            "question_items_count": null,
            "access_type": {
                "id": 1,
                "name": "anonymous_one_link",
                "code": "ANONYMOUS_ONE_LINK"
            },
            "is_webinaire": false,
            "is_default_webinaire_questionnaire": true,
            "webinaire_link": "",
            "has_changed_phase_into_creation": 0,
            "has_email_generation": false,
            "one_link_access_url": "http://localhost:3000/actions/voter/signin/onelink/MTA=",
            "superadmin_has_access": true,
            "recommandation": null,
            "presentation": null,
            "voter_questionnaires_count": null,
            "refusal_voter_questionnaires_count": 0,
            "completed_voter_questionnaires_count": 0,
            "pending_voter_questionnaires_count": 0
        },
        {
            "id": 10,
            "start_date": "2026-01-07T13:21:18.000000Z",
            "end_date": "2026-01-08T13:21:18.000000Z",
            "phase_changed_at": null,
            "created_at": "2026-01-07T13:21:18.000000Z",
            "updated_at": "2026-01-07T13:21:18.000000Z",
            "email_administration_language_id": 1,
            "email_design_id": null,
            "language_id": 1,
            "last_slice_id": null,
            "phase_id": 2,
            "questionnaire_design_id": null,
            "slice_id": 1,
            "properties": {
                "max_voters": 500,
                "access_type_id": 1,
                "has_generated_email": false
            },
            "title": "Webinaire (Default)",
            "parsed_contents": {
                "title": {
                    "1": "Webinaire (Default)"
                }
            },
            "product": {
                "id": 1,
                "name": "survey",
                "image_url": null,
                "description": "sondage description"
            },
            "question_items_count": null,
            "access_type": {
                "id": 1,
                "name": "anonymous_one_link",
                "code": "ANONYMOUS_ONE_LINK"
            },
            "is_webinaire": false,
            "is_default_webinaire_questionnaire": true,
            "webinaire_link": "",
            "has_changed_phase_into_creation": 0,
            "has_email_generation": false,
            "one_link_access_url": "http://localhost:3000/actions/voter/signin/onelink/MTA=",
            "superadmin_has_access": true,
            "recommandation": null,
            "presentation": null,
            "voter_questionnaires_count": null,
            "refusal_voter_questionnaires_count": 0,
            "completed_voter_questionnaires_count": 0,
            "pending_voter_questionnaires_count": 0
        }
    ]
}

Statistic

Visu | Questionnaire global statistic

GET

http://localhost:8000

/api/v1/visu/questionnaires/{questionnaireId}/statistics

requires authentication

Get global statistic of a questionnaire

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

The id of the questionnaire

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/visu/questionnaires/1/statistics" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

Visu | Filter statistic

POST

http://localhost:8000

/api/v1/visu/questionnaires/{questionnaireId}/statistics/filter

requires authentication

Get statistic of a questionnaire with filter

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

The id of the questionnaire

Example:

Body Parameters

global_filters

object

required

answer_filters

object[]

question_item_id

integer

required

Example:

filtered_answers

object[]

required

sub_questions

object[]

layouts

object

required

Auth

Bearer

Headers

URL Parameters

Body

{ "global_filters": { "start_date": "2026-01-08T21:24:56", "end_date": "2052-02-01", "include_progress_voter": true }, "answer_filters": [ { "question_item_id": 16, "filtered_answers": [ { "key": 16, "value": "architecto" } ], "sub_questions": [ { "question_item_component_id": 16, "filtered_answers": [ { "key": "architecto", "value": "architecto" } ] } ] } ], "layouts": { "report_design_id": 16 } }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/visu/questionnaires/1/statistics/filter" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"global_filters\": {
        \"start_date\": \"2026-01-08T21:24:56\",
        \"end_date\": \"2052-02-01\",
        \"include_progress_voter\": true
    },
    \"layouts\": {
        \"report_design_id\": 16
    },
    \"answer_filters\": [
        {
            \"question_item_id\": 16,
            \"filtered_answers\": [
                {
                    \"key\": 16,
                    \"value\": \"architecto\"
                }
            ],
            \"sub_questions\": [
                {
                    \"question_item_component_id\": 16,
                    \"filtered_answers\": [
                        {
                            \"key\": \"architecto\",
                            \"value\": \"architecto\"
                        }
                    ]
                }
            ]
        }
    ]
}"

Print parameter

Print parameter | Get

POST

http://localhost:8000

/api/v1/visu/questionnaires/{questionnaireId}/printParameters

requires authentication

Get print parameter of a questionnaire

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

questionnaireId

integer

required

The id of the questionnaire

Example:

Body Parameters

logo

file

Represent the logo of the application. Must be an image. Must not be greater than 1024 kilobytes.

Example:

/tmp/phpMF2O5s

background_image

file

Must be an image. Must not be greater than 2048 kilobytes.

Example:

/tmp/phpkm4Li6

report_design_id

string

required

Represent the report design id for the questionnaire. The id of an existing record in the report_designs table.

Example:

architecto

subtitles

object[]

Must not have more than 3 items.

add_card_around_graph

string

required

Define if the graph will be surrounded by a card or not.

Example:

chart_settings

object[]

Represent the list of chart settings

single_choice: chart config: ["bar","pie"]

multiple_choice: chart config: ["bar","pie"]

numeric_choice: chart config: ["bar","pie"]

ranked_numeric: chart config: ["bar","pie"]

text_scale: chart config: ["column","pie"]

prioritization: chart config: ["statistic","statistic_rank"]

open_question: chart config: []

introductory_texts

object

introduction

string

Example:

architecto

result

string

Example:

architecto

conclusion

string

Example:

architecto

method_concept

string

Example:

architecto

method_admin

string

Example:

architecto

general_informations

string

Example:

architecto

strengths_section

string

Example:

architecto

improvement_points

string

Example:

architecto

open_questions

string

Example:

architecto

development_plan

string

Example:

architecto

should_validate_logo

string

should_validate_background_image

string

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/visu/questionnaires/1/printParameters" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "report_design_id=architecto"\
    --form "add_card_around_graph=1"\
    --form "introductory_texts[introduction]=architecto"\
    --form "introductory_texts[result]=architecto"\
    --form "introductory_texts[conclusion]=architecto"\
    --form "introductory_texts[method_concept]=architecto"\
    --form "introductory_texts[method_admin]=architecto"\
    --form "introductory_texts[general_informations]=architecto"\
    --form "introductory_texts[strengths_section]=architecto"\
    --form "introductory_texts[improvement_points]=architecto"\
    --form "introductory_texts[open_questions]=architecto"\
    --form "introductory_texts[development_plan]=architecto"\
    --form "subtitles[][order]=1"\
    --form "subtitles[][value]=architecto"\
    --form "logo=@/tmp/phpMF2O5s" \
    --form "background_image=@/tmp/phpkm4Li6"

Example response :

{
    "message": "success",
    "status": 200
}

Print parameter | Update

GET

http://localhost:8000

/api/v1/visu/questionnaires/{questionnaireId}/printParameters

requires authentication

Update print parameter of a questionnaire

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

questionnaireId

integer

required

The id of the questionnaire

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/visu/questionnaires/1/printParameters" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "Unauthenticated."
}

Webinaires

Webinaire | Questions List

GET

http://localhost:8000

/api/v1/webinaire/questionnaires/{questionnaireId}/questionItems

List of questions

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/webinaire/questionnaires/{questionnaireId}/questionItems" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

Headers


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

{
    "message": "App\\Http\\Controllers\\V1\\Webinaire\\Questions\\WebinaireQuestionItemController::index(): Argument #1 ($questionnaireId) must be of type int, string given, called in /var/www/html/vendor/laravel/framework/src/Illuminate/Routing/ControllerDispatcher.php on line 46",
    "exception": "TypeError",
    "file": "/var/www/html/app/Http/Controllers/V1/Webinaire/Questions/WebinaireQuestionItemController.php",
    "line": 38,
    "trace": [
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/ControllerDispatcher.php",
            "line": 46,
            "function": "index",
            "class": "App\\Http\\Controllers\\V1\\Webinaire\\Questions\\WebinaireQuestionItemController",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 265,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\ControllerDispatcher",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Route.php",
            "line": 211,
            "function": "runController",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 822,
            "function": "run",
            "class": "Illuminate\\Routing\\Route",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "Illuminate\\Routing\\{closure}",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Middleware/SubstituteBindings.php",
            "line": 50,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Routing\\Middleware\\SubstituteBindings",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/sanctum/src/Http/Middleware/EnsureFrontendRequestsAreStateful.php",
            "line": 26,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "Laravel\\Sanctum\\Http\\Middleware\\{closure}",
            "class": "Laravel\\Sanctum\\Http\\Middleware\\EnsureFrontendRequestsAreStateful",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 137,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/sanctum/src/Http/Middleware/EnsureFrontendRequestsAreStateful.php",
            "line": 25,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Laravel\\Sanctum\\Http\\Middleware\\EnsureFrontendRequestsAreStateful",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 137,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 821,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 800,
            "function": "runRouteWithinStack",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 764,
            "function": "runRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Routing/Router.php",
            "line": 753,
            "function": "dispatchToRoute",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 200,
            "function": "dispatch",
            "class": "Illuminate\\Routing\\Router",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 180,
            "function": "Illuminate\\Foundation\\Http\\{closure}",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/livewire/livewire/src/Features/SupportDisablingBackButtonCache/DisableBackButtonCacheMiddleware.php",
            "line": 19,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Livewire\\Features\\SupportDisablingBackButtonCache\\DisableBackButtonCacheMiddleware",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/ConvertEmptyStringsToNull.php",
            "line": 31,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\ConvertEmptyStringsToNull",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TransformsRequest.php",
            "line": 21,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/TrimStrings.php",
            "line": 51,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TransformsRequest",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\TrimStrings",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Http/Middleware/ValidatePostSize.php",
            "line": 27,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\ValidatePostSize",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/PreventRequestsDuringMaintenance.php",
            "line": 109,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\PreventRequestsDuringMaintenance",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Http/Middleware/HandleCors.php",
            "line": 61,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\HandleCors",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Http/Middleware/TrustProxies.php",
            "line": 58,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\TrustProxies",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Middleware/InvokeDeferredCallbacks.php",
            "line": 22,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Middleware\\InvokeDeferredCallbacks",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Http/Middleware/ValidatePathEncoding.php",
            "line": 26,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 219,
            "function": "handle",
            "class": "Illuminate\\Http\\Middleware\\ValidatePathEncoding",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Pipeline/Pipeline.php",
            "line": 137,
            "function": "Illuminate\\Pipeline\\{closure}",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 175,
            "function": "then",
            "class": "Illuminate\\Pipeline\\Pipeline",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Http/Kernel.php",
            "line": 144,
            "function": "sendRequestThroughRouter",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 256,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Http\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 249,
            "function": "callLaravelRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 86,
            "function": "makeApiCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Strategies/Responses/ResponseCalls.php",
            "line": 39,
            "function": "makeResponseCall",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 240,
            "function": "__invoke",
            "class": "Knuckles\\Scribe\\Extracting\\Strategies\\Responses\\ResponseCalls",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 165,
            "function": "iterateThroughStrategies",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Extracting/Extractor.php",
            "line": 97,
            "function": "fetchResponses",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 125,
            "function": "processRoute",
            "class": "Knuckles\\Scribe\\Extracting\\Extractor",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 72,
            "function": "extractEndpointsInfoFromLaravelApp",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/GroupedEndpoints/GroupedEndpointsFromApp.php",
            "line": 50,
            "function": "extractEndpointsInfoAndWriteToDisk",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/knuckleswtf/scribe/src/Commands/GenerateDocumentation.php",
            "line": 55,
            "function": "get",
            "class": "Knuckles\\Scribe\\GroupedEndpoints\\GroupedEndpointsFromApp",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 36,
            "function": "handle",
            "class": "Knuckles\\Scribe\\Commands\\GenerateDocumentation",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/Util.php",
            "line": 43,
            "function": "Illuminate\\Container\\{closure}",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 96,
            "function": "unwrapIfClosure",
            "class": "Illuminate\\Container\\Util",
            "type": "::"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/BoundMethod.php",
            "line": 35,
            "function": "callBoundMethod",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Container/Container.php",
            "line": 799,
            "function": "call",
            "class": "Illuminate\\Container\\BoundMethod",
            "type": "::"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 211,
            "function": "call",
            "class": "Illuminate\\Container\\Container",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/symfony/console/Command/Command.php",
            "line": 341,
            "function": "execute",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Console/Command.php",
            "line": 180,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Command\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/symfony/console/Application.php",
            "line": 1102,
            "function": "run",
            "class": "Illuminate\\Console\\Command",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/symfony/console/Application.php",
            "line": 356,
            "function": "doRunCommand",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/symfony/console/Application.php",
            "line": 195,
            "function": "doRun",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Console/Kernel.php",
            "line": 198,
            "function": "run",
            "class": "Symfony\\Component\\Console\\Application",
            "type": "->"
        },
        {
            "file": "/var/www/html/vendor/laravel/framework/src/Illuminate/Foundation/Application.php",
            "line": 1235,
            "function": "handle",
            "class": "Illuminate\\Foundation\\Console\\Kernel",
            "type": "->"
        },
        {
            "file": "/var/www/html/artisan",
            "line": 13,
            "function": "handleCommand",
            "class": "Illuminate\\Foundation\\Application",
            "type": "->"
        }
    ]
}

Webinaire | Participate to a vote

POST

http://localhost:8000

/api/v1/webinaire/questionnaires/{questionnaireId}/questionItems

Respond to a webinaire questions

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Example:

architecto

surname

string

required

Example:

architecto

phone_number

string

required

Example:

architecto

string

required

Must be a valid email address.

Example:

zbailey@example.net

Headers

Body

{ "name": "architecto", "surname": "architecto", "phone_number": "architecto", "email": "zbailey@example.net" }

Received response

Example request:

curl --request POST \
    "http://localhost:8000/api/v1/webinaire/questionnaires/{questionnaireId}/questionItems" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"surname\": \"architecto\",
    \"phone_number\": \"architecto\",
    \"email\": \"zbailey@example.net\"
}"

Example response :

{
    "message": "success",
    "status": 200
}

Coachs | List

GET

http://localhost:8000

/api/v1/webinaire/coachs

requires authentication

Get all coachs that matches webinaire rules

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/webinaire/coachs" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "id": 1,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "is_direct_child": 1,
            "role_id": 1,
            "status_id": 1,
            "formated_code": "SAdm20260107132106",
            "parent_id": null,
            "user": {
                "id": 1,
                "name": "yvan",
                "email": "ynguetse@gmail.com",
                "email_verified_at": "2026-01-07T13:21:06.000000Z",
                "surname": "Schneider",
                "address": "42, boulevard de Duhamel\n64544 Guibert",
                "city": "Lesage",
                "country": "VA",
                "po_box": "95141",
                "fix_phone": "04 08 58 96 89",
                "mobile_phone": "06 98 35 74 11",
                "fax": "+33 (0)1 68 97 72 78",
                "date_of_birth": null,
                "speciality": "Opérateur piquage",
                "society": "Hubert",
                "generic_language_id": null,
                "other_information": null,
                "created_at": "2026-01-07T13:21:06.000000Z",
                "updated_at": "2026-01-07T13:21:06.000000Z"
            },
            "act_as_global_admin": true,
            "voter_messages_count": null
        },
        {
            "id": 1,
            "created_at": "2026-01-07T13:21:06.000000Z",
            "updated_at": "2026-01-07T13:21:06.000000Z",
            "is_direct_child": 1,
            "role_id": 1,
            "status_id": 1,
            "formated_code": "SAdm20260107132106",
            "parent_id": null,
            "user": {
                "id": 1,
                "name": "yvan",
                "email": "ynguetse@gmail.com",
                "email_verified_at": "2026-01-07T13:21:06.000000Z",
                "surname": "Schneider",
                "address": "42, boulevard de Duhamel\n64544 Guibert",
                "city": "Lesage",
                "country": "VA",
                "po_box": "95141",
                "fix_phone": "04 08 58 96 89",
                "mobile_phone": "06 98 35 74 11",
                "fax": "+33 (0)1 68 97 72 78",
                "date_of_birth": null,
                "speciality": "Opérateur piquage",
                "society": "Hubert",
                "generic_language_id": null,
                "other_information": null,
                "created_at": "2026-01-07T13:21:06.000000Z",
                "updated_at": "2026-01-07T13:21:06.000000Z"
            },
            "act_as_global_admin": true,
            "voter_messages_count": null
        }
    ]
}

Coachs | Event Coached

GET

http://localhost:8000

/api/v1/webinaire/coachs/events

requires authentication

Return the list of all coached events

Headers

Authorization

Example:

Bearer {YOUR_AUTH_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

filter_type

string

The type of filter (date when event was created,date in title of events,number of inscriptions) to filter from

Must be one of:

hold_date
creation_date
inscription_number

Example:

hold_date

start_date

string

start date

Example:

2024-02-12

end_date

string

end date

Example:

2024-02-20

themes

string

filter by a specific theme

Must be one of:

Leadership
Leader
Entretien
Projet

Example:

Projet

paid_type

string

filter by type of paid

Must be one of:

free
paid

Example:

free

coach_id

integer

filter by coach id

Example:

Response Fields

events_count

integer

required

the number of events(questionnaires) that matches the filters values

Example:

coach

string[]

required

represent a item coach

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://localhost:8000/api/v1/webinaire/coachs/events?filter_type=hold_date&start_date=2024-02-12&end_date=2024-02-20&themes=Projet&paid_type=free&coach_id=1" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response :

{
    "data": [
        {
            "events_count": 1,
            "inscriptions_count": 1,
            "coach": {
                "id": 3,
                "name": "Olivie Durand",
                "surname": "Garcia",
                "email": "julien.claudine@example.net"
            }
        },
        {
            "events_count": 1,
            "inscriptions_count": 12,
            "coach": {
                "id": 4,
                "name": "Pierre Guyon",
                "surname": "Barthelemy",
                "email": "vincent54@example.com"
            }
        }
    ]
}