List users

Teammates of your eDesk account with their role.

GET https://cotlet.dev/api/v1/edesk/users

read

Lists the users of the account with user_id, name and role (Owner, Admin, Team Leader, Agent or a custom role). Use user_id as owner_id or mention_user_id in update_ticket. A ticket has one owner at a time.

Parameters

Parameters: list_users
NameTypeDescription
query string string Only users whose name or email contains this text.

Request

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

Example response

JSON

{
  "users": [
    {
      "user_id": 3105,
      "name": "Marco Silva",
      "role": "Agent"
    },
    {
      "user_id": 3102,
      "name": "Priya Nair",
      "role": "Team Leader"
    }
  ]
}

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.