---
title: "Returns all custom field definitions."
method: GET
path: "/customfielddefinitions"
tags: ["customFields"]
---

# Returns all custom field definitions.

`GET /customfielddefinitions`

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

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

## Query parameters

- `includeLinkedProjectIds` boolean

## Headers

- `Authorization` string, required

## Response `200`

OK

- CustomFieldDefinitionWithSelectionOptionsAndLinkedProjectIds[]
  - `id` string, uuid — The id of the custom field definition.
  - `name` string, 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.
  - `createdOn` string, date-time — The date this entity was created.
  - `createdBy` string, uuid — The id of the user who created this entity.
  - `updatedOn` string, date-time — The date this entity was last modified.
  - `updatedBy` string, uuid — The id of the user who last modified this entity.
  - `order` number, 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.
  - `isExternal` boolean — True if this entity is coming from an external workspace (awork Connect).
  - `selectionOptions` CustomFieldSelectionOption[], nullable — The selection options for this custom field definition.
    - `id` string, uuid — The id of the custom field selection option.
    - `value` string, required — The selection value which can be later used in a select custom field.
    - `color` 'red' | 'orange' | 'yellow' | 'green' | 'cyan' | 'blue' | 'indigo' | 'purple' | 'steel' — The color of the selection option.
    - `order` number, double — The order of the custom field selection option.
  - `linkedProjectIds` string[], nullable — The linked project ids for this custom field definition.

---

[API](https://skmtc.net/awork-io/apis/api-v1-reference.md) · [All operations](https://skmtc.net/awork-io/apis/api-v1-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/awork-io/api-v1-reference/versions/f784a53f60df/schema)