List employees
List the people of a unit or section with their status and badge number.
GET https://cotlet.dev/api/v1/quinyx/employees
read
Returns employee_id, name, badge number, status and home unit. Passive employees are left out by default because Quinyx cannot assign a shift to them. The list shows only people your roles let you see.
Parameters
| Name | Type | Description |
|---|---|---|
| group_id string | string | Unit or section id from list_groups. Defaults to your home unit. |
| query string | string | Part of a name or a badge number. |
| include_passive boolean | boolean | Include employees with the Passive status. Default false. |
Request
curl https://cotlet.dev/api/v1/quinyx/employees \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("quinyx", "list_employees")const result = await cotlet.call('quinyx', 'list_employees');cotlet call quinyx list_employeesExample response
{
"employees": [
{
"employee_id": "3011",
"name": "Tom Becker",
"badge_number": "2041",
"status": "active",
"home_unit": "Harbor Cafe"
},
{
"employee_id": "3027",
"name": "Maria Silva",
"badge_number": "2058",
"status": "active",
"home_unit": "Harbor Cafe"
}
]
}