API v1 ReferenceCustom Fields

Returns all custom field definitions.

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

Required Permissions
Any authenticated user.

Headers

AuthorizationstringRequired

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

Query parameters

includeLinkedProjectIdsbooleanOptionalDefaults to false

Whether to also include the linked project ids.

Response

OK

idUUIDOptional

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.

Allowed values:
typeenumOptional

The type of the custom field definition.

createdOndatetimeOptional

The date this entity was created.

createdByUUIDOptional

The id of the user who created this entity.

updatedOndatetimeOptional

The date this entity was last modified.

updatedByUUIDOptional

The id of the user who last modified this entity.

selectionOptionslist of objectsOptional

The selection options for this custom field definition.

linkedProjectIdslist of UUIDsOptional

The linked project ids for this custom field definition.