API v1 ReferenceCustom Fields

Returns all custom field definitions linked to a workflow.

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

Path parameters

workflowIdstringRequiredformat: "uuid"
The id of the workflow.

Response

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

Errors

404
Not Found Error