For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Integration Example (PSA)
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
      • GETReturns all project roles.
      • POSTCreates a new project role.
      • GETReturns all project roles assigned to the specified user.
      • GETReturns a project role by its id.
      • PUTUpdates an existing project role.
      • POSTDeletes a project role and migrates its members to a new role.
      • GETReturns all permissions assigned to a project role.
      • POSTCreates or updates a permission for a project role.
    • 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
    • Workflows Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceProject Roles

Returns all permissions assigned to a project role.

GET
https://api.awork.com/api/v1/projectroles/:projectRoleId/permissions
GET
/api/v1/projectroles/:projectRoleId/permissions
$curl https://api.awork.com/api/v1/projectroles/projectRoleId/permissions \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1[
2  {
3    "feature": "timeTracking",
4    "accessLevels": [
5      "read",
6      "write"
7    ],
8    "id": "a12b34cd-56ef-78ab-90cd-ef1234567890",
9    "createdOn": "2024-04-10T08:15:00Z",
10    "updatedOn": "2024-05-01T12:00:00Z"
11  },
12  {
13    "feature": "taskManagement",
14    "accessLevels": [
15      "read",
16      "write",
17      "delete"
18    ],
19    "id": "b23c45de-67fa-89bc-01de-fa2345678901",
20    "createdOn": "2024-02-20T10:00:00Z",
21    "updatedOn": "2024-05-02T14:30:00Z"
22  },
23  {
24    "feature": "reporting",
25    "accessLevels": [
26      "read"
27    ],
28    "id": "c34d56ef-78ab-90cd-12ef-ab3456789012",
29    "createdOn": "2024-03-05T11:45:00Z",
30    "updatedOn": "2024-05-03T09:00:00Z"
31  }
32]
<Check title="Required Permissions" icon="key">Any authenticated user.</Check>
Was this page helpful?
Previous

Creates or updates a permission for a project role.

Next
Built with
Required Permissions
Any authenticated user.

Authentication

AuthorizationBearer

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

Path parameters

projectRoleIdstringRequiredformat: "uuid"
The id of the project role.

Query parameters

pageintegerOptionalDefaults to 1
Page number for pagination
pageSizeintegerOptionalDefaults to 10
Number of items per page
orderbystringOptional
The properties to order by
filterbystringOptional
The filter expression to filter by

Response

OK
featurestring or null
The feature these permissions belong to.
accessLevelslist of strings or null
The access levels applied to this feature.
idstringformat: "uuid"
The id of the permission.
createdOnstringformat: "date-time"
The date this entity was created.
updatedOnstringformat: "date-time"
The date this entity was last modified.

Errors

404
Not Found Error