List employees

Team members of a location with their IDs.

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

read

Returns team members of one location, or of all your locations when location_id is omitted, with the employee_id other tools take. Terminated employees are left out.

Parameters

Parameters: list_employees
NameTypeDescription
location_id integer integer Location ID from list_locations. Default: all your locations.
search string string Part of the name to match.

Request

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

Example response

JSON

{
  "employees": [
    {
      "employee_id": 3,
      "name": "Ana Lopez",
      "location_id": 1
    },
    {
      "employee_id": 4,
      "name": "Tom Becker",
      "location_id": 1
    }
  ]
}

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.