Returns all custom field definitions linked to the specified project, including definitions linked via a workflow. | awork API

<Check title="Required Permissions" icon="key">The user must have either `project-master-data:read` permissions or access to at least one task in the project.</Check>

Required Permissions

The user must have either project-master-data:read permissions or access to at least one task in the project.

<Check title="Required Permissions" icon="key">The user must have either `project-master-data:read` permissions or access to at least one task in the project.</Check>

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequiredformat: "uuid"

The id of the project.

Response

idstringformat: "uuid"

The id of the custom field definition.

namestring or null

The name of the custom field definition.

entityenum

The entity the custom field definition can be linked to.

Allowed values:

typeenum

The type of the custom field definition.

createdOnstringformat: "date-time"

The date this entity was created.

createdBystringformat: "uuid"

The id of the user who created this entity.

updatedOnstringformat: "date-time"

The date this entity was last modified.

updatedBystringformat: "uuid"

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.

isExternalboolean

True if this entity is coming from an external workspace (awork Connect).

selectionOptionslist of objects or null

The selection options for this custom field definition.

Errors

401

Unauthorized Error

404

Not Found Error