Sign in
Workspaces

Lists all the users that are in a workspace if the authorized user has admin permissions to the related workspace. To add a user to a workspace an invitation must be sent first.

get/api/workspaces/users/workspace/{workspace_id}/

Path parameters

workspace_idinteger required

Lists workspace users related to the provided workspace value.

Query parameters

searchstring

Search for workspace users by username, or email.

sortsstring

Sort workspace users by name, email or role.

Response

idinteger required
namestring required

User defined name.

emailstring required

User email.

workspaceinteger required

The workspace that the user has access to.

permissionsstring

The permissions that the user has within the workspace.

created_onstring date-time required
user_idinteger required

The user that has access to the workspace.

to_be_deletedboolean required

True if user account is pending deletion.

two_factor_authstring required
role_uidstring nullable

Enterprise or advanced only: the uid of the role that is assigned to this workspace user in this workspace.

highest_role_uidstring nullable

Enterprise or advanced only: the highest role uid assigned to this user in this workspace on anything, including roles from teams.

Changes

No recorded changes to this endpoint across all 6 revisions of this API.