customFields

Returns custom fields linked to a workflow.

Changed on

Returns custom fields linked to a workflow. The result includes fields linked to the workflow. <Check title="Required Permissions" icon="key">The user must have permission to access the requested resource.</Check>

get/workflows/{workflowId}/customfielddefinitions

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/workflows/{workflowId}/customfielddefinitions
  • Auth: HTTP bearer

Path parameters

workflowIdstring uuid required

The id of the workflow.

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

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id GetWorkflowCustomFieldDefinitionsByWorkflowId removed and replaced with customFields_GetWorkflowCustomFieldDefinitionsByWorkflowId