projectRoles

Returns project roles in the workspace.

Changed on

Returns project roles in the workspace. Set includeMembers to include each role's members.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

get/projectroles

Request

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

Query parameters

includeMembersboolean

Whether to include the members of each project role in the response.

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

orderbystring

The properties to order by

filterbystring

The filter expression to filter by

Response

OK

namestring required

The name of the project role. Required.

isDefaultboolean nullable

Whether to use this role as default when adding new project members.

defaultProjectRoleIdstring uuid nullable

The id of the new default project role. Required if the updated project role is the current default role.

allowOnlyProjectMasterDataReadboolean

Whether this role is allowed to have only read permissions for project-master-data.

idstring uuid

The id of the project role.

memberCountinteger

The count of members which are linked to this role.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id GetProjectRoles removed and replaced with projectRoles_GetProjectRoles