users
List team members with filters for workspace, department, branch, status, and availability.
Use userDetail for a single user or currentUser
for the caller’s own profile.
Auth · x-app-token · required permission showUsers
Related: userDetail, currentUser, User, Authentication
users(sortField: String, sortDirection: SortDirection, page: Int, perPage: Int, status: String, excludeIds: Boolean, searchValue: String, isActive: Boolean, requireUsername: Boolean, ids: [String], workspaceIds: [String], branchIds: [String], departmentIds: [String], availability: UserChatStatus): UserListResponseArguments
Field to sort by.
Sort direction for sortField.
1-based page index. See Pagination.
Page size. See Pagination.
Filter by account status.
When true, ids excludes instead of includes.
Case-insensitive partial match on name, username, or email.
Filter by active/inactive account state.
When true, only return users that have a username set.
Restrict to these user ids.
Restrict to users in these workspaces.
Restrict to users in these branches.
Restrict to users in these departments.
Filter by presence/chat status. See UserChatStatus.
Returns
Standard pagination metadata: totalCount, currentPage, totalPages,
hasNextPage, hasPreviousPage, perPage.