Custom Fields in ClickUp via API

The ClickUp API lets you add powerful structure to your workspaces by managing custom fields programmatically. With custom fields, you can store extra data on tasks, organize workflows, and sync information with other tools through the REST API.

This how-to guide walks you through every available custom field endpoint so you can confidently build and automate around your workspace data.

Understanding ClickUp Custom Fields

Custom fields in ClickUp are additional data points you attach to tasks. Instead of relying only on standard properties like name, status, and assignee, you can define your own fields to track exactly what matters to your team.

Common examples include:

• Client name or account ID
• Budget, cost, or revenue
• Sprint number or release version
• Priority scales or risk levels
• Feature flags or internal IDs

With the REST API, you can read these fields and set their values to keep external systems in sync.

ClickUp Custom Fields and Spaces

Custom fields live inside Spaces. Each Space can have its own set of fields, which can then be used on tasks within that Space and its Lists and Folders.

At the API level, you interact with custom fields primarily through Spaces and Lists. You cannot create new custom field types through the public REST API. Instead, you must create the field in the web or desktop app first, then use the API to read available fields in a Space and manage values on tasks.

The workflow looks like this:

1. Create or configure custom fields in the ClickUp interface.
2. Use the API to list custom fields for a Space or List.
3. Get tasks, see their custom field values, and update them as needed.

List ClickUp Custom Fields in a Space

To work with custom fields by API, you first need to discover which fields are available in a Space.

How to Retrieve Custom Fields for a Space

Use the Get Accessible Custom Fields endpoint. This returns a list of custom fields that can be applied to tasks in a specific Space.

1. Find the Space ID in the ClickUp app or via Space-related API endpoints.
2. Call the GET endpoint for accessible custom fields for that Space.
3. Inspect the response for field IDs, names, types, and configuration.

Each item in the response includes an id and other metadata that you will use when setting or reading field values on tasks.

List Available ClickUp Custom Fields for a List

Within a Space, not every custom field is always available to every List. To see which fields are allowed for a specific List, you can use the Get Available Custom Fields endpoint.

Steps to View List-Level Custom Fields

1. Identify the List ID.
2. Make a GET request to the available custom fields endpoint for that List.
3. Review the returned fields and their IDs.

This is useful when you want to validate which custom fields can be safely applied to tasks in that List before trying to set a value.

View ClickUp Custom Field Values on a Task

Once you know which custom fields are available, you can read the current values set on a specific task.

Get a Task Including Custom Fields

Use the Get Task endpoint. The standard task response includes a section for custom fields containing their current values.

1. Obtain the task ID.
2. Send a GET request for that task.
3. Locate the custom_fields array in the response.

Each object in the array ties a custom field ID to its current value. You will use those same IDs when updating or removing values.

Set Custom Field Values with the ClickUp API

You can apply or update a custom field value on a task using a dedicated endpoint. This is central to keeping external data in sync with your workspace.

How to Set a Custom Field Value

1. Retrieve the custom field ID from the Space or List endpoints.
2. Identify the target task ID.
3. Call the Set Custom Field Value endpoint using POST or PUT as documented.
4. Include the value in the request body in the correct format for the field type (for example, text, number, date, or dropdown option ID).

After a successful request, the task will store the new value, which will be visible in both the ClickUp interface and subsequent API responses.

Remove Custom Field Values in ClickUp

If a value is no longer needed, you can remove it from a task while keeping the field itself available for future use.

Steps to Remove a Custom Field Value from a Task

1. Find the field ID and task ID as before.
2. Use the Remove Custom Field Value endpoint, typically with a DELETE request.
3. Confirm in the response that the value has been cleared.

Removing a value does not delete the custom field definition. It only clears the data for that specific task.

ClickUp API Tips for Working with Custom Fields

To keep your implementation stable and maintainable, follow these practical guidelines when working with the ClickUp API and custom fields:

• Always reference fields by ID rather than name, because names can change.
• Check field types before setting values to ensure you send the right structure and data format.
• Validate availability per List so you do not attempt to set fields that the List cannot use.
• Handle missing values gracefully when reading from custom_fields, because tasks may not have a value for every field.

These practices help prevent errors and make your integrations more resilient as your workspace evolves.

Official ClickUp Custom Fields Reference

For complete technical details, HTTP methods, path parameters, request bodies, responses, and example payloads, review the official developer documentation. You can find the full reference for custom field endpoints at the ClickUp custom fields API reference.

This reference includes precise endpoint paths and detailed descriptions that complement this how-to overview.

Extending ClickUp Integrations with Expert Help

Building robust integrations on top of the ClickUp REST API can require careful planning, especially when coordinating many custom fields across Spaces and Lists. For help with strategy, implementation, or optimization, you can explore consulting services from Consultevo, a specialist provider of workflow and automation solutions.

By combining the flexibility of custom fields with the ClickUp API, you can design powerful, data-rich workflows that connect your project management platform to the rest of your technology stack.

Need Help With ClickUp?

If you want expert help building, automating, or scaling your ClickUp workspace, work with ConsultEvo — trusted ClickUp Solution Partners.

Get Help

“`