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 ReferenceCustom Fields

GET
https://api.awork.com/api/v1/projecttemplates/:projectTemplateId/customfielddefinitions
GET
/api/v1/projecttemplates/:projectTemplateId/customfielddefinitions
1curl https://api.awork.com/api/v1/projecttemplates/projectTemplateId/customfielddefinitions \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1{
2  "id": "123e4567-e89b-12d3-a456-426614174000",
3  "name": "Ticket-Number",
4  "entity": "task",
5  "type": "text",
6  "createdOn": "2022-03-10T16:25:09.100Z",
7  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
8  "updatedOn": "2022-03-10T18:55:00.500Z",
9  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
10  "order": 1,
11  "isExternal": true,
12  "selectionOptions": [
13    {
14      "value": "Website Design",
15      "order": 0,
16      "id": "123e4567-e89b-12d3-a456-426614174000",
17      "color": "red"
18    }
19  ]
20}
Was this page helpful?
Previous

Updates the order of a custom field definition for a project template.

Next
Built with
<Check title="Required Permissions">Any authenticated user.</Check>
Returns all custom field definitions linked to a project template.

Authentication

AuthorizationBearer

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

Path Parameters

projectTemplateIdstringRequiredformat: "uuid"
The id of the project template.

Response

OK
idstring or nullformat: "uuid"
The id of the custom field definition.
namestring or null
The name of the custom field definition.
entityenum or null
The entity the custom field definition can be linked to.
Allowed values:
typeenum or null
The type of the custom field definition.
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.
orderdouble or null
If it's a project custom field, it's the global order of the custom field definition. Otherwise, it's the order of the custom field definition within a project template or a project.
isExternalboolean or null
True if this entity is coming from an external workspace (awork Connect).
selectionOptionslist of objects or null
The selection options for this custom field definition.
Required Permissions
Any authenticated user.

True if this entity is coming from an external workspace (awork Connect).