Search...
/
Support
Developer Forum
Login
Overview
Introduction
Getting Started
Authentication
Error Handling
Pagination
Filtering
Ordering
Rate Limits
Permissions
Webhooks
Changelog
Support
API Reference
Projects Overview
Projects
Project Types
Project Statuses
Project Roles
Project Comments
Project Tags
Project Milestones
Project Automations
Project Actions
Project Time Bookings
Autopilot
Tasks Overview
Tasks
Task Lists
Task Views
Project Tasks
Private Tasks
Assigned Tasks
Checklist Items
Task Comments
Task Tags
Task Dependencies
Task Schedules
Tasks Batch
Type of Work
Time Tracking Overview
Time Entries
Time Tracking
Time Reports
Project Time Entries
Task Time Entries
Companies Overview
Companies
Company Tags
Users Overview
Users
User Capacity
User Tags
Absences
Dashboards
Files & Images Overview
Files
Project Files
Task Files
Company Files
Comment Files
User Files
Workspace Files
Project Template Files
Task Template Files
Shared Files
Temporary Files
Images
Custom Fields Overview
Custom Fields
GET
Returns all custom field definitions.
POST
Creates a new custom field definition.
PUT
Updates a custom field selection option for an existing custom field definition.
DEL
Deletes a custom field selection option for an existing custom field definition.
PUT
Updates an existing custom field definition with the specified id.
DEL
Deletes the custom field definition with the specified id.
POST
Sets the custom fields for a task template.
POST
Unlinks a custom field definition from a projectTemplate.
PUT
Updates the order of a custom field definition for a project template.
POST
Links a custom field definition to a project.
POST
Links a custom field definition to a project template.
POST
Creates a custom field selection option for an existing custom field definition.
POST
Unlinks a custom field definition from a project.
GET
Returns all custom field definitions for a project template.
POST
Sets the custom fields for a task.
GET
Returns all custom field definitions for a project.
PUT
Updates the order of a custom field definition for a project.
Workload & Planning Overview
Workload
Project Templates Overview
Project Templates
Task Bundles
Task Templates
Task Dependency Templates
Project Template Tags
Project Milestone Templates
Project Template Automations
Project Template Actions
Login & Access Overview
Accounts
Invitations
Permissions
Roles
Teams
Workspaces
API Management Overview
API Users
Webhooks
Client Applications
Support
Developer Forum
Login
API Reference
Custom Fields
Returns all custom field definitions for a project template.
GET
https://
api.awork.com
/
api
/
v1
/
projecttemplates
/
:projectTemplateId
/
customfielddefinitions
Required Permissions:
The user must be an admin.
Path parameters
projectTemplateId
string
Required
The id of the project template.
Response
This endpoint returns an object.
id
string
Optional
The id of the custom field definition.
name
string
Optional
The name of the custom field definition.
entity
"task"
Optional
The entity the custom field definition can be linked to.
type
enum
Optional
The type of the custom field definition.
Show 9 enum values
createdOn
datetime
Optional
The date this entity was created.
createdBy
string
Optional
The id of the user who created this entity.
updatedOn
datetime
Optional
The date this entity was last modified.
updatedBy
string
Optional
The id of the user who last modified this entity.
selectionOptions
list of objects
Optional
The selection options for this custom field definition.
Show 4 properties
linkedProjectIds
list of strings
Optional
The linked project ids for this custom field definition.
Built with