roles

Returns all users in roles of the workspace.

Changed on

<Check title="Required Permissions" icon="key">The user must be an admin or have workspace-manage-config:read permissions.</Check>

get/roles/users

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/roles/users
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

orderbystring

The properties to order by

filterbystring

The filter expression to filter by

Headers

aw-internal-requeststring required

Marks this request as an internal request. Only allowed by the awork app or internally.

Response

OK

userIdstring uuid required

The id of the user to add to the role.

isDeactivatedboolean

Whether the user is deactivated in this role.

roleIdstring uuid

The id of the role the user is assigned to.

Changes