Sign in
latestSwagger 2.02026-08-2053114259.7 KB

41da8739a690

Users

List users

Returns all users in your organization. Users with 'Manage Users and Groups' permission receive additional account metadata. Pass includeDeleted=true (requires 'Manage Users and Groups') to also include soft-deleted users.

Required Permissions

  • Global: View Users And Groups
get/api/Users

Query parameters

includeDeletedboolean

Response

Returns organization users

idstring required

The unique identifier of the user or group.

userNamestring nullable required

The display name of the user or group.

firstNamestring nullable

The user's first name.

lastNamestring nullable

The user's last name.

organizationIdstring nullable

The identifier of the organization the user belongs to.

teamNamestring nullable

The name of the team the user belongs to, if set.

deletedboolean

Whether the user has been soft-deleted. Only surfaced to callers with permission to manage users.