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 a project role by its id.

GET
https://api.awork.com/api/v1/projectroles/:projectRoleId
GET
/api/v1/projectroles/:projectRoleId
$curl https://api.awork.com/api/v1/projectroles/projectRoleId \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "name": "Project Manager",
3  "isDefault": true,
4  "defaultProjectRoleId": "9f8b7c6d-1234-4a56-b789-0c1d2e3f4a5b",
5  "allowOnlyProjectMasterDataRead": true,
6  "id": "9f8b7c6d-1234-4a56-b789-0c1d2e3f4a5b",
7  "memberCount": 5,
8  "members": [
9    {
10      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
11      "userId": "b1c2d3e4-f5a6-7890-bcde-fa1234567890",
12      "firstName": "Lisa",
13      "lastName": "Smith",
14      "hasImage": true,
15      "projectRoleId": "9f8b7c6d-1234-4a56-b789-0c1d2e3f4a5b",
16      "projectRoleName": "Project Manager",
17      "isResponsible": true,
18      "isDeactivated": false,
19      "isExternal": true
20    }
21  ],
22  "createdOn": "2024-01-15T09:30:00Z",
23  "createdBy": "d4e5f6a7-b890-1234-cdef-567890abcdef",
24  "updatedOn": "2024-04-10T14:45:00Z",
25  "updatedBy": "d4e5f6a7-b890-1234-cdef-567890abcdef"
26}
<Check title="Required Permissions" icon="key">Any authenticated user.</Check>
Was this page helpful?
Previous

Updates an existing 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.

Response

OK
namestring0-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

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

idstringformat: "uuid"
The id of the project role.
memberCountinteger
The count of members which are linked to this role.
memberslist of objects or null
The members which are linked to this role.
createdOnstringformat: "date-time"
The date this entity was created.
createdBystringformat: "uuid"
The id of the user who created this entity.
updatedOnstringformat: "date-time"
The date this entity was last modified.
updatedBystringformat: "uuid"
The id of the user who last modified this entity.

Errors

404
Not Found Error