API v1 ReferenceCustom Fields

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’.

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
idUUID or null
The id of the custom field definition.
namestring or null
The name of the custom field definition.
entityenum or null
The entity the custom field definition can be linked to.
Allowed values:
typeenum or null
The type of the custom field definition.
createdOndatetime or null
The date this entity was created.
createdByUUID or null
The id of the user who created this entity.
updatedOndatetime or null
The date this entity was last modified.
updatedByUUID or null
The id of the user who last modified this entity.
orderdouble or null
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.
selectionOptionslist of objects or null
The selection options for this custom field definition.
linkedProjectIdslist of UUIDs or null
The linked project ids for this custom field definition.