List employees

List employees, with their department and contract type.

GET https://cotlet.dev/api/v1/shiftbase/employees

read

Returns the employee id, name, department and contract type. Which employees appear depends on the departments your role can open.

Parameters

Parameters: list_employees
NameTypeDescription
department_id string string Only employees of this department.
query string string Part of a name.

Request

cURL
curl https://cotlet.dev/api/v1/shiftbase/employees \
  -H "Authorization: Bearer $COTLET_API_KEY"
Python
result = client.call("shiftbase", "list_employees")
Node.js
const result = await cotlet.call('shiftbase', 'list_employees');
CLI
cotlet call shiftbase list_employees

Example response

JSON

{
  "employees": [
    {
      "id": "501",
      "name": "Lena Ortiz",
      "department": "Harbor Cafe",
      "contract_type": "Part-time"
    },
    {
      "id": "502",
      "name": "Sam Okafor",
      "department": "Harbor Cafe",
      "contract_type": "Full-time"
    }
  ]
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.