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

Creates a new project role.

POST
https://api.awork.com/api/v1/projectroles
POST
/api/v1/projectroles
$curl -X POST https://api.awork.com/api/v1/projectroles \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "Lead Developer"
>}'
1{
2  "name": "Lead Developer",
3  "isDefault": false,
4  "defaultProjectRoleId": "9f8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
5  "allowOnlyProjectMasterDataRead": false,
6  "id": "4a3b2c1d-0e9f-8a7b-6c5d-4e3f2a1b0c9d",
7  "memberCount": 3,
8  "members": [
9    {
10      "id": "7e6d5c4b-3a2f-1e0d-9c8b-7a6f5e4d3c2b",
11      "userId": "2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
12      "firstName": "Michael",
13      "lastName": "Johnson",
14      "hasImage": true,
15      "projectRoleId": "4a3b2c1d-0e9f-8a7b-6c5d-4e3f2a1b0c9d",
16      "projectRoleName": "Lead Developer",
17      "isResponsible": true,
18      "isDeactivated": false,
19      "isExternal": false
20    }
21  ],
22  "createdOn": "2024-04-10T08:45:00Z",
23  "createdBy": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
24  "updatedOn": "2024-04-12T14:20:00Z",
25  "updatedBy": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
26}
<Note title="Subscription Level" icon="layer-group">This endpoint requires the `Standard` plan or higher.</Note> <Check title="Required Permissions" icon="key">The user must be an admin or have `workspace-manage-config:write` permissions.</Check>
Was this page helpful?
Previous

Returns all project roles assigned to the specified user.

Next
Built with
Subscription Level
This endpoint requires the Standard plan or higher.
Required Permissions
The user must be an admin or have workspace-manage-config:write permissions.

Authentication

AuthorizationBearer

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

Request

The model to create the project role.
namestringRequired0-255 characters
The name of the project role. Required.
isDefaultboolean or nullOptional
Whether to use this role as default when adding new project members.
defaultProjectRoleIdstring or nullOptionalformat: "uuid"
The id of the new default project role. Required if the updated project role is the current default role.
allowOnlyProjectMasterDataReadbooleanOptional

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

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

400
Bad Request Error