MENU navbar-image
bash javascript

Introduction

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

Base URL

http://localhost

Authenticating requests

This API is not authenticated.

Admin

List entities for admin

Example request:
curl --request GET \
    --get "http://localhost/api/admin/company" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/admin/company"
);

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

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

Example response (200):


{
"draw": 0,
"recordsTotal": 5,
"recordsFiltered": 5,
"data": [
{"id": 2, "name": "Company 2", "reseller_name": "Webbee Digital", "number_of_employees": 35, "created_at": "2021-07-19 09:16:37", "status": "active"},
{"id": 3, "name": "Company 3", "reseller_name": null, "number_of_employees": 12, "created_at": "2021-07-19 09:30:30", "status": "active"},
{"id": 4, "name": "Company 4", "reseller_name": null, "number_of_employees": 0, "created_at": "2021-07-20 06:53:14", "status": "active"},
{"id": 5, "name": "Company 5", "reseller_name": null, "number_of_employees": 0, "created_at": "2021-07-20 06:54:36", "status": "active"},
]
}
 

Request      

GET api/admin/{entity_type}

URL Parameters

entity_type  string  

entity type to be listed.

columns  string optional  

object[] required

data  string  

field name

name  string optional  

searchable  string optional  

bool Is it possible to filter by this column

orderable  string optional  

bool Is it possible to sort by this column

search  string optional  

array

regex  string optional  

bool is the search value a regex

value  string optional  

filter column by a this value

List admin users

Example request:
curl --request GET \
    --get "http://localhost/api/admin/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/admin/users"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "data": [
        {
            "id": 26,
            "name": "Eli DM",
            "email": "eli.demayo+c12@gmail.com",
            "created_at": "2021-07-29 09:13:09"
        }
    ]
}
 

Request      

GET api/admin/users

Create admin user

Example request:
curl --request POST \
    "http://localhost/api/admin/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"iwfkmhmghobhfazicddadnbmpvcobclzrrsttrbpmpvnqwtcwo\",
    \"email\": \"zzbgmizaxhtpjbnhaobuokldihznygfxxnkxkifmewctsvpdhcpktwufytahpkauulvgtxkzexdehbyihrgppyjipjlanplpmtlhloulqqncthehjvaxnsiwcsyjesmsieklknmeaigakrcivegqiprzpnoczysuveape\"
}"
const url = new URL(
    "http://localhost/api/admin/users"
);

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

let body = {
    "name": "iwfkmhmghobhfazicddadnbmpvcobclzrrsttrbpmpvnqwtcwo",
    "email": "zzbgmizaxhtpjbnhaobuokldihznygfxxnkxkifmewctsvpdhcpktwufytahpkauulvgtxkzexdehbyihrgppyjipjlanplpmtlhloulqqncthehjvaxnsiwcsyjesmsieklknmeaigakrcivegqiprzpnoczysuveape"
};

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

Example response (200):


{
    "email": "eli.demayo+a4@gmail.com",
    "name": "new user",
    "updated_at": "2021-08-03T11:38:42.000000Z",
    "created_at": "2021-08-03T11:38:42.000000Z",
    "id": 31,
    "profiles": []
}
 

Request      

POST api/admin/users

Body Parameters

name  string  

Must not be greater than 255 characters.

email  string  

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

Update admin user

Example request:
curl --request PUT \
    "http://localhost/api/admin/users/7" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ldrdvwuqcerwsfkqawqzcqvgbowozrvcvzsxkpsamokuqjwyoxxhbtgxyibowkvcmifpzgnhevbqsfsnpgswzeuuzbgolgnpwbexznjbicnfnwzccikhjxhebrchooiqdowsmleggitybfdvfpvidmvzkygtoviuppoiamkuqjqtvvvwfjdlpripiurwbathmj\",
    \"email\": \"zuqtrvadolydozcsjbtrsfkgekmgtcmcmhyoxzrrokmulmsxiyfcnbesuoigepuzwpbjdnrdsefueynkdkplzcsdvluipzuxxczbrthratnygdivispkrzlkhxqlw\"
}"
const url = new URL(
    "http://localhost/api/admin/users/7"
);

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

let body = {
    "name": "ldrdvwuqcerwsfkqawqzcqvgbowozrvcvzsxkpsamokuqjwyoxxhbtgxyibowkvcmifpzgnhevbqsfsnpgswzeuuzbgolgnpwbexznjbicnfnwzccikhjxhebrchooiqdowsmleggitybfdvfpvidmvzkygtoviuppoiamkuqjqtvvvwfjdlpripiurwbathmj",
    "email": "zuqtrvadolydozcsjbtrsfkgekmgtcmcmhyoxzrrokmulmsxiyfcnbesuoigepuzwpbjdnrdsefueynkdkplzcsdvluipzuxxczbrthratnygdivispkrzlkhxqlw"
};

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

Example response (200):


{
    "email": "eli.demayo+a4@gmail.com",
    "name": "new user",
    "updated_at": "2021-08-03T11:38:42.000000Z",
    "created_at": "2021-08-03T11:38:42.000000Z",
    "id": 31,
    "profiles": []
}
 

Request      

PUT api/admin/users/{user_id}

URL Parameters

user_id  integer  

The ID of the user.

Body Parameters

name  string  

Must not be greater than 255 characters.

email  string  

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

Get current logged in user/profile details

Example request:
curl --request GET \
    --get "http://localhost/api/admin/users/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/admin/users/4"
);

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

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

Example response (200):


{
    "id": 26,
    "name": "Eli DM",
    "email": "eli.demayo+c12@gmail.com",
    "email_verified_at": null,
    "created_at": "2021-07-29T09:13:09.000000Z",
    "updated_at": "2021-09-05T07:41:31.000000Z",
    "super_user": true,
    "language": null,
    "profiles": [
        {
            "id": 12,
            "user_id": 26,
            "entity_id": 13,
            "type_id": 1,
            "status": "active",
            "id_number": null,
            "email": null,
            "first_name": "Eli",
            "last_name": null,
            "business_name": null,
            "phone": null,
            "birth_date": null,
            "street_name": null,
            "house_number": null,
            "apartment_number": null,
            "city": null,
            "payment_method": null,
            "bank_number": null,
            "bank_branch_number": null,
            "bank_account_number": null,
            "policy_status": null,
            "policy_id": null,
            "policy_legal_number": null,
            "gender": null,
            "external_id": null,
            "payroll_id": null,
            "marital_status": "single",
            "direct_manager_id": null,
            "indirect_manager_id": null,
            "department_id": null,
            "role_id": null,
            "require_101": null,
            "language": "he",
            "legal_id": null,
            "website": null,
            "created_at": "2021-07-29T09:13:09.000000Z",
            "updated_at": "2021-08-29T07:13:02.000000Z",
            "tasks": [],
            "permissions": {
                "Company.Dashboard": 7,
                "Company.EmployeeManagement": 7,
                "Company.User.PersonalInfo": 7,
                "Company.User.RoleSettings": 7,
                "Company.User.Messages": 7,
                "Company.User.Documents": 7,
                "Company.User.Attachments": 7,
                "Company.User.Finance": 7,
                "Company.User.Status": 7,
                "Company.EmployeeForms": 7,
                "Company.LateForms": 7,
                "Company.101Report": 7,
                "Company.CustomerServiceReport": 7,
                "Company.TemplateForms": 7,
                "Company.CustomerService": 7,
                "Company.Settings.Company": 7,
                "Company.Settings.Onboarding": 7,
                "Company.Settings.Roles": 7,
                "Company.Settings.Departments": 7,
                "Company.Settings.ManagerUsers": 7,
                "Company.Settings.FeatureGroups": 7,
                "Company.Settings.Api": 7,
                "Company.Settings.QuickSend": 7,
                "Company.User.Equipment": 7,
                "Company.User.Training": 7,
                "Company.LeaveManagement": 7,
                "Company.Settings.Partners": 7,
                "Company.Partner.Documents": 7,
                "Company.Partners.Attachments": 7,
                "Company.Partner.Messages": 7,
                "Company.Partner.Profile": 7,
                "Company.User.EmploymentTerms": 7,
                "Employee.Messages": 7,
                "Employee.MyForms": 7,
                "Employee.WaitingForSign": 7,
                "Employee.PersonalInfo": 7,
                "Employee.Signature": 7,
                "Employee.RoleSettings": 7,
                "Employee.Attachments": 7,
                "Employee.Payslips": 7,
                "Employee.Password": 7,
                "Employee.CustomerService": 7,
                "Employee.Onboarding.EmailPhone": 7,
                "Employee.Onboarding.Address": 7,
                "Employee.Onboarding.Signature": 7,
                "Employee.Onboarding.Payments": 7,
                "Employee.Onboarding.Pension": 7,
                "Employee.Onboarding.Picture": 7,
                "Employee.LeaveManagement": 7
            },
            "current": true
        },
        {
            "id": 13,
            "status": "active",
            "first_name": "Moshe",
            "last_name": "Bakal",
            "current": false
        }
    ],
    "user_view": "admin"
}
 

Request      

GET api/admin/users/{user_id}

URL Parameters

user_id  integer  

The ID of the user.

Get company statistics

Example request:
curl --request GET \
    --get "http://localhost/api/admin/statistics/company" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/admin/statistics/company"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 18,
    "recordsFiltered": 18,
    "data": [
        {
            "id": 2,
            "name": "חברה",
            "resellelr_name": null,
            "created_at": "2021-07-19 09:16:37",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": null,
            "login_count": 0
        },
        {
            "id": 3,
            "name": "חברה",
            "resellelr_name": null,
            "created_at": "2021-07-19 09:30:30",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": null,
            "login_count": 0
        },
        {
            "id": 4,
            "name": "חברה",
            "resellelr_name": null,
            "created_at": "2021-07-20 06:53:14",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": null,
            "login_count": 0
        },
        {
            "id": 5,
            "name": "חברה",
            "resellelr_name": null,
            "created_at": "2021-07-20 06:54:36",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": null,
            "login_count": 0
        },
        {
            "id": 6,
            "name": "חברה",
            "resellelr_name": null,
            "created_at": "2021-07-20 06:58:46",
            "templates": 1,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": "2021-08-10 08:31:50",
            "login_count": 1
        },
        {
            "id": 7,
            "name": "חברה",
            "resellelr_name": null,
            "created_at": "2021-07-20 07:55:06",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": "2021-09-29 15:27:44",
            "login_count": 1
        },
        {
            "id": 8,
            "name": "חברה",
            "resellelr_name": null,
            "created_at": "2021-07-26 16:24:11",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": null,
            "login_count": 0
        },
        {
            "id": 9,
            "name": "חברה",
            "resellelr_name": null,
            "created_at": "2021-07-29 07:14:53",
            "templates": 0,
            "forms": 0,
            "contacts": "1",
            "employees": "0",
            "last_login": "2021-08-10 08:42:50",
            "login_count": 3
        },
        {
            "id": 10,
            "name": "חברה",
            "resellelr_name": null,
            "created_at": "2021-07-29 07:16:07",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": "2021-09-02 14:11:45",
            "login_count": 3
        },
        {
            "id": 11,
            "name": "חברה",
            "resellelr_name": "new name",
            "created_at": "2021-07-29 07:31:06",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": null,
            "login_count": 0
        },
        {
            "id": 12,
            "name": "חברה",
            "resellelr_name": null,
            "created_at": "2021-07-29 09:11:16",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "1",
            "last_login": null,
            "login_count": 0
        },
        {
            "id": 13,
            "name": "new name",
            "resellelr_name": null,
            "created_at": "2021-07-29 09:13:09",
            "templates": 3,
            "forms": 46,
            "contacts": "0",
            "employees": "5",
            "last_login": "2021-08-10 08:42:50",
            "login_count": 3
        },
        {
            "id": 14,
            "name": "New Company",
            "resellelr_name": "new name",
            "created_at": "2021-08-02 14:32:11",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": null,
            "login_count": 0
        },
        {
            "id": 17,
            "name": "חברה",
            "resellelr_name": "EasyDoc Main",
            "created_at": "2021-08-03 08:06:02",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": "2021-08-03 08:06:02",
            "login_count": 1
        },
        {
            "id": 19,
            "name": "2 חברה",
            "resellelr_name": "EasyDoc Main",
            "created_at": "2021-10-03 08:07:24",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": "2021-10-24 15:36:58",
            "login_count": 2
        },
        {
            "id": 20,
            "name": "2 חברה",
            "resellelr_name": "EasyDoc Main",
            "created_at": "2021-11-10 13:43:38",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": "2021-11-10 13:43:45",
            "login_count": 1
        },
        {
            "id": 21,
            "name": "2 חברה",
            "resellelr_name": "EasyDoc Main",
            "created_at": "2021-11-10 13:44:29",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": "2021-11-10 13:45:15",
            "login_count": 1
        },
        {
            "id": 22,
            "name": "2 חברה",
            "resellelr_name": "EasyDoc Main",
            "created_at": "2021-11-10 13:46:13",
            "templates": 0,
            "forms": 0,
            "contacts": "0",
            "employees": "0",
            "last_login": "2021-11-10 13:46:33",
            "login_count": 1
        }
    ]
}
 

Request      

GET api/admin/statistics/company

Authentication

Get current logged in user/profile details

Example request:
curl --request GET \
    --get "http://localhost/api/user/me" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/user/me"
);

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

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

Example response (200):


{
    "id": 26,
    "name": "Eli DM",
    "email": "eli.demayo+c12@gmail.com",
    "email_verified_at": null,
    "created_at": "2021-07-29T09:13:09.000000Z",
    "updated_at": "2021-09-05T07:41:31.000000Z",
    "super_user": true,
    "language": null,
    "profiles": [
        {
            "id": 12,
            "user_id": 26,
            "entity_id": 13,
            "type_id": 1,
            "status": "active",
            "id_number": null,
            "email": null,
            "first_name": "Eli",
            "last_name": null,
            "business_name": null,
            "phone": null,
            "birth_date": null,
            "street_name": null,
            "house_number": null,
            "apartment_number": null,
            "city": null,
            "payment_method": null,
            "bank_number": null,
            "bank_branch_number": null,
            "bank_account_number": null,
            "policy_status": null,
            "policy_id": null,
            "policy_legal_number": null,
            "gender": null,
            "external_id": null,
            "payroll_id": null,
            "marital_status": "single",
            "direct_manager_id": null,
            "indirect_manager_id": null,
            "department_id": null,
            "role_id": null,
            "require_101": null,
            "language": "he",
            "legal_id": null,
            "website": null,
            "created_at": "2021-07-29T09:13:09.000000Z",
            "updated_at": "2021-08-29T07:13:02.000000Z",
            "tasks": [],
            "permissions": {
                "Company.Dashboard": 7,
                "Company.EmployeeManagement": 7,
                "Company.User.PersonalInfo": 7,
                "Company.User.RoleSettings": 7,
                "Company.User.Messages": 7,
                "Company.User.Documents": 7,
                "Company.User.Attachments": 7,
                "Company.User.Finance": 7,
                "Company.User.Status": 7,
                "Company.EmployeeForms": 7,
                "Company.LateForms": 7,
                "Company.101Report": 7,
                "Company.CustomerServiceReport": 7,
                "Company.TemplateForms": 7,
                "Company.CustomerService": 7,
                "Company.Settings.Company": 7,
                "Company.Settings.Onboarding": 7,
                "Company.Settings.Roles": 7,
                "Company.Settings.Departments": 7,
                "Company.Settings.ManagerUsers": 7,
                "Company.Settings.FeatureGroups": 7,
                "Company.Settings.Api": 7,
                "Company.Settings.QuickSend": 7,
                "Company.User.Equipment": 7,
                "Company.User.Training": 7,
                "Company.LeaveManagement": 7,
                "Company.Settings.Partners": 7,
                "Company.Partner.Documents": 7,
                "Company.Partners.Attachments": 7,
                "Company.Partner.Messages": 7,
                "Company.Partner.Profile": 7,
                "Company.User.EmploymentTerms": 7,
                "Employee.Messages": 7,
                "Employee.MyForms": 7,
                "Employee.WaitingForSign": 7,
                "Employee.PersonalInfo": 7,
                "Employee.Signature": 7,
                "Employee.RoleSettings": 7,
                "Employee.Attachments": 7,
                "Employee.Payslips": 7,
                "Employee.Password": 7,
                "Employee.CustomerService": 7,
                "Employee.Onboarding.EmailPhone": 7,
                "Employee.Onboarding.Address": 7,
                "Employee.Onboarding.Signature": 7,
                "Employee.Onboarding.Payments": 7,
                "Employee.Onboarding.Pension": 7,
                "Employee.Onboarding.Picture": 7,
                "Employee.LeaveManagement": 7
            },
            "current": true
        },
        {
            "id": 13,
            "status": "active",
            "first_name": "Moshe",
            "last_name": "Bakal",
            "current": false
        }
    ],
    "user_view": "admin"
}
 

Request      

GET api/user/me

Set current user profile

Example request:
curl --request PUT \
    "http://localhost/api/user/profile" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"profile_id\": 15
}"
const url = new URL(
    "http://localhost/api/user/profile"
);

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

let body = {
    "profile_id": 15
};

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

Request      

PUT api/user/profile

Body Parameters

profile_id  integer  

API Login

Example request:
curl --request POST \
    "http://localhost/api/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"client_id\": \"sunt\",
    \"client_secret\": \"sed\",
    \"grant_type\": \"omnis\",
    \"username\": \"ratione\",
    \"password\": \"sit\"
}"
const url = new URL(
    "http://localhost/api/login"
);

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

let body = {
    "client_id": "sunt",
    "client_secret": "sed",
    "grant_type": "omnis",
    "username": "ratione",
    "password": "sit"
};

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

Example response (200):


{
    "token_type": "Bearer",
    "expires_in": 31536000,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5M2VhMjhhYy00ODJkLTQ1ZWQtYjBjNS04NTUxNWVmOWRiOWEiLCJqdGkiOiIyMzYwMWZjMzBkNzM5NDAyZTc1MzczNTM4YmJjNWFiNTMwYzE2OWYyZGQxMzYwZWNlODM2ZWI4OTYzMzE1M2RhMjFiNjNjZmJmM2IwYmQ2NyIsImlhdCI6MTYyNjkzOTc2MC42NDg0NDUsIm5iZiI6MTYyNjkzOTc2MC42NDg0NDksImV4cCI6MTY1ODQ3NTc2MC41OTI1MjcsInN1YiI6IjEiLCJzY29wZXMiOltdfQ.lO4dEFjtTCUGM0RZ2tC6-auJkHzfhTgk6Fb4NK_-yhS6tP0MJdi9KbHraWMRh-1STW6QQk9ymhuLrTVjAZfODgvoSAmPR7pmgeZsKJFX2t8t2mMoUATKuuCXFTt4478bdRFK2PEE14MwxuytJ1HDeaIrHfp6ypCbil8_U0T7hLW6anW0WqJThMRjOgM6HQ6uLScWnQKGuXqb0I2aqJzfvvspGhdrHz30oS_7-Fecu-i3cyBLzJrfsWFKjpb5Uj6HmlDk8qCR_eG7aazyBwxFhxKdiTuwFuEpwFARFaGRPVXv8ZpUmsWEpdnkeFOlggMFHnHhZmnURcKnamkb22JWjAfNUnxZt3EI8nWQ3oMe05Fk3YJzeBDCcqj20NKqJK8S-ZD1n1dIJvcxWYPP4GqKUT6S5859tn_xlDXwxKUKAJvXfwnj9Pvt5di2-avJ4FjhV5XzFO5VoYTcvy6nO81-7IDfw9CQsIRcGbUBuLJmdOEfY-ghZeOPeyNJlKHkd2N9WEOxYiZ-KnEiwRaTkcLizSV41XpkQqLdJ0tNxP9_EgIUlNdqPkFXpIXHDJPfymCD6okglGwZINgghdEh3ArxJfSHN2PtoUaswrxAKywczBpaYQhI4QKmuLMjXd-EaZSpvTGqGC-bWqJHiCEGNArvHszOuSgmwvPHob9DpqnizBw",
    "refresh_token": "def502002258ce848eabb806a0556fa18147eca56471cc29948769549d517d023b81c83a9d0502df7a1856b4765b8efce2bff3ccec34711ddb91544d77ce394ad78e60621e5dd796e7438dd2a49c0c062bbf95fd99ebb3973c7609158b7c1415df1aabf875bd538e7b0f77107545497aada0055c4b753c544a4a31ec99b753cb104b899ae05de1c6a386373a0c94c63b30a943efb1a89c2585455ffcde841d6ce561a040970e42be4fe84a9bf2b9ddc5fbceeeec3293924ee94e6ab68080652c7d8a1bb2dbacba495c2e5fe4c6355249da329074d64525c58868f699e8d528899f2776b1a556f9cfcaccb0eb9182d322fbfca631ae13fea57d033e1e189bb8ced62e17e9bc9d2e40e45dbba3951fcb2e46296e86e9fcafb6fbb74489b4739284f7d33aec309cede127bc196cb575297a763f9871e81169c429e8f5f0778dcc31efc901a4f1318d1a95f011e58ef3fb0b4af7c3b0556734fab608e7cf5e33048c103d89ba5cfa9baebb98616d08f58bc944f7c4dfd72545b4e37fb08b7af7854e3b470fce"
}
 

Request      

POST api/login

Body Parameters

client_id  string  

client_secret  string  

grant_type  string  

username  string  

password  string  

Register Entity (Company/Reseller) and create first user

Example request:
curl --request POST \
    "http://localhost/api/company/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"client_id\": \"lamnzaqvvrcucliwwmqvexikrlwwlmjdsqhklpadmxqifafhwudfcdozbmfbgbybbldfggrnyznsuedt\",
    \"client_secret\": \"ksnfmujecrgakdqrdlljmfzszkvyllwtqxqnvqvucbcxlxlwibrtzoihggxjmudwerbwgcdhfdomhaxdderqzlmgfmjntoatbefpcyquanbsudyuervwlsakyotrvpwowwittxxdbjjcrjrbha\",
    \"grant_type\": \"dolor\",
    \"name\": \"dafpmejocedgohsexqhejdpvvesyiqpcvftfmspjeqzhzoxxkkybfocqsesgmpcpdflluhpiespjzftpcgezzmdpcfmglvacrpdlfntaeznxjslamutkyywmipykabkfokzhdfmmpzmwnaejzufqaistswhu\",
    \"email\": \"wcmswmydefyqnswqvxpvptzqfsmihjkpsdkdeacikkfaljbfdcgsgeegivobubuedjytrdojtovyyviollopjykgmjvsazatjskfekgawsxbibuultlqzecmpkkudqthzpjobqktkuuantjyobufsnatvgmmmlloarmwupzixuiopusfizy\",
    \"password\": \"zffxcbh\",
    \"full_name\": \"uepiftnpvqmcuazdefiokdzpbjomtnpumydyawklwaqpokxrsjoowwoykxszikhdoxixpfttnfhzfvoaepctrlbanovpavhrctxbocqyepbmosdehxjvhgqpxcbhsftqkce\",
    \"phone\": \"dolor\"
}"
const url = new URL(
    "http://localhost/api/company/register"
);

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

let body = {
    "client_id": "lamnzaqvvrcucliwwmqvexikrlwwlmjdsqhklpadmxqifafhwudfcdozbmfbgbybbldfggrnyznsuedt",
    "client_secret": "ksnfmujecrgakdqrdlljmfzszkvyllwtqxqnvqvucbcxlxlwibrtzoihggxjmudwerbwgcdhfdomhaxdderqzlmgfmjntoatbefpcyquanbsudyuervwlsakyotrvpwowwittxxdbjjcrjrbha",
    "grant_type": "dolor",
    "name": "dafpmejocedgohsexqhejdpvvesyiqpcvftfmspjeqzhzoxxkkybfocqsesgmpcpdflluhpiespjzftpcgezzmdpcfmglvacrpdlfntaeznxjslamutkyywmipykabkfokzhdfmmpzmwnaejzufqaistswhu",
    "email": "wcmswmydefyqnswqvxpvptzqfsmihjkpsdkdeacikkfaljbfdcgsgeegivobubuedjytrdojtovyyviollopjykgmjvsazatjskfekgawsxbibuultlqzecmpkkudqthzpjobqktkuuantjyobufsnatvgmmmlloarmwupzixuiopusfizy",
    "password": "zffxcbh",
    "full_name": "uepiftnpvqmcuazdefiokdzpbjomtnpumydyawklwaqpokxrsjoowwoykxszikhdoxixpfttnfhzfvoaepctrlbanovpavhrctxbocqyepbmosdehxjvhgqpxcbhsftqkce",
    "phone": "dolor"
};

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

Example response (200):


{
    "token_type": "Bearer",
    "expires_in": 31536000,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5M2VhMjhhYy00ODJkLTQ1ZWQtYjBjNS04NTUxNWVmOWRiOWEiLCJqdGkiOiIyMzYwMWZjMzBkNzM5NDAyZTc1MzczNTM4YmJjNWFiNTMwYzE2OWYyZGQxMzYwZWNlODM2ZWI4OTYzMzE1M2RhMjFiNjNjZmJmM2IwYmQ2NyIsImlhdCI6MTYyNjkzOTc2MC42NDg0NDUsIm5iZiI6MTYyNjkzOTc2MC42NDg0NDksImV4cCI6MTY1ODQ3NTc2MC41OTI1MjcsInN1YiI6IjEiLCJzY29wZXMiOltdfQ.lO4dEFjtTCUGM0RZ2tC6-auJkHzfhTgk6Fb4NK_-yhS6tP0MJdi9KbHraWMRh-1STW6QQk9ymhuLrTVjAZfODgvoSAmPR7pmgeZsKJFX2t8t2mMoUATKuuCXFTt4478bdRFK2PEE14MwxuytJ1HDeaIrHfp6ypCbil8_U0T7hLW6anW0WqJThMRjOgM6HQ6uLScWnQKGuXqb0I2aqJzfvvspGhdrHz30oS_7-Fecu-i3cyBLzJrfsWFKjpb5Uj6HmlDk8qCR_eG7aazyBwxFhxKdiTuwFuEpwFARFaGRPVXv8ZpUmsWEpdnkeFOlggMFHnHhZmnURcKnamkb22JWjAfNUnxZt3EI8nWQ3oMe05Fk3YJzeBDCcqj20NKqJK8S-ZD1n1dIJvcxWYPP4GqKUT6S5859tn_xlDXwxKUKAJvXfwnj9Pvt5di2-avJ4FjhV5XzFO5VoYTcvy6nO81-7IDfw9CQsIRcGbUBuLJmdOEfY-ghZeOPeyNJlKHkd2N9WEOxYiZ-KnEiwRaTkcLizSV41XpkQqLdJ0tNxP9_EgIUlNdqPkFXpIXHDJPfymCD6okglGwZINgghdEh3ArxJfSHN2PtoUaswrxAKywczBpaYQhI4QKmuLMjXd-EaZSpvTGqGC-bWqJHiCEGNArvHszOuSgmwvPHob9DpqnizBw",
    "refresh_token": "def502002258ce848eabb806a0556fa18147eca56471cc29948769549d517d023b81c83a9d0502df7a1856b4765b8efce2bff3ccec34711ddb91544d77ce394ad78e60621e5dd796e7438dd2a49c0c062bbf95fd99ebb3973c7609158b7c1415df1aabf875bd538e7b0f77107545497aada0055c4b753c544a4a31ec99b753cb104b899ae05de1c6a386373a0c94c63b30a943efb1a89c2585455ffcde841d6ce561a040970e42be4fe84a9bf2b9ddc5fbceeeec3293924ee94e6ab68080652c7d8a1bb2dbacba495c2e5fe4c6355249da329074d64525c58868f699e8d528899f2776b1a556f9cfcaccb0eb9182d322fbfca631ae13fea57d033e1e189bb8ced62e17e9bc9d2e40e45dbba3951fcb2e46296e86e9fcafb6fbb74489b4739284f7d33aec309cede127bc196cb575297a763f9871e81169c429e8f5f0778dcc31efc901a4f1318d1a95f011e58ef3fb0b4af7c3b0556734fab608e7cf5e33048c103d89ba5cfa9baebb98616d08f58bc944f7c4dfd72545b4e37fb08b7af7854e3b470fce"
}
 

Request      

POST api/{entity_type}/register

URL Parameters

entity_type  string  

Body Parameters

client_id  string  

Must not be greater than 255 characters.

client_secret  string  

Must not be greater than 255 characters.

grant_type  string  

name  string  

Must not be greater than 255 characters.

email  string  

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

password  string optional  

This field is required when grant_type is password. Must be at least 8 characters.

token  string optional  

This field is required when grant_type is google_token.

full_name  string  

Must not be greater than 255 characters.

phone  string optional  

This field is required when grant_type is password.

Generate temporary login token for current user

Example request:
curl --request POST \
    "http://localhost/api/user/me/login-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/user/me/login-token"
);

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

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

Example response (200):


{
    "id": 3,
    "user_id": 37,
    "token": "RcnJaVdSbVdp9OSLH2XrJ3OZvlHGttyuZmCp",
    "expires_at": "2021-09-25T12:39:57.000000Z",
    "sent_platform": null,
    "created_at": "2021-09-15T12:39:57.000000Z",
    "updated_at": "2021-09-15T12:39:57.000000Z"
}
 

Request      

POST api/user/me/login-token

API logout

Example request:
curl --request PUT \
    "http://localhost/api/user/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/user/logout"
);

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

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

Example response (200):


{"message" => "token successfully revoked"}
 

Request      

PUT api/user/logout

Generate temporary login token with SMS

Example request:
curl --request POST \
    "http://localhost/api/user/sms-login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"identifier\": \"doloribus\"
}"
const url = new URL(
    "http://localhost/api/user/sms-login"
);

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

let body = {
    "identifier": "doloribus"
};

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

Example response (200):


{
    "user_id": 41,
    "token": "mVkKcPJ2O6KvpjzSb4976QHdqv97nRjB0ty5",
    "expires_at": "2021-11-03T15:36:14.000000Z",
    "sent_platform": "sms",
    "updated_at": "2021-10-24T15:36:14.000000Z",
    "created_at": "2021-10-24T15:36:14.000000Z",
    "id": 8
}
 

Request      

POST api/user/sms-login

Body Parameters

identifier  string  

Get current logged in user profiles

Example request:
curl --request GET \
    --get "http://localhost/api/user/profiles" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/user/profiles"
);

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

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

Example response (200):


[
    {
        "id": 12,
        "user_id": 26,
        "entity_id": 13,
        "type_id": 1,
        "status": "active",
        "id_number": null,
        "email": "eli.demayo+c24@gmail.com",
        "first_name": "Eli",
        "last_name": null,
        "business_name": null,
        "phone": null,
        "birth_date": null,
        "street_name": "חבצלת השרון",
        "house_number": "14",
        "apartment_number": "12",
        "city": null,
        "zip": "65789432",
        "payment_method": null,
        "bank_number": "45654545",
        "bank_branch_number": null,
        "bank_account_number": null,
        "policy_status": null,
        "policy_id": null,
        "policy_legal_number": null,
        "gender": null,
        "external_id": null,
        "payroll_id": null,
        "marital_status": "single",
        "direct_manager_id": 13,
        "indirect_manager_id": 13,
        "department_id": 2,
        "role_id": null,
        "features_group_id": null,
        "require_101": null,
        "language": "he",
        "legal_id": null,
        "website": null,
        "permission_group_id": "616bf3110135867cd56b1e91",
        "created_at": "2021-07-29T09:13:09.000000Z",
        "updated_at": "2021-11-22T15:33:23.000000Z",
        "info_id": null,
        "deleted_at": null,
        "entity": {
            "id": 13,
            "type": "company",
            "name": "new name"
        },
        "tasks": [],
        "permissions": {
            "Dashboard.*": false,
            "Employee-Management.Employee.create": true,
            "Employee-Management.Attachments.view": true,
            "Employee-Management.Attachments.upload": true,
            "Employee-Management.Attachments.update": false,
            "Employee-Management.Attachments.delete": true,
            "Employee-Management.Attachments.download": true,
            "Employee-Management.Role-Settings.update": true,
            "Employee-Management.Messages.list": true,
            "Employee-Management.Messages.view": true
        },
        "current": true
    },
    {
        "id": 13,
        "user_id": 26,
        "entity_id": 9,
        "type_id": 2,
        "status": "active",
        "id_number": null,
        "email": null,
        "first_name": "Moshe",
        "last_name": "Bakal",
        "business_name": null,
        "phone": null,
        "birth_date": null,
        "street_name": null,
        "house_number": null,
        "apartment_number": null,
        "city": "",
        "zip": null,
        "payment_method": null,
        "bank_number": null,
        "bank_branch_number": null,
        "bank_account_number": null,
        "policy_status": null,
        "policy_id": null,
        "policy_legal_number": null,
        "gender": null,
        "external_id": null,
        "payroll_id": null,
        "marital_status": "single",
        "direct_manager_id": null,
        "indirect_manager_id": null,
        "department_id": null,
        "role_id": null,
        "features_group_id": null,
        "require_101": null,
        "language": null,
        "legal_id": null,
        "website": null,
        "permission_group_id": null,
        "created_at": "2021-07-29T09:13:09.000000Z",
        "updated_at": "2021-07-29T09:13:09.000000Z",
        "info_id": null,
        "deleted_at": null,
        "entity": {
            "id": 9,
            "type": "company",
            "name": "חברה"
        },
        "tasks": [],
        "permissions": [],
        "current": false
    }
]
 

Request      

GET api/user/profiles

Boarding

List all Boarding processes

Example request:
curl --request GET \
    --get "http://localhost/api/entity/16/proc/boarding" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/16/proc/boarding"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 4,
    "recordsFiltered": 4,
    "data": [
        {
            "id": 1,
            "name": "New Boarding",
            "created_at": "2021-08-30T14:00:57.000000Z",
            "department_ids": null,
            "template_ids": [
                55,
                66,
                75
            ],
            "status": "active"
        },
        {
            "id": 3,
            "name": "New Boarding",
            "created_at": "2021-08-30T14:21:49.000000Z",
            "department_ids": null,
            "template_ids": [
                2
            ],
            "status": "active"
        },
        {
            "id": 4,
            "name": "New Boarding",
            "created_at": "2021-08-30T14:22:16.000000Z",
            "department_ids": null,
            "template_ids": [
                2
            ],
            "status": "active"
        },
        {
            "id": 5,
            "name": "New Boarding",
            "created_at": "2021-08-30T14:49:44.000000Z",
            "department_ids": [
                2
            ],
            "template_ids": [
                2
            ],
            "status": "active"
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/proc/boarding

URL Parameters

entity_id  integer  

The ID of the entity.

Create Onboarding process

Example request:
curl --request POST \
    "http://localhost/api/entity/6/proc/boarding" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vzhmkpfbayqbrnnbgphgypouxjbzwnvrupqejjrwquczuwqdvwuzmlvvzxxjorkebqfwsnxsqbbpjgcweulhkcppqnzsjrklvfndmmjldltluzbzeyfmdlpssafoqlljolyjbtjuyqbccuwameosdegcrcdtxbtayqbsffzccu\",
    \"department_ids\": [
        9
    ],
    \"template_ids\": [
        13
    ]
}"
const url = new URL(
    "http://localhost/api/entity/6/proc/boarding"
);

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

let body = {
    "name": "vzhmkpfbayqbrnnbgphgypouxjbzwnvrupqejjrwquczuwqdvwuzmlvvzxxjorkebqfwsnxsqbbpjgcweulhkcppqnzsjrklvfndmmjldltluzbzeyfmdlpssafoqlljolyjbtjuyqbccuwameosdegcrcdtxbtayqbsffzccu",
    "department_ids": [
        9
    ],
    "template_ids": [
        13
    ]
};

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

Example response (200):


{
    "name": "New Boarding",
    "template_ids": [
        2
    ],
    "department_ids": [
        2
    ],
    "entity_id": 13,
    "updated_at": "2021-08-30T14:49:44.000000Z",
    "created_at": "2021-08-30T14:49:44.000000Z",
    "id": 5
}
 

Request      

POST api/entity/{entity_id}/proc/boarding

URL Parameters

entity_id  integer  

The ID of the entity.

Body Parameters

name  string  

Must not be greater than 255 characters.

department_ids  integer[] optional  

template_ids  integer[] optional  

Update Onboarding process

Example request:
curl --request PUT \
    "http://localhost/api/entity/7/proc/boarding/7" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"xfobluonhwwmanxxfennqqlzwljvcvlaooxvslhlmrifgnouxiphsdndpgzumahkriljppxxqnxuofadafkmqrgoddmjgqjznj\",
    \"department_ids\": [
        11
    ],
    \"template_ids\": [
        13
    ]
}"
const url = new URL(
    "http://localhost/api/entity/7/proc/boarding/7"
);

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

let body = {
    "name": "xfobluonhwwmanxxfennqqlzwljvcvlaooxvslhlmrifgnouxiphsdndpgzumahkriljppxxqnxuofadafkmqrgoddmjgqjznj",
    "department_ids": [
        11
    ],
    "template_ids": [
        13
    ]
};

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

Example response (200):


{
    "name": "New Boarding",
    "template_ids": [
        2
    ],
    "department_ids": [
        2
    ],
    "entity_id": 13,
    "updated_at": "2021-08-30T14:49:44.000000Z",
    "created_at": "2021-08-30T14:49:44.000000Z",
    "id": 5
}
 

Request      

PUT api/entity/{entity_id}/proc/boarding/{proc_id}

URL Parameters

entity_id  integer  

The ID of the entity.

proc_id  integer  

The ID of the proc.

Body Parameters

name  string optional  

Must not be greater than 255 characters.

department_ids  integer[] optional  

template_ids  integer[] optional  

Delete Onboarding process

Example request:
curl --request DELETE \
    "http://localhost/api/entity/13/proc/boarding/20" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/13/proc/boarding/20"
);

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

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

Example response (200):


{
    "id": 2,
    "entity_id": 13,
    "name": "New name",
    "type": "onboarding",
    "status": "inactive",
    "department_ids": [
        2
    ],
    "template_ids": [
        3,
        2
    ],
    "created_at": "2021-08-30T14:02:37.000000Z",
    "updated_at": "2021-08-30T15:18:00.000000Z"
}
 

Request      

DELETE api/entity/{entity_id}/proc/boarding/{proc_id}

URL Parameters

entity_id  integer  

The ID of the entity.

proc_id  integer  

The ID of the proc.

Buckets

Get entity buckets usage

Example request:
curl --request GET \
    --get "http://localhost/api/entity/4/buckets/usage" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/4/buckets/usage"
);

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

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

Example response (200):


{
    "sms": {
        "used": 0,
        "total": 30,
        "entity_id": 13
    }
}
 

Request      

GET api/entity/{entity_id}/buckets/usage

URL Parameters

entity_id  integer  

The ID of the entity.

Company Stamp

Download company stamp

Example request:
curl --request GET \
    --get "http://localhost/api/entity/15/stamp" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/15/stamp"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/entity/{entity_id}/stamp

URL Parameters

entity_id  integer  

The ID of the entity.

Upload company stamp

Example request:
curl --request POST \
    "http://localhost/api/entity/10/stamp" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "stamp=@/tmp/php3UNiun" 
const url = new URL(
    "http://localhost/api/entity/10/stamp"
);

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

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

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

Example response (200):


{}
 

Request      

POST api/entity/{entity_id}/stamp

URL Parameters

entity_id  integer  

The ID of the entity.

Body Parameters

stamp  file  

Must be a file. Must not be greater than 512 kilobytes.

Conversations

List all entity conversations

Example request:
curl --request GET \
    --get "http://localhost/api/entity/9/conversations?columns[]=cupiditate&search[]=odio&search[value]=et&search[regex]=1&start=3&length=6&order[]=repudiandae&order[column]=quas&order[dir]=sit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/9/conversations"
);

const params = {
    "columns[]": "cupiditate",
    "search[]": "odio",
    "search[value]": "et",
    "search[regex]": "1",
    "start": "3",
    "length": "6",
    "order[]": "repudiandae",
    "order[column]": "quas",
    "order[dir]": "sit",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 2,
    "recordsFiltered": 2,
    "data": [
        {
            "id": 1,
            "updated_at": "2021-10-03 06:13:49",
            "created_at": "2021-09-30 10:52:04",
            "status": "in-progress",
            "reporter": {
                "id": 12,
                "name": "Eli"
            },
            "assignee": {
                "id": null,
                "name": null
            },
            "entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 2,
            "updated_at": "2021-09-30 10:53:39",
            "created_at": "2021-09-30 10:53:39",
            "status": "new",
            "reporter": {
                "id": 12,
                "name": "Eli"
            },
            "assignee": {
                "id": null,
                "name": null
            },
            "entity": {
                "id": 13,
                "name": "new name"
            }
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/conversations

URL Parameters

entity_id  integer  

The ID of the entity.

Query Parameters

columns  string[] optional  

List of columns definition

search  string[] optional  

general search definition

search[value]  string optional  

search value

search[regex]  boolean optional  

start  integer optional  

pagination start record number

length  integer optional  

pagination number of records

order  string[] optional  

sort definition

order[column]  string optional  

name of column to sort by

order[dir]  string optional  

sort direction DESC|ASC

Update Conversation

Example request:
curl --request PUT \
    "http://localhost/api/entity/7/conversations/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"minutes_spent\": 0
}"
const url = new URL(
    "http://localhost/api/entity/7/conversations/17"
);

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

let body = {
    "minutes_spent": 0
};

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

Example response (200):


{
    "id": 1,
    "reporter_id": 12,
    "entity_id": 13,
    "assignee_id": null,
    "status": "in-progress",
    "minutes_spent": 0,
    "category": null,
    "created_at": "2021-09-30T10:52:04.000000Z",
    "updated_at": "2021-10-03T06:13:49.000000Z",
    "messages": [
        {
            "id": 1,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "update",
            "content": {
                "type": "change_status",
                "value": "new",
                "before": "closed"
            },
            "created_at": "2021-09-30T14:09:12.000000Z",
            "updated_at": "2021-09-30T14:09:12.000000Z"
        },
        {
            "id": 2,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "update",
            "content": {
                "type": "change_status",
                "value": "closed",
                "before": "new"
            },
            "created_at": "2021-09-30T14:10:45.000000Z",
            "updated_at": "2021-09-30T14:10:45.000000Z"
        },
        {
            "id": 3,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-03T06:13:49.000000Z",
            "updated_at": "2021-10-03T06:13:49.000000Z"
        }
    ]
}
 

Request      

PUT api/entity/{entity_id}/conversations/{conversation_id}

URL Parameters

entity_id  integer optional  

entity ID

conversation_id  integer optional  

conversation ID

Body Parameters

status  string optional  

minutes_spent  integer optional  

Must be at least 0.

Add conversation message

Example request:
curl --request POST \
    "http://localhost/api/entity/17/conversations/19" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"sender\": {
        \"id\": 13
    },
    \"contentType\": \"est\",
    \"content\": [
        \"aspernatur\"
    ]
}"
const url = new URL(
    "http://localhost/api/entity/17/conversations/19"
);

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

let body = {
    "sender": {
        "id": 13
    },
    "contentType": "est",
    "content": [
        "aspernatur"
    ]
};

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

Example response (200):


{
    "id": 3,
    "ticket_id": 1,
    "sender_id": 12,
    "type": "text",
    "content": {
        "text": "hello"
    },
    "created_at": "2021-10-03T06:13:49.000000Z",
    "updated_at": "2021-10-03T06:13:49.000000Z"
}
 

Request      

POST api/entity/{entity_id}/conversations/{conversation_id}

URL Parameters

entity_id  integer  

The ID of the entity.

conversation_id  integer optional  

Conversation ID

Body Parameters

sender  object optional  

sender.id  integer optional  

contentType  string  

content  string[]  

Delete conversation message

Example request:
curl --request DELETE \
    "http://localhost/api/entity/13/conversations/repudiandae/message/14" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/13/conversations/repudiandae/message/14"
);

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

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

Request      

DELETE api/entity/{entity_id}/conversations/{conversation_id}/message/{message_id}

URL Parameters

entity_id  integer  

The ID of the entity.

conversation_id  string  

The ID of the conversation.

message_id  integer  

The ID of the message.

Get conversation message

Example request:
curl --request GET \
    --get "http://localhost/api/entity/8/conversations/15/message/10" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/8/conversations/15/message/10"
);

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

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

Example response (200):


{
    "id": 3,
    "ticket_id": 1,
    "sender_id": 12,
    "type": "text",
    "content": {
        "text": "hello"
    },
    "created_at": "2021-10-03T06:13:49.000000Z",
    "updated_at": "2021-10-03T06:13:49.000000Z"
}
 

Request      

GET api/entity/{entity_id}/conversations/{conversation_id}/message/{message_id}

URL Parameters

entity_id  integer  

The ID of the entity.

conversation_id  integer optional  

Conversation ID

message_id  integer optional  

message_id

List all profile conversations

Example request:
curl --request GET \
    --get "http://localhost/api/profile/18116/conversations?columns[]=dolorem&search[]=aspernatur&search[value]=assumenda&search[regex]=1&start=17&length=7&order[]=et&order[column]=eaque&order[dir]=dolorem" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/18116/conversations"
);

const params = {
    "columns[]": "dolorem",
    "search[]": "aspernatur",
    "search[value]": "assumenda",
    "search[regex]": "1",
    "start": "17",
    "length": "7",
    "order[]": "et",
    "order[column]": "eaque",
    "order[dir]": "dolorem",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 2,
    "recordsFiltered": 2,
    "data": [
        {
            "id": 1,
            "updated_at": "2021-10-03 06:13:49",
            "created_at": "2021-09-30 10:52:04",
            "status": "in-progress",
            "reporter": {
                "id": 12,
                "name": "Eli"
            },
            "assignee": {
                "id": null,
                "name": null
            },
            "entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 2,
            "updated_at": "2021-09-30 10:53:39",
            "created_at": "2021-09-30 10:53:39",
            "status": "new",
            "reporter": {
                "id": 12,
                "name": "Eli"
            },
            "assignee": {
                "id": null,
                "name": null
            },
            "entity": {
                "id": 13,
                "name": "new name"
            }
        }
    ]
}
 

Request      

GET api/profile/{profile_id}/conversations

URL Parameters

profile_id  integer  

The ID of the profile.

Query Parameters

columns  string[] optional  

List of columns definition

search  string[] optional  

general search definition

search[value]  string optional  

search value

search[regex]  boolean optional  

start  integer optional  

pagination start record number

length  integer optional  

pagination number of records

order  string[] optional  

sort definition

order[column]  string optional  

name of column to sort by

order[dir]  string optional  

sort direction DESC|ASC

Entity conversation report

Example request:
curl --request GET \
    --get "http://localhost/api/entity/14/conversations/report" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/14/conversations/report"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 2,
    "recordsFiltered": 2,
    "data": [
        {
            "total_tickets": 2,
            "minutes_total": "0",
            "minutes_spent": "0.0000",
            "rep": {
                "id": null,
                "name": null
            },
            "entity": {
                "id": 13,
                "name": "new name"
            }
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/conversations/report

URL Parameters

entity_id  integer  

The ID of the entity.

Get conversation

Example request:
curl --request GET \
    --get "http://localhost/api/entity/2/conversations/19" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/2/conversations/19"
);

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

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

Example response (200):


{
    "id": 1,
    "reporter_id": 12,
    "entity_id": 13,
    "assignee_id": 16,
    "status": "in-progress",
    "minutes_spent": 0,
    "category": null,
    "created_at": "2021-09-30T10:52:04.000000Z",
    "updated_at": "2021-10-03T06:13:49.000000Z",
    "messages": [
        {
            "id": 1,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "update",
            "content": {
                "type": "change_status",
                "value": "new",
                "before": "closed"
            },
            "created_at": "2021-09-30T14:09:12.000000Z",
            "updated_at": "2021-09-30T14:09:12.000000Z"
        },
        {
            "id": 2,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "update",
            "content": {
                "type": "change_status",
                "value": "closed",
                "before": "new"
            },
            "created_at": "2021-09-30T14:10:45.000000Z",
            "updated_at": "2021-09-30T14:10:45.000000Z"
        },
        {
            "id": 3,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-03T06:13:49.000000Z",
            "updated_at": "2021-10-03T06:13:49.000000Z"
        },
        {
            "id": 5,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-03T14:25:55.000000Z",
            "updated_at": "2021-10-03T14:25:55.000000Z"
        },
        {
            "id": 6,
            "ticket_id": 1,
            "sender_id": 16,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-03T14:27:14.000000Z",
            "updated_at": "2021-10-03T14:27:14.000000Z"
        },
        {
            "id": 7,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-12T06:31:58.000000Z",
            "updated_at": "2021-10-12T06:31:58.000000Z"
        },
        {
            "id": 8,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-12T07:38:44.000000Z",
            "updated_at": "2021-10-12T07:38:44.000000Z"
        },
        {
            "id": 9,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-12T07:39:40.000000Z",
            "updated_at": "2021-10-12T07:39:40.000000Z"
        },
        {
            "id": 10,
            "ticket_id": 1,
            "sender_id": 16,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-12T07:41:15.000000Z",
            "updated_at": "2021-10-12T07:41:15.000000Z"
        },
        {
            "id": 11,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-12T07:42:15.000000Z",
            "updated_at": "2021-10-12T07:42:15.000000Z"
        },
        {
            "id": 12,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-12T07:45:52.000000Z",
            "updated_at": "2021-10-12T07:45:52.000000Z"
        },
        {
            "id": 13,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-12T07:46:15.000000Z",
            "updated_at": "2021-10-12T07:46:15.000000Z"
        },
        {
            "id": 14,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-12T07:54:33.000000Z",
            "updated_at": "2021-10-12T07:54:33.000000Z"
        },
        {
            "id": 16,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-14T06:46:45.000000Z",
            "updated_at": "2021-10-14T06:46:45.000000Z"
        },
        {
            "id": 17,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-14T06:48:28.000000Z",
            "updated_at": "2021-10-14T06:48:28.000000Z"
        },
        {
            "id": 18,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-14T06:49:04.000000Z",
            "updated_at": "2021-10-14T06:49:04.000000Z"
        },
        {
            "id": 19,
            "ticket_id": 1,
            "sender_id": 12,
            "type": "text",
            "content": {
                "text": "hello"
            },
            "created_at": "2021-10-14T06:52:21.000000Z",
            "updated_at": "2021-10-14T06:52:21.000000Z"
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/conversations/{conversation_id}

URL Parameters

entity_id  integer  

The ID of the entity.

conversation_id  integer optional  

Conversation ID

Create new conversation

Example request:
curl --request POST \
    "http://localhost/api/profile/17/conversations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"assignee\": {
        \"id\": 16
    }
}"
const url = new URL(
    "http://localhost/api/profile/17/conversations"
);

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

let body = {
    "assignee": {
        "id": 16
    }
};

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

Example response (200):


{
    "id": 1,
    "reporter_id": 12,
    "entity_id": 13,
    "assignee_id": null,
    "status": "in-progress",
    "minutes_spent": 0,
    "category": null,
    "created_at": "2021-09-30T10:52:04.000000Z",
    "updated_at": "2021-10-03T06:13:49.000000Z",
    "messages": []
}
 

Request      

POST api/profile/{profile_id}/conversations

URL Parameters

profile_id  integer optional  

Reporter profile ID

Body Parameters

assignee  object optional  

assignee.id  integer optional  

Departments

List all entity departments

Example request:
curl --request GET \
    --get "http://localhost/api/entity/13/departments?columns[]=eos&search[]=consequatur&search[value]=quidem&search[regex]=&start=7&length=12&order[]=atque&order[column]=eum&order[dir]=alias" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/13/departments"
);

const params = {
    "columns[]": "eos",
    "search[]": "consequatur",
    "search[value]": "quidem",
    "search[regex]": "0",
    "start": "7",
    "length": "12",
    "order[]": "atque",
    "order[column]": "eum",
    "order[dir]": "alias",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "data": [
        {
            "id": 1,
            "name": "New Department",
            "number_of_employees": 0,
            "parent_id": null,
            "external_id": null,
            "parent_name": null,
            "created_at": "2021-08-25 10:09:43"
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/departments

URL Parameters

entity_id  integer  

The ID of the entity.

Query Parameters

columns  string[] optional  

List of columns definition

search  string[] optional  

general search definition

search[value]  string optional  

search value

search[regex]  boolean optional  

start  integer optional  

pagination start record number

length  integer optional  

pagination number of records

order  string[] optional  

sort definition

order[column]  string optional  

name of column to sort by

order[dir]  string optional  

sort direction DESC|ASC

Create new entity Department

Example request:
curl --request POST \
    "http://localhost/api/entity/15/departments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"oixnyltvtxiqkczajrfothkulexnkbwqyuvnlykhdobysytcxdvknsyymzeyuqcwbmsxcbnunlaxenzhxwwobgusqlgryzpqsvpnxxflirmmbdvyjtrcwpqnpjewxmgf\",
    \"parent_id\": 18,
    \"external_id\": \"wysqrlmgyidjbafubvknbidmjoqegewyieswsvcyeohnugasswaujjjeyqfsfdwmichzualnkriyphxjpdndlkxmiknqsylmyujmziznxtzingvzamiwntxgoygpekhiradehshhuknheystjckatzzfsvrvsirhkygzufrxouccoccgttwkawnucxngibnndgznnl\",
    \"head_profile_id\": 1
}"
const url = new URL(
    "http://localhost/api/entity/15/departments"
);

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

let body = {
    "name": "oixnyltvtxiqkczajrfothkulexnkbwqyuvnlykhdobysytcxdvknsyymzeyuqcwbmsxcbnunlaxenzhxwwobgusqlgryzpqsvpnxxflirmmbdvyjtrcwpqnpjewxmgf",
    "parent_id": 18,
    "external_id": "wysqrlmgyidjbafubvknbidmjoqegewyieswsvcyeohnugasswaujjjeyqfsfdwmichzualnkriyphxjpdndlkxmiknqsylmyujmziznxtzingvzamiwntxgoygpekhiradehshhuknheystjckatzzfsvrvsirhkygzufrxouccoccgttwkawnucxngibnndgznnl",
    "head_profile_id": 1
};

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

Example response (200):


{
    "name": "New Department",
    "parent_id": null,
    "external_id": null,
    "head_profile_id": null,
    "entity_id": 13,
    "updated_at": "2021-08-25T10:09:43.000000Z",
    "created_at": "2021-08-25T10:09:43.000000Z",
    "id": 1
}
 

Request      

POST api/entity/{entity_id}/departments

URL Parameters

entity_id  integer  

The ID of the entity.

Body Parameters

name  string  

Must not be greater than 255 characters.

parent_id  integer optional  

external_id  string optional  

Must not be greater than 255 characters.

head_profile_id  integer optional  

Update entity Department

Example request:
curl --request PUT \
    "http://localhost/api/entity/8/departments/20" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"qfsnufymkkutpcumgybesahxrzlrgjzkjfxuigmjihbkzdqfffamimqqfkvzsncrdexvokwnwxyyxxszbqjyznmvcnjapvvkuuwojxereeadmwhyhhfecrnqzldfylhoqevrnzjkruafpilovsxhkysgaaabdstkdibzhiuozmkotgvoyoahumgperiqymbgvffgwjanxzcpagskvcffmjuwtfervvsslksxlpmccdjbgncmvqtonuvbti\",
    \"parent_id\": 3,
    \"external_id\": \"nkmiclxzrhqkwernkprihjhyutgtkbmmjdvwztquyndvwbwfbtrsccnwmohnyubwzdgsldnywvvtrlifvinbwmzkdddrdktbjtbyrfaptrysymichfqgxwxsytfqwlpicvpzdjscuojyqgfvylg\",
    \"head_profile_id\": 20
}"
const url = new URL(
    "http://localhost/api/entity/8/departments/20"
);

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

let body = {
    "name": "qfsnufymkkutpcumgybesahxrzlrgjzkjfxuigmjihbkzdqfffamimqqfkvzsncrdexvokwnwxyyxxszbqjyznmvcnjapvvkuuwojxereeadmwhyhhfecrnqzldfylhoqevrnzjkruafpilovsxhkysgaaabdstkdibzhiuozmkotgvoyoahumgperiqymbgvffgwjanxzcpagskvcffmjuwtfervvsslksxlpmccdjbgncmvqtonuvbti",
    "parent_id": 3,
    "external_id": "nkmiclxzrhqkwernkprihjhyutgtkbmmjdvwztquyndvwbwfbtrsccnwmohnyubwzdgsldnywvvtrlifvinbwmzkdddrdktbjtbyrfaptrysymichfqgxwxsytfqwlpicvpzdjscuojyqgfvylg",
    "head_profile_id": 20
};

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

Example response (200):


{
    "message": "record not found or not accessible",
    "error": "record_not_accessible",
    "hint": "",
    "error_description": "The requested record was not found or is not avaiable for the current access privileges",
    "data": {
        "model": "department"
    }
}
 

Request      

PUT api/entity/{entity_id}/departments/{department_id}

URL Parameters

entity_id  integer  

The ID of the entity.

department_id  integer optional  

Department ID

Body Parameters

name  string optional  

Must not be greater than 255 characters.

parent_id  integer optional  

external_id  string optional  

Must not be greater than 255 characters.

head_profile_id  integer optional  

Delete entity department

Example request:
curl --request DELETE \
    "http://localhost/api/entity/1/departments/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/1/departments/2"
);

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

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

Example response (200):


{
    "profiles_affected": 0
}
 

Request      

DELETE api/entity/{entity_id}/departments/{department_id}

URL Parameters

entity_id  integer  

The ID of the entity.

department_id  integer optional  

Department ID

Employees

Update employee info

Example request:
curl --request PUT \
    "http://localhost/api/profile/6/employee-info" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/6/employee-info"
);

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

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

Example response (200):


{
    "first_name": "משה",
    "last_name": "בקל",
    "birth_date": "1955-10-20T00:00:00.000000Z",
    "id_number_type": "id",
    "id_number": "5321649987",
    "immigration_date": null,
    "street_name": "galil",
    "house_number": "12",
    "city": "Karmiel",
    "gender": "male",
    "marital_status": "married",
    "signature_hash": "615c4bb5aaa76",
    "kids_array": [
        {
            "name": "kid",
            "id": "111154544",
            "birth_date": "2021-10-20",
            "under_my_custody": true,
            "receive_social_security": false
        }
    ],
    "profile_id": 16,
    "updated_at": "2021-11-14T11:22:52.132000Z",
    "created_at": "2021-11-14T11:22:52.132000Z",
    "_id": "6190f18c73b17632631a7a63"
}
 

Request      

PUT api/profile/{profile_id}/employee-info

URL Parameters

profile_id  integer optional  

Employee profile ID

Get employee info

Example request:
curl --request GET \
    --get "http://localhost/api/profile/20/employee-info" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/20/employee-info"
);

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

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

Example response (200):


{
    "first_name": "משה",
    "last_name": "בקל",
    "birth_date": "1955-10-20T00:00:00.000000Z",
    "id_number_type": "id",
    "id_number": "5321649987",
    "immigration_date": null,
    "street_name": "galil",
    "house_number": "12",
    "city": "Karmiel",
    "gender": "male",
    "marital_status": "married",
    "signature_hash": "615c4bb5aaa76",
    "kids_array": [
        {
            "name": "kid",
            "id": "111154544",
            "birth_date": "2021-10-20",
            "under_my_custody": true,
            "receive_social_security": false
        }
    ],
    "profile_id": 16,
    "updated_at": "2021-11-14T11:22:52.132000Z",
    "created_at": "2021-11-14T11:22:52.132000Z",
    "_id": "6190f18c73b17632631a7a63"
}
 

Request      

GET api/profile/{profile_id}/employee-info

URL Parameters

profile_id  integer optional  

Employee profile ID

Get employee info history

Example request:
curl --request GET \
    --get "http://localhost/api/profile/15/employee-info/history" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/15/employee-info/history"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 2,
    "recordsFiltered": 2,
    "data": [
        {
            "_id": "6190f18c73b17632631a7a63",
            "first_name": "משה",
            "last_name": "בקל",
            "birth_date": "1955-10-20T00:00:00.000000Z",
            "id_number_type": "id",
            "id_number": "5321649987",
            "immigration_date": null,
            "street_name": "galil",
            "house_number": "12",
            "city": "Karmiel",
            "gender": "male",
            "marital_status": "married",
            "signature_hash": "615c4bb5aaa76",
            "kids_array": [
                {
                    "name": "kid",
                    "id": "111154544",
                    "birth_date": "2021-10-20",
                    "under_my_custody": true,
                    "receive_social_security": false
                }
            ],
            "profile_id": 16,
            "updated_at": "2021-11-14T11:22:52.132000Z",
            "created_at": "2021-11-14T11:22:52.132000Z"
        },
        {
            "_id": "6190f12773b17632631a7a62",
            "first_name": "Moshe",
            "last_name": "Bakal",
            "birth_date": "2021-10-20T00:00:00.000000Z",
            "id_number_type": "id",
            "id_number": "5321649987",
            "immigration_date": null,
            "street_name": "galil",
            "house_number": "12",
            "city": "Karmiel",
            "gender": "male",
            "marital_status": "married",
            "signature_hash": "615c4bb5aaa76",
            "kids_array": [
                {
                    "name": "kid",
                    "id": "111154544",
                    "birth_date": "2021-10-20",
                    "under_my_custody": true,
                    "receive_social_security": false
                }
            ],
            "profile_id": 16,
            "updated_at": "2021-11-14T11:21:11.209000Z",
            "created_at": "2021-11-14T11:21:11.209000Z"
        }
    ]
}
 

Request      

GET api/profile/{profile_id}/employee-info/history

URL Parameters

profile_id  integer optional  

Employee profile ID

Endpoints

Authenticate the request for channel access.

Example request:
curl --request GET \
    --get "http://localhost/api/broadcasting/auth" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/broadcasting/auth"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/broadcasting/auth

POST api/broadcasting/auth

Entity

Update entity details.

Get entity details

Example request:
curl --request GET \
    --get "http://localhost/api/entity/7" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/7"
);

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

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

Example response (200):


{
    "id": 13,
    "type": "company",
    "name": "new name",
    "parent_entity_id": null,
    "phone": null,
    "email": "eli.demayo+c12@gmail.com",
    "address": null,
    "legal_id": null,
    "deduction_id": null,
    "payroll_system": null,
    "external_id": null,
    "wl": null,
    "reseller_id": null,
    "rep_id": null,
    "features_group_id": 4,
    "package_id": null,
    "status": "active",
    "default": 0,
    "default_langauge": "he",
    "whm_product_id": null,
    "created_at": "2021-07-29T09:13:09.000000Z",
    "updated_at": "2021-11-07T09:01:59.000000Z",
    "is_client": true,
    "billing_client_id": null,
    "features": {
        "Dashboard": true,
        "Employee-Management": true,
        "Role-Management": true,
        "Outgoing-Messages": true,
        "Document-Send": true,
        "Sent-Documents": true,
        "Send-Documents": true,
        "Employee-Finance-Info": true,
        "Customer-Service": true,
        "101-Report": true,
        "Payslips": true,
        "Email-Payslips": true,
        "Template-Forms": true,
        "Company-Settings": true,
        "Onboarding": true,
        "Department-Management": true,
        "Managers-Management": true,
        "Permission-Groups": true,
        "Employee-Equipment": true,
        "Employee-Training": true,
        "Leave-Management": true,
        "Contacts": true,
        "Alert-Center": true,
        "Employee-Agreement": true,
        "Bulk-Forms": true,
        "My-Forms": true,
        "Waiting-For-Sign": true,
        "Signature": true,
        "Attachments": true,
        "Password": true,
        "Employee-Onboarding-ContactInfo": true,
        "Employee-Onboarding-Address": true,
        "Employee-Onboarding-Signature": true,
        "Employee-Onboarding-Payments": true,
        "Employee-Onboarding-Pension": true,
        "Employee-Onboarding-Picture": true
    },
    "stamp_hash": "612de9c1401bc"
}
 

Request      

GET api/entity/{entity_id}

URL Parameters

entity_id  integer  

The ID of the entity.

Update Entity

Example request:
curl --request PUT \
    "http://localhost/api/entity/18" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"jflqwjcczvdzhfbi\",
    \"email\": \"rtaszuoiucpfktwiupoecyfizydsdwxlcvovoxrivisbahgxxoheesglclkrhpjmkgwrvgejygeaprdyqgwlyvrkgtmalxfbgrfruymfaeheiqykalypjlaugxkveksfflibpaemjvimwycdfphojdcablkm\",
    \"address\": \"est\",
    \"legal_id\": \"ea\",
    \"deduction_id\": \"doloribus\",
    \"external_id\": \"sit\",
    \"rep_id\": 11,
    \"is_client\": false
}"
const url = new URL(
    "http://localhost/api/entity/18"
);

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

let body = {
    "name": "jflqwjcczvdzhfbi",
    "email": "rtaszuoiucpfktwiupoecyfizydsdwxlcvovoxrivisbahgxxoheesglclkrhpjmkgwrvgejygeaprdyqgwlyvrkgtmalxfbgrfruymfaeheiqykalypjlaugxkveksfflibpaemjvimwycdfphojdcablkm",
    "address": "est",
    "legal_id": "ea",
    "deduction_id": "doloribus",
    "external_id": "sit",
    "rep_id": 11,
    "is_client": false
};

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

Request      

PUT api/entity/{entity_id}

URL Parameters

entity_id  integer  

The ID of the entity.

Body Parameters

name  string optional  

Must not be greater than 255 characters.

email  string optional  

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

phone  string optional  

address  string optional  

legal_id  string optional  

deduction_id  string optional  

external_id  string optional  

rep_id  integer optional  

status  string optional  

payroll_system  string optional  

is_client  boolean optional  

Create new entity

Example request:
curl --request POST \
    "http://localhost/api/admin/private" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"mfcpfftmwthaalerwmpzcfpbjcxdgrconimtstitokntwqksosnautgtelqcgirjusrdvewiaekgynupexnhiemqygwgdieddjgaaktkjmkaawejmmwscvngjnstlbdcowmlmtbvsxrfmmocereskxkxljixqfpjhbyqbpymvncjrnusynvpvkuchvcaclamzcserbmsilobxyvvhsurzcpi\",
    \"email\": \"cofjbyynwae\",
    \"address\": \"architecto\",
    \"legal_id\": \"atque\",
    \"deduction_id\": \"voluptate\",
    \"external_id\": \"voluptas\",
    \"is_client\": true
}"
const url = new URL(
    "http://localhost/api/admin/private"
);

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

let body = {
    "name": "mfcpfftmwthaalerwmpzcfpbjcxdgrconimtstitokntwqksosnautgtelqcgirjusrdvewiaekgynupexnhiemqygwgdieddjgaaktkjmkaawejmmwscvngjnstlbdcowmlmtbvsxrfmmocereskxkxljixqfpjhbyqbpymvncjrnusynvpvkuchvcaclamzcserbmsilobxyvvhsurzcpi",
    "email": "cofjbyynwae",
    "address": "architecto",
    "legal_id": "atque",
    "deduction_id": "voluptate",
    "external_id": "voluptas",
    "is_client": true
};

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

Request      

POST api/admin/{entity_type}

URL Parameters

entity_type  string  

Body Parameters

name  string  

Must not be greater than 255 characters.

email  string optional  

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

phone  string optional  

address  string optional  

legal_id  string optional  

deduction_id  string optional  

external_id  string optional  

is_client  boolean optional  

Create new company

Create a new company under this entity (reseller)

Example request:
curl --request POST \
    "http://localhost/api/entity/20/company" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"iugtrkwfdaoeyfdjhkjyaqjoji\",
    \"email\": \"lvtrbrpbzftyntwjswoowvslguhvlalzdjomzkagqhtukmwraqufpfglrlhpsfuqichziwnpasvutdfxfhjpjbhgjndnkerdactfprlzyfcbclfgkecgbaxxurpxnwzcanxkewlqsv\",
    \"address\": \"et\",
    \"legal_id\": \"sunt\",
    \"deduction_id\": \"temporibus\",
    \"external_id\": \"laboriosam\",
    \"rep_id\": 4
}"
const url = new URL(
    "http://localhost/api/entity/20/company"
);

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

let body = {
    "name": "iugtrkwfdaoeyfdjhkjyaqjoji",
    "email": "lvtrbrpbzftyntwjswoowvslguhvlalzdjomzkagqhtukmwraqufpfglrlhpsfuqichziwnpasvutdfxfhjpjbhgjndnkerdactfprlzyfcbclfgkecgbaxxurpxnwzcanxkewlqsv",
    "address": "et",
    "legal_id": "sunt",
    "deduction_id": "temporibus",
    "external_id": "laboriosam",
    "rep_id": 4
};

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

Example response (200):


{
    "id": 11,
    "type": "company",
    "name": "חברה",
    "parent_entity_id": 13,
    "phone": null,
    "email": "eli.demayo+c10@gmail.com",
    "address": null,
    "legal_id": null,
    "deduction_id": null,
    "payroll_system": null,
    "external_id": null,
    "wl": null,
    "reseller_id": null,
    "reseller_rep_id": null,
    "features_group_id": null,
    "package_id": null,
    "status": "active",
    "default": 0,
    "whm_product_id": null,
    "created_at": "2021-07-29T07:31:06.000000Z",
    "updated_at": "2021-07-29T07:31:06.000000Z"
}
 

Request      

POST api/entity/{entity_id}/company

URL Parameters

entity_id  integer  

The ID of the entity.

Body Parameters

name  string  

Must not be greater than 255 characters.

email  string  

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

phone  string optional  

address  string optional  

legal_id  string optional  

deduction_id  string optional  

payroll_system  string optional  

external_id  string optional  

rep_id  integer optional  

List Companies

This EP list all company type entity under the requested entity (generally reseller)

Example request:
curl --request GET \
    --get "http://localhost/api/entity/3/company" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/3/company"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 2,
    "recordsFiltered": 1,
    "data": [
        {
            "id": 14,
            "name": "New Company",
            "number_of_employees": 0,
            "created_at": "2021-08-02 14:32:11",
            "status": "active",
            "rep_id": null,
            "deduction_id": null,
            "legal_id": null
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/company

URL Parameters

entity_id  integer  

The ID of the entity.

Get entity dashboard summary

Example request:
curl --request GET \
    --get "http://localhost/api/entity/2/reports/dashboard" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/2/reports/dashboard"
);

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

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

Example response (200):


{
    "forms": {
        "signed": "0",
        "waiting": "0",
        "total": 0
    }
}
 

Request      

GET api/entity/{entity_id}/reports/dashboard

URL Parameters

entity_id  integer  

The ID of the entity.

Entity Settings

List available entity settings

Example request:
curl --request GET \
    --get "http://localhost/api/entity/settings/cumque" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/settings/cumque"
);

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

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

Example response (200):


{
    "form-101": {
        "require_authentication": {
            "label": "Authenticate to Fill",
            "default": "require",
            "options": [
                {
                    "label": "Require Authentication",
                    "value": "require",
                    "description": "Will Require the user to log-in in order to fill the form"
                },
                {
                    "label": "Allow filling when logged out",
                    "value": "not_require",
                    "description": "Will allow the user to fill the form as public"
                }
            ]
        },
        "form101_type": {
            "label": "Form Type",
            "default": "certified",
            "options": [
                {
                    "label": "IRS Certified Form",
                    "value": "certified",
                    "description": "Will Apply the strict IRS requirements on the 101 Form"
                },
                {
                    "label": "Flexible Managed Form",
                    "value": "flexible",
                    "description": "Will Allow to fill the form with the non strict IRS requirements"
                }
            ]
        }
    }
}
 

Request      

GET api/entity/settings/{type}

URL Parameters

type  string optional  

Type of entity

Update entity settings

Example request:
curl --request PUT \
    "http://localhost/api/entity/4/settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/4/settings"
);

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

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

Example response (200):


{
    "id": 13,
    "type": "company",
    "name": "new name",
    "parent_entity_id": null,
    "phone": null,
    "email": "eli.demayo+c12@gmail.com",
    "address": null,
    "legal_id": null,
    "deduction_id": null,
    "payroll_system": null,
    "external_id": null,
    "wl": null,
    "reseller_id": null,
    "rep_id": null,
    "features_group_id": 4,
    "package_id": null,
    "status": "active",
    "default": 0,
    "default_langauge": "he",
    "whm_product_id": null,
    "created_at": "2021-07-29T09:13:09.000000Z",
    "updated_at": "2021-11-28T15:24:01.000000Z",
    "is_client": true,
    "billing_client_id": null,
    "settings_id": "61a39f11a88452705416b1f4",
    "features": {
        "Dashboard": true,
        "Employee-Management": true,
        "Role-Management": true,
        "Outgoing-Messages": true,
        "Document-Send": true,
        "Sent-Documents": false,
        "Send-Documents": true,
        "Employee-Finance-Info": true,
        "Customer-Service": true,
        "101-Report": true,
        "Payslips": true,
        "Email-Payslips": true,
        "Template-Forms": true,
        "Company-Settings": true,
        "Onboarding": true,
        "Department-Management": true,
        "Managers-Management": true,
        "Permission-Groups": true,
        "Employee-Equipment": false,
        "Employee-Training": true,
        "Leave-Management": true,
        "Contacts": true,
        "Alert-Center": true,
        "Employee-Agreement": false,
        "Bulk-Forms": true,
        "My-Forms": true,
        "Waiting-For-Sign": true,
        "Signature": true,
        "Attachments": true,
        "Password": true,
        "Employee-Onboarding-ContactInfo": true,
        "Employee-Onboarding-Address": true,
        "Employee-Onboarding-Signature": true,
        "Employee-Onboarding-Payments": true,
        "Employee-Onboarding-Pension": true,
        "Employee-Onboarding-Picture": true
    },
    "stamp_hash": "612de9c1401bc",
    "settings": {
        "form-101": {
            "require_authentication": "not_require",
            "form101_type": "certified"
        }
    }
}
 

Request      

PUT api/entity/{entity_id}/settings

URL Parameters

entity_id  integer optional  

Entity ID

Equipment

List all entity equipment

Example request:
curl --request GET \
    --get "http://localhost/api/entity/19/equipment?columns[]=officia&search[]=quo&search[value]=aliquid&search[regex]=&start=17&length=19&order[]=ullam&order[column]=velit&order[dir]=exercitationem" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/19/equipment"
);

const params = {
    "columns[]": "officia",
    "search[]": "quo",
    "search[value]": "aliquid",
    "search[regex]": "0",
    "start": "17",
    "length": "19",
    "order[]": "ullam",
    "order[column]": "velit",
    "order[dir]": "exercitationem",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "data": [
        {
            "id": 1,
            "name": "new equipment",
            "profile_id": 16,
            "profile_name": "Eli",
            "manager_id": null,
            "manager_name": null,
            "received_at": "2021-07-29 09:13:09",
            "returned_at": null,
            "return_by_date": null,
            "status": "received",
            "notes": null
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/equipment

URL Parameters

entity_id  integer  

The ID of the entity.

Query Parameters

columns  string[] optional  

List of columns definition

search  string[] optional  

general search definition

search[value]  string optional  

search value

search[regex]  boolean optional  

start  integer optional  

pagination start record number

length  integer optional  

pagination number of records

order  string[] optional  

sort definition

order[column]  string optional  

name of column to sort by

order[dir]  string optional  

sort direction DESC|ASC

Update entity equipment

Example request:
curl --request PUT \
    "http://localhost/api/entity/4/equipment/5" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ztxammxwnonmaqpjpcwynuctffexviltnbsiigimgmrnbafssbazpxsnbh\",
    \"manager_id\": 13,
    \"received_at\": \"2022-01-18T09:00:47\",
    \"returned_at\": \"2022-01-18T09:00:47\",
    \"return_by_date\": \"2022-01-18T09:00:47\",
    \"notes\": \"quo\"
}"
const url = new URL(
    "http://localhost/api/entity/4/equipment/5"
);

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

let body = {
    "name": "ztxammxwnonmaqpjpcwynuctffexviltnbsiigimgmrnbafssbazpxsnbh",
    "manager_id": 13,
    "received_at": "2022-01-18T09:00:47",
    "returned_at": "2022-01-18T09:00:47",
    "return_by_date": "2022-01-18T09:00:47",
    "notes": "quo"
};

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

Request      

PUT api/entity/{entity_id}/equipment/{equipment_id}

URL Parameters

entity_id  integer  

The ID of the entity.

equipment_id  integer optional  

Equipment ID

Body Parameters

name  string optional  

Must not be greater than 255 characters.

manager_id  integer optional  

received_at  string optional  

Must be a valid date.

returned_at  string optional  

Must be a valid date.

return_by_date  string optional  

Must be a valid date.

status  string optional  

notes  string optional  

Delete entity equipment

Example request:
curl --request DELETE \
    "http://localhost/api/entity/8/equipment/5" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/8/equipment/5"
);

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

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

Request      

DELETE api/entity/{entity_id}/equipment/{equipment_id}

URL Parameters

entity_id  integer  

The ID of the entity.

equipment_id  integer optional  

Equipment ID

List all profile equipment

Example request:
curl --request GET \
    --get "http://localhost/api/profile/2/equipment?columns[]=sint&search[]=officiis&search[value]=sint&search[regex]=1&start=17&length=13&order[]=repudiandae&order[column]=veritatis&order[dir]=nulla" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/2/equipment"
);

const params = {
    "columns[]": "sint",
    "search[]": "officiis",
    "search[value]": "sint",
    "search[regex]": "1",
    "start": "17",
    "length": "13",
    "order[]": "repudiandae",
    "order[column]": "veritatis",
    "order[dir]": "nulla",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "data": [
        {
            "id": 1,
            "name": "new equipment",
            "profile_id": 16,
            "profile_name": "Eli",
            "manager_id": null,
            "manager_name": null,
            "received_at": "2021-07-29 09:13:09",
            "returned_at": null,
            "return_by_date": null,
            "status": "received",
            "notes": null
        }
    ]
}
 

Request      

GET api/profile/{profile_id}/equipment

URL Parameters

profile_id  integer  

The ID of the profile.

Query Parameters

columns  string[] optional  

List of columns definition

search  string[] optional  

general search definition

search[value]  string optional  

search value

search[regex]  boolean optional  

start  integer optional  

pagination start record number

length  integer optional  

pagination number of records

order  string[] optional  

sort definition

order[column]  string optional  

name of column to sort by

order[dir]  string optional  

sort direction DESC|ASC

Create new entity equipment

Example request:
curl --request POST \
    "http://localhost/api/profile/933070516/equipment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"gegmhbsuwlefcfrdwdvxnflcwrstpfetanweytzvnvbilpsgktjhfvkqjgchpbsnmplolaqqbxbmnhecnujxeodadeumebalzphaffmlhxzdxcgxlrajporwyhslqijbcjibv\",
    \"manager_id\": 10,
    \"received_at\": \"2022-01-18T09:00:48\",
    \"returned_at\": \"2022-01-18T09:00:48\",
    \"return_by_date\": \"2022-01-18T09:00:48\",
    \"notes\": \"repellat\"
}"
const url = new URL(
    "http://localhost/api/profile/933070516/equipment"
);

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

let body = {
    "name": "gegmhbsuwlefcfrdwdvxnflcwrstpfetanweytzvnvbilpsgktjhfvkqjgchpbsnmplolaqqbxbmnhecnujxeodadeumebalzphaffmlhxzdxcgxlrajporwyhslqijbcjibv",
    "manager_id": 10,
    "received_at": "2022-01-18T09:00:48",
    "returned_at": "2022-01-18T09:00:48",
    "return_by_date": "2022-01-18T09:00:48",
    "notes": "repellat"
};

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

Request      

POST api/profile/{profile_id}/equipment

URL Parameters

profile_id  integer  

The ID of the profile.

Body Parameters

name  string  

Must not be greater than 255 characters.

manager_id  integer optional  

received_at  string  

Must be a valid date.

returned_at  string optional  

Must be a valid date.

return_by_date  string optional  

Must be a valid date.

status  string optional  

notes  string optional  

Export

Export entity employees

Example request:
curl --request GET \
    --get "http://localhost/api/entity/1/export/payroll/impedit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/1/export/payroll/impedit"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/entity/{entity_id}/export/payroll/{type}

URL Parameters

entity_id  integer  

The ID of the entity.

type  string  

Features

Update entity features

Example request:
curl --request PUT \
    "http://localhost/api/entity/14/features" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/14/features"
);

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

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

Example response (200):


{
    "id": 13,
    "type": "company",
    "name": "new name",
    "parent_entity_id": null,
    "phone": null,
    "email": "eli.demayo+c12@gmail.com",
    "address": null,
    "legal_id": null,
    "deduction_id": null,
    "payroll_system": null,
    "external_id": null,
    "wl": null,
    "reseller_id": null,
    "rep_id": null,
    "features_group_id": 4,
    "package_id": null,
    "status": "active",
    "default": 0,
    "whm_product_id": null,
    "created_at": "2021-07-29T09:13:09.000000Z",
    "updated_at": "2021-10-06T12:43:50.000000Z",
    "is_client": true,
    "features": {
        "Team.Manage": 0,
        "Team.PersonalInfo": 0,
        "Team.Roles": 0,
        "Team.Messages": 0,
        "Team.Documents": 0,
        "Team.Attachments": 0,
        "Team.Finance": 0,
        "Team.Equipment": 0,
        "Team.Training": 0,
        "Team.LeaveManagement": 0,
        "Form101.Report": 0,
        "Forms.Sent": 0,
        "Forms.Templates": true,
        "Forms.QuickSend": true,
        "Dashboard": 0,
        "Settings.Company": 0,
        "Settings.Onboarding": 0,
        "Settings.Roles": 0,
        "Settings.Departments": 0,
        "Settings.Managers": 0,
        "Settings.Management": 0,
        "Settings.Documents": 0,
        "Settings.Attachments": 0
    }
}
 

Request      

PUT api/entity/{entity_id}/features

URL Parameters

entity_id  integer  

The ID of the entity.

Get entity features

Example request:
curl --request GET \
    --get "http://localhost/api/entity/12/features" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/12/features"
);

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

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

Example response (200):


{
    "Team.Manage": {
        "label": "Team - Management",
        "default": true,
        "section": "team",
        "value": true
    },
    "Team.PersonalInfo": {
        "label": "Team - Personal Info",
        "default": true,
        "section": "team",
        "value": false
    },
    "Team.Roles": {
        "label": "Team - Role Settings",
        "default": true,
        "section": "team",
        "value": false
    },
    "Team.Messages": {
        "label": "Team - Messages",
        "default": true,
        "section": "team",
        "value": true
    },
    "Team.Documents": {
        "label": "Team - Documents",
        "default": true,
        "section": "team",
        "value": false
    },
    "Team.Attachments": {
        "label": "Team - Attachments",
        "default": true,
        "section": "team",
        "value": false
    },
    "Team.Finance": {
        "label": "Team - Finance",
        "default": true,
        "section": "team",
        "value": true
    },
    "Team.Equipment": {
        "label": "Team - Equipment",
        "default": true,
        "section": "team",
        "value": false
    },
    "Team.Training": {
        "label": "Team - Training",
        "default": true,
        "section": "team",
        "value": false
    },
    "Team.LeaveManagement": {
        "label": "Team - Leave Management",
        "default": true,
        "section": "team",
        "value": true
    },
    "Form101.Report": {
        "label": "101 Report",
        "default": true,
        "section": "company",
        "value": false
    },
    "Forms.Sent": {
        "label": "Sent Forms",
        "default": true,
        "section": "company",
        "value": false
    },
    "Forms.Templates": {
        "label": "Template Forms",
        "default": true,
        "section": "company",
        "value": null
    },
    "Forms.QuickSend": {
        "label": "Quick Send",
        "default": true,
        "section": "company",
        "value": null
    },
    "Dashboard": {
        "label": "Dashboard",
        "default": true,
        "section": "company",
        "value": false
    },
    "Settings.Company": {
        "label": "Settings - Company",
        "default": true,
        "section": "settings",
        "value": false
    },
    "Settings.Onboarding": {
        "label": "Settings - Onboarding",
        "default": true,
        "section": "settings",
        "value": false
    },
    "Settings.Roles": {
        "label": "Settings - Roles",
        "default": true,
        "section": "settings",
        "value": false
    },
    "Settings.Departments": {
        "label": "Settings - Departments",
        "default": true,
        "section": "settings",
        "value": false
    },
    "Settings.Managers": {
        "label": "Settings - Managers",
        "default": true,
        "section": "settings",
        "value": false
    },
    "Settings.Management": {
        "label": "Settings - Management",
        "default": true,
        "section": "settings",
        "value": false
    },
    "Settings.Documents": {
        "label": "Settings - Documents",
        "default": true,
        "section": "settings",
        "value": false
    },
    "Settings.Attachments": {
        "label": "Settings - Attachments",
        "default": true,
        "section": "settings",
        "value": false
    },
    "Contacts.Manage": {
        "label": "Contacts - Management",
        "default": true,
        "section": "team",
        "value": null
    },
    "Contacts.PersonalInfo": {
        "label": "Contacts - Personal Info",
        "default": true,
        "section": "team",
        "value": null
    },
    "Contacts.Documents": {
        "label": "Contacts - Documents",
        "default": true,
        "section": "team",
        "value": null
    },
    "Contacts.Attachments": {
        "label": "Contacts - Attachments",
        "default": true,
        "section": "team",
        "value": null
    }
}
 

Request      

GET api/entity/{entity_id}/features

URL Parameters

entity_id  integer  

The ID of the entity.

List entity feature groups

Example request:
curl --request GET \
    --get "http://localhost/api/entity/17/feature-groups" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/17/feature-groups"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "data": [
        {
            "id": 3,
            "name": "deafult",
            "default": true,
            "created_at": "2021-10-06T12:28:25.000000Z"
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/feature-groups

URL Parameters

entity_id  integer  

The ID of the entity.

Get entity feature group

Example request:
curl --request GET \
    --get "http://localhost/api/entity/5/feature-groups/15" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/5/feature-groups/15"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "data": [
        {
            "id": 3,
            "name": "deafult",
            "default": true,
            "created_at": "2021-10-06T12:28:25.000000Z"
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/feature-groups/{group_id}

URL Parameters

entity_id  integer  

The ID of the entity.

group_id  integer  

Feature group ID. also accepts string 'default' and returns the entity default feature group

Update entity feature group

If 'default' key is used then this request will also create a default feature group if not exists

Example request:
curl --request PUT \
    "http://localhost/api/entity/5/feature-groups/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/5/feature-groups/4"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "data": [
        {
            "id": 3,
            "name": "deafult",
            "default": true,
            "created_at": "2021-10-06T12:28:25.000000Z"
        }
    ]
}
 

Request      

PUT api/entity/{entity_id}/feature-groups/{group_id}

URL Parameters

entity_id  integer  

The ID of the entity.

group_id  integer  

Feature group ID. also accepts string 'default' and returns the entity default feature group

Files

List profile files

Example request:
curl --request GET \
    --get "http://localhost/api/profile/5/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/5/files"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 12,
    "recordsFiltered": 12,
    "data": [
        {
            "id": 1,
            "profile_id": 12,
            "name": "טופס-1.pdf",
            "display_name": null,
            "visibility": [
                "self",
                "manager",
                "reseller"
            ],
            "date": "2021-08-24 14:22:43",
            "extension": "pdf"
        },
        {
            "id": 2,
            "profile_id": 12,
            "name": "הסכם.pdf",
            "display_name": "new name",
            "visibility": [
                "self",
                "manager",
                "reseller"
            ],
            "date": "2021-08-25 14:28:38",
            "extension": "pdf"
        },
        {
            "id": 3,
            "profile_id": 12,
            "name": "הסכם.pdf",
            "display_name": null,
            "visibility": [
                "self",
                "manager",
                "reseller"
            ],
            "date": "2021-08-25 14:47:07",
            "extension": "pdf"
        },
        {
            "id": 4,
            "profile_id": 12,
            "name": "הסכם.pdf",
            "display_name": null,
            "visibility": [
                "self",
                "manager",
                "reseller"
            ],
            "date": "2021-08-25 14:54:58",
            "extension": "pdf"
        },
        {
            "id": 5,
            "profile_id": 12,
            "name": "הסכם.pdf",
            "display_name": null,
            "visibility": [
                "self",
                "manager",
                "reseller"
            ],
            "date": "2021-08-25 14:59:39",
            "extension": "pdf"
        },
        {
            "id": 6,
            "profile_id": 12,
            "name": "הסכם.pdf",
            "display_name": "new name",
            "visibility": [
                "manager",
                "reseller"
            ],
            "date": "2021-08-25 15:00:11",
            "extension": "pdf"
        },
        {
            "id": 7,
            "profile_id": 12,
            "name": "הסכם.pdf",
            "display_name": null,
            "visibility": [
                "self",
                "manager",
                "reseller"
            ],
            "date": "2021-08-26 06:46:40",
            "extension": "pdf"
        },
        {
            "id": 11,
            "profile_id": 12,
            "name": "6139c75decabd.png",
            "display_name": null,
            "visibility": [
                "self",
                "manager",
                "reseller"
            ],
            "date": "2021-08-26 14:28:22",
            "extension": "png"
        },
        {
            "id": 13,
            "profile_id": 12,
            "name": "ERAS-Medical-Residency-Headshot.jpeg",
            "display_name": null,
            "visibility": [
                "self",
                "manager",
                "reseller"
            ],
            "date": "2021-09-01 06:15:34",
            "extension": "jpeg"
        },
        {
            "id": 14,
            "profile_id": 12,
            "name": "ERAS-Medical-Residency-Headshot.jpeg",
            "display_name": null,
            "visibility": [
                "self",
                "manager",
                "reseller"
            ],
            "date": "2021-09-01 06:57:53",
            "extension": "jpeg"
        },
        {
            "id": 15,
            "profile_id": 12,
            "name": "ERAS-Medical-Residency-Headshot.jpeg",
            "display_name": null,
            "visibility": [
                "self",
                "manager",
                "reseller"
            ],
            "date": "2021-09-01 07:19:30",
            "extension": "jpeg"
        },
        {
            "id": 16,
            "profile_id": 12,
            "name": "ERAS-Medical-Residency-Headshot.jpeg",
            "display_name": null,
            "visibility": [
                "self",
                "manager",
                "reseller"
            ],
            "date": "2021-09-01 07:20:09",
            "extension": "jpeg"
        }
    ]
}
 

Request      

GET api/profile/{profile_id}/files

URL Parameters

profile_id  integer  

The ID of the profile.

Upload profile attachment

Example request:
curl --request POST \
    "http://localhost/api/profile/ut/files" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "attachment=@/tmp/php1AwZXG" 
const url = new URL(
    "http://localhost/api/profile/ut/files"
);

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

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

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

Example response (200):


{
    "profile_id": 12,
    "entity_id": null,
    "name": "1.png",
    "path": "YLyP6LOXqdrZO6j33PyzopOhz9nuBhOocFHbL3MU.txt",
    "status": "active",
    "crypt": 9335747466565946,
    "visibility": [
        "self",
        "manager",
        "reseller"
    ],
    "updated_at": "2021-10-13T07:08:35.000000Z",
    "created_at": "2021-10-13T07:08:35.000000Z",
    "id": 46,
    "extension": "png",
    "url": "http://localhost:8000/api/profile/12/files/46/download"
}
 

Request      

POST api/profile/{profile_id}/files

URL Parameters

profile_id  string optional  

int|string required Profile ID or the string "me" for current profile

Body Parameters

attachment  file  

Must be a file.

Update profile file

Example request:
curl --request PUT \
    "http://localhost/api/profile/beatae/files/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"display_name\": \"rsaqxxksogwbkvnnqenapguqnuyziislpb\",
    \"visibility\": [
        null
    ]
}"
const url = new URL(
    "http://localhost/api/profile/beatae/files/4"
);

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

let body = {
    "display_name": "rsaqxxksogwbkvnnqenapguqnuyziislpb",
    "visibility": [
        null
    ]
};

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

Example response (200):


{
    "profile_id": 12,
    "entity_id": null,
    "name": "1.png",
    "path": "YLyP6LOXqdrZO6j33PyzopOhz9nuBhOocFHbL3MU.txt",
    "status": "active",
    "crypt": 9335747466565946,
    "visibility": [
        "self",
        "manager",
        "reseller"
    ],
    "updated_at": "2021-10-13T07:08:35.000000Z",
    "created_at": "2021-10-13T07:08:35.000000Z",
    "id": 46,
    "extension": "png",
    "url": "http://localhost:8000/api/profile/12/files/46/download"
}
 

Request      

PUT api/profile/{profile_id}/files/{file_id}

URL Parameters

profile_id  string optional  

int|string required Profile ID or the string "me" for current profile

file_id  integer optional  

File ID

Body Parameters

display_name  string optional  

Must not be greater than 255 characters.

visibility  string[] optional  

Delete file

Example request:
curl --request DELETE \
    "http://localhost/api/profile/0/files/20" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/0/files/20"
);

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

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

Request      

DELETE api/profile/{profile_id}/files/{file_id}

URL Parameters

profile_id  integer  

The ID of the profile.

file_id  integer  

The ID of the file.

Download file

Example request:
curl --request GET \
    --get "http://localhost/api/profile/0/files/14/download" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/0/files/14/download"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/profile/{profile_id}/files/{file_id}/download

URL Parameters

profile_id  integer  

The ID of the profile.

file_id  integer  

The ID of the file.

Forms

List entity sent forms

Example request:
curl --request GET \
    --get "http://localhost/api/entity/15/forms" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/15/forms"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 26,
    "recordsFiltered": 4,
    "data": [
        {
            "id": 23,
            "recipient_name": "Eli",
            "recipient_type": "Manager",
            "recipient_id": 12,
            "name": "Form 101",
            "status": "waiting",
            "created_at": "2021-09-05 15:23:09",
            "signed_date": null,
            "template_id": 5,
            "dir_hash": "0f5ff456-d5f9-44c0-8270-4eb930a981c2",
            "file_id": null,
            "admin_status": "not approved",
            "admin_notes": null,
            "updated_at": "2021-09-05 15:23:09",
            "company_name": "new name",
            "sender_name": null,
            "template_slug": "form101",
            "assignees": [
                {
                    "slug": "6134e0dd1848c",
                    "placeholder": null,
                    "status": "waiting",
                    "sent_date": "2021-09-05T15:23:09.000000Z",
                    "signed_date": null,
                    "profile": {
                        "id": 12,
                        "first_name": "Eli",
                        "last_name": null
                    }
                }
            ]
        },
        {
            "id": 24,
            "recipient_name": null,
            "recipient_type": null,
            "recipient_id": null,
            "name": "Form 101",
            "status": "waiting",
            "created_at": "2021-09-05 15:30:33",
            "signed_date": null,
            "template_id": 5,
            "dir_hash": "0f5ff456-d5f9-44c0-8270-4eb930a981c2",
            "file_id": null,
            "admin_status": "not approved",
            "admin_notes": null,
            "updated_at": "2021-09-05 15:30:33",
            "company_name": "new name",
            "sender_name": null,
            "template_slug": "form101",
            "assignees": [
                {
                    "slug": "6134e299c5f5a",
                    "placeholder": null,
                    "status": "waiting",
                    "sent_date": "2021-09-05T15:30:33.000000Z",
                    "signed_date": null,
                    "profile": null
                }
            ]
        },
        {
            "id": 25,
            "recipient_name": "Eli",
            "recipient_type": "Employee",
            "recipient_id": 16,
            "name": "Form 101",
            "status": "signed",
            "created_at": "2021-09-13 13:37:52",
            "signed_date": "2021-09-19",
            "template_id": 5,
            "dir_hash": "0f5ff456-d5f9-44c0-8270-4eb930a981c2",
            "file_id": 19,
            "admin_status": "not approved",
            "admin_notes": null,
            "updated_at": "2021-09-19 08:24:22",
            "company_name": "new name",
            "sender_name": "Eli",
            "template_slug": "form101",
            "assignees": [
                {
                    "slug": "613f543036eee",
                    "placeholder": null,
                    "status": "signed",
                    "sent_date": "2021-09-13T13:37:52.000000Z",
                    "signed_date": "2021-09-19T08:24:18.000000Z",
                    "profile": {
                        "id": 16,
                        "first_name": "Eli",
                        "last_name": null
                    }
                }
            ]
        },
        {
            "id": 26,
            "recipient_name": "Eli",
            "recipient_type": "Employee",
            "recipient_id": 15,
            "name": "Form 101",
            "status": "waiting",
            "created_at": "2021-09-23 09:46:38",
            "signed_date": null,
            "template_id": 5,
            "dir_hash": "0f5ff456-d5f9-44c0-8270-4eb930a981c2",
            "file_id": null,
            "admin_status": "not approved",
            "admin_notes": null,
            "updated_at": "2021-09-23 09:46:39",
            "company_name": "new name",
            "sender_name": "Eli",
            "template_slug": "form101",
            "assignees": [
                {
                    "slug": "614c4cfef1a40",
                    "placeholder": null,
                    "status": "waiting",
                    "sent_date": "2021-09-23T09:46:38.000000Z",
                    "signed_date": null,
                    "profile": {
                        "id": 15,
                        "first_name": "Eli",
                        "last_name": null
                    }
                }
            ]
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/forms

URL Parameters

entity_id  integer  

The ID of the entity.

Update form

Example request:
curl --request PUT \
    "http://localhost/api/entity/14/forms/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ggcebofescxsudecvpqipie\",
    \"recurring_month\": 2,
    \"recurring_day\": 8,
    \"admin_notes\": \"expedita\"
}"
const url = new URL(
    "http://localhost/api/entity/14/forms/4"
);

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

let body = {
    "name": "ggcebofescxsudecvpqipie",
    "recurring_month": 2,
    "recurring_day": 8,
    "admin_notes": "expedita"
};

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

Example response (200):


{
    "id": 1,
    "entity_id": 6,
    "name": "New Role name",
    "type": "pdf",
    "dir_hash": null,
    "payload_id": "6112650a0dcbc802b50fc482",
    "status": "draft",
    "schedule": null,
    "created_by": null,
    "created_at": "2021-08-10T10:13:41.000000Z",
    "updated_at": "2021-08-10T11:37:46.000000Z",
    "payload": {
        "data": [
            [
                {
                    "pos_x": 0.4594594594594595,
                    "pos_y": 0.21810572467739525,
                    "width": 0.18018018018018017,
                    "height": 0.01976981714912062,
                    "name": "ds_user_full_name",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-user"
                },
                {
                    "pos_x": 0.46216216216216216,
                    "pos_y": 0.24744158238254196,
                    "width": 0.18018018018018017,
                    "height": 0.01976981714912062,
                    "name": "ds_company_name",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-user"
                }
            ],
            [
                {
                    "pos_x": 0.4691722972972973,
                    "pos_y": 0.40365701758756417,
                    "width": 0.18018018018018017,
                    "height": 0.10203776593094514,
                    "name": null,
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-signature"
                }
            ]
        ],
        "roles": []
    }
}
 

Request      

PUT api/entity/{entity_id}/forms/{form_id}

URL Parameters

entity_id  integer  

The ID of the entity.

form_id  integer  

The ID of the form.

Body Parameters

name  string optional  

Must not be greater than 255 characters.

recurring_type  string optional  

recurring_month  integer optional  

recurring_day  integer optional  

payload  string optional  

admin_notes  string optional  

admin_status  string optional  

Set form file

Example request:
curl --request POST \
    "http://localhost/api/entity/13/forms/98/file" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/13/forms/98/file"
);

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

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

Example response (200):


{
    "id": 1,
    "entity_id": 6,
    "name": "New Role name",
    "type": "pdf",
    "dir_hash": null,
    "payload_id": "6112650a0dcbc802b50fc482",
    "status": "draft",
    "schedule": null,
    "created_by": null,
    "created_at": "2021-08-10T10:13:41.000000Z",
    "updated_at": "2021-08-10T11:37:46.000000Z",
    "payload": {
        "data": [
            [
                {
                    "pos_x": 0.4594594594594595,
                    "pos_y": 0.21810572467739525,
                    "width": 0.18018018018018017,
                    "height": 0.01976981714912062,
                    "name": "ds_user_full_name",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-user"
                },
                {
                    "pos_x": 0.46216216216216216,
                    "pos_y": 0.24744158238254196,
                    "width": 0.18018018018018017,
                    "height": 0.01976981714912062,
                    "name": "ds_company_name",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-user"
                }
            ],
            [
                {
                    "pos_x": 0.4691722972972973,
                    "pos_y": 0.40365701758756417,
                    "width": 0.18018018018018017,
                    "height": 0.10203776593094514,
                    "name": null,
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-signature"
                }
            ]
        ],
        "roles": []
    }
}
 

Request      

POST api/entity/{entity_id}/forms/{form_id}/file

URL Parameters

entity_id  integer  

The ID of the entity.

form_id  integer  

The ID of the form.

Get form details

Example request:
curl --request GET \
    --get "http://localhost/api/entity/15/forms/42" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/15/forms/42"
);

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

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

Example response (200):


{
    "id": 12,
    "template_id": 2,
    "sender_id": 12,
    "recipient_id": "16",
    "entity_id": "13",
    "name": "New Role name",
    "file_id": null,
    "dir_hash": "57d1452b-0cf6-46f7-a01a-c07f24164df0",
    "payload_id": "611e76551995ae10e45d3f98",
    "status": "waiting",
    "admin_status": "not approved",
    "admin_notes": null,
    "signed_date": null,
    "public": 0,
    "schedule": null,
    "parent_form_id": null,
    "created_at": "2021-08-19T15:18:45.000000Z",
    "updated_at": "2021-08-19T15:18:45.000000Z",
    "payload": {
        "data": {
            "http://localhost:8000/forms/57d1452b-0cf6-46f7-a01a-c07f24164df0/bg/1.jpg": [
                {
                    "pos_x": 0.4594594594594595,
                    "pos_y": 0.21810572467739525,
                    "width": 0.18018018018018017,
                    "height": 0.01976981714912062,
                    "name": "ds_user_full_name",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-user",
                    "role_id": "1"
                },
                {
                    "pos_x": 0.46216216216216216,
                    "pos_y": 0.24744158238254196,
                    "width": 0.18018018018018017,
                    "height": 0.01976981714912062,
                    "name": "ds_company_name",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-user"
                }
            ],
            "http://localhost:8000/forms/57d1452b-0cf6-46f7-a01a-c07f24164df0/bg/2.jpg": [
                {
                    "pos_x": 0.4691722972972973,
                    "pos_y": 0.40365701758756417,
                    "width": 0.18018018018018017,
                    "height": 0.10203776593094514,
                    "name": null,
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-signature"
                }
            ]
        },
        "roles": [
            {
                "sequence": 1,
                "placeholder": {
                    "name": null,
                    "id": null
                },
                "profile": {
                    "name": "שני כהן",
                    "id": 63,
                    "phone": "052656565",
                    "email": "email@example.com"
                },
                "recipient": true
            },
            {
                "sequence": 2,
                "placeholder": {
                    "name": null,
                    "id": null
                },
                "profile": {
                    "name": "שני כהן",
                    "id": 63,
                    "phone": "052656565",
                    "email": "email@example.com"
                },
                "recipient": true
            }
        ]
    },
    "assignees": [
        {
            "id": 9,
            "slug": "611e76550141a",
            "form_id": 12,
            "sequence": 1,
            "profile_id": 15,
            "placeholder": null,
            "template_role_id": null,
            "public": false,
            "status": "waiting",
            "sign_ip": null,
            "sign_device": null,
            "sent_date": "2021-08-19T15:18:45.000000Z",
            "signed_date": null,
            "notify_platform": null,
            "notify_notes": null,
            "created_at": "2021-08-19T15:18:48.000000Z",
            "updated_at": "2021-08-19T15:18:48.000000Z"
        },
        {
            "id": 10,
            "slug": "611e76550246e",
            "form_id": 12,
            "sequence": 2,
            "profile_id": 12,
            "placeholder": null,
            "template_role_id": 1,
            "public": false,
            "status": "pending",
            "sign_ip": null,
            "sign_device": null,
            "sent_date": null,
            "signed_date": null,
            "notify_platform": null,
            "notify_notes": null,
            "created_at": "2021-08-19T15:18:48.000000Z",
            "updated_at": "2021-08-19T15:18:48.000000Z"
        }
    ],
    "files": [
        {
            "id": 1,
            "form_id": 12,
            "file_id": 1,
            "name": "somekind_of_file",
            "display_name": null,
            "status": "exists",
            "created_at": "2021-08-24T14:22:43.000000Z",
            "updated_at": "2021-08-24T14:22:43.000000Z",
            "visibility": [
                "manager",
                "reseller"
            ],
            "file_name": "טופס-1.pdf",
            "path": "fpkEiQGrkaWqAQsaHTT6ePOLGS81N0TMsFEvJkMV.pdf",
            "profile_id": 12
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/forms/{form_id}

URL Parameters

entity_id  integer  

The ID of the entity.

form_id  integer  

The ID of the form.

Delete entity form

Example request:
curl --request DELETE \
    "http://localhost/api/entity/20/forms/exercitationem" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/20/forms/exercitationem"
);

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

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

Example response (200):


{}
 

Request      

DELETE api/entity/{entity_id}/forms/{form_id}

URL Parameters

entity_id  integer  

The ID of the entity.

form_id  string optional  

Form ID

Get form fill data

Example request:
curl --request GET \
    --get "http://localhost/api/forms/fill/modi" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/forms/fill/modi"
);

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

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

Example response (200):


{
    "id": 28,
    "slug": "6155694f3f5e1",
    "form_id": 28,
    "sequence": 1,
    "profile_id": 19,
    "placeholder": "Main recipient",
    "template_role_id": 1,
    "public": false,
    "status": "waiting",
    "sign_ip": null,
    "sign_device": null,
    "sent_date": "2021-09-30T07:37:51.000000Z",
    "signed_date": null,
    "notify_platform": "email",
    "notify_notes": null,
    "created_at": "2021-09-30T07:37:51.000000Z",
    "updated_at": "2021-09-30T07:37:51.000000Z",
    "payload": {
        "data": {
            "http://localhost:8000/forms/57725a3d-b9e4-4b22-b293-10dc65cb9a5a/bg/1.jpg": [
                {
                    "pos_x": 0.4594594594594595,
                    "pos_y": 0.21810572467739525,
                    "width": 0.18018018018018017,
                    "height": 0.01976981714912062,
                    "name": "ds_user_full_name",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-user",
                    "role_id": "1",
                    "read_only": false,
                    "content_value": null
                },
                {
                    "pos_x": 0.46216216216216216,
                    "pos_y": 0.24744158238254196,
                    "width": 0.18018018018018017,
                    "height": 0.01976981714912062,
                    "name": "ds_company_name",
                    "placeholder": "new name",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-user",
                    "role_id": "1",
                    "read_only": false,
                    "content_value": "new name"
                }
            ]
        },
        "roles": {
            "1": {
                "sequence": 1,
                "placeholder": {
                    "name": "Main recipient",
                    "id": null
                },
                "profile": {
                    "name": null,
                    "id": null,
                    "phone": null,
                    "email": null
                },
                "recipient": true
            }
        }
    },
    "profile": {
        "id": 19,
        "user_id": 40,
        "entity_id": 13,
        "type_id": 4,
        "status": "active",
        "id_number": "0343434358",
        "email": "eli.demayo+e6@gmail.com",
        "first_name": "Eli",
        "last_name": "Last",
        "business_name": null,
        "phone": null,
        "birth_date": null,
        "street_name": null,
        "house_number": null,
        "apartment_number": null,
        "city": null,
        "zip": null,
        "payment_method": null,
        "bank_number": null,
        "bank_branch_number": null,
        "bank_account_number": null,
        "policy_status": null,
        "policy_id": null,
        "policy_legal_number": null,
        "gender": null,
        "external_id": null,
        "payroll_id": null,
        "marital_status": "single",
        "direct_manager_id": null,
        "indirect_manager_id": null,
        "department_id": null,
        "role_id": null,
        "require_101": null,
        "language": null,
        "legal_id": null,
        "website": null,
        "created_at": "2021-09-30T07:37:50.000000Z",
        "updated_at": "2021-09-30T07:37:50.000000Z"
    },
    "template_slug": null
}
 

Request      

GET api/forms/fill/{slug}

URL Parameters

slug  string optional  

Form assignee slug 13 characters hexadecimal

Fill form for assignee

Example request:
curl --request PUT \
    "http://localhost/api/forms/fill/74d5f0f28b528" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"data\": [
        \"veritatis\"
    ],
    \"draft\": true
}"
const url = new URL(
    "http://localhost/api/forms/fill/74d5f0f28b528"
);

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

let body = {
    "data": [
        "veritatis"
    ],
    "draft": true
};

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

Example response (200):


{
    "id": 68,
    "template_id": 5,
    "sender_id": null,
    "recipient_id": "16",
    "entity_id": "16",
    "name": "Form 101",
    "file_id": 43,
    "dir_hash": "0f5ff456-d5f9-44c0-8270-4eb930a981c2",
    "payload_id": "616424150135867cd56b1e8b",
    "status": "missing-files",
    "admin_status": "not approved",
    "admin_notes": null,
    "signed_date": "2021-10-11T00:00:00.000000Z",
    "public": 0,
    "schedule": null,
    "parent_form_id": null,
    "created_at": "2021-10-11T11:46:29.000000Z",
    "updated_at": "2021-10-11T11:46:33.000000Z",
    "payload": {
        "data": {
            "http://localhost:8000/forms/0f5ff456-d5f9-44c0-8270-4eb930a981c2/bg/1.jpg": [
                {
                    "pos_x": 0.3746058558558559,
                    "pos_y": 0.10007473469184396,
                    "width": 0.111022,
                    "height": 0.019899354092969956,
                    "name": "tax_year",
                    "placeholder": "2 0 2 1 ",
                    "font": "Arial",
                    "font_size": "26",
                    "type": "input-system",
                    "content_value": "2 0 2 1 "
                },
                {
                    "pos_x": 0.7036176801801802,
                    "pos_y": 0.19894374968860545,
                    "width": 0.17678776576576577,
                    "height": 0.019899354092969956,
                    "name": "employer_name",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-system",
                    "content_value": null
                }
            ],
            "http://localhost:8000/forms/0f5ff456-d5f9-44c0-8270-4eb930a981c2/bg/2.jpg": [
                {
                    "pos_x": 0.06345720720720721,
                    "pos_y": 0.7384385431717403,
                    "width": 0.13693693693693693,
                    "height": 0.03826416222410443,
                    "name": "signature",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-signature",
                    "role_id": 1,
                    "signature_hash": "615c4bb5aaa76",
                    "content_value": "signature-signed"
                },
                {
                    "pos_x": 0.24342623873873873,
                    "pos_y": 0.7511932639131085,
                    "width": 0.12183281081081081,
                    "height": 0.019899354092969956,
                    "name": "current_date",
                    "placeholder": "11/10/2021",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-system",
                    "role_id": 1,
                    "content_value": "11/10/2021"
                }
            ]
        }
    },
    "assignees": [
        {
            "id": 68,
            "slug": "61642414f40b7",
            "form_id": 68,
            "sequence": 1,
            "profile_id": 16,
            "placeholder": null,
            "template_role_id": 1,
            "public": false,
            "status": "signed",
            "sign_ip": null,
            "sign_device": null,
            "sent_date": "2021-10-11T11:46:28.000000Z",
            "signed_date": "2021-10-11T11:46:29.000000Z",
            "notify_platform": "email",
            "notify_notes": null,
            "created_at": "2021-10-11T11:46:29.000000Z",
            "updated_at": "2021-10-11T11:46:29.000000Z"
        }
    ],
    "file": {
        "visibility": [
            "self",
            "manager",
            "reseller"
        ],
        "file_name": "132bc62b-f1a5-43b5-977e-c08ddf37fdf6.pdf",
        "path": "132bc62b-f1a5-43b5-977e-c08ddf37fdf6.pdf",
        "profile_id": 16,
        "public_until": "2021-10-20T00:00:00.000000Z"
    },
    "files": [
        {
            "id": 54,
            "form_id": 68,
            "file_id": null,
            "name": "employeeIdCertificate",
            "display_name": null,
            "status": "missing",
            "created_at": "2021-10-11T11:46:29.000000Z",
            "updated_at": "2021-10-11T11:46:29.000000Z"
        }
    ]
}
 

Request      

PUT api/forms/fill/{slug}

URL Parameters

slug  string  

Body Parameters

data  string[] optional  

draft  boolean optional  

Attach file to form

Example request:
curl --request POST \
    "http://localhost/api/forms/fill/66c9e4ddeff4d/attachment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/forms/fill/66c9e4ddeff4d/attachment"
);

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

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

Request      

POST api/forms/fill/{slug}/attachment

URL Parameters

slug  string  

Send form fill reminder

Example request:
curl --request POST \
    "http://localhost/api/forms/fill/fuga/reminder" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/forms/fill/fuga/reminder"
);

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

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

Example response (200):


{
    "data": [
        [
            {
                "pos_x": 0.4594594594594595,
                "pos_y": 0.21810572467739525,
                "width": 0.18018018018018017,
                "height": 0.01976981714912062,
                "name": "ds_user_full_name",
                "placeholder": null,
                "font": "Arial",
                "font_size": "16",
                "type": "input-user",
                "role_id": "1",
                "read_only": false,
                "content_value": null
            },
            {
                "pos_x": 0.46216216216216216,
                "pos_y": 0.24744158238254196,
                "width": 0.18018018018018017,
                "height": 0.01976981714912062,
                "name": "ds_company_name",
                "placeholder": "new name",
                "font": "Arial",
                "font_size": "16",
                "type": "input-user",
                "read_only": true,
                "content_value": "new name"
            }
        ],
        [
            {
                "pos_x": 0.4691722972972973,
                "pos_y": 0.40365701758756417,
                "width": 0.18018018018018017,
                "height": 0.10203776593094514,
                "name": null,
                "placeholder": null,
                "font": "Arial",
                "font_size": "16",
                "type": "input-signature",
                "read_only": true
            }
        ]
    ],
    "roles": [
        {
            "sequence": 1,
            "placeholder": {
                "name": null,
                "id": null
            },
            "profile": {
                "name": "שני כהן",
                "id": 63,
                "phone": "052656565",
                "email": "email@example.com"
            },
            "recipient": true
        },
        {
            "sequence": 2,
            "placeholder": {
                "name": null,
                "id": null
            },
            "profile": {
                "name": "שני כהן",
                "id": 63,
                "phone": "052656565",
                "email": "email@example.com"
            },
            "recipient": true
        }
    ]
}
 

Request      

POST api/forms/fill/{slug}/reminder

URL Parameters

slug  string optional  

Form assignee slug 13 characters hexadecimal

Send form reminders

Example request:
curl --request POST \
    "http://localhost/api/entity/16/forms/3/reminder" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/16/forms/3/reminder"
);

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

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

Example response (200):


{
    "data": [
        [
            {
                "pos_x": 0.4594594594594595,
                "pos_y": 0.21810572467739525,
                "width": 0.18018018018018017,
                "height": 0.01976981714912062,
                "name": "ds_user_full_name",
                "placeholder": null,
                "font": "Arial",
                "font_size": "16",
                "type": "input-user",
                "role_id": "1",
                "read_only": false,
                "content_value": null
            },
            {
                "pos_x": 0.46216216216216216,
                "pos_y": 0.24744158238254196,
                "width": 0.18018018018018017,
                "height": 0.01976981714912062,
                "name": "ds_company_name",
                "placeholder": "new name",
                "font": "Arial",
                "font_size": "16",
                "type": "input-user",
                "read_only": true,
                "content_value": "new name"
            }
        ],
        [
            {
                "pos_x": 0.4691722972972973,
                "pos_y": 0.40365701758756417,
                "width": 0.18018018018018017,
                "height": 0.10203776593094514,
                "name": null,
                "placeholder": null,
                "font": "Arial",
                "font_size": "16",
                "type": "input-signature",
                "read_only": true
            }
        ]
    ],
    "roles": [
        {
            "sequence": 1,
            "placeholder": {
                "name": null,
                "id": null
            },
            "profile": {
                "name": "שני כהן",
                "id": 63,
                "phone": "052656565",
                "email": "email@example.com"
            },
            "recipient": true
        },
        {
            "sequence": 2,
            "placeholder": {
                "name": null,
                "id": null
            },
            "profile": {
                "name": "שני כהן",
                "id": 63,
                "phone": "052656565",
                "email": "email@example.com"
            },
            "recipient": true
        }
    ]
}
 

Request      

POST api/entity/{entity_id}/forms/{form_id}/reminder

URL Parameters

entity_id  integer  

The ID of the entity.

form_id  integer optional  

Form ID

List template forms

Example request:
curl --request GET \
    --get "http://localhost/api/entity/19/templates/repellat/forms" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/19/templates/repellat/forms"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 26,
    "recordsFiltered": 4,
    "data": [
        {
            "id": 23,
            "recipient_name": "Eli",
            "recipient_type": "Manager",
            "recipient_id": 12,
            "name": "Form 101",
            "status": "waiting",
            "created_at": "2021-09-05 15:23:09",
            "signed_date": null,
            "template_id": 5,
            "dir_hash": "0f5ff456-d5f9-44c0-8270-4eb930a981c2",
            "file_id": null,
            "admin_status": "not approved",
            "admin_notes": null,
            "updated_at": "2021-09-05 15:23:09",
            "company_name": "new name",
            "sender_name": null,
            "template_slug": "form101",
            "assignees": [
                {
                    "slug": "6134e0dd1848c",
                    "placeholder": null,
                    "status": "waiting",
                    "sent_date": "2021-09-05T15:23:09.000000Z",
                    "signed_date": null,
                    "profile": {
                        "id": 12,
                        "first_name": "Eli",
                        "last_name": null
                    }
                }
            ]
        },
        {
            "id": 24,
            "recipient_name": null,
            "recipient_type": null,
            "recipient_id": null,
            "name": "Form 101",
            "status": "waiting",
            "created_at": "2021-09-05 15:30:33",
            "signed_date": null,
            "template_id": 5,
            "dir_hash": "0f5ff456-d5f9-44c0-8270-4eb930a981c2",
            "file_id": null,
            "admin_status": "not approved",
            "admin_notes": null,
            "updated_at": "2021-09-05 15:30:33",
            "company_name": "new name",
            "sender_name": null,
            "template_slug": "form101",
            "assignees": [
                {
                    "slug": "6134e299c5f5a",
                    "placeholder": null,
                    "status": "waiting",
                    "sent_date": "2021-09-05T15:30:33.000000Z",
                    "signed_date": null,
                    "profile": null
                }
            ]
        },
        {
            "id": 25,
            "recipient_name": "Eli",
            "recipient_type": "Employee",
            "recipient_id": 16,
            "name": "Form 101",
            "status": "signed",
            "created_at": "2021-09-13 13:37:52",
            "signed_date": "2021-09-19",
            "template_id": 5,
            "dir_hash": "0f5ff456-d5f9-44c0-8270-4eb930a981c2",
            "file_id": 19,
            "admin_status": "not approved",
            "admin_notes": null,
            "updated_at": "2021-09-19 08:24:22",
            "company_name": "new name",
            "sender_name": "Eli",
            "template_slug": "form101",
            "assignees": [
                {
                    "slug": "613f543036eee",
                    "placeholder": null,
                    "status": "signed",
                    "sent_date": "2021-09-13T13:37:52.000000Z",
                    "signed_date": "2021-09-19T08:24:18.000000Z",
                    "profile": {
                        "id": 16,
                        "first_name": "Eli",
                        "last_name": null
                    }
                }
            ]
        },
        {
            "id": 26,
            "recipient_name": "Eli",
            "recipient_type": "Employee",
            "recipient_id": 15,
            "name": "Form 101",
            "status": "waiting",
            "created_at": "2021-09-23 09:46:38",
            "signed_date": null,
            "template_id": 5,
            "dir_hash": "0f5ff456-d5f9-44c0-8270-4eb930a981c2",
            "file_id": null,
            "admin_status": "not approved",
            "admin_notes": null,
            "updated_at": "2021-09-23 09:46:39",
            "company_name": "new name",
            "sender_name": "Eli",
            "template_slug": "form101",
            "assignees": [
                {
                    "slug": "614c4cfef1a40",
                    "placeholder": null,
                    "status": "waiting",
                    "sent_date": "2021-09-23T09:46:38.000000Z",
                    "signed_date": null,
                    "profile": {
                        "id": 15,
                        "first_name": "Eli",
                        "last_name": null
                    }
                }
            ]
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/templates/{template_id}/forms

URL Parameters

entity_id  integer  

The ID of the entity.

template_id  string optional  

ID or slug of template

Fill Form 101

Example request:
curl --request POST \
    "http://localhost/api/profile/4/form101" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"deserunt\",
    \"last_name\": \"illo\",
    \"birth_date\": \"perferendis\",
    \"id_number_type\": \"occaecati\",
    \"id_number\": \"veritatis\",
    \"phone\": \"atque\",
    \"immigration_date\": \"pariatur\",
    \"street_name\": \"ut\",
    \"house_number\": \"beatae\",
    \"city\": \"cum\",
    \"gender\": \"reprehenderit\",
    \"marital_status\": \"ut\",
    \"israeli_citizen\": true,
    \"kibutz_member\": false,
    \"health_care_member\": true,
    \"health_care_company_name\": \"mollitia\",
    \"spouse_first_name\": \"dicta\",
    \"spouse_last_name\": \"aliquam\",
    \"spouse_birth_date\": \"animi\",
    \"spouse_immigration_date\": \"rerum\",
    \"spouse_id_number_type\": \"temporibus\",
    \"spouse_id_number\": \"inventore\",
    \"spouse_income\": \"eos\",
    \"spouse_income_type\": \"eum\",
    \"has_kids\": true,
    \"kids_array\": \"qui\",
    \"salary_type\": \"aut\",
    \"start_of_employment\": \"dolorem\",
    \"additional_income\": \"cumque\",
    \"additional_income_type\": \"totam\",
    \"additional_income_type_other_value\": \"aliquid\",
    \"nekudot_zikui\": \"et\",
    \"hafrashot_no_policy\": true,
    \"hafrashot_no_insurance\": true,
    \"tax_benefit_israeli_resident\": false,
    \"tax_benefit_disability\": true,
    \"tax_benefit_living_place\": true,
    \"tax_benefit_living_place_start_date\": \"modi\",
    \"tax_benefit_living_place_name\": \"porro\",
    \"tax_benefit_immigrant\": true,
    \"tax_benefit_spouse\": false,
    \"tax_benefit_immigrant_start_date\": \"ut\",
    \"tax_benefit_immigrant_first_payment_in_tax_year\": \"cum\",
    \"tax_benefit_single_parent_family\": true,
    \"tax_benefit_kids_in_custody\": 1,
    \"tax_benefit_kids_in_custody_born_in_tax_year\": 13,
    \"tax_benefit_kids_in_custody_between_1_5\": 16,
    \"tax_benefit_kids_in_custody_between_6_17\": 19,
    \"tax_benefit_kids_in_custody_over_18\": 4,
    \"tax_benefit_infant_kids\": 9,
    \"tax_benefit_infant_kids_born_in_tax_year\": 20,
    \"tax_benefit_infant_kids_between_1_5\": 13,
    \"tax_benefit_single_parent\": false,
    \"tax_benefit_non_custody_kids\": 15,
    \"tax_benefit_disabled_under_19\": false,
    \"tax_benefit_child_support\": true,
    \"tax_benefit_ages_16_18\": 5,
    \"tax_benefit_army\": true,
    \"tax_benefit_army_start_date\": \"modi\",
    \"tax_benefit_army_end_date\": \"debitis\",
    \"tax_benefit_graduation\": true,
    \"signature_hash\": \"distinctio\"
}"
const url = new URL(
    "http://localhost/api/profile/4/form101"
);

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

let body = {
    "first_name": "deserunt",
    "last_name": "illo",
    "birth_date": "perferendis",
    "id_number_type": "occaecati",
    "id_number": "veritatis",
    "phone": "atque",
    "immigration_date": "pariatur",
    "street_name": "ut",
    "house_number": "beatae",
    "city": "cum",
    "gender": "reprehenderit",
    "marital_status": "ut",
    "israeli_citizen": true,
    "kibutz_member": false,
    "health_care_member": true,
    "health_care_company_name": "mollitia",
    "spouse_first_name": "dicta",
    "spouse_last_name": "aliquam",
    "spouse_birth_date": "animi",
    "spouse_immigration_date": "rerum",
    "spouse_id_number_type": "temporibus",
    "spouse_id_number": "inventore",
    "spouse_income": "eos",
    "spouse_income_type": "eum",
    "has_kids": true,
    "kids_array": "qui",
    "salary_type": "aut",
    "start_of_employment": "dolorem",
    "additional_income": "cumque",
    "additional_income_type": "totam",
    "additional_income_type_other_value": "aliquid",
    "nekudot_zikui": "et",
    "hafrashot_no_policy": true,
    "hafrashot_no_insurance": true,
    "tax_benefit_israeli_resident": false,
    "tax_benefit_disability": true,
    "tax_benefit_living_place": true,
    "tax_benefit_living_place_start_date": "modi",
    "tax_benefit_living_place_name": "porro",
    "tax_benefit_immigrant": true,
    "tax_benefit_spouse": false,
    "tax_benefit_immigrant_start_date": "ut",
    "tax_benefit_immigrant_first_payment_in_tax_year": "cum",
    "tax_benefit_single_parent_family": true,
    "tax_benefit_kids_in_custody": 1,
    "tax_benefit_kids_in_custody_born_in_tax_year": 13,
    "tax_benefit_kids_in_custody_between_1_5": 16,
    "tax_benefit_kids_in_custody_between_6_17": 19,
    "tax_benefit_kids_in_custody_over_18": 4,
    "tax_benefit_infant_kids": 9,
    "tax_benefit_infant_kids_born_in_tax_year": 20,
    "tax_benefit_infant_kids_between_1_5": 13,
    "tax_benefit_single_parent": false,
    "tax_benefit_non_custody_kids": 15,
    "tax_benefit_disabled_under_19": false,
    "tax_benefit_child_support": true,
    "tax_benefit_ages_16_18": 5,
    "tax_benefit_army": true,
    "tax_benefit_army_start_date": "modi",
    "tax_benefit_army_end_date": "debitis",
    "tax_benefit_graduation": true,
    "signature_hash": "distinctio"
};

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

Example response (200):


{
    "id": 68,
    "template_id": 5,
    "sender_id": null,
    "recipient_id": "16",
    "entity_id": "16",
    "name": "Form 101",
    "file_id": 43,
    "dir_hash": "0f5ff456-d5f9-44c0-8270-4eb930a981c2",
    "payload_id": "616424150135867cd56b1e8b",
    "status": "missing-files",
    "admin_status": "not approved",
    "admin_notes": null,
    "signed_date": "2021-10-11T00:00:00.000000Z",
    "public": 0,
    "schedule": null,
    "parent_form_id": null,
    "created_at": "2021-10-11T11:46:29.000000Z",
    "updated_at": "2021-10-11T11:46:33.000000Z",
    "entity": {
        "id": 16,
        "type": "reseller",
        "name": "EasyDoc Main",
        "parent_entity_id": 13,
        "phone": null,
        "email": null,
        "address": null,
        "legal_id": null,
        "deduction_id": null,
        "payroll_system": null,
        "external_id": null,
        "wl": null,
        "reseller_id": null,
        "rep_id": null,
        "features_group_id": null,
        "package_id": null,
        "status": "active",
        "default": 1,
        "whm_product_id": null,
        "created_at": null,
        "updated_at": null,
        "is_client": true
    },
    "recipient": {
        "id": 16,
        "user_id": 37,
        "entity_id": 16,
        "type_id": 4,
        "status": "active",
        "id_number": "5321649987",
        "email": "eli.demayo+e3@gmail.com",
        "first_name": "Eli",
        "last_name": null,
        "business_name": null,
        "phone": null,
        "birth_date": "2021-10-20",
        "street_name": "galil",
        "house_number": "12",
        "apartment_number": null,
        "city": "Karmiel",
        "zip": null,
        "payment_method": null,
        "bank_number": null,
        "bank_branch_number": null,
        "bank_account_number": null,
        "policy_status": null,
        "policy_id": null,
        "policy_legal_number": null,
        "gender": "male",
        "external_id": null,
        "payroll_id": null,
        "marital_status": "married",
        "direct_manager_id": null,
        "indirect_manager_id": null,
        "department_id": null,
        "role_id": null,
        "features_group_id": null,
        "require_101": null,
        "language": null,
        "legal_id": null,
        "website": null,
        "created_at": "2021-08-04T13:43:50.000000Z",
        "updated_at": "2021-10-10T14:49:13.000000Z"
    },
    "payload": {
        "data": {
            "http://localhost:8000/forms/0f5ff456-d5f9-44c0-8270-4eb930a981c2/bg/1.jpg": [
                {
                    "pos_x": 0.3746058558558559,
                    "pos_y": 0.10007473469184396,
                    "width": 0.111022,
                    "height": 0.019899354092969956,
                    "name": "tax_year",
                    "placeholder": "2 0 2 1 ",
                    "font": "Arial",
                    "font_size": "26",
                    "type": "input-system",
                    "content_value": "2 0 2 1 "
                },
                {
                    "pos_x": 0.7036176801801802,
                    "pos_y": 0.19894374968860545,
                    "width": 0.17678776576576577,
                    "height": 0.019899354092969956,
                    "name": "employer_name",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-system",
                    "content_value": null
                },
                {
                    "pos_x": 0.36126126126126124,
                    "pos_y": 0.19895371431418465,
                    "width": 0.311022,
                    "height": 0.019899354092969956,
                    "name": "employer_address",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-system",
                    "content_value": null
                },
                {
                    "pos_x": 0.22345157657657658,
                    "pos_y": 0.19959145035125306,
                    "width": 0.1074183963963964,
                    "height": 0.01862388201883314,
                    "name": "employer_phone",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-system",
                    "content_value": null
                },
                {
                    "pos_x": 0.7342483108108108,
                    "pos_y": 0.2589009017986149,
                    "width": 0.15336434234234234,
                    "height": 0.019899354092969956,
                    "name": "id_number_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1,
                    "content_value": "5321649987"
                },
                {
                    "pos_x": 0.06307713963963964,
                    "pos_y": 0.20022918638832146,
                    "width": 0.13624722522522523,
                    "height": 0.017348409944696327,
                    "name": "employer_number",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-system",
                    "role_id": 1,
                    "content_value": null
                },
                {
                    "pos_x": 0.5369510135135135,
                    "pos_y": 0.2589009017986149,
                    "width": 0.17768866666666666,
                    "height": 0.019899354092969956,
                    "name": "last_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-text",
                    "role_id": 1,
                    "content_value": "Bakal"
                },
                {
                    "pos_x": 0.35855855855855856,
                    "pos_y": 0.2595386378356833,
                    "width": 0.14795893693693693,
                    "height": 0.01926161805590155,
                    "name": "first_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-text",
                    "role_id": 1,
                    "content_value": "Moshe"
                },
                {
                    "pos_x": 0.19659346846846848,
                    "pos_y": 0.2608141099098201,
                    "width": 0.14075172972972974,
                    "height": 0.02117482616710677,
                    "name": "birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-date",
                    "format": "d/m/Y",
                    "save_as": "recipient.birth_date",
                    "role_id": 1,
                    "content_value": "2021-10-20"
                },
                {
                    "pos_x": 0.04276463963963964,
                    "pos_y": 0.26080414528424095,
                    "width": 0.13354452252252252,
                    "height": 0.019899354092969956,
                    "name": "immigration_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "format": "d/m/Y",
                    "type": "input-date",
                    "role_id": 1,
                    "content_value": null
                },
                {
                    "pos_x": 0.4477477477477477,
                    "pos_y": 0.2914154750635245,
                    "width": 0.18579677477477477,
                    "height": 0.019899354092969956,
                    "name": "street_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-text",
                    "save_as": "recipient.street_name",
                    "role_id": 1,
                    "content_value": "galil"
                },
                {
                    "pos_x": 0.34054054054054056,
                    "pos_y": 0.2920432464750137,
                    "width": 0.02093190990990991,
                    "height": 0.019899354092969956,
                    "name": "house_number",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-text",
                    "save_as": "recipient.house_number",
                    "role_id": 1,
                    "content_value": "12"
                },
                {
                    "pos_x": 0.2153153153153153,
                    "pos_y": 0.2920631757261721,
                    "width": 0.102012990990991,
                    "height": 0.020537090130038363,
                    "name": "city",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-text",
                    "save_as": "recipient.city",
                    "role_id": 1,
                    "content_value": "Karmiel"
                },
                {
                    "pos_x": 0.048662725225225224,
                    "pos_y": 0.2920631757261721,
                    "width": 0.1137247027027027,
                    "height": 0.019899354092969956,
                    "name": "zip",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "save_as": "recipient.zip",
                    "role_id": 1
                },
                {
                    "pos_x": 0.4252533783783784,
                    "pos_y": 0.3711424443226546,
                    "width": 0.15516614414414415,
                    "height": 0.019899354092969956,
                    "name": "custom_field",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.16306306306306306,
                    "pos_y": 0.371780180359723,
                    "width": 0.15606704504504504,
                    "height": 0.020537090130038363,
                    "name": "phone",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-text",
                    "save_as": "recipient.phone",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8716216216216216,
                    "pos_y": 0.33159284539883416,
                    "width": 0.02072072072072072,
                    "height": 0.012754720741368143,
                    "name": "employeeGender_male",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "save_as": "recipient.gender(male)",
                    "role_id": 1,
                    "content_value": "checked"
                },
                {
                    "pos_x": 0.8743102477477478,
                    "pos_y": 0.3468785810373175,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "employeeGender_female",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "save_as": "recipient.gender(female)",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7923282657657658,
                    "pos_y": 0.3290319366249813,
                    "width": 0.018018018018018018,
                    "height": 0.014667928852573365,
                    "name": "employeeStatus_single",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "save_as": "recipient.marital_status(single)",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7923282657657658,
                    "pos_y": 0.34563300283991827,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "employeeStatus_widower",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "save_as": "recipient.marital_status(widower)",
                    "role_id": 1
                },
                {
                    "pos_x": 0.684206081081081,
                    "pos_y": 0.3290518658761397,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "employeeStatus_married",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "save_as": "recipient.marital_status(married)",
                    "role_id": 1,
                    "content_value": "checked"
                },
                {
                    "pos_x": 0.39683277027027025,
                    "pos_y": 0.42339694085994717,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "salary_type_monthly",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7049408783783784,
                    "pos_y": 0.3462707388769867,
                    "width": 0.02072072072072072,
                    "height": 0.012754720741368143,
                    "name": "employeeStatus_seperated",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "save_as": "recipient.marital_status(separated)",
                    "role_id": 1
                },
                {
                    "pos_x": 0.5716075450450451,
                    "pos_y": 0.3303273379502765,
                    "width": 0.01981981981981982,
                    "height": 0.014667928852573365,
                    "name": "employeeStatus_divorced",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "save_as": "recipient.marital_status(divorced)",
                    "role_id": 1
                },
                {
                    "pos_x": 0.46349943693693696,
                    "pos_y": 0.33095510936176575,
                    "width": 0.01891891891891892,
                    "height": 0.01339245677843655,
                    "name": "israeli_citizen_1",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.4616976351351351,
                    "pos_y": 0.3462707388769867,
                    "width": 0.01891891891891892,
                    "height": 0.01339245677843655,
                    "name": "israeli_citizen_0",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3283502252252252,
                    "pos_y": 0.3303273379502765,
                    "width": 0.01891891891891892,
                    "height": 0.014667928852573365,
                    "name": "kibutz_member_1",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3274634009009009,
                    "pos_y": 0.34690847491405513,
                    "width": 0.02072072072072072,
                    "height": 0.01339245677843655,
                    "name": "kibutz_member_0",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.21394988738738738,
                    "pos_y": 0.3284041652134921,
                    "width": 0.01891891891891892,
                    "height": 0.014667928852573365,
                    "name": "health_care_member_0",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.21304898648648649,
                    "pos_y": 0.3443674953913607,
                    "width": 0.01891891891891892,
                    "height": 0.014667928852573365,
                    "name": "health_care_member_1",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.051351351351351354,
                    "pos_y": 0.34818394698819194,
                    "width": 0.05876974774774775,
                    "height": 0.013521993722285883,
                    "name": "health_care_company_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "13",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7549831081081081,
                    "pos_y": 0.4604055602610732,
                    "width": 0.09570668468468468,
                    "height": 0.019899354092969956,
                    "name": "kid_1_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1,
                    "content_value": "kid"
                },
                {
                    "pos_x": 0.7553490990990991,
                    "pos_y": 0.4859349309949679,
                    "width": 0.09750848648648648,
                    "height": 0.019899354092969956,
                    "name": "kid_2_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7553490990990991,
                    "pos_y": 0.5120920731403518,
                    "width": 0.09750848648648648,
                    "height": 0.019899354092969956,
                    "name": "kid_3_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7553490990990991,
                    "pos_y": 0.5388769866972248,
                    "width": 0.09750848648648648,
                    "height": 0.019899354092969956,
                    "name": "kid_4_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7553490990990991,
                    "pos_y": 0.5631009914802452,
                    "width": 0.09750848648648648,
                    "height": 0.019899354092969956,
                    "name": "kid_5_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7553490990990991,
                    "pos_y": 0.587972696925913,
                    "width": 0.09750848648648648,
                    "height": 0.020537090130038363,
                    "name": "kid_6_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7553490990990991,
                    "pos_y": 0.6147675751083653,
                    "width": 0.09750848648648648,
                    "height": 0.020537090130038363,
                    "name": "kid_7_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7535472972972973,
                    "pos_y": 0.6421902247023068,
                    "width": 0.09750848648648648,
                    "height": 0.020537090130038363,
                    "name": "kid_8_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7544481981981982,
                    "pos_y": 0.6670619301479747,
                    "width": 0.09750848648648648,
                    "height": 0.020537090130038363,
                    "name": "kid_9_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7535191441441441,
                    "pos_y": 0.691285934930995,
                    "width": 0.09660758558558559,
                    "height": 0.020537090130038363,
                    "name": "kid_10_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7535472972972973,
                    "pos_y": 0.7174331124507997,
                    "width": 0.09750848648648648,
                    "height": 0.02117482616710677,
                    "name": "kid_11_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7535472972972973,
                    "pos_y": 0.7429425539335359,
                    "width": 0.09750848648648648,
                    "height": 0.02117482616710677,
                    "name": "kid_13_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7535472972972973,
                    "pos_y": 0.7678142593792038,
                    "width": 0.09750848648648648,
                    "height": 0.02117482616710677,
                    "name": "kid_13_name_6164241545fd1",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.5876970720720721,
                    "pos_y": 0.45978775347516315,
                    "width": 0.14165263063063063,
                    "height": 0.019899354092969956,
                    "name": "kid_1_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1,
                    "content_value": "111154544"
                },
                {
                    "pos_x": 0.5877111486486486,
                    "pos_y": 0.4859349309949679,
                    "width": 0.14165263063063063,
                    "height": 0.019899354092969956,
                    "name": "kid_2_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.588597972972973,
                    "pos_y": 0.5114443724777041,
                    "width": 0.14165263063063063,
                    "height": 0.019899354092969956,
                    "name": "kid_3_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.588597972972973,
                    "pos_y": 0.5375915499975088,
                    "width": 0.14165263063063063,
                    "height": 0.019899354092969956,
                    "name": "kid_4_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.5868102477477477,
                    "pos_y": 0.5631009914802452,
                    "width": 0.14165263063063063,
                    "height": 0.019899354092969956,
                    "name": "kid_5_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.584107545045045,
                    "pos_y": 0.5892481690000498,
                    "width": 0.14165263063063063,
                    "height": 0.02117482616710677,
                    "name": "kid_6_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.5859093468468468,
                    "pos_y": 0.6160330825569229,
                    "width": 0.14165263063063063,
                    "height": 0.02117482616710677,
                    "name": "kid_7_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.5868102477477477,
                    "pos_y": 0.6409047880025908,
                    "width": 0.14165263063063063,
                    "height": 0.02117482616710677,
                    "name": "kid_8_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.5840934684684684,
                    "pos_y": 0.6657864580738379,
                    "width": 0.14165263063063063,
                    "height": 0.02117482616710677,
                    "name": "kid_9_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.584107545045045,
                    "pos_y": 0.6900104628568582,
                    "width": 0.14165263063063063,
                    "height": 0.021812562204175177,
                    "name": "kid_10_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.5850084459459459,
                    "pos_y": 0.7155199043395944,
                    "width": 0.14165263063063063,
                    "height": 0.021812562204175177,
                    "name": "kid_11_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.5867961711711712,
                    "pos_y": 0.7435802899706043,
                    "width": 0.14165263063063063,
                    "height": 0.021812562204175177,
                    "name": "kid_12_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.5886120495495496,
                    "pos_y": 0.7697274674904091,
                    "width": 0.14165263063063063,
                    "height": 0.021812562204175177,
                    "name": "kid_13_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.43724662162162165,
                    "pos_y": 0.4604155248866524,
                    "width": 0.12093190990990992,
                    "height": 0.019899354092969956,
                    "name": "kid_1_birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "format": "d/m/Y",
                    "type": "input-date",
                    "role_id": 1,
                    "content_value": "2021-10-20"
                },
                {
                    "pos_x": 0.4381615990990991,
                    "pos_y": 0.48594489562054705,
                    "width": 0.12093190990990992,
                    "height": 0.019899354092969956,
                    "name": "kid_2_birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "format": "d/m/Y",
                    "type": "input-date",
                    "role_id": 1
                },
                {
                    "pos_x": 0.4372606981981982,
                    "pos_y": 0.5108066364406357,
                    "width": 0.12093190990990992,
                    "height": 0.02117482616710677,
                    "name": "kid_3_birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "format": "d/m/Y",
                    "type": "input-date",
                    "role_id": 1
                },
                {
                    "pos_x": 0.4372606981981982,
                    "pos_y": 0.536316077923372,
                    "width": 0.12093190990990992,
                    "height": 0.02117482616710677,
                    "name": "kid_4_birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "format": "d/m/Y",
                    "type": "input-date",
                    "role_id": 1
                },
                {
                    "pos_x": 0.4363597972972973,
                    "pos_y": 0.5618255194061084,
                    "width": 0.12093190990990992,
                    "height": 0.02117482616710677,
                    "name": "kid_5_birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "format": "d/m/Y",
                    "type": "input-date",
                    "role_id": 1
                },
                {
                    "pos_x": 0.4363457207207207,
                    "pos_y": 0.5873349608888446,
                    "width": 0.12093190990990992,
                    "height": 0.02117482616710677,
                    "name": "kid_6_birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "format": "d/m/Y",
                    "type": "input-date",
                    "role_id": 1
                },
                {
                    "pos_x": 0.4363457207207207,
                    "pos_y": 0.6128444023715809,
                    "width": 0.12003100900900901,
                    "height": 0.02117482616710677,
                    "name": "kid_7_birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "format": "d/m/Y",
                    "type": "input-date",
                    "role_id": 1
                },
                {
                    "pos_x": 0.4354448198198198,
                    "pos_y": 0.6383538438543171,
                    "width": 0.12093190990990992,
                    "height": 0.02117482616710677,
                    "name": "kid_8_birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "format": "d/m/Y",
                    "type": "input-date",
                    "role_id": 1
                },
                {
                    "pos_x": 0.433643018018018,
                    "pos_y": 0.6651387574111903,
                    "width": 0.12093190990990992,
                    "height": 0.021812562204175177,
                    "name": "kid_9_birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "format": "d/m/Y",
                    "type": "input-date",
                    "role_id": 1
                },
                {
                    "pos_x": 0.4345439189189189,
                    "pos_y": 0.691285934930995,
                    "width": 0.12093190990990992,
                    "height": 0.021812562204175177,
                    "name": "kid_10_birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "format": "d/m/Y",
                    "type": "input-date",
                    "role_id": 1
                },
                {
                    "pos_x": 0.4345439189189189,
                    "pos_y": 0.7180708484878681,
                    "width": 0.12093190990990992,
                    "height": 0.021812562204175177,
                    "name": "kid_11_birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "format": "d/m/Y",
                    "type": "input-date",
                    "role_id": 1
                },
                {
                    "pos_x": 0.4363457207207207,
                    "pos_y": 0.7435802899706043,
                    "width": 0.12093190990990992,
                    "height": 0.021812562204175177,
                    "name": "kid_12_birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "format": "d/m/Y",
                    "type": "input-date",
                    "role_id": 1
                },
                {
                    "pos_x": 0.43724662162162165,
                    "pos_y": 0.7697274674904091,
                    "width": 0.12093190990990992,
                    "height": 0.021812562204175177,
                    "name": "kid_13_birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "format": "d/m/Y",
                    "type": "input-date",
                    "role_id": 1
                },
                {
                    "pos_x": 0.886768018018018,
                    "pos_y": 0.4553236012156843,
                    "width": 0.02072072072072072,
                    "height": 0.014030192815504957,
                    "name": "kid_1_under_my_custody",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1,
                    "content_value": true
                },
                {
                    "pos_x": 0.8885979729729729,
                    "pos_y": 0.4821085147725574,
                    "width": 0.02072072072072072,
                    "height": 0.014667928852573365,
                    "name": "kid_2_under_my_custody",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8877111486486486,
                    "pos_y": 0.5076179562552937,
                    "width": 0.02072072072072072,
                    "height": 0.014667928852573365,
                    "name": "kid_3_under_my_custody",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.887697072072072,
                    "pos_y": 0.5344028698121668,
                    "width": 0.021621621621621623,
                    "height": 0.015305664889641772,
                    "name": "kid_4_under_my_custody",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8868102477477477,
                    "pos_y": 0.559912311294903,
                    "width": 0.021621621621621623,
                    "height": 0.015305664889641772,
                    "name": "kid_5_under_my_custody",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8867820945945946,
                    "pos_y": 0.5866972248517762,
                    "width": 0.021621621621621623,
                    "height": 0.015305664889641772,
                    "name": "kid_6_under_my_custody",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8867820945945946,
                    "pos_y": 0.6128543669971601,
                    "width": 0.021621621621621623,
                    "height": 0.014667928852573365,
                    "name": "kid_7_under_my_custody",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8868102477477477,
                    "pos_y": 0.6390015445169648,
                    "width": 0.021621621621621623,
                    "height": 0.014667928852573365,
                    "name": "kid_8_under_my_custody",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8868102477477477,
                    "pos_y": 0.6645010213741218,
                    "width": 0.021621621621621623,
                    "height": 0.014667928852573365,
                    "name": "kid_9_under_my_custody",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8868102477477477,
                    "pos_y": 0.6887349907827214,
                    "width": 0.021621621621621623,
                    "height": 0.014667928852573365,
                    "name": "kid_10_under_my_custody",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8868102477477477,
                    "pos_y": 0.7161576403766629,
                    "width": 0.021621621621621623,
                    "height": 0.014667928852573365,
                    "name": "kid_11_under_my_custody",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8868102477477477,
                    "pos_y": 0.7416770464849783,
                    "width": 0.021621621621621623,
                    "height": 0.014667928852573365,
                    "name": "kid_12_under_my_custody",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8868102477477477,
                    "pos_y": 0.7703751681530566,
                    "width": 0.021621621621621623,
                    "height": 0.014667928852573365,
                    "name": "kid_13_under_my_custody",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8678913288288288,
                    "pos_y": 0.45596133725275273,
                    "width": 0.02072072072072072,
                    "height": 0.015305664889641772,
                    "name": "kid_1_receive_social_scurity",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8669622747747747,
                    "pos_y": 0.4814807433610682,
                    "width": 0.02072072072072072,
                    "height": 0.015305664889641772,
                    "name": "kid_2_receive_social_scurity",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8660754504504504,
                    "pos_y": 0.5082556922923621,
                    "width": 0.02072072072072072,
                    "height": 0.015305664889641772,
                    "name": "kid_3_receive_social_scurity",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8669904279279279,
                    "pos_y": 0.5337750984006776,
                    "width": 0.02072072072072072,
                    "height": 0.015305664889641772,
                    "name": "kid_4_receive_social_scurity",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8651886261261261,
                    "pos_y": 0.5605600119575507,
                    "width": 0.02072072072072072,
                    "height": 0.015305664889641772,
                    "name": "kid_5_receive_social_scurity",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8642877252252252,
                    "pos_y": 0.5873349608888446,
                    "width": 0.021621621621621623,
                    "height": 0.015305664889641772,
                    "name": "kid_6_receive_social_scurity",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8651886261261261,
                    "pos_y": 0.6128543669971601,
                    "width": 0.021621621621621623,
                    "height": 0.014667928852573365,
                    "name": "kid_7_receive_social_scurity",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8651886261261261,
                    "pos_y": 0.6390015445169648,
                    "width": 0.02072072072072072,
                    "height": 0.014667928852573365,
                    "name": "kid_8_receive_social_scurity",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8660754504504504,
                    "pos_y": 0.6651387574111903,
                    "width": 0.021621621621621623,
                    "height": 0.014667928852573365,
                    "name": "kid_9_receive_social_scurity",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8651745495495495,
                    "pos_y": 0.6887449554083005,
                    "width": 0.021621621621621623,
                    "height": 0.014667928852573365,
                    "name": "kid_10_receive_social_scurity",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8633868243243243,
                    "pos_y": 0.7167953764137313,
                    "width": 0.021621621621621623,
                    "height": 0.014667928852573365,
                    "name": "kid_11_receive_social_scurity",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8642877252252252,
                    "pos_y": 0.7429425539335359,
                    "width": 0.021621621621621623,
                    "height": 0.014667928852573365,
                    "name": "kid_12_receive_social_scurity",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8651886261261261,
                    "pos_y": 0.7697274674904091,
                    "width": 0.02072072072072072,
                    "height": 0.014667928852573365,
                    "name": "kid_13_receive_social_scurity",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3967060810810811,
                    "pos_y": 0.43683922076627973,
                    "width": 0.018018018018018018,
                    "height": 0.014030192815504957,
                    "name": "salary_type_addtional",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3958051801801802,
                    "pos_y": 0.4514971849932739,
                    "width": 0.018018018018018018,
                    "height": 0.014030192815504957,
                    "name": "salary_type_partial",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3967060810810811,
                    "pos_y": 0.46616511384584725,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "salary_type_daily",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3967060810810811,
                    "pos_y": 0.4801953066613522,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "salary_type_allowance",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3967060810810811,
                    "pos_y": 0.49359772806536795,
                    "width": 0.018018018018018018,
                    "height": 0.014030192815504957,
                    "name": "salary_type_scholarship",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.05589808558558559,
                    "pos_y": 0.44633550894325147,
                    "width": 0.1263373153153153,
                    "height": 0.01926161805590155,
                    "name": "start_of_employment",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.39294763513513514,
                    "pos_y": 0.5388769866972248,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "additional_income_0",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.39294763513513514,
                    "pos_y": 0.5548104229983558,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "additional_income_1",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3947353603603604,
                    "pos_y": 0.5669274077026556,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "additional_income_type_monthly",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.39384853603603603,
                    "pos_y": 0.5796821284440237,
                    "width": 0.01891891891891892,
                    "height": 0.012754720741368143,
                    "name": "additional_income_type_addtionalJob",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.39294763513513514,
                    "pos_y": 0.5937222858851079,
                    "width": 0.01891891891891892,
                    "height": 0.012754720741368143,
                    "name": "additional_income_type_partial",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.39383445945945944,
                    "pos_y": 0.6077524787006128,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "additional_income_type_daily",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.18212274774774775,
                    "pos_y": 0.5669274077026556,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "additional_income_type_allowance",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.18213682432432432,
                    "pos_y": 0.5803198644810921,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "additional_income_type_scholarship",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.18123592342342343,
                    "pos_y": 0.5943500572965971,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "additional_income_type_other",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.05229448198198198,
                    "pos_y": 0.6082008868516765,
                    "width": 0.12453551351351351,
                    "height": 0.017348409944696327,
                    "name": "additional_income_type_other_value",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3902449324324324,
                    "pos_y": 0.6345274276319067,
                    "width": 0.02252252252252252,
                    "height": 0.015943400926710177,
                    "name": "nekudot_zikui_new_request",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3902449324324324,
                    "pos_y": 0.661322305814359,
                    "width": 0.02252252252252252,
                    "height": 0.015943400926710177,
                    "name": "nekudot_zikui_already_receive",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3902308558558559,
                    "pos_y": 0.691285934930995,
                    "width": 0.02252252252252252,
                    "height": 0.015305664889641772,
                    "name": "hafrashot_no_policy",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.39114583333333336,
                    "pos_y": 0.730197797817747,
                    "width": 0.02252252252252252,
                    "height": 0.015943400926710177,
                    "name": "hafrashot_no_insurance",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7369791666666666,
                    "pos_y": 0.8241642170295451,
                    "width": 0.14345443243243244,
                    "height": 0.020537090130038363,
                    "name": "spouse_id_number_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.5298845720720721,
                    "pos_y": 0.8252204673409397,
                    "width": 0.17949046846846847,
                    "height": 0.019899354092969956,
                    "name": "spouse_last_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3533079954954955,
                    "pos_y": 0.8252105027153604,
                    "width": 0.15066163963963963,
                    "height": 0.02117482616710677,
                    "name": "spouse_first_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.20195664414414413,
                    "pos_y": 0.8239350306412236,
                    "width": 0.12813911711711712,
                    "height": 0.022450298241243585,
                    "name": "spouse_birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.053307995495495496,
                    "pos_y": 0.8226695231926661,
                    "width": 0.12813911711711712,
                    "height": 0.021812562204175177,
                    "name": "spouse_immigration",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.6821368243243243,
                    "pos_y": 0.8475412286383339,
                    "width": 0.02252252252252252,
                    "height": 0.015305664889641772,
                    "name": "spouse_income_0",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.470411036036036,
                    "pos_y": 0.8475312640127547,
                    "width": 0.02252252252252252,
                    "height": 0.015305664889641772,
                    "name": "spouse_income_1",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.2641188063063063,
                    "pos_y": 0.8481690000498231,
                    "width": 0.02252252252252252,
                    "height": 0.015305664889641772,
                    "name": "spouse_income_type_job/allowance/bussines",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.12808277027027026,
                    "pos_y": 0.8500822081610283,
                    "width": 0.023423423423423424,
                    "height": 0.016581136963778585,
                    "name": "spouse_income_type_other",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7018158783783783,
                    "pos_y": 0.2965472572368093,
                    "width": 0.18039136936936936,
                    "height": 0.01926161805590155,
                    "name": "id_number_passport",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7126266891891891,
                    "pos_y": 0.8526730108116187,
                    "width": 0.16327425225225226,
                    "height": 0.019899354092969956,
                    "name": "spouse_id_number_passport",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                }
            ],
            "http://localhost:8000/forms/0f5ff456-d5f9-44c0-8270-4eb930a981c2/bg/2.jpg": [
                {
                    "pos_x": 0.06345720720720721,
                    "pos_y": 0.7384385431717403,
                    "width": 0.13693693693693693,
                    "height": 0.03826416222410443,
                    "name": "signature",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-signature",
                    "role_id": 1,
                    "signature_hash": "615c4bb5aaa76",
                    "content_value": "signature-signed"
                },
                {
                    "pos_x": 0.24342623873873873,
                    "pos_y": 0.7511932639131085,
                    "width": 0.12183281081081081,
                    "height": 0.019899354092969956,
                    "name": "current_date",
                    "placeholder": "11/10/2021",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-system",
                    "role_id": 1,
                    "content_value": "11/10/2021"
                },
                {
                    "pos_x": 0.8524070945945946,
                    "pos_y": 0.06053510039360271,
                    "width": 0.02252252252252252,
                    "height": 0.015943400926710177,
                    "name": "tax_benefit_israeli_resident",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8524070945945946,
                    "pos_y": 0.07902944546858652,
                    "width": 0.02252252252252252,
                    "height": 0.015943400926710177,
                    "name": "tax_benefit_disability",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8515061936936937,
                    "pos_y": 0.10964077524787007,
                    "width": 0.02252252252252252,
                    "height": 0.015943400926710177,
                    "name": "tax_benefit_living_place",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.43157376126126124,
                    "pos_y": 0.10813611678541178,
                    "width": 0.10561659459459459,
                    "height": 0.01862388201883314,
                    "name": "tax_benefit_living_place_start_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.6091638513513513,
                    "pos_y": 0.12430870410044342,
                    "width": 0.1065174954954955,
                    "height": 0.019899354092969956,
                    "name": "tax_benefit_living_place_pame",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.852393018018018,
                    "pos_y": 0.14343082058691645,
                    "width": 0.021621621621621623,
                    "height": 0.015305664889641772,
                    "name": "tax_benifit_immagrant_oleHadash",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.9603603603603603,
                    "pos_y": 0.007603009316924917,
                    "width": 0.02072072072072072,
                    "height": 0.014667928852573365,
                    "name": "tax_benifit_immagrant_toshavHozer",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.5775197072072072,
                    "pos_y": 0.14002291863883215,
                    "width": 0.08309407207207208,
                    "height": 0.01926161805590155,
                    "name": "tax_benifit_immagrant_start_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3190596846846847,
                    "pos_y": 0.15555776991679537,
                    "width": 0.08399497297297297,
                    "height": 0.020537090130038363,
                    "name": "tax_benifit_immagrant_first_payment_in_tax_year",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.1612894144144144,
                    "pos_y": 0.016351950575457127,
                    "width": 0.1101210990990991,
                    "height": 0.01926161805590155,
                    "name": "id_number",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-text",
                    "save_as": "recipient.id_number",
                    "role_id": 1,
                    "content_value": "5321649987"
                },
                {
                    "pos_x": 0.8533079954954955,
                    "pos_y": 0.2033979373225051,
                    "width": 0.02252252252252252,
                    "height": 0.015943400926710177,
                    "name": "tax_benefit_spouse",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8549408783783784,
                    "pos_y": 0.2563200637736037,
                    "width": 0.01981981981981982,
                    "height": 0.014030192815504957,
                    "name": "tax_benefit_kids_in_custody",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8524070945945946,
                    "pos_y": 0.2282596781425938,
                    "width": 0.02252252252252252,
                    "height": 0.015943400926710177,
                    "name": "tax_benefit_single_parent_family",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8542088963963964,
                    "pos_y": 0.31307857107269194,
                    "width": 0.02252252252252252,
                    "height": 0.015305664889641772,
                    "name": "tax_benefit_infant_kids",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8533079954954955,
                    "pos_y": 0.35900553036719646,
                    "width": 0.02252252252252252,
                    "height": 0.015305664889641772,
                    "name": "tax_benefit_single_parent",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.852393018018018,
                    "pos_y": 0.38195406307607993,
                    "width": 0.02252252252252252,
                    "height": 0.015943400926710177,
                    "name": "tax_benefit_non_custody_kids",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8506052927927928,
                    "pos_y": 0.4106521847441582,
                    "width": 0.02252252252252252,
                    "height": 0.015305664889641772,
                    "name": "tax_benefit_disabled_under_19",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8505912162162163,
                    "pos_y": 0.43807483433809974,
                    "width": 0.02252252252252252,
                    "height": 0.015943400926710177,
                    "name": "tax_benefit_child_support",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8524070945945946,
                    "pos_y": 0.45849235214986794,
                    "width": 0.02252252252252252,
                    "height": 0.015305664889641772,
                    "name": "tax_benefit_ages_16_18",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.852393018018018,
                    "pos_y": 0.477614468636341,
                    "width": 0.02252252252252252,
                    "height": 0.015943400926710177,
                    "name": "tax_benefit_army",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8533079954954955,
                    "pos_y": 0.5075880623785561,
                    "width": 0.02072072072072072,
                    "height": 0.014667928852573365,
                    "name": "tax_benefit_graduation",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.6189611486486486,
                    "pos_y": 0.2816003188680185,
                    "width": 0.020031009009009008,
                    "height": 0.01862388201883314,
                    "name": "tax_benefit_kids_in_custody_born_in_tax_year",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.1343890765765766,
                    "pos_y": 0.2926710178865029,
                    "width": 0.02093190990990991,
                    "height": 0.019899354092969956,
                    "name": "tax_benefit_kids_in_custody_over_18",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.47312781531531534,
                    "pos_y": 0.2920332818494345,
                    "width": 0.02093190990990991,
                    "height": 0.019899354092969956,
                    "name": "tax_benefit_kids_in_custody_between_1_5",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.6190737612612612,
                    "pos_y": 0.32328234766578645,
                    "width": 0.020031009009009008,
                    "height": 0.019899354092969956,
                    "name": "tax_benefit_infant_kids_born_in_tax_year",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.4749296171171171,
                    "pos_y": 0.33795027651835985,
                    "width": 0.02093190990990991,
                    "height": 0.019899354092969956,
                    "name": "tax_benefit_infant_kids_between_1_5",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.32615427927927926,
                    "pos_y": 0.47378805241393057,
                    "width": 0.08219317117117117,
                    "height": 0.019899354092969956,
                    "name": "tax_benefit_army_start_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.10375844594594595,
                    "pos_y": 0.4750635244880674,
                    "width": 0.08399497297297297,
                    "height": 0.01926161805590155,
                    "name": "tax_benefit_army_end_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.06486486486486487,
                    "pos_y": 0.27677744008768873,
                    "width": 0.020031009009009008,
                    "height": 0.019899354092969956,
                    "name": "tax_benefit_kids_in_custody_between_6_17",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "name": "employeeIdCertificate",
                    "type": "file",
                    "content_value": null,
                    "image_path": null,
                    "file_id": null,
                    "signature_hash": null,
                    "required": true,
                    "role_id": 1
                },
                {
                    "name": "seperatedCoupleCertificate",
                    "type": "file",
                    "content_value": null,
                    "image_path": null,
                    "file_id": null,
                    "signature_hash": null,
                    "required": "if(employeeStatus_seperated)",
                    "role_id": 1
                },
                {
                    "name": "taxClaimCertificate",
                    "type": "file",
                    "content_value": null,
                    "image_path": null,
                    "file_id": null,
                    "signature_hash": null,
                    "required": "if(additional_income_1)",
                    "role_id": 1
                },
                {
                    "name": "taxBenefit-livingPlace-certificate",
                    "type": "file",
                    "content_value": null,
                    "image_path": null,
                    "file_id": null,
                    "signature_hash": null,
                    "required": "if(tax_benefit_living_place)",
                    "role_id": 1
                },
                {
                    "name": "tax-Benefit-immagrant-IMOCertificate",
                    "type": "file",
                    "content_value": null,
                    "image_path": null,
                    "file_id": null,
                    "signature_hash": null,
                    "required": "if(tax_benefit_immigrant)",
                    "role_id": 1
                },
                {
                    "name": "tax_benefit_spouse-certifitace",
                    "type": "file",
                    "content_value": null,
                    "image_path": null,
                    "file_id": null,
                    "signature_hash": null,
                    "required": "if(tax_benefit_spouse)",
                    "role_id": 1
                },
                {
                    "name": "tax-benefit-nonCustodyKids-certificate",
                    "type": "file",
                    "content_value": null,
                    "image_path": null,
                    "file_id": null,
                    "signature_hash": null,
                    "required": "if(tax_benefit_non_custody_kids)",
                    "role_id": 1
                },
                {
                    "name": "tax_benefit_disabledUnder19-certificate",
                    "type": "file",
                    "content_value": null,
                    "image_path": null,
                    "file_id": null,
                    "signature_hash": null,
                    "required": "if(tax_benefit_disabled_under_19)",
                    "role_id": 1
                },
                {
                    "name": "tax-benefit-childSupport-certificate",
                    "type": "file",
                    "content_value": null,
                    "image_path": null,
                    "file_id": null,
                    "signature_hash": null,
                    "required": "if(tax_benefit_child_support)",
                    "role_id": 1
                },
                {
                    "name": "tax-benefit-army-certificate",
                    "type": "file",
                    "content_value": null,
                    "image_path": null,
                    "file_id": null,
                    "signature_hash": null,
                    "required": "if(tax_benefit_army)",
                    "role_id": 1
                },
                {
                    "name": "tax-benefit-graduation-certificate",
                    "type": "file",
                    "content_value": null,
                    "image_path": null,
                    "file_id": null,
                    "signature_hash": null,
                    "required": "if(tax_benefit_graduation)",
                    "role_id": 1
                },
                {
                    "name": "tax_benefit_graduation-certificate",
                    "type": "file",
                    "content_value": null,
                    "image_path": null,
                    "file_id": null,
                    "signature_hash": null,
                    "required": "if(tax_benefit_graduation)",
                    "role_id": 1
                },
                {
                    "name": "taxBenefit-disability-certificate",
                    "type": "file",
                    "content_value": null,
                    "image_path": null,
                    "file_id": null,
                    "signature_hash": null,
                    "required": "if(tax_benefit_disability)",
                    "role_id": 1
                }
            ]
        }
    },
    "assignees": [
        {
            "id": 68,
            "slug": "61642414f40b7",
            "form_id": 68,
            "sequence": 1,
            "profile_id": 16,
            "placeholder": null,
            "template_role_id": 1,
            "public": false,
            "status": "signed",
            "sign_ip": null,
            "sign_device": null,
            "sent_date": "2021-10-11T11:46:28.000000Z",
            "signed_date": "2021-10-11T11:46:29.000000Z",
            "notify_platform": "email",
            "notify_notes": null,
            "created_at": "2021-10-11T11:46:29.000000Z",
            "updated_at": "2021-10-11T11:46:29.000000Z"
        }
    ],
    "files": [
        {
            "id": 54,
            "form_id": 68,
            "file_id": null,
            "name": "employeeIdCertificate",
            "display_name": null,
            "status": "missing",
            "created_at": "2021-10-11T11:46:29.000000Z",
            "updated_at": "2021-10-11T11:46:29.000000Z"
        }
    ]
}
 

Request      

POST api/profile/{profile_id}/form101

URL Parameters

profile_id  integer  

Profile ID

Body Parameters

first_name  string optional  

last_name  string optional  

birth_date  date optional  

id_number_type  string optional  

allowed values ("id", "passport")

id_number  string optional  

phone  phone optional  

immigration_date  date optional  

street_name  string optional  

house_number  string optional  

city  string optional  

gender  string optional  

allowed values ("male", "female")

marital_status  string optional  

allowed values ("married", "single", "divorced", "widower", "separated")

israeli_citizen  boolean optional  

kibutz_member  boolean optional  

health_care_member  boolean optional  

health_care_company_name  string optional  

spouse_first_name  string optional  

spouse_last_name  string optional  

spouse_birth_date  date optional  

spouse_immigration_date  date optional  

spouse_id_number_type  string optional  

allowed values ("id", "passport")

spouse_id_number  string, optional  

spouse_income  bool, optional  

spouse_income_type  string optional  

allowed values ("job/allowance/business", "other")

has_kids  boolean optional  

kids_array  Child[], optional  

salary_type  string optional  

allowed values ("monthly", "additional", "partial", "daily", "allowance", "scholarship")

start_of_employment  date optional  

additional_income  bool, optional  

additional_income_type  string optional  

allowed values ("monthly", "additional", "partial", "daily", "allowance", "scholarship", "other")

additional_income_type_other_value  string optional  

nekudot_zikui  [ optional  

string allowed values ("new_request", "already_receive")

hafrashot_no_policy  boolean optional  

hafrashot_no_insurance  boolean optional  

tax_benefit_israeli_resident  boolean optional  

tax_benefit_disability  boolean optional  

tax_benefit_living_place  boolean optional  

tax_benefit_living_place_start_date  date optional  

tax_benefit_living_place_name  string optional  

tax_benefit_immigrant  boolean optional  

tax_benefit_spouse  boolean optional  

tax_benefit_immigrant_start_date  date optional  

tax_benefit_immigrant_first_payment_in_tax_year  date optional  

tax_benefit_single_parent_family  boolean optional  

tax_benefit_kids_in_custody  integer optional  

possitive value only

tax_benefit_kids_in_custody_born_in_tax_year  integer optional  

possitive value only

tax_benefit_kids_in_custody_between_1_5  integer optional  

possitive value only

tax_benefit_kids_in_custody_between_6_17  integer optional  

possitive value only

tax_benefit_kids_in_custody_over_18  integer optional  

possitive value only

tax_benefit_infant_kids  integer optional  

possitive value only

tax_benefit_infant_kids_born_in_tax_year  integer optional  

possitive value only

tax_benefit_infant_kids_between_1_5  integer optional  

possitive value only

tax_benefit_single_parent  boolean optional  

tax_benefit_non_custody_kids  integer optional  

possitive value only

tax_benefit_disabled_under_19  boolean optional  

tax_benefit_child_support  boolean optional  

tax_benefit_ages_16_18  integer optional  

possitive value only

tax_benefit_army  boolean optional  

tax_benefit_army_start_date  dat optional  

tax_benefit_army_end_date  dat optional  

tax_benefit_graduation  boolean optional  

signature_hash  string optional  

Download public form PDF file (using slug)

Example request:
curl --request GET \
    --get "http://localhost/api/forms/fill/a9048b73c8a0a/file" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/forms/fill/a9048b73c8a0a/file"
);

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

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

Example response (400):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "record not found or not accessible",
    "error": "record_not_accessible",
    "hint": "",
    "error_description": "The requested record was not found or is not avaiable for the current access privileges"
}
 

Request      

GET api/forms/fill/{slug}/file

URL Parameters

slug  string  

Download form PDF file

Example request:
curl --request GET \
    --get "http://localhost/api/entity/7/forms/1/download" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/7/forms/1/download"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/entity/{entity_id}/forms/{form_id}/download

URL Parameters

entity_id  integer  

The ID of the entity.

form_id  integer optional  

Form ID

Send form PDF file by email

Example request:
curl --request POST \
    "http://localhost/api/entity/5/forms/2/send-pdf" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"runolfsdottir.russ@example.net\",
    \"name\": \"nisi\",
    \"profile_id\": 12
}"
const url = new URL(
    "http://localhost/api/entity/5/forms/2/send-pdf"
);

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

let body = {
    "email": "runolfsdottir.russ@example.net",
    "name": "nisi",
    "profile_id": 12
};

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

Request      

POST api/entity/{entity_id}/forms/{form_id}/send-pdf

URL Parameters

entity_id  integer  

The ID of the entity.

form_id  integer optional  

Form ID

Body Parameters

email  string optional  

Must be a valid email address.This field is required when profile_id is not present.

name  string optional  

profile_id  integer optional  

This field is required when email is not present.

Re-create form PDF file

Example request:
curl --request PUT \
    "http://localhost/api/forms/2/pdf" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/forms/2/pdf"
);

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

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

Request      

PUT api/forms/{form_id}/pdf

URL Parameters

form_id  integer optional  

Form ID

Assign form to entity

Example request:
curl --request PUT \
    "http://localhost/api/entity/19/forms/6/entity" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"entity_id\": 7
}"
const url = new URL(
    "http://localhost/api/entity/19/forms/6/entity"
);

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

let body = {
    "entity_id": 7
};

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

Example response (200):


{
    "id": 113,
    "template_id": 2,
    "sender_id": null,
    "recipient_id": null,
    "entity_id": 17,
    "name": "New Role name",
    "file_id": 58,
    "dir_hash": "d306a8e8-34f9-408a-8cd1-149cf9ab5461",
    "payload_id": "61a88d77b02d2f0a0b3bdba2",
    "status": "signed",
    "admin_status": "not approved",
    "admin_notes": null,
    "signed_date": "2021-12-02T00:00:00.000000Z",
    "public": 0,
    "schedule": null,
    "parent_form_id": null,
    "created_at": "2021-12-02T09:10:15.000000Z",
    "updated_at": "2021-12-06T11:02:36.000000Z",
    "external_ref": null,
    "serial_number": "A0003",
    "redirect_url": null,
    "recipient": null,
    "payload": {
        "data": {
            "http://localhost:8000/forms/d306a8e8-34f9-408a-8cd1-149cf9ab5461/bg/1.jpg": [
                {
                    "pos_x": 0.4594594594594595,
                    "pos_y": 0.21810572467739525,
                    "width": 0.18018018018018017,
                    "height": 0.01976981714912062,
                    "name": "ds_user_full_name",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-user",
                    "role_id": "1"
                },
                {
                    "pos_x": 0.46216216216216216,
                    "pos_y": 0.24744158238254196,
                    "width": 0.18018018018018017,
                    "height": 0.01976981714912062,
                    "name": "custom_field",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": "1",
                    "content_value": "blah blah"
                }
            ]
        },
        "roles": {
            "1": {
                "sequence": 1,
                "placeholder": {
                    "name": "Main recipient",
                    "id": null
                },
                "profile": {
                    "name": null,
                    "id": null,
                    "phone": null,
                    "email": null
                },
                "recipient": true
            }
        }
    },
    "data": {
        "ds_user_full_name": "",
        "custom_field": "blah blah"
    },
    "assignees": [
        {
            "id": 115,
            "slug": "61a88d7740eb3",
            "form_id": 113,
            "sequence": 1,
            "profile_id": 12,
            "placeholder": "Main recipient",
            "template_role_id": 1,
            "public": true,
            "status": "signed",
            "sign_ip": null,
            "sign_device": null,
            "sent_date": "2021-12-02T09:10:15.000000Z",
            "signed_date": "2021-12-02T09:10:15.000000Z",
            "notify_platform": null,
            "notify_notes": null,
            "created_at": "2021-12-02T09:10:15.000000Z",
            "updated_at": "2021-12-02T09:10:15.000000Z"
        }
    ],
    "file": {
        "visibility": [
            "self",
            "manager",
            "reseller"
        ],
        "file_name": "8a2e27ba-d4c5-4e1b-9698-7ee16919ee89.pdf",
        "path": "8a2e27ba-d4c5-4e1b-9698-7ee16919ee89.pdf",
        "profile_id": 12,
        "public_until": "2021-12-03T00:00:00.000000Z"
    },
    "files": []
}
 

Request      

PUT api/entity/{entity_id}/forms/{form_id}/entity

URL Parameters

entity_id  integer optional  

original entity ID

form_id  integer optional  

Form ID

Body Parameters

entity_id  integer  

Extract model data from form

Example request:
curl --request GET \
    --get "http://localhost/api/entity/19/forms/15/models" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"models\": [
        null
    ]
}"
const url = new URL(
    "http://localhost/api/entity/19/forms/15/models"
);

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

let body = {
    "models": [
        null
    ]
};

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

Example response (200):


{
    "recipient": {
        "birth_date": "1977-10-26",
        "house_number": "45",
        "city": "רחובות"
    },
    "employee_data": {
        "birth_date": "1977-10-26"
    }
}
 

Request      

GET api/entity/{entity_id}/forms/{form_id}/models

URL Parameters

entity_id  integer optional  

original entity ID

form_id  integer optional  

Form ID

Body Parameters

models  string[] optional  

Assign form to recipient

Example request:
curl --request PUT \
    "http://localhost/api/entity/3/forms/14/recipient" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"profile_id\": 11,
    \"update_data\": false
}"
const url = new URL(
    "http://localhost/api/entity/3/forms/14/recipient"
);

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

let body = {
    "profile_id": 11,
    "update_data": false
};

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

Example response (200):


{
    "id": 113,
    "template_id": 2,
    "sender_id": null,
    "recipient_id": null,
    "entity_id": 17,
    "name": "New Role name",
    "file_id": 58,
    "dir_hash": "d306a8e8-34f9-408a-8cd1-149cf9ab5461",
    "payload_id": "61a88d77b02d2f0a0b3bdba2",
    "status": "signed",
    "admin_status": "not approved",
    "admin_notes": null,
    "signed_date": "2021-12-02T00:00:00.000000Z",
    "public": 0,
    "schedule": null,
    "parent_form_id": null,
    "created_at": "2021-12-02T09:10:15.000000Z",
    "updated_at": "2021-12-06T11:02:36.000000Z",
    "external_ref": null,
    "serial_number": "A0003",
    "redirect_url": null,
    "recipient": null,
    "payload": {
        "data": {
            "http://localhost:8000/forms/d306a8e8-34f9-408a-8cd1-149cf9ab5461/bg/1.jpg": [
                {
                    "pos_x": 0.4594594594594595,
                    "pos_y": 0.21810572467739525,
                    "width": 0.18018018018018017,
                    "height": 0.01976981714912062,
                    "name": "ds_user_full_name",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-user",
                    "role_id": "1"
                },
                {
                    "pos_x": 0.46216216216216216,
                    "pos_y": 0.24744158238254196,
                    "width": 0.18018018018018017,
                    "height": 0.01976981714912062,
                    "name": "custom_field",
                    "placeholder": null,
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": "1",
                    "content_value": "blah blah"
                }
            ]
        },
        "roles": {
            "1": {
                "sequence": 1,
                "placeholder": {
                    "name": "Main recipient",
                    "id": null
                },
                "profile": {
                    "name": null,
                    "id": null,
                    "phone": null,
                    "email": null
                },
                "recipient": true
            }
        }
    },
    "data": {
        "ds_user_full_name": "",
        "custom_field": "blah blah"
    },
    "assignees": [
        {
            "id": 115,
            "slug": "61a88d7740eb3",
            "form_id": 113,
            "sequence": 1,
            "profile_id": 12,
            "placeholder": "Main recipient",
            "template_role_id": 1,
            "public": true,
            "status": "signed",
            "sign_ip": null,
            "sign_device": null,
            "sent_date": "2021-12-02T09:10:15.000000Z",
            "signed_date": "2021-12-02T09:10:15.000000Z",
            "notify_platform": null,
            "notify_notes": null,
            "created_at": "2021-12-02T09:10:15.000000Z",
            "updated_at": "2021-12-02T09:10:15.000000Z"
        }
    ],
    "file": {
        "visibility": [
            "self",
            "manager",
            "reseller"
        ],
        "file_name": "8a2e27ba-d4c5-4e1b-9698-7ee16919ee89.pdf",
        "path": "8a2e27ba-d4c5-4e1b-9698-7ee16919ee89.pdf",
        "profile_id": 12,
        "public_until": "2021-12-03T00:00:00.000000Z"
    },
    "files": []
}
 

Request      

PUT api/entity/{entity_id}/forms/{form_id}/recipient

URL Parameters

entity_id  integer optional  

original entity ID

form_id  integer optional  

Form ID

Body Parameters

profile_id  integer  

update_data  boolean optional  

Export template forms

Example request:
curl --request GET \
    --get "http://localhost/api/entity/1/templates/libero/export-forms" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/1/templates/libero/export-forms"
);

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

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

Example response (401):

Show headers
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}
 

Request      

GET api/entity/{entity_id}/templates/{template_id}/export-forms

URL Parameters

entity_id  integer  

The ID of the entity.

template_id  string optional  

ID or slug of template

Import

Import entity employees

Example request:
curl --request POST \
    "http://localhost/api/entity/16/import/payroll-employees" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "dry_run=" \
    --form "employees_file=@/tmp/phpScCFY7" 
const url = new URL(
    "http://localhost/api/entity/16/import/payroll-employees"
);

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

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

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

Example response (200):


[{"data":{"payroll_id":6,"first_name":"\u05e1\u05d9\u05d2\u05dc","last_name":"\u05d1\u05e8\u05e7","birth_date":"1972-03-29T00:00:00.000000Z","id_number_type":"id","id_number":27681022,"phone":507422177,"email":"sbarak@mycwt.com","street_name":"\u05e7\u05d9\u05d3\u05d4","house_number":14,"city":"\u05de\u05d5\u05d3\u05d9\u05e2\u05d9\u05df","gender":"female","marital_status":"married","health_care_company_name":"maccabi","spouse_first_name":"\u05de\u05e9\u05d4","spouse_birth_date":"1960-01-29T00:00:00.000000Z","spouse_id_number_type":"id","spouse_id_number":56213267,"spouse_income_type":"job\/allowance\/business","spouse_income":true,"health_care_member":true,"kids_array":[{"name":"\u05e8\u05d5\u05e2\u05d9","id":212322796,"birth_date":"2001-11-18T00:00:00.000000Z","under_my_custody":null,"receive_social_security":null},{"name":"\u05e2\u05d9\u05dc\u05d9","id":326283371,"birth_date":"2003-11-20T00:00:00.000000Z","under_my_custody":null,"receive_social_security":null}],"has_kids":true,"profile_id":null},"message":"employee imported successfully","status":"created","warning":[]},{"data":{"payroll_id":7,"first_name":"\u05d0\u05dc\u05d5\u05df","last_name":"\u05ea\u05d3\u05d4\u05e8","birth_date":"1975-08-16T00:00:00.000000Z","id_number_type":"id","id_number":32391070,"phone":524679358,"email":"alontidhar@gmail.com","street_name":"\u05e6\u05d9\u05e4\u05d5\u05e8\u05d4 \u05d8\u05d5\u05d1","house_number":3,"city":"\u05e8\u05d7\u05d5\u05d1\u05d5\u05ea","gender":"male","marital_status":"single","health_care_company_name":"clalit","spouse_birth_date":"1970-01-01T00:00:00.000000Z","spouse_id_number_type":"id","spouse_id_number":0,"spouse_income":false,"health_care_member":true,"kids_array":[],"has_kids":false,"profile_id":null},"message":"employee imported successfully","status":"created","warning":[]},{"data":{"payroll_id":12,"first_name":"\u05e9\u05dc\u05d5\u05de\u05d9","last_name":"\u05d0\u05d8\u05d9\u05d0\u05e1","birth_date":"1974-12-18T00:00:00.000000Z","id_number_type":"id","id_number":32073777,"phone":778150101,"email":"shlomy51@gmail.com","street_name":"\u05e2\u05d6\u05e8\u05d0","house_number":36,"city":"\u05e8\u05d7\u05d5\u05d1\u05d5\u05ea","gender":"male","marital_status":"married","health_care_company_name":"united","spouse_first_name":"\u05e8\u05d7\u05dc","spouse_birth_date":"1976-02-10T00:00:00.000000Z","spouse_id_number_type":"id","spouse_id_number":11255718,"spouse_income_type":"job\/allowance\/business","spouse_income":true,"health_care_member":true,"kids_array":[{"name":"\u05e0\u05e2\u05dd","id":333633626,"birth_date":"2009-09-24T00:00:00.000000Z","under_my_custody":null,"receive_social_security":null}]
 

Request      

POST api/entity/{entity_id}/import/payroll-employees

URL Parameters

entity_id  integer  

The ID of the entity.

Body Parameters

dry_run  boolean optional  

employees_file  file  

Must be a file.

Import entity contacts

Example request:
curl --request POST \
    "http://localhost/api/entity/10/import/contacts" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "dry_run=1" \
    --form "file=@/tmp/phpDAtF7i" 
const url = new URL(
    "http://localhost/api/entity/10/import/contacts"
);

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

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

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

Example response (200):


{
    "2": {
        "status": "created",
        "warnings": {
            "type": "fail to resolve type. defaulted to `contact`"
        },
        "model": {
            "first_name": "Eli",
            "last_name": "Contact",
            "email": "eli.demayo+x1@gmail.com",
            "phone": 502356894,
            "type_id": 3,
            "entity_id": 13
        }
    },
    "3": {
        "status": "created",
        "warnings": {
            "type": "fail to resolve type. defaulted to `contact`"
        },
        "model": {
            "first_name": "Moshe",
            "last_name": "Supplier",
            "email": "eli.demayo+x2@gmail.com",
            "phone": 531465246,
            "type_id": 3,
            "entity_id": 13
        }
    }
}
 

Request      

POST api/entity/{entity_id}/import/contacts

URL Parameters

entity_id  integer  

The ID of the entity.

Body Parameters

dry_run  boolean optional  

file  file  

Must be a file.

Import companies

Example request:
curl --request POST \
    "http://localhost/api/entity/14/company/import" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "file=@/tmp/phpD8PGVU" 
const url = new URL(
    "http://localhost/api/entity/14/company/import"
);

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

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

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

Example response (200):


{
    "2": {
        "status": "created",
        "warnings": [],
        "model": {
            "type": "company",
            "name": "חברה 1",
            "email": null,
            "parent_entity_id": 12,
            "external_id": "חברה 1",
            "phone": null,
            "address": null,
            "legal_id": null,
            "deduction_id": null,
            "is_client": false,
            "updated_at": "2021-12-28T08:18:49.000000Z",
            "created_at": "2021-12-28T08:18:49.000000Z",
            "id": 43
        }
    },
    "3": {
        "status": "created",
        "warnings": [],
        "model": {
            "type": "company",
            "name": "חברה 2",
            "email": null,
            "parent_entity_id": 12,
            "external_id": "חברה 2",
            "phone": null,
            "address": null,
            "legal_id": null,
            "deduction_id": null,
            "is_client": false,
            "updated_at": "2021-12-28T08:18:49.000000Z",
            "created_at": "2021-12-28T08:18:49.000000Z",
            "id": 44
        }
    }
}
 

Request      

POST api/entity/{entity_id}/company/import

URL Parameters

entity_id  integer  

The ID of the entity.

Body Parameters

file  file  

Must be a file.

Get companies import example file

Example request:
curl --request GET \
    --get "http://localhost/api/company/import/example" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/company/import/example"
);

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

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

Example response (200):

Show headers
cache-control: public
content-disposition: attachment; filename=companies.xlsx
content-type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
accept-ranges: bytes
access-control-allow-origin: *
access-control-allow-methods: POST, GET, OPTIONS, PUT, PATCH, DELETE
access-control-allow-headers: Access-Control-Allow-Headers, Origin,Accept, X-Token-Auth, X-Requested-With, Content-Type, Access-Control-Request-Method, Authorization , Access-Control-Request-Headers
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
 


 

Request      

GET api/company/import/example

Info

Monday query tunnel

Tunnels a query request to Monday API and returns the response. see Monday API reference for more details https://api.developer.monday.com/docs/activity-logs

Example request:
curl --request POST \
    "http://localhost/api/tunnel/monday" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"string\": \"quae\"
}"
const url = new URL(
    "http://localhost/api/tunnel/monday"
);

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

let body = {
    "string": "quae"
};

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

Example response (200):


{
    "data": {
        "create_item": {
            "id": "1534647224"
        }
    },
    "account_id": 1640587
}
 

Request      

POST api/tunnel/monday

Body Parameters

string  $query optional  

  • JSON encoded value of Monday query

Leads

Create Lead

Example request:
curl --request POST \
    "http://localhost/api/leads" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"osinski.brenden@example.com\",
    \"utm_source\": \"voluptatem\",
    \"utm_medium\": \"ad\",
    \"utm_name\": \"voluptatibus\",
    \"full_url\": \"impedit\"
}"
const url = new URL(
    "http://localhost/api/leads"
);

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

let body = {
    "email": "osinski.brenden@example.com",
    "utm_source": "voluptatem",
    "utm_medium": "ad",
    "utm_name": "voluptatibus",
    "full_url": "impedit"
};

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

Example response (200):


{
    "id": "ZXlKcGRpSTZJakF4WTI5SmR6ZFNlbWRsY0hSM1dXNHhWa3B6Y1VFOVBTSXNJblpoYkhWbElqb2lPREZtTW5sWk5ETlVWMWN4TkRKWVREWlRUREpVVVQwOUlpd2liV0ZqSWpvaU4ySXdaVFF3WVRNNE1ETXhabVJqWldJell6UTJNbVkzTkRnM01HWTFaVFkxTW1ZME9URmhZVFEyT0dNMk5UUmxOREJrWldJeE5tUXdNek16T0ROaE5TSjk="
}
 

Request      

POST api/leads

Body Parameters

email  string optional  

Must be a valid email address.

utm_source  string optional  

utm_medium  string optional  

utm_name  string optional  

full_url  string optional  

Update Lead

Example request:
curl --request PUT \
    "http://localhost/api/leads/iure" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_size\": \"voluptas\",
    \"full_name\": \"alias\",
    \"ref\": \"nisi\",
    \"phone\": \"cumque\",
    \"company_name\": \"facilis\"
}"
const url = new URL(
    "http://localhost/api/leads/iure"
);

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

let body = {
    "company_size": "voluptas",
    "full_name": "alias",
    "ref": "nisi",
    "phone": "cumque",
    "company_name": "facilis"
};

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

Example response (200):


{
    "id": "ZXlKcGRpSTZJakF4WTI5SmR6ZFNlbWRsY0hSM1dXNHhWa3B6Y1VFOVBTSXNJblpoYkhWbElqb2lPREZtTW5sWk5ETlVWMWN4TkRKWVREWlRUREpVVVQwOUlpd2liV0ZqSWpvaU4ySXdaVFF3WVRNNE1ETXhabVJqWldJell6UTJNbVkzTkRnM01HWTFaVFkxTW1ZME9URmhZVFEyT0dNMk5UUmxOREJrWldJeE5tUXdNek16T0ROaE5TSjk="
}
 

Request      

PUT api/leads/{leadId}

URL Parameters

leadId  string  

Body Parameters

company_size  string optional  

full_name  string optional  

ref  string optional  

phone  string  

company_name  string optional  

Make Lead Beta

Example request:
curl --request PUT \
    "http://localhost/api/leads/quisquam/beta" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"phone\": \"cum\"
}"
const url = new URL(
    "http://localhost/api/leads/quisquam/beta"
);

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

let body = {
    "phone": "cum"
};

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

Example response (200):


{
    "id": "ZXlKcGRpSTZJakF4WTI5SmR6ZFNlbWRsY0hSM1dXNHhWa3B6Y1VFOVBTSXNJblpoYkhWbElqb2lPREZtTW5sWk5ETlVWMWN4TkRKWVREWlRUREpVVVQwOUlpd2liV0ZqSWpvaU4ySXdaVFF3WVRNNE1ETXhabVJqWldJell6UTJNbVkzTkRnM01HWTFaVFkxTW1ZME9URmhZVFEyT0dNMk5UUmxOREJrWldJeE5tUXdNek16T0ROaE5TSjk="
}
 

Request      

PUT api/leads/{leadId}/beta

URL Parameters

leadId  string  

Body Parameters

phone  string  

Leave Request

List all entity leave request

Example request:
curl --request GET \
    --get "http://localhost/api/entity/19/leave-request?columns[]=in&search[]=velit&search[value]=beatae&search[regex]=1&start=5&length=11&order[]=unde&order[column]=et&order[dir]=optio" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/19/leave-request"
);

const params = {
    "columns[]": "in",
    "search[]": "velit",
    "search[value]": "beatae",
    "search[regex]": "1",
    "start": "5",
    "length": "11",
    "order[]": "unde",
    "order[column]": "et",
    "order[dir]": "optio",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "data": [
        {
            "id": 1,
            "type": "maternity",
            "profile_id": 16,
            "profile_name": "Eli",
            "manager_id": 12,
            "manager_name": "Eli",
            "start_date": "2021-07-25 09:13:09",
            "end_date": "2021-08-29 09:13:09",
            "status": "approved",
            "file_id": 20,
            "created_at": "2021-09-29 07:58:42",
            "updated_at": "2021-09-29 08:36:05"
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/leave-request

URL Parameters

entity_id  integer  

The ID of the entity.

Query Parameters

columns  string[] optional  

List of columns definition

search  string[] optional  

general search definition

search[value]  string optional  

search value

search[regex]  boolean optional  

start  integer optional  

pagination start record number

length  integer optional  

pagination number of records

order  string[] optional  

sort definition

order[column]  string optional  

name of column to sort by

order[dir]  string optional  

sort direction DESC|ASC

Update entity leave request

Example request:
curl --request PUT \
    "http://localhost/api/entity/2/leave-request/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"vacation\",
    \"start_date\": \"delectus\",
    \"end_date\": \"dicta\"
}"
const url = new URL(
    "http://localhost/api/entity/2/leave-request/4"
);

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

let body = {
    "type": "vacation",
    "start_date": "delectus",
    "end_date": "dicta"
};

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

Request      

PUT api/entity/{entity_id}/leave-request/{request_id}

URL Parameters

entity_id  integer  

The ID of the entity.

request_id  integer optional  

Leave Request ID

Body Parameters

type  string optional  

Allowed values: maternity, sick, vacation, accident, mourning

start_date  date optional  

end_date  date optional  

Approve entity leave request

Example request:
curl --request PUT \
    "http://localhost/api/entity/5/leave-request/17/approve" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"et\",
    \"manager_id\": 4
}"
const url = new URL(
    "http://localhost/api/entity/5/leave-request/17/approve"
);

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

let body = {
    "status": "et",
    "manager_id": 4
};

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

Request      

PUT api/entity/{entity_id}/leave-request/{request_id}/approve

URL Parameters

entity_id  integer  

The ID of the entity.

request_id  integer optional  

Leave Request ID

Body Parameters

status  string  

Allowed values: approved, rejected, pending

manager_id  integer optional  

Upload file to leave request

Example request:
curl --request POST \
    "http://localhost/api/entity/4/leave-request/3/file" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "file=@/tmp/phpKULvj8" 
const url = new URL(
    "http://localhost/api/entity/4/leave-request/3/file"
);

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

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

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

Request      

POST api/entity/{entity_id}/leave-request/{request_id}/file

URL Parameters

entity_id  integer  

The ID of the entity.

request_id  integer optional  

Leave Request ID

Body Parameters

file  file  

Must be a file.

Delete entity leave request

Example request:
curl --request DELETE \
    "http://localhost/api/entity/15/leave-request/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/15/leave-request/4"
);

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

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

Request      

DELETE api/entity/{entity_id}/leave-request/{request_id}

URL Parameters

entity_id  integer  

The ID of the entity.

request_id  integer optional  

Leave Request ID

List all profile leave requests

Example request:
curl --request GET \
    --get "http://localhost/api/profile/0/leave-request?columns[]=veniam&search[]=ut&search[value]=ipsum&search[regex]=&start=5&length=11&order[]=quisquam&order[column]=voluptas&order[dir]=qui" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/0/leave-request"
);

const params = {
    "columns[]": "veniam",
    "search[]": "ut",
    "search[value]": "ipsum",
    "search[regex]": "0",
    "start": "5",
    "length": "11",
    "order[]": "quisquam",
    "order[column]": "voluptas",
    "order[dir]": "qui",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "data": [
        {
            "id": 1,
            "type": "maternity",
            "profile_id": 16,
            "profile_name": "Eli",
            "manager_id": 12,
            "manager_name": "Eli",
            "start_date": "2021-07-25 09:13:09",
            "end_date": "2021-08-29 09:13:09",
            "status": "approved",
            "file_id": 20,
            "created_at": "2021-09-29 07:58:42",
            "updated_at": "2021-09-29 08:36:05"
        }
    ]
}
 

Request      

GET api/profile/{profile_id}/leave-request

URL Parameters

profile_id  integer  

The ID of the profile.

Query Parameters

columns  string[] optional  

List of columns definition

search  string[] optional  

general search definition

search[value]  string optional  

search value

search[regex]  boolean optional  

start  integer optional  

pagination start record number

length  integer optional  

pagination number of records

order  string[] optional  

sort definition

order[column]  string optional  

name of column to sort by

order[dir]  string optional  

sort direction DESC|ASC

Create new entity leave request

Example request:
curl --request POST \
    "http://localhost/api/profile/0/leave-request" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"vacation\",
    \"start_date\": \"quae\",
    \"end_date\": \"consequatur\"
}"
const url = new URL(
    "http://localhost/api/profile/0/leave-request"
);

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

let body = {
    "type": "vacation",
    "start_date": "quae",
    "end_date": "consequatur"
};

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

Request      

POST api/profile/{profile_id}/leave-request

URL Parameters

profile_id  integer  

The ID of the profile.

Body Parameters

type  string  

Allowed values: maternity, sick, vacation, accident, mourning

start_date  date  

end_date  date  

Messages

List entity messages

Example request:
curl --request GET \
    --get "http://localhost/api/entity/14/messages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/14/messages"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 5,
    "recordsFiltered": 5,
    "data": [
        {
            "id": 1,
            "sender_id": null,
            "recipient_id": 16,
            "sender_name": "",
            "recipient_name": "Eli",
            "subject": null,
            "status": "success",
            "created_at": "2021-09-01 15:21:19",
            "platform": "email"
        },
        {
            "id": 2,
            "sender_id": 13,
            "recipient_id": 16,
            "sender_name": "Moshe Bakal",
            "recipient_name": "Eli",
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-09-01 15:24:51",
            "platform": "email"
        },
        {
            "id": 3,
            "sender_id": 12,
            "recipient_id": 16,
            "sender_name": "Eli",
            "recipient_name": "Eli",
            "subject": "testing emails",
            "status": "success",
            "created_at": "2021-09-02 08:22:44",
            "platform": "email"
        },
        {
            "id": 4,
            "sender_id": null,
            "recipient_id": 16,
            "sender_name": "",
            "recipient_name": "Eli",
            "subject": "Welcome to easydoc",
            "status": "success",
            "created_at": "2021-09-09 09:48:40",
            "platform": "email"
        },
        {
            "id": 5,
            "sender_id": 12,
            "recipient_id": 16,
            "sender_name": "Eli",
            "recipient_name": "Eli",
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-09-13 13:37:55",
            "platform": "email"
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/messages

URL Parameters

entity_id  integer  

The ID of the entity.

List profile messages

Example request:
curl --request GET \
    --get "http://localhost/api/profile/0/messages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/0/messages"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 5,
    "recordsFiltered": 5,
    "data": [
        {
            "id": 1,
            "sender_id": null,
            "sender_name": "",
            "subject": null,
            "status": "success",
            "created_at": "2021-09-01 15:21:19",
            "platform": "email"
        },
        {
            "id": 2,
            "sender_id": 13,
            "sender_name": "Moshe Bakal",
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-09-01 15:24:51",
            "platform": "email"
        },
        {
            "id": 3,
            "sender_id": 12,
            "sender_name": "Eli",
            "subject": "testing emails",
            "status": "success",
            "created_at": "2021-09-02 08:22:44",
            "platform": "email"
        },
        {
            "id": 4,
            "sender_id": null,
            "sender_name": "",
            "subject": "Welcome to easydoc",
            "status": "success",
            "created_at": "2021-09-09 09:48:40",
            "platform": "email"
        },
        {
            "id": 5,
            "sender_id": 12,
            "sender_name": "Eli",
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-09-13 13:37:55",
            "platform": "email"
        }
    ]
}
 

Request      

GET api/profile/{profile_id}/messages

URL Parameters

profile_id  integer  

The ID of the profile.

Get Message

Example request:
curl --request GET \
    --get "http://localhost/api/entity/7/messages/13" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/7/messages/13"
);

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

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

Example response (200):


{
    "id": 2,
    "recipient_id": 16,
    "sender_id": null,
    "subject": "Welcome to :app_name",
    "content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\" style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<head style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\" style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<meta name=\"color-scheme\" content=\"light\" style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<meta name=\"supported-color-schemes\" content=\"light\" style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<link href=\"https://fonts.googleapis.com/css2?family=Heebo:wght@500;700&amp;display=swap\" rel=\"stylesheet\" style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<style style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n@media  only screen and (max-width: 600px) {\n.inner-body {\nwidth: 100% !important;\n}\n\n.footer {\nwidth: 100% !important;\n}\n}\n\n@media  only screen and (max-width: 500px) {\n.button {\nwidth: 100% !important;\n}\n}\n* {\n            font-family: \"Heebo\", sans-serif;\n            color:#3F4253;\n        }\n</style>\n</head>\n<body style=\"box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; -webkit-text-size-adjust: none; background-color: #ffffff; color: #718096; height: 100%; line-height: 1.4; margin: 0; padding: 0; width: 100% !important;\">\n\n<table class=\"wrapper\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" role=\"presentation\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; -premailer-cellpadding: 0; -premailer-cellspacing: 0; -premailer-width: 100%; background-color: #edf2f7; margin: 0; padding: 0; width: 100%;\">\n<tr style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<td align=\"center\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative;\">\n<table class=\"content\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" role=\"presentation\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; -premailer-cellpadding: 0; -premailer-cellspacing: 0; -premailer-width: 100%; margin: 0; padding: 0; width: 100%;\">\n<tr style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<td class=\"header\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; padding: 25px 0; text-align: center;\">\n<div id=\"topRow\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative;\">\n    <div id=\"companyLogo\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; text-align: left;\">\n        <img src=\"https://cdn.easydoc.co.il/logos/ec-logo-small.png\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; max-width: 100%;\">\n    </div>\n</div>\n</td>\n</tr>\n\n<!-- Email Body -->\n<tr style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<td class=\"body\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; -premailer-cellpadding: 0; -premailer-cellspacing: 0; -premailer-width: 100%; background-color: #edf2f7; border-bottom: 1px solid #edf2f7; border-top: 1px solid #edf2f7; margin: 0; padding: 0; width: 100%;\">\n<table class=\"inner-body\" align=\"center\" width=\"570\" cellpadding=\"0\" cellspacing=\"0\" role=\"presentation\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; -premailer-cellpadding: 0; -premailer-cellspacing: 0; -premailer-width: 570px; background-color: #ffffff; border-color: #e8e5ef; border-radius: 2px; border-width: 1px; box-shadow: 0 2px 0 rgba(0, 0, 150, 0.025), 2px 4px 0 rgba(0, 0, 150, 0.015); margin: 0 auto; padding: 0; width: 570px;\">\n<!-- Body content -->\n<tr style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<td class=\"content-cell\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; max-width: 100vw; padding: 32px;\">\n<div id=\"heroIcon\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; text-align: center;\">\n    <img src=\"https://cdn.easydoc.co.il/images/email-welcome.png\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; max-width: 100%;\">\n  </div>\n  <h2 style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; font-size: 16px; font-weight: bold; margin-top: 0; text-align: left;\">\n    Your Employee portal in new name\n  </h2>\n  <p style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; font-size: 16px; line-height: 1.5em; margin-top: 0; text-align: left;\">\n    In order to ger stated, Please login to your account\n    <br style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n  </p>\n  <a id=\"button\" style=\"box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; margin-top: 30px; color: white; background-color: #5AC0BB; border-radius: 6px; padding: 15px 0; width: 100%; display: block; text-decoration: none;\" href=\"https://devapp2.easydoc.co.il/employee/onboardreset_password_token=loginXXX&amp;login_token=restXXX\">\n    Get Started\n  </a>\n\n\n</td>\n</tr>\n</table>\n</td>\n</tr>\n\n<tr style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<td style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative;\">\n<table class=\"footer\" align=\"center\" width=\"570\" cellpadding=\"0\" cellspacing=\"0\" role=\"presentation\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; -premailer-cellpadding: 0; -premailer-cellspacing: 0; -premailer-width: 570px; margin: 0 auto; padding: 0; text-align: center; width: 570px;\">\n<tr style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<td class=\"content-cell\" align=\"center\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; max-width: 100vw; padding: 32px;\">\n<img src=\"https://0.0.0.0/assets/media/wl/easydoc/logos/ec-logo-small.png\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; max-width: 100%;\">\n© 2021 easydoc. All rights reserved.\n\n</td>\n</tr>\n</table>\n</td>\n</tr>\n</table>\n</td>\n</tr>\n</table>\n</body>\n</html>",
    "platform": "email",
    "status": "success",
    "notes": null,
    "created_at": "2021-09-01T15:24:51.000000Z",
    "updated_at": "2021-09-01T15:24:51.000000Z"
}
 

Request      

GET api/entity/{entity_id}/messages/{message_id}

URL Parameters

entity_id  integer  

The ID of the entity.

message_id  integer optional  

Get Message

Example request:
curl --request GET \
    --get "http://localhost/api/profile/10/messages/13" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/10/messages/13"
);

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

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

Example response (200):


{
    "id": 2,
    "recipient_id": 16,
    "sender_id": null,
    "subject": "Welcome to :app_name",
    "content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\" style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<head style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\" style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\" style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<meta name=\"color-scheme\" content=\"light\" style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<meta name=\"supported-color-schemes\" content=\"light\" style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<link href=\"https://fonts.googleapis.com/css2?family=Heebo:wght@500;700&amp;display=swap\" rel=\"stylesheet\" style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<style style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n@media  only screen and (max-width: 600px) {\n.inner-body {\nwidth: 100% !important;\n}\n\n.footer {\nwidth: 100% !important;\n}\n}\n\n@media  only screen and (max-width: 500px) {\n.button {\nwidth: 100% !important;\n}\n}\n* {\n            font-family: \"Heebo\", sans-serif;\n            color:#3F4253;\n        }\n</style>\n</head>\n<body style=\"box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; -webkit-text-size-adjust: none; background-color: #ffffff; color: #718096; height: 100%; line-height: 1.4; margin: 0; padding: 0; width: 100% !important;\">\n\n<table class=\"wrapper\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" role=\"presentation\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; -premailer-cellpadding: 0; -premailer-cellspacing: 0; -premailer-width: 100%; background-color: #edf2f7; margin: 0; padding: 0; width: 100%;\">\n<tr style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<td align=\"center\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative;\">\n<table class=\"content\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" role=\"presentation\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; -premailer-cellpadding: 0; -premailer-cellspacing: 0; -premailer-width: 100%; margin: 0; padding: 0; width: 100%;\">\n<tr style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<td class=\"header\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; padding: 25px 0; text-align: center;\">\n<div id=\"topRow\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative;\">\n    <div id=\"companyLogo\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; text-align: left;\">\n        <img src=\"https://cdn.easydoc.co.il/logos/ec-logo-small.png\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; max-width: 100%;\">\n    </div>\n</div>\n</td>\n</tr>\n\n<!-- Email Body -->\n<tr style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<td class=\"body\" width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; -premailer-cellpadding: 0; -premailer-cellspacing: 0; -premailer-width: 100%; background-color: #edf2f7; border-bottom: 1px solid #edf2f7; border-top: 1px solid #edf2f7; margin: 0; padding: 0; width: 100%;\">\n<table class=\"inner-body\" align=\"center\" width=\"570\" cellpadding=\"0\" cellspacing=\"0\" role=\"presentation\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; -premailer-cellpadding: 0; -premailer-cellspacing: 0; -premailer-width: 570px; background-color: #ffffff; border-color: #e8e5ef; border-radius: 2px; border-width: 1px; box-shadow: 0 2px 0 rgba(0, 0, 150, 0.025), 2px 4px 0 rgba(0, 0, 150, 0.015); margin: 0 auto; padding: 0; width: 570px;\">\n<!-- Body content -->\n<tr style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<td class=\"content-cell\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; max-width: 100vw; padding: 32px;\">\n<div id=\"heroIcon\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; text-align: center;\">\n    <img src=\"https://cdn.easydoc.co.il/images/email-welcome.png\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; max-width: 100%;\">\n  </div>\n  <h2 style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; font-size: 16px; font-weight: bold; margin-top: 0; text-align: left;\">\n    Your Employee portal in new name\n  </h2>\n  <p style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; font-size: 16px; line-height: 1.5em; margin-top: 0; text-align: left;\">\n    In order to ger stated, Please login to your account\n    <br style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n  </p>\n  <a id=\"button\" style=\"box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; margin-top: 30px; color: white; background-color: #5AC0BB; border-radius: 6px; padding: 15px 0; width: 100%; display: block; text-decoration: none;\" href=\"https://devapp2.easydoc.co.il/employee/onboardreset_password_token=loginXXX&amp;login_token=restXXX\">\n    Get Started\n  </a>\n\n\n</td>\n</tr>\n</table>\n</td>\n</tr>\n\n<tr style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<td style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative;\">\n<table class=\"footer\" align=\"center\" width=\"570\" cellpadding=\"0\" cellspacing=\"0\" role=\"presentation\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; -premailer-cellpadding: 0; -premailer-cellspacing: 0; -premailer-width: 570px; margin: 0 auto; padding: 0; text-align: center; width: 570px;\">\n<tr style=\"font-family: 'Heebo', sans-serif; color: #3F4253;\">\n<td class=\"content-cell\" align=\"center\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; max-width: 100vw; padding: 32px;\">\n<img src=\"https://0.0.0.0/assets/media/wl/easydoc/logos/ec-logo-small.png\" style=\"color: #3F4253; box-sizing: border-box; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol'; position: relative; max-width: 100%;\">\n© 2021 easydoc. All rights reserved.\n\n</td>\n</tr>\n</table>\n</td>\n</tr>\n</table>\n</td>\n</tr>\n</table>\n</body>\n</html>",
    "platform": "email",
    "status": "success",
    "notes": null,
    "created_at": "2021-09-01T15:24:51.000000Z",
    "updated_at": "2021-09-01T15:24:51.000000Z"
}
 

Request      

GET api/profile/{profile_id}/messages/{message_id}

URL Parameters

profile_id  integer  

The ID of the profile.

message_id  integer optional  

Send message to profile

Example request:
curl --request POST \
    "http://localhost/api/profile/0/messages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"subject\": \"idexonjjvmrijkbbvzcjrmojdwsoloibuqykinbyebseznpklzlzkqahoglwwa\",
    \"message\": \"incidunt\"
}"
const url = new URL(
    "http://localhost/api/profile/0/messages"
);

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

let body = {
    "subject": "idexonjjvmrijkbbvzcjrmojdwsoloibuqykinbyebseznpklzlzkqahoglwwa",
    "message": "incidunt"
};

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

Request      

POST api/profile/{profile_id}/messages

URL Parameters

profile_id  integer  

The ID of the profile.

Body Parameters

subject  string optional  

Must not be greater than 255 characters.

message  string  

platform  string optional  

List all messages

Example request:
curl --request GET \
    --get "http://localhost/api/admin/messages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/admin/messages"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 24,
    "recordsFiltered": 24,
    "data": [
        {
            "id": 1,
            "subject": null,
            "status": "success",
            "created_at": "2021-09-01 15:21:19",
            "platform": "email",
            "sender": {
                "id": null,
                "name": ""
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 2,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-09-01 15:24:51",
            "platform": "email",
            "sender": {
                "id": 13,
                "name": "Moshe Bakal"
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 3,
            "subject": "testing emails",
            "status": "failure",
            "created_at": "2021-09-02 08:22:44",
            "platform": "email",
            "sender": {
                "id": 12,
                "name": "Eli"
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 4,
            "subject": "Welcome to easydoc",
            "status": "success",
            "created_at": "2021-09-09 09:48:40",
            "platform": "email",
            "sender": {
                "id": null,
                "name": ""
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 5,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-09-13 13:37:55",
            "platform": "email",
            "sender": {
                "id": 12,
                "name": "Eli"
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 6,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-09-23 09:46:41",
            "platform": "email",
            "sender": {
                "id": 12,
                "name": "Eli"
            },
            "recipient": {
                "id": 15,
                "name": "Eli"
            },
            "entity": {
                "id": 13,
                "name": "new name"
            },
            "parent_entity": {
                "id": null,
                "name": null
            }
        },
        {
            "id": 7,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-09-30 07:37:53",
            "platform": "email",
            "sender": {
                "id": 12,
                "name": "Eli"
            },
            "recipient": {
                "id": 19,
                "name": "Eli Last"
            },
            "entity": {
                "id": 13,
                "name": "new name"
            },
            "parent_entity": {
                "id": null,
                "name": null
            }
        },
        {
            "id": 8,
            "subject": "Welcome to easydoc",
            "status": "success",
            "created_at": "2021-10-03 08:08:18",
            "platform": "email",
            "sender": {
                "id": null,
                "name": ""
            },
            "recipient": {
                "id": 20,
                "name": "Eli DM"
            },
            "entity": {
                "id": 19,
                "name": "2 חברה"
            },
            "parent_entity": {
                "id": 16,
                "name": "EasyDoc Main"
            }
        },
        {
            "id": 9,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-10-12 07:54:35",
            "platform": "email",
            "sender": {
                "id": 12,
                "name": "Eli"
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 10,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-10-14 06:44:19",
            "platform": "email",
            "sender": {
                "id": 16,
                "name": "Eli"
            },
            "recipient": {
                "id": 12,
                "name": "Eli"
            },
            "entity": {
                "id": 13,
                "name": "new name"
            },
            "parent_entity": {
                "id": null,
                "name": null
            }
        },
        {
            "id": 11,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-10-14 06:46:47",
            "platform": "email",
            "sender": {
                "id": 12,
                "name": "Eli"
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 12,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-10-14 06:48:30",
            "platform": "email",
            "sender": {
                "id": 12,
                "name": "Eli"
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 13,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-10-14 06:49:06",
            "platform": "email",
            "sender": {
                "id": 12,
                "name": "Eli"
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 14,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-10-14 06:52:23",
            "platform": "email",
            "sender": {
                "id": 12,
                "name": "Eli"
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 15,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-10-14 07:14:00",
            "platform": "email",
            "sender": {
                "id": 12,
                "name": "Eli"
            },
            "recipient": {
                "id": 15,
                "name": "Eli"
            },
            "entity": {
                "id": 13,
                "name": "new name"
            },
            "parent_entity": {
                "id": null,
                "name": null
            }
        },
        {
            "id": 16,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-10-14 07:21:37",
            "platform": "email",
            "sender": {
                "id": 12,
                "name": "Eli"
            },
            "recipient": {
                "id": 15,
                "name": "Eli"
            },
            "entity": {
                "id": 13,
                "name": "new name"
            },
            "parent_entity": {
                "id": null,
                "name": null
            }
        },
        {
            "id": 17,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-10-14 07:25:46",
            "platform": "email",
            "sender": {
                "id": 12,
                "name": "Eli"
            },
            "recipient": {
                "id": 15,
                "name": "Eli"
            },
            "entity": {
                "id": 13,
                "name": "new name"
            },
            "parent_entity": {
                "id": null,
                "name": null
            }
        },
        {
            "id": 18,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-10-14 07:29:19",
            "platform": "email",
            "sender": {
                "id": 12,
                "name": "Eli"
            },
            "recipient": {
                "id": 15,
                "name": "Eli"
            },
            "entity": {
                "id": 13,
                "name": "new name"
            },
            "parent_entity": {
                "id": null,
                "name": null
            }
        },
        {
            "id": 19,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-10-18 10:27:26",
            "platform": "email",
            "sender": {
                "id": 12,
                "name": "Eli"
            },
            "recipient": {
                "id": 21,
                "name": "Eli Last"
            },
            "entity": {
                "id": 13,
                "name": "new name"
            },
            "parent_entity": {
                "id": null,
                "name": null
            }
        },
        {
            "id": 20,
            "subject": "Welcome to :app_name",
            "status": "failure",
            "created_at": "2021-10-20 13:56:57",
            "platform": "email",
            "sender": {
                "id": null,
                "name": ""
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 21,
            "subject": "Welcome to :app_name",
            "status": "failure",
            "created_at": "2021-10-20 13:58:50",
            "platform": "email",
            "sender": {
                "id": null,
                "name": ""
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 22,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-10-20 14:04:48",
            "platform": "email",
            "sender": {
                "id": null,
                "name": ""
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 23,
            "subject": "Welcome to :app_name",
            "status": "success",
            "created_at": "2021-10-20 14:12:48",
            "platform": "email",
            "sender": {
                "id": null,
                "name": ""
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        },
        {
            "id": 24,
            "subject": "Welcome to :app_name",
            "status": "failure",
            "created_at": "2021-10-20 14:16:26",
            "platform": "email",
            "sender": {
                "id": null,
                "name": ""
            },
            "recipient": {
                "id": 16,
                "name": "Eli"
            },
            "entity": {
                "id": 16,
                "name": "EasyDoc Main"
            },
            "parent_entity": {
                "id": 13,
                "name": "new name"
            }
        }
    ]
}
 

Request      

GET api/admin/messages

Password

Send forgot my password email

Example request:
curl --request POST \
    "http://localhost/api/user/forgot-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"german50@example.net\"
}"
const url = new URL(
    "http://localhost/api/user/forgot-password"
);

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

let body = {
    "email": "german50@example.net"
};

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

Request      

POST api/user/forgot-password

Body Parameters

email  string  

Must be a valid email address.

Reset user password

Example request:
curl --request PUT \
    "http://localhost/api/user/reset-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"est\",
    \"email\": \"xabbott@example.com\",
    \"password\": \"stg\"
}"
const url = new URL(
    "http://localhost/api/user/reset-password"
);

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

let body = {
    "token": "est",
    "email": "xabbott@example.com",
    "password": "stg"
};

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

Request      

PUT api/user/reset-password

Body Parameters

token  string  

email  string  

Must be a valid email address.

password  string  

Must be at least 8 characters.

Change user password

Example request:
curl --request PUT \
    "http://localhost/api/user/me/password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"current_password\": \"ans\",
    \"password\": \"wimh\"
}"
const url = new URL(
    "http://localhost/api/user/me/password"
);

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

let body = {
    "current_password": "ans",
    "password": "wimh"
};

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

Example response (200):


{
    "id": 26,
    "name": "Eli DM",
    "email": "eli.demayo+c12@gmail.com",
    "email_verified_at": null,
    "created_at": "2021-07-29T09:13:09.000000Z",
    "updated_at": "2021-09-05T07:41:31.000000Z",
    "super_user": true,
    "language": null,
    "profiles": [
        {
            "id": 12,
            "user_id": 26,
            "entity_id": 13,
            "type_id": 1,
            "status": "active",
            "id_number": null,
            "email": null,
            "first_name": "Eli",
            "last_name": null,
            "business_name": null,
            "phone": null,
            "birth_date": null,
            "street_name": null,
            "house_number": null,
            "apartment_number": null,
            "city": null,
            "payment_method": null,
            "bank_number": null,
            "bank_branch_number": null,
            "bank_account_number": null,
            "policy_status": null,
            "policy_id": null,
            "policy_legal_number": null,
            "gender": null,
            "external_id": null,
            "payroll_id": null,
            "marital_status": "single",
            "direct_manager_id": null,
            "indirect_manager_id": null,
            "department_id": null,
            "role_id": null,
            "require_101": null,
            "language": "he",
            "legal_id": null,
            "website": null,
            "created_at": "2021-07-29T09:13:09.000000Z",
            "updated_at": "2021-08-29T07:13:02.000000Z",
            "tasks": [],
            "permissions": {
                "Company.Dashboard": 7,
                "Company.EmployeeManagement": 7,
                "Company.User.PersonalInfo": 7,
                "Company.User.RoleSettings": 7,
                "Company.User.Messages": 7,
                "Company.User.Documents": 7,
                "Company.User.Attachments": 7,
                "Company.User.Finance": 7,
                "Company.User.Status": 7,
                "Company.EmployeeForms": 7,
                "Company.LateForms": 7,
                "Company.101Report": 7,
                "Company.CustomerServiceReport": 7,
                "Company.TemplateForms": 7,
                "Company.CustomerService": 7,
                "Company.Settings.Company": 7,
                "Company.Settings.Onboarding": 7,
                "Company.Settings.Roles": 7,
                "Company.Settings.Departments": 7,
                "Company.Settings.ManagerUsers": 7,
                "Company.Settings.FeatureGroups": 7,
                "Company.Settings.Api": 7,
                "Company.Settings.QuickSend": 7,
                "Company.User.Equipment": 7,
                "Company.User.Training": 7,
                "Company.LeaveManagement": 7,
                "Company.Settings.Partners": 7,
                "Company.Partner.Documents": 7,
                "Company.Partners.Attachments": 7,
                "Company.Partner.Messages": 7,
                "Company.Partner.Profile": 7,
                "Company.User.EmploymentTerms": 7,
                "Employee.Messages": 7,
                "Employee.MyForms": 7,
                "Employee.WaitingForSign": 7,
                "Employee.PersonalInfo": 7,
                "Employee.Signature": 7,
                "Employee.RoleSettings": 7,
                "Employee.Attachments": 7,
                "Employee.Payslips": 7,
                "Employee.Password": 7,
                "Employee.CustomerService": 7,
                "Employee.Onboarding.EmailPhone": 7,
                "Employee.Onboarding.Address": 7,
                "Employee.Onboarding.Signature": 7,
                "Employee.Onboarding.Payments": 7,
                "Employee.Onboarding.Pension": 7,
                "Employee.Onboarding.Picture": 7,
                "Employee.LeaveManagement": 7
            },
            "current": true
        },
        {
            "id": 13,
            "status": "active",
            "first_name": "Moshe",
            "last_name": "Bakal",
            "current": false
        }
    ]
}
 

Request      

PUT api/user/me/password

Body Parameters

current_password  string  

Must be at least 8 characters.

password  string  

Must be at least 8 characters.

Payslips

Create profile payslip

Example request:
curl --request POST \
    "http://localhost/api/profile/10/payslips" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"year\": 422,
    \"period\": 18
}"
const url = new URL(
    "http://localhost/api/profile/10/payslips"
);

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

let body = {
    "year": 422,
    "period": 18
};

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

Example response (200):


{
    "type": "monthly",
    "year": "2021",
    "period": "10",
    "profile_id": 16,
    "updated_at": "2021-10-19T12:22:33.000000Z",
    "created_at": "2021-10-19T12:22:33.000000Z",
    "id": 1
}
 

Request      

POST api/profile/{profile_id}/payslips

URL Parameters

profile_id  integer optional  

Profile ID or "me" to get current logged in profile

Body Parameters

type  string optional  

year  integer  

Must be at least 1960. Must not be greater than 2050.

period  integer  

Upload profile payslip file

Example request:
curl --request POST \
    "http://localhost/api/profile/17/payslips/1/file" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "file=@/tmp/phpef8P74" 
const url = new URL(
    "http://localhost/api/profile/17/payslips/1/file"
);

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

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

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

Example response (200):


{
    "id": 1,
    "profile_id": null,
    "file_id": 49,
    "year": 2021,
    "period": 10,
    "type": "monthly",
    "created_at": "2021-10-19T12:22:33.000000Z",
    "updated_at": "2021-10-20T12:41:42.000000Z",
    "visibility": [
        "self",
        "manager",
        "reseller"
    ],
    "file_name": "CSHAIFAPOR-3837.pdf",
    "path": "v5tHMn5qpAXDbpufXOVJ2xoAHircVrxI8ho9sXvj.pdf"
}
 

Request      

POST api/profile/{profile_id}/payslips/{payslip_id}/file

URL Parameters

profile_id  integer optional  

Profile ID or "me" to get current logged in profile

payslip_id  integer optional  

Payslip ID

Body Parameters

file  file  

Must be a file.

List all entity payslips

Example request:
curl --request GET \
    --get "http://localhost/api/entity/1/payslips?columns[]=est&search[]=quis&search[value]=ut&search[regex]=&start=10&length=16&order[]=magni&order[column]=voluptatem&order[dir]=autem" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/1/payslips"
);

const params = {
    "columns[]": "est",
    "search[]": "quis",
    "search[value]": "ut",
    "search[regex]": "0",
    "start": "10",
    "length": "16",
    "order[]": "magni",
    "order[column]": "voluptatem",
    "order[dir]": "autem",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "data": [
        {
            "id": 1,
            "type": "monthly",
            "profile_id": 16,
            "profile_name": "Eli",
            "year": 2021,
            "period": 10,
            "created_at": "2021-10-19 12:22:33",
            "updated_at": "2021-10-20 12:41:42"
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/payslips

URL Parameters

entity_id  integer  

The ID of the entity.

Query Parameters

columns  string[] optional  

List of columns definition

search  string[] optional  

general search definition

search[value]  string optional  

search value

search[regex]  boolean optional  

start  integer optional  

pagination start record number

length  integer optional  

pagination number of records

order  string[] optional  

sort definition

order[column]  string optional  

name of column to sort by

order[dir]  string optional  

sort direction DESC|ASC

List all profile payslips

Example request:
curl --request GET \
    --get "http://localhost/api/profile/64679/payslips?columns[]=repellendus&search[]=maxime&search[value]=veniam&search[regex]=1&start=6&length=19&order[]=saepe&order[column]=qui&order[dir]=cumque" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/64679/payslips"
);

const params = {
    "columns[]": "repellendus",
    "search[]": "maxime",
    "search[value]": "veniam",
    "search[regex]": "1",
    "start": "6",
    "length": "19",
    "order[]": "saepe",
    "order[column]": "qui",
    "order[dir]": "cumque",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "data": [
        {
            "id": 1,
            "type": "monthly",
            "profile_id": 16,
            "profile_name": "Eli",
            "year": 2021,
            "period": 10,
            "created_at": "2021-10-19 12:22:33",
            "updated_at": "2021-10-20 12:41:42"
        }
    ]
}
 

Request      

GET api/profile/{profile_id}/payslips

URL Parameters

profile_id  integer  

The ID of the profile.

Query Parameters

columns  string[] optional  

List of columns definition

search  string[] optional  

general search definition

search[value]  string optional  

search value

search[regex]  boolean optional  

start  integer optional  

pagination start record number

length  integer optional  

pagination number of records

order  string[] optional  

sort definition

order[column]  string optional  

name of column to sort by

order[dir]  string optional  

sort direction DESC|ASC

Update profile payslip

Example request:
curl --request PUT \
    "http://localhost/api/profile/3/payslips/20" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"year\": 852,
    \"period\": 11
}"
const url = new URL(
    "http://localhost/api/profile/3/payslips/20"
);

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

let body = {
    "year": 852,
    "period": 11
};

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

Example response (200):


{
    "id": 1,
    "profile_id": null,
    "file_id": 49,
    "year": 2021,
    "period": 10,
    "type": "monthly",
    "created_at": "2021-10-19T12:22:33.000000Z",
    "updated_at": "2021-10-20T12:41:42.000000Z",
    "visibility": [
        "self",
        "manager",
        "reseller"
    ],
    "file_name": "CSHAIFAPOR-3837.pdf",
    "path": "v5tHMn5qpAXDbpufXOVJ2xoAHircVrxI8ho9sXvj.pdf"
}
 

Request      

PUT api/profile/{profile_id}/payslips/{payslip_id}

URL Parameters

profile_id  integer optional  

Profile ID or "me" to get current logged in profile

payslip_id  integer optional  

Payslip ID

Body Parameters

type  string optional  

year  integer optional  

Must be at least 1960. Must not be greater than 2050.

period  integer optional  

Send payslip to profile

Example request:
curl --request POST \
    "http://localhost/api/profile/4/payslips/3/send" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/4/payslips/3/send"
);

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

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

Request      

POST api/profile/{profile_id}/payslips/{payslip_id}/send

URL Parameters

profile_id  integer optional  

Profile ID or "me" to get current logged in profile

payslip_id  integer  

The ID of the payslip.

Delete profile payslip

Example request:
curl --request DELETE \
    "http://localhost/api/profile/19/payslips/18" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/19/payslips/18"
);

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

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

Request      

DELETE api/profile/{profile_id}/payslips/{payslip_id}

URL Parameters

profile_id  integer optional  

Profile ID or "me" to get current logged in profile

payslip_id  integer  

The ID of the payslip.

Permissions

List all entity permission groups

Example request:
curl --request GET \
    --get "http://localhost/api/entity/17/permissions?columns[]=illum&search[]=suscipit&search[value]=iure&search[regex]=1&start=16&length=17&order[]=molestias&order[column]=commodi&order[dir]=quasi" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/17/permissions"
);

const params = {
    "columns[]": "illum",
    "search[]": "suscipit",
    "search[value]": "iure",
    "search[regex]": "1",
    "start": "16",
    "length": "17",
    "order[]": "molestias",
    "order[column]": "commodi",
    "order[dir]": "quasi",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 2,
    "recordsFiltered": 2,
    "data": [
        {
            "_id": "616bf3110135867cd56b1e91",
            "default": true,
            "permissions": {
                "Dashboard.Form-Summary.display": true,
                "Employee-Management.Employee.create": true,
                "Employee-Management.Attachments.view": true,
                "Employee-Management.Attachments.upload": true,
                "Employee-Management.Attachments.update": false,
                "Employee-Management.Attachments.delete": true,
                "Employee-Management.Attachments.download": true,
                "Employee-Management.Role-Settings.update": true,
                "Employee-Management.Messages.list": true,
                "Employee-Management.Messages.view": true
            },
            "entity_id": 13,
            "updated_at": "2021-10-18T07:12:45.693000Z",
            "created_at": "2021-10-17T09:55:29.349000Z",
            "name": "New Permission 2",
            "number_of_profiles": 2
        },
        {
            "_id": "616d1f260135867cd56b1e93",
            "default": false,
            "permissions": {
                "Employee-Management.Employee.create": true
            },
            "entity_id": 13,
            "updated_at": "2021-10-18T07:15:50.469000Z",
            "created_at": "2021-10-18T07:15:50.469000Z",
            "number_of_profiles": 0
        }
    ]
}
 

Request      

GET api/entity/{entity_id}/permissions

URL Parameters

entity_id  integer  

The ID of the entity.

Query Parameters

columns  string[] optional  

List of columns definition

search  string[] optional  

general search definition

search[value]  string optional  

search value

search[regex]  boolean optional  

start  integer optional  

pagination start record number

length  integer optional  

pagination number of records

order  string[] optional  

sort definition

order[column]  string optional  

name of column to sort by

order[dir]  string optional  

sort direction DESC|ASC

Create new entity permission group

Example request:
curl --request POST \
    "http://localhost/api/entity/18/permissions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"teasshbvsdvllzznxhmkjfgbuhrjdtqmbyubzgipvbcrzadpwuuqcifxofhndpzlrokziimnsxmkusshweravyvyvymxnanodnkvuvvbtkcdpuhecnrvtcrtgdcvhpitfokfrexunglgiwneygrgcrzudhdpsecixhpygcxbhunqwvlctghphxltwqkftrdvfaeaeiymdwegxpmhcuxaqgsmpmsoyivcr\",
    \"permissions\": [
        \"aspernatur\"
    ]
}"
const url = new URL(
    "http://localhost/api/entity/18/permissions"
);

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

let body = {
    "name": "teasshbvsdvllzznxhmkjfgbuhrjdtqmbyubzgipvbcrzadpwuuqcifxofhndpzlrokziimnsxmkusshweravyvyvymxnanodnkvuvvbtkcdpuhecnrvtcrtgdcvhpitfokfrexunglgiwneygrgcrzudhdpsecixhpygcxbhunqwvlctghphxltwqkftrdvfaeaeiymdwegxpmhcuxaqgsmpmsoyivcr",
    "permissions": [
        "aspernatur"
    ]
};

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

Example response (200):


{
    "name": "New Permission 3",
    "default": false,
    "profile_type": "manager",
    "permissions": [
        "dashboard.*",
        "employee-management.list"
    ],
    "entity_id": 13,
    "updated_at": "2021-10-20T07:57:32.066000Z",
    "created_at": "2021-10-20T07:57:32.066000Z",
    "id": "616fcbeca307282c3735b543"
}
 

Request      

POST api/entity/{entity_id}/permissions

URL Parameters

entity_id  integer  

Entity ID or "me" for current logged in profile entity

Body Parameters

name  string  

Must not be greater than 255 characters.

permissions  string[]  

a list of key => value pairs (action => enabled (bool)). use #get-permission-group enpoint to get available permission actions. use "new" as the group_id.

Update entity permission group

Example request:
curl --request PUT \
    "http://localhost/api/entity/14/permissions/est" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ygfvlrlksrpqgzityjqcbkcuisiozdanoneqaujfntjnqaxmxhacppzpbghllqqrgskginxanyezuwtt\",
    \"permissions\": [
        \"quia\"
    ]
}"
const url = new URL(
    "http://localhost/api/entity/14/permissions/est"
);

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

let body = {
    "name": "ygfvlrlksrpqgzityjqcbkcuisiozdanoneqaujfntjnqaxmxhacppzpbghllqqrgskginxanyezuwtt",
    "permissions": [
        "quia"
    ]
};

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

Example response (200):


{
    "name": "New Permission 3",
    "default": false,
    "profile_type": "manager",
    "permissions": [
        "dashboard.*",
        "employee-management.*"
    ],
    "entity_id": 13,
    "updated_at": "2021-10-20T08:02:23.553000Z",
    "created_at": "2021-10-20T07:57:32.066000Z",
    "id": "616fcbeca307282c3735b543"
}
 

Request      

PUT api/entity/{entity_id}/permissions/{group_id}

URL Parameters

entity_id  integer  

Entity ID or "me" for current logged in profile entity

group_id  string  

Permission Group ID, "employee" or "manager" for the default group of this profile type

Body Parameters

name  string optional  

Must not be greater than 255 characters.

permissions  string[]  

a list of key => value pairs (action => enabled (bool)). use #get-permission-group enpoint to get available permission actions.

Set entity permission group as default

Example request:
curl --request PUT \
    "http://localhost/api/entity/14/permissions/non/default" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/14/permissions/non/default"
);

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

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

Example response (200):


{
    "name": "New Permission 3",
    "default": true,
    "profile_type": "manager",
    "permissions": [
        "dashboard.*",
        "employee-management.*"
    ],
    "entity_id": 13,
    "updated_at": "2021-10-20T08:03:47.268000Z",
    "created_at": "2021-10-20T07:57:32.066000Z",
    "id": "616fcbeca307282c3735b543"
}
 

Request      

PUT api/entity/{entity_id}/permissions/{group_id}/default

URL Parameters

entity_id  integer  

Entity ID or "me" for current logged in profile entity

group_id  string  

Permission Group ID

Delete entity permission group

Example request:
curl --request DELETE \
    "http://localhost/api/entity/13/permissions/similique" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/13/permissions/similique"
);

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

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

Request      

DELETE api/entity/{entity_id}/permissions/{group_id}

URL Parameters

entity_id  integer  

Entity ID or "me" for current logged in profile entity

group_id  string  

Permission Group ID

Get Permission Group

Example request:
curl --request GET \
    --get "http://localhost/api/entity/8/permissions/ut" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/entity/8/permissions/ut"
);

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

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

Example response (200):


{
    "dashboard": {
        "label": "Dasboard",
        "items": {
            "display": {
                "label": "Display Company summary",
                "permission": "dashboard.display",
                "enabled": false
            }
        },
        "permission": "dashboard.*",
        "enabled": true
    },
    "employee-management": {
        "label": "Employee Management",
        "items": {
            "list": {
                "label": "List All Employees",
                "permission": "employee-management.list",
                "enabled": false
            },
            "employee-info": {
                "label": "Personal Info",
                "items": {
                    "view": {
                        "label": "view Empoyee Info",
                        "permission": "employee-management.employee-info.view",
                        "enabled": false
                    },
                    "update": {
                        "label": "Update Employee Info",
                        "permission": "employee-management.employee-info.update",
                        "enabled": false
                    }
                },
                "permission": "employee-management.employee-info.*",
                "enabled": false
            },
            "employee-role": {
                "label": "Employee Role",
                "items": {
                    "view": {
                        "label": "Dispay Employee Role",
                        "permission": "employee-management.employee-role.view",
                        "enabled": false
                    },
                    "update": {
                        "label": "Change Employee Role",
                        "permission": "employee-management.employee-role.update",
                        "enabled": false
                    }
                },
                "permission": "employee-management.employee-role.*",
                "enabled": false
            },
            "employee-attachments": {
                "label": "Employee Attachments",
                "items": {
                    "list": {
                        "label": "List attachments",
                        "permission": "employee-management.employee-attachments.list",
                        "enabled": false
                    },
                    "view": {
                        "label": "View attachment details",
                        "permission": "employee-management.employee-attachments.view",
                        "enabled": false
                    },
                    "upload": {
                        "label": "Upload an attachment",
                        "permission": "employee-management.employee-attachments.upload",
                        "enabled": false
                    },
                    "update": {
                        "label": "Update attachment details",
                        "permission": "employee-management.employee-attachments.update",
                        "enabled": false
                    },
                    "delete": {
                        "label": "Remove attachment",
                        "permission": "employee-management.employee-attachments.delete",
                        "enabled": false
                    },
                    "download": {
                        "label": "Download attachment",
                        "permission": "employee-management.employee-attachments.download",
                        "enabled": false
                    }
                },
                "permission": "employee-management.employee-attachments.*",
                "enabled": false
            },
            "employee-messages": {
                "label": "Employee Messages",
                "items": {
                    "list": {
                        "label": "List attachments",
                        "permission": "employee-management.employee-messages.list",
                        "enabled": false
                    },
                    "view": {
                        "label": "View attachment details",
                        "permission": "employee-management.employee-messages.view",
                        "enabled": false
                    }
                },
                "permission": "employee-management.employee-messages.*",
                "enabled": false
            },
            "employee-documents": {
                "label": "Employee Documents",
                "items": {
                    "list": {
                        "label": "View Empployee Documents",
                        "permission": "employee-management.employee-documents.list",
                        "enabled": false
                    },
                    "download": {
                        "label": "Download PDF file",
                        "permission": "employee-management.employee-documents.download",
                        "enabled": false
                    }
                },
                "permission": "employee-management.employee-documents.*",
                "enabled": false
            },
            "employee-finance": {
                "label": "Employee Finance",
                "items": {
                    "update": {
                        "label": "Update Finance Details",
                        "permission": "employee-management.employee-finance.update",
                        "enabled": false
                    }
                },
                "permission": "employee-management.employee-finance.*",
                "enabled": false
            },
            "employee-status": {
                "label": "Employee Status",
                "items": {
                    "update": {
                        "label": "Update Employee Status",
                        "permission": "employee-management.employee-status.update",
                        "enabled": false
                    }
                },
                "permission": "employee-management.employee-status.*",
                "enabled": false
            },
            "employee-equipment": {
                "label": "Employee Equipment",
                "items": {
                    "create": {
                        "label": "Create Employee Equipment",
                        "permission": "employee-management.employee-equipment.create",
                        "enabled": false
                    },
                    "update": {
                        "label": "Update Employee Equipment",
                        "permission": "employee-management.employee-equipment.update",
                        "enabled": false
                    },
                    "delete": {
                        "label": "Delete Employee Equipment",
                        "permission": "employee-management.employee-equipment.delete",
                        "enabled": false
                    }
                },
                "permission": "employee-management.employee-equipment.*",
                "enabled": false
            },
            "employee-training": {
                "label": "Employee Training",
                "items": {
                    "create": {
                        "label": "Create Training",
                        "permission": "employee-management.employee-training.create",
                        "enabled": false
                    },
                    "update": {
                        "label": "Update Training",
                        "permission": "employee-management.employee-training.update",
                        "enabled": false
                    },
                    "delete": {
                        "label": "Delete Training",
                        "permission": "employee-management.employee-training.delete",
                        "enabled": false
                    }
                },
                "permission": "employee-management.employee-training.*",
                "enabled": false
            },
            "employee-leave-requests": {
                "label": "Employee Leave Request",
                "items": {
                    "create": {
                        "label": "Create Leave Request",
                        "permission": "employee-management.employee-leave-requests.create",
                        "enabled": false
                    },
                    "update": {
                        "label": "Update Leave Request",
                        "permission": "employee-management.employee-leave-requests.update",
                        "enabled": false
                    },
                    "delete": {
                        "label": "Delete Leave Request",
                        "permission": "employee-management.employee-leave-requests.delete",
                        "enabled": false
                    },
                    "approve": {
                        "label": "Approve Leave Request",
                        "permission": "employee-management.employee-leave-requests.approve",
                        "enabled": false
                    }
                },
                "permission": "employee-management.employee-leave-requests.*",
                "enabled": false
            }
        },
        "permission": "employee-management.*",
        "enabled": true
    },
    "sent-forms": {
        "label": "Sent Documents",
        "items": {
            "list": {
                "label": "List Sent Docuemnts",
                "permission": "sent-forms.list",
                "enabled": false
            }
        },
        "permission": "sent-forms.*",
        "enabled": false
    },
    "101-Form": {
        "label": "101 Report",
        "items": {
            "show": {
                "label": "Show 101 Form Report",
                "permission": "101-Form.show",
                "enabled": false
            }
        },
        "permission": "101-Form.*",
        "enabled": false
    },
    "templates": {
        "label": "Template Forms",
        "items": {
            "list": {
                "label": "List Templates",
                "permission": "templates.list",
                "enabled": false
            },
            "create": {
                "label": "Create Template Form",
                "permission": "templates.create",
                "enabled": false
            },
            "update": {
                "label": "Update Template",
                "permission": "templates.update",
                "enabled": false
            }
        },
        "permission": "templates.*",
        "enabled": false
    },
    "settings": {
        "label": "Settings",
        "items": {
            "company-settings": {
                "label": "Company Settings",
                "items": {
                    "show": {
                        "label": "Display Company Settings",
                        "permission": "settings.company-settings.show",
                        "enabled": false
                    },
                    "update": {
                        "label": "Update Company Settings",
                        "permission": "settings.company-settings.update",
                        "enabled": false
                    }
                },
                "permission": "settings.company-settings.*",
                "enabled": false
            },
            "onborading": {
                "label": "Onboarding Settings",
                "items": {
                    "list": {
                        "label": "List Onboarding processes",
                        "permission": "settings.onborading.list",
                        "enabled": false
                    },
                    "create": {
                        "label": "Create Onboarding process",
                        "permission": "settings.onborading.create",
                        "enabled": false
                    },
                    "update": {
                        "label": "Update Onboarding process",
                        "permission": "settings.onborading.update",
                        "enabled": false
                    }
                },
                "permission": "settings.onborading.*",
                "enabled": false
            },
            "roles": {
                "label": "Role Settings",
                "items": {
                    "list": {
                        "label": "List Roles",
                        "permission": "settings.roles.list",
                        "enabled": false
                    },
                    "create": {
                        "label": "Create Role",
                        "permission": "settings.roles.create",
                        "enabled": false
                    },
                    "update": {
                        "label": "Update Role",
                        "permission": "settings.roles.update",
                        "enabled": false
                    }
                },
                "permission": "settings.roles.*",
                "enabled": false
            },
            "departments": {
                "label": "Department Settings",
                "items": {
                    "list": {
                        "label": "List Departments",
                        "permission": "settings.departments.list",
                        "enabled": false
                    },
                    "create": {
                        "label": "Create Department",
                        "permission": "settings.departments.create",
                        "enabled": false
                    },
                    "update": {
                        "label": "Update Department",
                        "permission": "settings.departments.update",
                        "enabled": false
                    }
                },
                "permission": "settings.departments.*",
                "enabled": false
            },
            "managers": {
                "label": "Manager Users",
                "items": {
                    "list": {
                        "label": "List Managers",
                        "permission": "settings.managers.list",
                        "enabled": false
                    },
                    "create": {
                        "label": "Create Manager",
                        "permission": "settings.managers.create",
                        "enabled": false
                    },
                    "update": {
                        "label": "Update Manager",
                        "permission": "settings.managers.update",
                        "enabled": false
                    },
                    "delete": {
                        "label": "Delete Manager",
                        "permission": "settings.managers.delete",
                        "enabled": false
                    }
                },
                "permission": "settings.managers.*",
                "enabled": false
            },
            "manager-permissions": {
                "label": "Manager Permission",
                "items": {
                    "update": {
                        "label": "Change Manager Permission Group",
                        "permission": "settings.manager-permissions.update",
                        "enabled": false
                    }
                },
                "permission": "settings.manager-permissions.*",
                "enabled": false
            }
        },
        "permission": "settings.*",
        "enabled": false
    },
    "permissions": {
        "label": "Permissions",
        "items": {
            "list": {
                "label": "List Permission Groups",
                "permission": "permissions.list",
                "enabled": false
            },
            "create": {
                "label": "Create Permission Group",
                "permission": "permissions.create",
                "enabled": false
            },
            "update": {
                "label": "Update Permission Group",
                "permission": "permissions.update",
                "enabled": false
            },
            "default": {
                "label": "Mark Permission Group as default",
                "permission": "permissions.default",
                "enabled": false
            }
        },
        "permission": "permissions.*",
        "enabled": false
    },
    "forms": {
        "label": "Forms",
        "items": {
            "form-send": {
                "label": "Quick Send",
                "items": {
                    "send": {
                        "label": "Send Form",
                        "permission": "forms.form-send.send",
                        "enabled": false
                    }
                },
                "permission": "forms.form-send.*",
                "enabled": false
            }
        },
        "permission": "forms.*",
        "enabled": false
    },
    "contact-management": {
        "label": "Contacts",
        "items": {
            "contact-info": {
                "label": "Contact Info",
                "items": {
                    "list": {
                        "label": "List Contacts",
                        "permission": "contact-management.contact-info.list",
                        "enabled": false
                    },
                    "create": {
                        "label": "Create Contact",
                        "permission": "contact-management.contact-info.create",
                        "enabled": false
                    },
                    "update": {
                        "label": "Update Contact",
                        "permission": "contact-management.contact-info.update",
                        "enabled": false
                    }
                },
                "permission": "contact-management.contact-info.*",
                "enabled": false
            },
            "contact-documents": {
                "label": "Contact Documents",
                "items": {
                    "list": {
                        "label": "View Contact Documents",
                        "permission": "contact-management.contact-documents.list",
                        "enabled": false
                    },
                    "download": {
                        "label": "Download PDF file",
                        "permission": "contact-management.contact-documents.download",
                        "enabled": false
                    }
                },
                "permission": "contact-management.contact-documents.*",
                "enabled": false
            },
            "contact-attachments": {
                "label": "Contact Attachments",
                "items": {
                    "list": {
                        "label": "List attachments",
                        "permission": "contact-management.contact-attachments.list",
                        "enabled": false
                    },
                    "view": {
                        "label": "View attachment details",
                        "permission": "contact-management.contact-attachments.view",
                        "enabled": false
                    },
                    "upload": {
                        "label": "Upload an attachment",
                        "permission": "contact-management.contact-attachments.upload",
                        "enabled": false
                    },
                    "update": {
                        "label": "Update attachment details",
                        "permission": "contact-management.contact-attachments.update",
                        "enabled": false
                    },
                    "delete": {
                        "label": "Remove attachment",
                        "permission": "contact-management.contact-attachments.delete",
                        "enabled": false
                    },
                    "download": {
                        "label": "Download attachment",
                        "permission": "contact-management.contact-attachments.download",
                        "enabled": false
                    }
                },
                "permission": "contact-management.contact-attachments.*",
                "enabled": false
            }
        },
        "permission": "contact-management.*",
        "enabled": false
    }
}
 

Request      

GET api/entity/{entity_id}/permissions/{group_id}

URL Parameters

entity_id  integer  

Entity ID or "me" for current logged in profile entity

group_id  string  

Permission Group ID, "employee" or "manager" for the default group of this profile type or "new" for default values for creation

Processes

Profile Process next step

Example request:
curl --request PUT \
    "http://localhost/api/profile/416047/process/in/next" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/416047/process/in/next"
);

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

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

Example response (200):


{
    "status": "in-progress",
    "step": null
}
 

Request      

PUT api/profile/{profile_id}/process/{process}/next

URL Parameters

profile_id  integer  

The ID of the profile.

process  string  

Products

Create Product

Example request:
curl --request POST \
    "http://localhost/api/admin/products/est" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"nihil\",
    \"price\": 31854,
    \"yearly_price\": 10752,
    \"monthly_price\": 42853,
    \"billing_ref\": \"ut\",
    \"type_default\": false,
    \"purchasable\": true,
    \"custom\": true
}"
const url = new URL(
    "http://localhost/api/admin/products/est"
);

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

let body = {
    "name": "nihil",
    "price": 31854,
    "yearly_price": 10752,
    "monthly_price": 42853,
    "billing_ref": "ut",
    "type_default": false,
    "purchasable": true,
    "custom": true
};

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

Example response (200):


{
    "id": 3,
    "name": "Pro",
    "monthly_price": 49.5,
    "yearly_price": null,
    "price": null,
    "billing_ref": "126",
    "type": "subscription",
    "type_default": 0,
    "purchasable": 1,
    "custom": 0,
    "product_ref_id": 3,
    "init_sms_bucket": 0,
    "created_at": "2021-11-07T09:21:01.000000Z",
    "updated_at": "2021-11-08T16:05:07.000000Z",
    "plan": {
        "id": 3,
        "monthly_form_limit": 99,
        "templates_limit": 10,
        "contacts_limit": 500,
        "employees_limit": null,
        "managers_limit": 2,
        "feature_group_id": null,
        "created_at": "2021-11-07T09:21:01.000000Z",
        "updated_at": "2021-11-08T16:05:07.000000Z"
    }
}
 

Request      

POST api/admin/products/{type}

URL Parameters

type  string optional  

Product type name

Body Parameters

name  string  

price  number optional  

Must be at least 0. Must not be greater than 65535.

yearly_price  number optional  

Must be at least 0. Must not be greater than 65535.

monthly_price  number optional  

Must be at least 0. Must not be greater than 65535.

billing_ref  string optional  

type_default  boolean optional  

purchasable  boolean optional  

custom  boolean optional  

Update Product

Example request:
curl --request PUT \
    "http://localhost/api/admin/products/6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"sint\",
    \"price\": 0,
    \"yearly_price\": 0,
    \"monthly_price\": 0,
    \"billing_ref\": \"praesentium\",
    \"type_default\": true,
    \"purchasable\": true,
    \"custom\": true
}"
const url = new URL(
    "http://localhost/api/admin/products/6"
);

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

let body = {
    "name": "sint",
    "price": 0,
    "yearly_price": 0,
    "monthly_price": 0,
    "billing_ref": "praesentium",
    "type_default": true,
    "purchasable": true,
    "custom": true
};

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

Example response (200):


{
    "id": 3,
    "name": "Pro",
    "monthly_price": 49.5,
    "yearly_price": null,
    "price": null,
    "billing_ref": "126",
    "type": "subscription",
    "type_default": 0,
    "purchasable": 1,
    "custom": 0,
    "product_ref_id": 3,
    "init_sms_bucket": 0,
    "created_at": "2021-11-07T09:21:01.000000Z",
    "updated_at": "2021-11-08T16:05:07.000000Z",
    "plan": {
        "id": 3,
        "monthly_form_limit": 99,
        "templates_limit": 10,
        "contacts_limit": 500,
        "employees_limit": null,
        "managers_limit": 2,
        "feature_group_id": null,
        "created_at": "2021-11-07T09:21:01.000000Z",
        "updated_at": "2021-11-08T16:05:07.000000Z"
    }
}
 

Request      

PUT api/admin/products/{product_id}

URL Parameters

product_id  integer optional  

Product ID

Body Parameters

name  string optional  

price  number optional  

Must be at least 0.

yearly_price  number optional  

Must be at least 0.

monthly_price  number optional  

Must be at least 0.

billing_ref  string optional  

type_default  boolean optional  

purchasable  boolean optional  

custom  boolean optional  

List Products

Example request:
curl --request GET \
    --get "http://localhost/api/admin/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/admin/products"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 6,
    "recordsFiltered": 6,
    "data": [
        {
            "id": 1,
            "name": "Free Trial",
            "price": null,
            "monthly_price": 0,
            "yearly_price": 0,
            "billing_ref": "124",
            "type": "subscription",
            "type_default": 1,
            "purchasable": 0,
            "custom": 0
        },
        {
            "id": 2,
            "name": "Basic",
            "price": null,
            "monthly_price": 19,
            "yearly_price": null,
            "billing_ref": "125",
            "type": "subscription",
            "type_default": 0,
            "purchasable": 1,
            "custom": 0
        },
        {
            "id": 3,
            "name": "Pro",
            "price": null,
            "monthly_price": 49.5,
            "yearly_price": null,
            "billing_ref": "126",
            "type": "subscription",
            "type_default": 0,
            "purchasable": 1,
            "custom": 0
        },
        {
            "id": 4,
            "name": "Business",
            "price": null,
            "monthly_price": 79,
            "yearly_price": null,
            "billing_ref": "119",
            "type": "subscription",
            "type_default": 0,
            "purchasable": 1,
            "custom": 0
        },
        {
            "id": 5,
            "name": "Enterprise",
            "price": null,
            "monthly_price": null,
            "yearly_price": null,
            "billing_ref": "130",
            "type": "subscription",
            "type_default": 0,
            "purchasable": 1,
            "custom": 1
        },
        {
            "id": 6,
            "name": "New Product",
            "price": null,
            "monthly_price": 49.5,
            "yearly_price": null,
            "billing_ref": null,
            "type": "subscription",
            "type_default": 0,
            "purchasable": 1,
            "custom": 0
        }
    ]
}
 

Request      

GET api/admin/products

Get Product

Example request:
curl --request GET \
    --get "http://localhost/api/admin/products/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/admin/products/4"
);

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

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

Example response (200):


{
    "id": 3,
    "name": "Pro",
    "monthly_price": 49.5,
    "yearly_price": null,
    "price": null,
    "billing_ref": "126",
    "type": "subscription",
    "type_default": 0,
    "purchasable": 1,
    "custom": 0,
    "product_ref_id": 3,
    "init_sms_bucket": 0,
    "created_at": "2021-11-07T09:21:01.000000Z",
    "updated_at": "2021-11-08T16:05:07.000000Z",
    "plan": {
        "id": 3,
        "monthly_form_limit": 99,
        "templates_limit": 10,
        "contacts_limit": 500,
        "employees_limit": null,
        "managers_limit": 2,
        "feature_group_id": null,
        "created_at": "2021-11-07T09:21:01.000000Z",
        "updated_at": "2021-11-08T16:05:07.000000Z"
    }
}
 

Request      

GET api/admin/products/{product_id}

URL Parameters

product_id  integer optional  

Product ID

Profile Forms

List all profile assigned forms

Example request:
curl --request GET \
    --get "http://localhost/api/profile/0/forms/assigned" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/0/forms/assigned"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 15,
    "recordsFiltered": 15,
    "data": [
        {
            "id": 2,
            "slug": "611bd25361fa7",
            "name": "New Role",
            "status": "pending",
            "signed_date": null,
            "sent_date": null,
            "template_id": 2,
            "dir_hash": "57d1452b-0cf6-46f7-a01a-c07f24164df0",
            "entity_id": "13",
            "sender_name": "Eli",
            "template_slug": null
        },
        {
            "id": 4,
            "slug": "611cd632d0f69",
            "name": "New Role",
            "status": "pending",
            "signed_date": null,
            "sent_date": null,
            "template_id": 2,
            "dir_hash": "57d1452b-0cf6-46f7-a01a-c07f24164df0",
            "entity_id": "13",
            "sender_name": "Eli",
            "template_slug": null
        },
        {
            "id": 6,
            "slug": "611cd97faea14",
            "name": "New Role",
            "status": "pending",
            "signed_date": null,
            "sent_date": null,
            "template_id": 2,
            "dir_hash": "57d1452b-0cf6-46f7-a01a-c07f24164df0",
            "entity_id": "13",
            "sender_name": "Eli",
            "template_slug": null
        },
        {
            "id": 8,
            "slug": "611d076bcfcfe",
            "name": "New Role",
            "status": "pending",
            "signed_date": null,
            "sent_date": null,
            "template_id": 2,
            "dir_hash": "57d1452b-0cf6-46f7-a01a-c07f24164df0",
            "entity_id": "13",
            "sender_name": "Eli",
            "template_slug": null
        },
        {
            "id": 12,
            "slug": "6125f96d7bd35",
            "name": "New Role name",
            "status": "pending",
            "signed_date": null,
            "sent_date": null,
            "template_id": 2,
            "dir_hash": "8f0671e3-1c1e-41d8-a53b-4c78de90c3f6",
            "entity_id": "13",
            "sender_name": "Eli",
            "template_slug": null
        },
        {
            "id": 14,
            "slug": "6125fa6d8d8cb",
            "name": "New Role name",
            "status": "pending",
            "signed_date": null,
            "sent_date": null,
            "template_id": 2,
            "dir_hash": "8f0671e3-1c1e-41d8-a53b-4c78de90c3f6",
            "entity_id": "13",
            "sender_name": "Eli",
            "template_slug": null
        },
        {
            "id": 15,
            "slug": "612b4bbe0546b",
            "name": "New Role name",
            "status": "signed",
            "signed_date": "2021-08-29 11:14:01",
            "sent_date": "2021-08-29 08:56:30",
            "template_id": 2,
            "dir_hash": "8f0671e3-1c1e-41d8-a53b-4c78de90c3f6",
            "entity_id": "13",
            "sender_name": "Eli",
            "template_slug": null
        },
        {
            "id": 16,
            "slug": "612cddf389646",
            "name": "New Role name",
            "status": "waiting",
            "signed_date": null,
            "sent_date": "2021-08-30 13:32:35",
            "template_id": 2,
            "dir_hash": "8f0671e3-1c1e-41d8-a53b-4c78de90c3f6",
            "entity_id": "13",
            "sender_name": "Eli",
            "template_slug": null
        },
        {
            "id": 17,
            "slug": "612cde1ce22b4",
            "name": "New Role name",
            "status": "waiting",
            "signed_date": null,
            "sent_date": "2021-08-30 13:33:16",
            "template_id": 2,
            "dir_hash": "8f0671e3-1c1e-41d8-a53b-4c78de90c3f6",
            "entity_id": "13",
            "sender_name": "Eli",
            "template_slug": null
        },
        {
            "id": 18,
            "slug": "612cdec6a1988",
            "name": "New Role name",
            "status": "waiting",
            "signed_date": null,
            "sent_date": "2021-08-30 13:36:06",
            "template_id": 2,
            "dir_hash": "8f0671e3-1c1e-41d8-a53b-4c78de90c3f6",
            "entity_id": "13",
            "sender_name": "Eli",
            "template_slug": null
        },
        {
            "id": 19,
            "slug": "612cdf911f2dd",
            "name": "New Role name",
            "status": "waiting",
            "signed_date": null,
            "sent_date": "2021-08-30 13:39:29",
            "template_id": 2,
            "dir_hash": "8f0671e3-1c1e-41d8-a53b-4c78de90c3f6",
            "entity_id": "13",
            "sender_name": "Eli",
            "template_slug": null
        },
        {
            "id": 20,
            "slug": "612cdfdf508b5",
            "name": "New Role name",
            "status": "waiting",
            "signed_date": null,
            "sent_date": "2021-08-30 13:40:47",
            "template_id": 2,
            "dir_hash": "8f0671e3-1c1e-41d8-a53b-4c78de90c3f6",
            "entity_id": "13",
            "sender_name": "Eli",
            "template_slug": null
        },
        {
            "id": 21,
            "slug": "612ce62582320",
            "name": "New Role name",
            "status": "waiting",
            "signed_date": null,
            "sent_date": "2021-08-30 14:07:32",
            "template_id": 2,
            "dir_hash": "8f0671e3-1c1e-41d8-a53b-4c78de90c3f6",
            "entity_id": "13",
            "sender_name": null,
            "template_slug": null
        },
        {
            "id": 22,
            "slug": "612e469da681a",
            "name": "New Role name",
            "status": "waiting",
            "signed_date": null,
            "sent_date": "2021-08-31 15:11:25",
            "template_id": 2,
            "dir_hash": "8f0671e3-1c1e-41d8-a53b-4c78de90c3f6",
            "entity_id": "13",
            "sender_name": "Eli",
            "template_slug": null
        },
        {
            "id": 25,
            "slug": "613f543036eee",
            "name": "Form 101",
            "status": "signed",
            "signed_date": "2021-09-19 08:24:18",
            "sent_date": "2021-09-13 13:37:52",
            "template_id": 5,
            "dir_hash": "0f5ff456-d5f9-44c0-8270-4eb930a981c2",
            "entity_id": "13",
            "sender_name": "Eli",
            "template_slug": "form101"
        }
    ]
}
 

Request      

GET api/profile/{profile_id}/forms/assigned

URL Parameters

profile_id  integer  

The ID of the profile.

List all profile received forms

Example request:
curl --request GET \
    --get "http://localhost/api/profile/7/forms" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/7/forms"
);

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

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

Example response (200):


{
    "draw": 0,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "data": [
        {
            "id": 23,
            "name": "Form 101",
            "status": "waiting",
            "signed_date": null,
            "created_at": "2021-09-05 15:23:09",
            "template_id": 5,
            "template_slug": "form101",
            "dir_hash": "0f5ff456-d5f9-44c0-8270-4eb930a981c2",
            "file_id": null,
            "entity_id": "13",
            "sender_name": null
        }
    ]
}
 

Request      

GET api/profile/{profile_id}/forms

URL Parameters

profile_id  integer  

The ID of the profile.

Get last form fill data

Example request:
curl --request GET \
    --get "http://localhost/api/profile/78/forms/18/last" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "http://localhost/api/profile/78/forms/18/last"
);

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

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

Example response (200):


{
    "id": 5,
    "template_id": 5,
    "sender_id": 12,
    "recipient_id": "16",
    "entity_id": null,
    "name": "Form 101",
    "file_id": 19,
    "dir_hash": "0f5ff456-d5f9-44c0-8270-4eb930a981c2",
    "payload_id": "6134a6e585a9c2798666ae42",
    "status": "active",
    "admin_status": "not approved",
    "admin_notes": null,
    "signed_date": "2021-09-19T00:00:00.000000Z",
    "public": 0,
    "schedule": null,
    "parent_form_id": null,
    "created_at": "2021-09-05T11:15:58.000000Z",
    "updated_at": "2021-09-05T11:15:58.000000Z",
    "slug": "form101",
    "type": "form",
    "created_by": null,
    "payload": {
        "data": {
            "http://localhost:8000/forms/0f5ff456-d5f9-44c0-8270-4eb930a981c2/bg/1.jpg": [
                {
                    "pos_x": 0.3746058558558559,
                    "pos_y": 0.10007473469184396,
                    "width": 0.111022,
                    "height": 0.019899354092969956,
                    "name": "tax_year",
                    "placeholder": "2  0  2  1",
                    "font": "Arial",
                    "font_size": "26",
                    "type": "input-label",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7036176801801802,
                    "pos_y": 0.19894374968860545,
                    "width": 0.17678776576576577,
                    "height": 0.019899354092969956,
                    "name": "employer_name",
                    "placeholder": "שם ",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.36126126126126124,
                    "pos_y": 0.19895371431418465,
                    "width": 0.311022,
                    "height": 0.019899354092969956,
                    "name": "employer_address",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.22345157657657658,
                    "pos_y": 0.19959145035125306,
                    "width": 0.1074183963963964,
                    "height": 0.01862388201883314,
                    "name": "employer_phone",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7342483108108108,
                    "pos_y": 0.2589009017986149,
                    "width": 0.15336434234234234,
                    "height": 0.019899354092969956,
                    "name": "id_number_id",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.06307713963963964,
                    "pos_y": 0.20022918638832146,
                    "width": 0.13624722522522523,
                    "height": 0.017348409944696327,
                    "name": "employer_number",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.5369510135135135,
                    "pos_y": 0.2589009017986149,
                    "width": 0.17768866666666666,
                    "height": 0.019899354092969956,
                    "name": "last_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.35855855855855856,
                    "pos_y": 0.2595386378356833,
                    "width": 0.14795893693693693,
                    "height": 0.01926161805590155,
                    "name": "first_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.19659346846846848,
                    "pos_y": 0.2608141099098201,
                    "width": 0.14075172972972974,
                    "height": 0.02117482616710677,
                    "name": "birth_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-date",
                    "save_as": "recipient.birth_date",
                    "role_id": 1
                },
                {
                    "pos_x": 0.04276463963963964,
                    "pos_y": 0.26080414528424095,
                    "width": 0.13354452252252252,
                    "height": 0.019899354092969956,
                    "name": "immigration_date",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-date",
                    "role_id": 1
                },
                {
                    "pos_x": 0.4477477477477477,
                    "pos_y": 0.2914154750635245,
                    "width": 0.18579677477477477,
                    "height": 0.019899354092969956,
                    "name": "street_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-text",
                    "role_id": 1,
                    "save_as": "recipient.street_name"
                },
                {
                    "pos_x": 0.34054054054054056,
                    "pos_y": 0.2920432464750137,
                    "width": 0.02093190990990991,
                    "height": 0.019899354092969956,
                    "name": "house_number",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-text",
                    "role_id": 1,
                    "save_as": "recipient.house_number"
                },
                {
                    "pos_x": 0.2153153153153153,
                    "pos_y": 0.2920631757261721,
                    "width": 0.102012990990991,
                    "height": 0.020537090130038363,
                    "name": "city",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-text",
                    "role_id": 1,
                    "save_as": "recipient.city"
                },
                {
                    "pos_x": 0.048662725225225224,
                    "pos_y": 0.2920631757261721,
                    "width": 0.1137247027027027,
                    "height": 0.019899354092969956,
                    "name": "zip",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1,
                    "save_as": "recipient.zip"
                },
                {
                    "pos_x": 0.4252533783783784,
                    "pos_y": 0.3711424443226546,
                    "width": 0.15516614414414415,
                    "height": 0.019899354092969956,
                    "name": "custom_field",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.16306306306306306,
                    "pos_y": 0.371780180359723,
                    "width": 0.15606704504504504,
                    "height": 0.020537090130038363,
                    "name": "phone",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "18",
                    "type": "input-text",
                    "role_id": 1,
                    "save_as": "recipient.phone"
                },
                {
                    "pos_x": 0.8716216216216216,
                    "pos_y": 0.33159284539883416,
                    "width": 0.02072072072072072,
                    "height": 0.012754720741368143,
                    "name": "employeeGender_male",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "save_as": "recipient.gender(male)",
                    "role_id": 1
                },
                {
                    "pos_x": 0.8743102477477478,
                    "pos_y": 0.3468785810373175,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "employeeGender_female",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "save_as": "recipient.gender(female)",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7923282657657658,
                    "pos_y": 0.3290319366249813,
                    "width": 0.018018018018018018,
                    "height": 0.014667928852573365,
                    "name": "employeeStatus_single",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "save_as": "recipient.marital_status(single)",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7923282657657658,
                    "pos_y": 0.34563300283991827,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "employeeStatus_widower",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "save_as": "recipient.marital_status(windower)",
                    "role_id": 1
                },
                {
                    "pos_x": 0.684206081081081,
                    "pos_y": 0.3290518658761397,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "employeeStatus_married",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "save_as": "recipient.marital_status(married)",
                    "role_id": 1
                },
                {
                    "pos_x": 0.39683277027027025,
                    "pos_y": 0.42339694085994717,
                    "width": 0.018018018018018018,
                    "height": 0.012754720741368143,
                    "name": "salary_type_monthly",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7049408783783784,
                    "pos_y": 0.3462707388769867,
                    "width": 0.02072072072072072,
                    "height": 0.012754720741368143,
                    "name": "employeeStatus_seperated",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "save_as": "recipient.marital_status(separated)",
                    "role_id": 1
                },
                {
                    "pos_x": 0.5716075450450451,
                    "pos_y": 0.3303273379502765,
                    "width": 0.01981981981981982,
                    "height": 0.014667928852573365,
                    "name": "employeeStatus_divorced",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "save_as": "recipient.marital_status(divorced)",
                    "role_id": 1
                },
                {
                    "pos_x": 0.46349943693693696,
                    "pos_y": 0.33095510936176575,
                    "width": 0.01891891891891892,
                    "height": 0.01339245677843655,
                    "name": "israeli_citizen_1",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.4616976351351351,
                    "pos_y": 0.3462707388769867,
                    "width": 0.01891891891891892,
                    "height": 0.01339245677843655,
                    "name": "israeli_citizen_0",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3283502252252252,
                    "pos_y": 0.3303273379502765,
                    "width": 0.01891891891891892,
                    "height": 0.014667928852573365,
                    "name": "kibutz_member_1",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.3274634009009009,
                    "pos_y": 0.34690847491405513,
                    "width": 0.02072072072072072,
                    "height": 0.01339245677843655,
                    "name": "kibutz_member_0",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.21394988738738738,
                    "pos_y": 0.3284041652134921,
                    "width": 0.01891891891891892,
                    "height": 0.014667928852573365,
                    "name": "health_care_member_0",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.21304898648648649,
                    "pos_y": 0.3443674953913607,
                    "width": 0.01891891891891892,
                    "height": 0.014667928852573365,
                    "name": "health_care_member_1",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-checkbox",
                    "role_id": 1
                },
                {
                    "pos_x": 0.051351351351351354,
                    "pos_y": 0.34818394698819194,
                    "width": 0.05876974774774775,
                    "height": 0.013521993722285883,
                    "name": "health_care_company_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "13",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7549831081081081,
                    "pos_y": 0.4604055602610732,
                    "width": 0.09570668468468468,
                    "height": 0.019899354092969956,
                    "name": "kid_1_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7553490990990991,
                    "pos_y": 0.4859349309949679,
                    "width": 0.09750848648648648,
                    "height": 0.019899354092969956,
                    "name": "kid_2_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7553490990990991,
                    "pos_y": 0.5120920731403518,
                    "width": 0.09750848648648648,
                    "height": 0.019899354092969956,
                    "name": "kid_3_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7553490990990991,
                    "pos_y": 0.5388769866972248,
                    "width": 0.09750848648648648,
                    "height": 0.019899354092969956,
                    "name": "kid_4_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7553490990990991,
                    "pos_y": 0.5631009914802452,
                    "width": 0.09750848648648648,
                    "height": 0.019899354092969956,
                    "name": "kid_5_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7553490990990991,
                    "pos_y": 0.587972696925913,
                    "width": 0.09750848648648648,
                    "height": 0.020537090130038363,
                    "name": "kid_6_name",
                    "placeholder": "",
                    "font": "Arial",
                    "font_size": "16",
                    "type": "input-text",
                    "role_id": 1
                },
                {
                    "pos_x": 0.7553490990990991,
                    "pos_y": 0.6147675751083653,
                    "width": 0.09750848648648648,
                    "height": 0.020537090130038363,
                    "name": "kid_7_name"