Returns all custom field definitions.

GET

The ‘linkedProjectIds’ property will only be included when the ‘includeLinkedProjectIds’ parameter is set to ‘true’.

Required Permissions: Any authenticated user.

Query parameters

includeLinkedProjectIdsbooleanOptionalDefaults to false

Whether to also include the linked project ids.

Response

OK

idstringOptionalformat: "uuid"

The id of the custom field definition.

namestringOptional

The name of the custom field definition.

entity"task"OptionalDefaults to task

The entity the custom field definition can be linked to.

typeenumOptional

The type of the custom field definition.

createdOndatetimeOptional

The date this entity was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this entity.

updatedOndatetimeOptional

The date this entity was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this entity.

selectionOptionslist of objectsOptional

The selection options for this custom field definition.

linkedProjectIdslist of stringsOptional

The linked project ids for this custom field definition.

Built with