Clickup

clickup Custom Fields API

Operations for retrieving custom field definitions and setting custom field values on tasks.

GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/list/{list_id}/field List a List's Custom Fields (v2) · Get List Custom Fields #
Ask an LLM
“Which Custom Fields can I use on tasks in a particular List?”
“Can I see which custom task types each List field applies to in v2?”
Tell an agent
Show the v2 Custom Fields available on List {list_id}.
List List {list_id}'s Custom Fields with applied objects: {include_applied_objects}.
GET /v2/folder/{folder_id}/field List Folder-level Custom Fields · Get Folder Custom Fields #
Ask an LLM
“What Custom Fields were created at the Folder level?”
“Does the Folder fields call include fields defined on individual Lists?”
Tell an agent
Show the Custom Fields created on Folder {folder_id}.
List Folder {folder_id}'s own fields with applied objects {include_applied_objects}.
GET /v2/space/{space_id}/field List Space-level Custom Fields · Get Space Custom Fields #
Ask an LLM
“Which Custom Fields are defined for a whole Space?”
“Are Folder and List fields excluded when I ask for a Space's fields?”
Tell an agent
Show the Custom Fields created on Space {space_id}.
List Space {space_id}'s own field definitions, applied objects {include_applied_objects}.
GET /v2/team/{team_id}/field List Workspace-level Custom Fields · Get Workspace Custom Fields #
Ask an LLM
“What Custom Fields exist at the Workspace level in ClickUp?”
“Can I find fields scoped to custom task types across my Workspace?”
Tell an agent
Show the Custom Fields created at the Workspace level of {team_id}.
List Workspace {team_id}'s global fields with applied objects {include_applied_objects}.
POST /v2/task/{task_id}/field/{field_id} Set a Custom Field on a task (v2) · Set Custom Field Value #
Ask an LLM
“How do I fill in a Custom Field on a task through the v2 API?”
“Can I address the task by its custom task ID when setting a field value in v2?”
Tell an agent
Using v2, set Custom Field {field_id} on task {task_id}.
Fill in field {field_id} for custom task ID {task_id} in Workspace {team_id} via v2.
DELETE /v2/task/{task_id}/field/{field_id} Clear a Custom Field on a task (v2) · Remove Custom Field Value #
Ask an LLM
“Can I clear a task's Custom Field without deleting the dropdown option itself?”
“What does removing a field value do in v2?”
Tell an agent destructive · confirm first
Using v2, clear Custom Field {field_id} on task {task_id}.
Blank out the v2 value of field {field_id} for task {task_id}.
GET /list/{list_id}/field List a List's Custom Fields (legacy path) · Get accessible custom fields #
Ask an LLM
“On the older unversioned path, what field definitions and dropdown options does a List expose?”
“Does the legacy endpoint include label field values?”
Tell an agent
On the legacy path, fetch field definitions and dropdown options for List {list_id}.
Using the older endpoint, enumerate the custom fields usable in {list_id}.
POST /task/{task_id}/field/{field_id} Set a Custom Field value (legacy path) · Set custom field value #
Ask an LLM
“On the older unversioned path, what format does a dropdown field value take?”
“Can the legacy endpoint set label fields with an array of label IDs?”
Tell an agent
On the legacy path, put {value} into field {field_id} of task {task_id}.
Using the older endpoint, write {value} to custom field {field_id} on {task_id}.
DELETE /task/{task_id}/field/{field_id} Reset a Custom Field value (legacy path) · Remove custom field value #
Ask an LLM
“On the older unversioned path, how is a task's field reset to empty?”
“Does the legacy reset call work with custom task IDs?”
Tell an agent destructive · confirm first
On the legacy path, reset field {field_id} on task {task_id} to empty.
Using the older endpoint, empty custom field {field_id} of {task_id}.

Documentation

📖
Documentation
https://developer.clickup.com/docs/tasks
📖
Documentation
https://developer.clickup.com/reference/get-spaces
📖
Documentation
https://developer.clickup.com/reference/get-lists
📖
Documentation
https://developer.clickup.com/reference/get-folders
📖
Documentation
https://developer.clickup.com/reference/get-goals
📖
Documentation
https://developer.clickup.com/reference/get-task-comments
📖
Documentation
https://developer.clickup.com/reference/get-teams
📖
Documentation
https://developer.clickup.com/docs/webhooks
📖
Documentation
https://developer.clickup.com/reference/get-accessible-custom-fields
📖
Documentation
https://developer.clickup.com/reference/get-time-entries-within-a-date-range
📖
Documentation
https://developer.clickup.com/reference/get-views
📖
Documentation
https://developer.clickup.com/docs/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/clickup/refs/heads/main/openapi/clickup-custom-fields-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/clickup/refs/heads/main/asyncapi/clickup-webhooks-asyncapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/clickup:clickup-custom-fields-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

clickup-custom-fields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Clickup Custom Fields API
  version: '2.0'
  description: 'Operations tagged Custom Fields across 2 of this provider''s published API definitions: clickup-api-v2-reference-openapi.json, clickup-custom-fields-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.clickup.com/api
  description: ClickUp
  variables: {}
- url: https://api.clickup.com/api/v2
  description: ClickUp API v2 Production Server
tags:


# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clickup/refs/heads/main/openapi/clickup-custom-fields-api-openapi.yml