List Users

Returns a filtered and paginated list of users belonging to an organizational unit and all sub-units the authenticated admin has access to.

Scope
If org_unit_id is omitted, the results default to the authenticated user's own organizational unit. The query automatically includes sub-groups within the specified org unit, so you always see the full team hierarchy.

Filtering

name — partial, case-insensitive match against first and last name combined.

email — partial, case-insensitive match against the user's login email address.

role_id — exact match by role ID (e.g. 1=Admin, 2=Standard, 3=ReadOnly).

Sorting

sort_by — field to sort on: created_on (default), name, or email.

sort_order — direction: desc (default, newest first) or asc.

Pagination

limit — maximum records to return (default: 100).

offset — number of records to skip (default: 0).

Authorization
Requires Admin role. Support admin accounts are automatically excluded from results.

Response
Each user record includes profile details (name, email, role), group and account assignment, call access permissions, scorecard assignment, ring-to configuration, and creation timestamp.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

{ "code": 200, "message": "Success", "data": { "users": [ { "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "user_ext_id": "EXT-12345", "ct_user_id": 10001, "status": "active", "agent_ring_to": "+14255551234", "agent_id": "AGT-001", "group": "Sales Team", "group_org_unit_id": 70035, "group_external_id": "GRP-70035", "account": "Acme Corporation", "account_org_unit_id": 60001, "account_external_id": "ACC-60001", "parent_group": "West Region", "parent_group_org_unit_id": 65000, "parent_group_external_id": "REG-65000", "role": "Standard User", "access_audio": "Yes", "group_access": 3, "report_access": 5, "assign_scorecard": true, "user_created": "2026-03-29T12:00:00.000Z" } ], "total": 50 }, "request_id": "550e8400-e29b-41d4-a716-446655440000", "timestamp": "2026-01-20T12:34:56.789Z" }

Request

Responses