customFields

Returns all custom field definitions.

Changed on

Returns all custom field definitions in the workspace. Set includeLinkedProjectIds to include the projects linked to each definition.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

get/customfielddefinitions

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/customfielddefinitions
  • Auth: HTTP bearer

Query parameters

includeLinkedProjectIdsboolean

Whether to include linked project Ids in the response.

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

linkedProjectIdsstring[] nullable

The linked project ids for this custom field definition.

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 GetCustomFieldDefinitions removed and replaced with customFields_GetCustomFieldDefinitions