User

Find all users on a workspace

get/v1/workspaces/{workspaceId}/users

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

Query parameters

emailstring

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

Example:mail@example.com

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

project-idstring

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

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

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

account-statusesstring

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.

namestring

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

Example:John

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

sort-column'ID' | 'EMAIL' | 'NAME' | 'NAME_LOWERCASE' | 'ACCESS' | 'HOURLYRATE' | 'COSTRATE'

Sorting column criteria. Default value: EMAIL

sort-order'ASCENDING' | 'DESCENDING'

Sorting mode. Default value: ASCENDING

pageinteger

Page number.

Example:1

Page number.

page-sizeinteger

Page size.

Example:50

Page size.

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

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

include-rolesstring required

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

Response

OK

UserDtoV1[] required— unresolved $ref

Changes