Employees
Manage employee accounts with role-based access control.
Use cases: Use the Employees API to onboard team members and assign roles and groups.
GET
/employeesList all employees.
Query Parameters
| Name | Type | Description | |
|---|---|---|---|
search | string | Free-text search across relevant fields. | |
page | number | Page number (default 1). | |
limit | number | Items per page (default 50). |
Request
curl -X GET "https://api.glance.co.il/employees" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Response
Response
{
"data": [
{
"visibleId": 1,
"firstName": "Sagi",
"lastName": "Shalom",
"email": "sagi@company.com",
"role": "owner",
"createdAt": "2024-01-01T00:00:00Z"
},
{
"visibleId": 2,
"firstName": "Dana",
"lastName": "Cohen",
"email": "dana@company.com",
"role": "manager",
"createdAt": "2024-02-01T09:00:00Z"
}
],
"pagination": {
"total": 8,
"limit": 50,
"offset": 0,
"hasMore": false
}
}GET
/employees/id/:visibleIdGet a single employee.
Path Parameters
| Name | Type | Description | |
|---|---|---|---|
visibleId | number | required | The employee visible ID. |
Request
curl -X GET "https://api.glance.co.il/employees/id/:visibleId" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Response
Response
{
"data": {
"visibleId": 2,
"firstName": "Dana",
"lastName": "Cohen",
"email": "dana@company.com",
"phoneNumber": "054-7654321",
"role": "manager",
"groupIds": [
1,
2
],
"createdAt": "2024-02-01T09:00:00Z"
}
}POST
/employees/createCreate a new employee.
Body Parameters
| Name | Type | Description | |
|---|---|---|---|
firstName | string | required | First name. |
lastName | string | Last name. | |
email | string | required | Email address (used for login). |
phoneNumber | string | Phone number. | |
role | string | Role: "owner", "manager", "shift_manager", or "employee" (default "employee"). | |
groupIds | number[] | Array of group IDs to assign. |
Request
curl -X POST "https://api.glance.co.il/employees/create" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"firstName": "example_firstName",
"lastName": "example_lastName",
"email": "example_email",
"phoneNumber": "example_phoneNumber",
"role": "example_role",
"groupIds": "example_groupIds"
}'Response
Response
{
"data": {
"visibleId": 5,
"firstName": "Yael",
"lastName": "Levi",
"email": "yael@company.com",
"role": "employee",
"createdAt": "2024-03-20T14:30:00Z"
}
}PUT
/employees/edit/:visibleIdUpdate an employee.
Path Parameters
| Name | Type | Description | |
|---|---|---|---|
visibleId | number | required | The employee visible ID. |
Body Parameters
| Name | Type | Description | |
|---|---|---|---|
firstName | string | First name. | |
lastName | string | Last name. | |
email | string | Email address. | |
phoneNumber | string | Phone number. | |
role | string | Role: "owner", "manager", "shift_manager", or "employee". | |
groupIds | number[] | Array of group IDs. |
Request
curl -X PUT "https://api.glance.co.il/employees/edit/:visibleId" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"firstName": "example_firstName",
"lastName": "example_lastName",
"email": "example_email",
"phoneNumber": "example_phoneNumber",
"role": "example_role",
"groupIds": "example_groupIds"
}'Response
Response
{
"data": {
"visibleId": 2,
"firstName": "Dana",
"lastName": "Cohen",
"role": "manager"
}
}DELETE
/employees/:visibleIdDelete an employee.
Path Parameters
| Name | Type | Description | |
|---|---|---|---|
visibleId | number | required | The employee visible ID. |
Request
curl -X DELETE "https://api.glance.co.il/employees/:visibleId" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Response
Response
{
"data": {
"success": true
}
}