Sign in

v1

latestOpenAPI 3.1.02026-08-066984441.1 MB
customFields

Returns all custom field definitions.

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>

get/customfielddefinitions

Query parameters

includeLinkedProjectIdsboolean

Whether to include linked project Ids in the response.

Headers

Authorizationstring required

Bearer authentication

Response

OK

idstring uuid

The id of the custom field definition.

namestring nullable

The name of the custom field definition.

entity'task' | 'project'

The entity the custom field definition can be linked to.

type'text' | 'number' | 'date' | 'datetime' | 'select' | 'coloredSelect' | 'link' | 'boolean' | 'user' | 'client'

The type of the custom field definition.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

ordernumber double nullable

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

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

linkedProjectIdsstring[] nullable

The linked project ids for this custom field definition.