SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceProject Roles

Returns all project roles.

GET
https://api.awork.com/api/v1/projectroles
GET
/api/v1/projectroles
1curl https://api.awork.com/api/v1/projectroles \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1[
2  {
3    "name": "Project Manager",
4    "isDefault": true,
5    "defaultProjectRoleId": "123e4567-e89b-12d3-a456-426614174000",
6    "allowOnlyProjectMasterDataRead": true,
7    "id": "123e4567-e89b-12d3-a456-426614174000",
8    "memberCount": 5,
9    "members": [
10      {
11        "id": "123e4567-e89b-12d3-a456-426614174000",
12        "userId": "123e4567-e89b-12d3-a456-426614174000",
13        "firstName": "Lisa",
14        "lastName": "Smith",
15        "hasImage": true,
16        "projectRoleId": "123e4567-e89b-12d3-a456-426614174000",
17        "projectRoleName": "Project Manager",
18        "isResponsible": true,
19        "isDeactivated": false,
20        "isExternal": true
21      }
22    ],
23    "createdOn": "2024-01-15T09:30:00Z",
24    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
25    "updatedOn": "2024-01-15T09:30:00Z",
26    "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
27  }
28]
Returns all project roles. <Check title="Required Permissions">Any authenticated user.</Check>
Was this page helpful?
Previous

Creates a new project role.

Next
Built with
Creates a new project role.

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Query parameters

includeMembersbooleanOptionalDefaults to true
If set, all the assigned members to that role a included in the response. Default is true.
pageintegerOptionalDefaults to 1
Page number for pagination
pageSizeintegerOptionalDefaults to 10
Number of items per page
Number of items per page
If set, all the assigned members to that role a included in the response. Default is true.
Page number for pagination

Bearer authentication of the form Bearer <token>, where token is your auth token.

orderbystringOptional
The properties to order by
filterbystringOptional
The filter expression to filter by

Response

OK
namestring>=0 characters<=255 characters
The name of the project role. Required.
isDefaultboolean or null
Whether to use this role as default when adding new project members.
defaultProjectRoleIdstring or nullformat: "uuid"
The id of the new default project role. Required if the updated project role is the current default role.
allowOnlyProjectMasterDataReadboolean or null
Whether this role is allowed to have only read permissions for project-master-data.
idstring or nullformat: "uuid"
The id of the project role.
memberCountinteger or null
The count of members which are linked to this role.
memberslist of objects or null
The members which are linked to this role.
createdOnstring or nullformat: "date-time"
The date this entity was created.
createdBystring or nullformat: "uuid"
The id of the user who created this entity.
updatedOnstring or nullformat: "date-time"
The date this entity was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this entity.

Returns all project roles.

Required Permissions
Any authenticated user.

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