Sign in
User

Filter workspace users

post/v1/workspaces/{workspaceId}/users/info

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

Request body

accountStatusesstring[]

If provided, you'll get a filtered list of users with the corresponding account status filter. If not, this will only filter ACTIVE, PENDING_EMAIL_VERIFICATION, and NOT_REGISTERED Users.

emailstring

If provided, you'll get a filtered list of users that contain the provided string in their email address.

includeRolesboolean

If you pass along includeRoles=true, you'll get each user's detailed manager role (including projects and members for whom they're managers)

memberships'ALL' | 'NONE' | 'WORKSPACE' | 'PROJECT' | 'USERGROUP'

If provided, you'll get all users along with workspaces, groups, or projects they have access to.

namestring

If provided, you'll get a filtered list of users that contain the provided string in their name.

pageinteger

Page number.

pageSizeinteger

Page size.

projectIdstring

If provided, you'll get a list of users that have access to the project.

rolesstring[]

If provided, you'll get a filtered list of users that have any of the specified roles. Owners are counted as admins when filtering.

sortColumn'ID' | 'EMAIL' | 'NAME' | 'NAME_LOWERCASE' | 'ACCESS' | 'HOURLYRATE' | 'COSTRATE'

Sorting criteria

sortOrder'ASCENDING' | 'DESCENDING'

Sorting mode

status'PENDING' | 'ACTIVE' | 'DECLINED' | 'INACTIVE' | 'ALL'

If provided, you'll get a filtered list of users with the corresponding status.

userGroupsstring[]

If provided, you'll get a list of users that belong to the specified user group IDs.

Example request

{
  "accountStatuses": [
    "LIMITED",
    "ACTIVE"
  ],
  "email": "mail@example.com",
  "memberships": "NONE",
  "name": "John",
  "page": 1,
  "pageSize": 50,
  "projectId": "21a687e29ae1f428e7ebe606",
  "roles": [
    "WORKSPACE_ADMIN",
    "OWNER"
  ],
  "sortColumn": "ID",
  "sortOrder": "ASCENDING",
  "status": "ACTIVE",
  "userGroups": [
    "5a0ab5acb07987125438b60f",
    "72wab5acb07987125438b564"
  ]
}

Response

OK

UserDtoV1[] required— unresolved $ref

Changes