Returns all custom field definitions.

GET

https://api.awork.com/api/v1/customfielddefinitions

GET

/api/v1/customfielddefinitions

$ curl https://api.awork.com/api/v1/customfielddefinitions \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 [
2   {
3     "id": "123e4567-e89b-12d3-a456-426614174000",
4     "name": "Ticket-Number",
5     "entity": "task",
6     "type": "text",
7     "createdOn": "2022-03-10T16:25:09.100Z",
8     "createdBy": "123e4567-e89b-12d3-a456-426614174000",
9     "updatedOn": "2022-03-10T18:55:00.500Z",
10     "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
11     "order": 1,
12     "isExternal": true,
13     "selectionOptions": [
14       {
15         "value": "Website Design",
16         "id": "123e4567-e89b-12d3-a456-426614174000",
17         "color": "purple",
18         "order": 0
19       }
20     ],
21     "linkedProjectIds": [
22       "123e4567-e89b-12d3-a456-426614174000"
23     ]
24   }
25 ]

The ‘linkedProjectIds’ are the project Ids that are linked to the custom field definition. The ‘linkedProjectIds’ property will only be included when the ‘includeLinkedProjectIds’ parameter is set to ‘true’.

Required Permissions

Any authenticated user.

The 'linkedProjectIds' are the project Ids that are linked to the custom field definition. The 'linkedProjectIds' property will only be included when the 'includeLinkedProjectIds' parameter is set to 'true'. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

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

Query parameters

includeLinkedProjectIdsbooleanOptionalDefaults to false

Whether to include linked project Ids in the response.

Response

idstringOptionalformat: "uuid"

The id of the custom field definition.

namestring or nullOptional

The name of the custom field definition.

entityenumOptional

The entity the custom field definition can be linked to.

typeenumOptional

The type of the custom field definition.

createdOnstringOptionalformat: "date-time"

The date this entity was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this entity.

updatedOnstringOptionalformat: "date-time"

The date this entity was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this entity.

orderdouble or nullOptional

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.

isExternalbooleanOptional

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

selectionOptionslist of objects or nullOptional

The selection options for this custom field definition.

linkedProjectIdslist of strings or nullOptional

The linked project ids for this custom field definition.