List users

Employees and admins of your Connecteam account with their user IDs.

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

read

Returns the users of your account, one row each, with user_id, name and role. Use user_id in the other tools. status active is the default; archived shows archived users. Pass next_cursor back as cursor for the next page.

Parameters

Parameters: list_users
NameTypeDescription
status enum enum active (default) or archived.
name string string Only users whose name contains this text.
cursor string string Next page cursor from the previous call.

Request

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

Example response

JSON

{
  "users": [
    {
      "user_id": 8821034,
      "name": "Dana Whitfield",
      "role": "user"
    },
    {
      "user_id": 8821051,
      "name": "Luis Ortega",
      "role": "user"
    },
    {
      "user_id": 8821077,
      "name": "Priya Nair",
      "role": "user"
    }
  ],
  "next_cursor": null
}

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.