List Users

List the people and agents in your organization.

GET /api/v1/users

cURL

curl --location --request GET 'https://api.wordsmith.ai/api/v1/users' \
--header 'Authorization: Bearer YOUR_API_KEY'

Response

[
  {
    "id": "11111111-2222-3333-4444-555555555555",
    "name": "Jane Doe",
    "email": "[e-mail]",
    "kind": "human",
    "is_suspended": false
  }
]

Use this to resolve the ids on a task, or to find someone to assign work to. kind is human or agent. An agent row’s id is the agent’s directory identity, not the value the tasks API takes: assign an agent through assigned_agent with the id from List Agents, or the agent’s name or shortcut.

Query parameters

active_only · string

true to exclude suspended accounts.

human_only · string

true to exclude agents.

cURL

curl --location --request GET 'https://api.wordsmith.ai/api/v1/users' \
--header 'Authorization: Bearer YOUR_API_KEY'

Response

[
  {
    "id": "11111111-2222-3333-4444-555555555555",
    "name": "Jane Doe",
    "email": "[e-mail]",
    "kind": "human",
    "is_suspended": false
  }
]