Documents & Productivity — entry 005 of 31

ClickUp

Verified Jul 2026

ClickUp's REST API mirrors nearly every surface of its all-in-one project management app -- tasks, docs, goals, time tracking, and custom fields -- authenticated with either a personal API token or a full OAuth2 app flow for marketplace integrations. The Free Forever plan includes real API access at 100 requests/minute per token, scaling up to 10,000 requests/minute on Enterprise -- pricing tier changes throughput, not access. The live API host sends no CORS headers, so browser calls need a server-side proxy.

project-managementtask-managementproductivitycollaboration

Visit clickup.com ↗Read the docs ↗Pricing ↗Status ↗More Documents & Productivity

AuthenticationOAuthRequires an OAuth flow; expect app registration.

HTTPSSupportedTraffic is encrypted in transit.

CORSDisabledBrowser calls need a server-side proxy.

PricingFreemiumA usable free tier exists, with paid plans for more volume.

FormatsJSONResponses can be requested as JSON.

GreatAPIs Score

Score74out of 100

Authentication8/25OAuth flow required

Pricing17/20Freemium tier available

Docs20/20Machine-readable spec file bundled

Formats9/15Single response format

Freshness20/20Verified within 6 months

Embed this badge

<a href="https://greatapis.com/api/clickup/"><img src="https://greatapis.com/badge/clickup.svg" alt="Scored 74 on greatapis.com"></a>

Auth quickstart

Register an app / run the OAuth flow to obtain a bearer token.
Send it as an Authorization headerAuthorization: Bearer <token>

Stored keyNo key stored

Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.

Endpoints

Servers

https://api.clickup.com/api

Auth

Authorization_Token

Authorization2

POST/v2/oauth/tokenGet Access Token

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

GET/v2/userGet Authorized User

Responses

Status	Description	Schema
`200`		—

Attachments1

POST/v2/task/{task_id}/attachmentCreate Task Attachment

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Request body

multipart/form-data (required)

Responses

Status	Description	Schema
`200`		—

Comments10

PUT/v2/comment/{comment_id}Update Comment

Parameters

Name	In	Required	Type
`comment_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/comment/{comment_id}Delete Comment

Parameters

Name	In	Required	Type
`comment_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

GET/v2/comment/{comment_id}/replyGet Threaded Comments

Parameters

Name	In	Required	Type
`comment_id`	path	yes	number

Responses

Status	Description	Schema
`200`		`schema`

POST/v2/comment/{comment_id}/replyCreate Threaded Comment

Parameters

Name	In	Required	Type
`comment_id`	path	yes	number

Request body

application/json — schema (required)

Responses

Status	Description	Schema
`200`		—

GET/v2/list/{list_id}/commentGet List Comments

Parameters

Name	In	Required	Type
`list_id`	path	yes	number
`start`	query	no	integer
`start_id`	query	no	string

Responses

Status	Description	Schema
`200`		—

POST/v2/list/{list_id}/commentCreate List Comment

Parameters

Name	In	Required	Type
`list_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

GET/v2/task/{task_id}/commentGet Task Comments

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number
`start`	query	no	integer
`start_id`	query	no	string

Responses

Status	Description	Schema
`200`		—

POST/v2/task/{task_id}/commentCreate Task Comment

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

GET/v2/view/{view_id}/commentGet Chat View Comments

Parameters

Name	In	Required	Type
`view_id`	path	yes	string
`start`	query	no	integer
`start_id`	query	no	string

Responses

Status	Description	Schema
`200`		—

POST/v2/view/{view_id}/commentCreate Chat View Comment

Parameters

Name	In	Required	Type
`view_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

Custom Task Types1

GET/v2/team/{team_id}/custom_itemGet Custom Task Types

Parameters

Name	In	Required	Type
`team_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

Custom Fields6

GET/v2/folder/{folder_id}/fieldGet Folder Custom Fields

Parameters

Name	In	Required	Type
`folder_id`	path	yes	number
`include_applied_objects`	query	no	boolean
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

GET/v2/list/{list_id}/fieldGet List Custom Fields

Parameters

Name	In	Required	Type
`list_id`	path	yes	number
`include_applied_objects`	query	no	boolean
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

GET/v2/space/{space_id}/fieldGet Space Custom Fields

Parameters

Name	In	Required	Type
`space_id`	path	yes	number
`include_applied_objects`	query	no	boolean
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

POST/v2/task/{task_id}/field/{field_id}Set Custom Field Value

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`field_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—
`400`	Returned when the Custom Field is not applicable to the task's custom task type.	—

DELETE/v2/task/{task_id}/field/{field_id}Remove Custom Field Value

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`field_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Responses

Status	Description	Schema
`200`		—

GET/v2/team/{team_id}/fieldGet Workspace Custom Fields

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`include_applied_objects`	query	no	boolean
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

Folders6

GET/v2/folder/{folder_id}Get Folder

Parameters

Name	In	Required	Type
`folder_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

PUT/v2/folder/{folder_id}Update Folder

Parameters

Name	In	Required	Type
`folder_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/folder/{folder_id}Delete Folder

Parameters

Name	In	Required	Type
`folder_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

GET/v2/space/{space_id}/folderGet Folders

Parameters

Name	In	Required	Type
`space_id`	path	yes	number
`archived`	query	no	boolean

Responses

Status	Description	Schema
`200`		—

POST/v2/space/{space_id}/folderCreate Folder

Parameters

Name	In	Required	Type
`space_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

POST/v2/space/{space_id}/folder_template/{template_id}Create Folder from template

Parameters

Name	In	Required	Type
`space_id`	path	yes	string
`template_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`	Folder created successfully	—
`400`	Bad request - Name is required	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Template or space not found	—
`500`	Internal server error	—

Goals8

GET/v2/goal/{goal_id}Get Goal

Parameters

Name	In	Required	Type
`goal_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—

PUT/v2/goal/{goal_id}Update Goal

Parameters

Name	In	Required	Type
`goal_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/goal/{goal_id}Delete Goal

Parameters

Name	In	Required	Type
`goal_id`	path	yes	string
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

POST/v2/goal/{goal_id}/key_resultCreate Key Result

Parameters

Name	In	Required	Type
`goal_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

PUT/v2/key_result/{key_result_id}Edit Key Result

Parameters

Name	In	Required	Type
`key_result_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/key_result/{key_result_id}Delete Key Result

Parameters

Name	In	Required	Type
`key_result_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—

GET/v2/team/{team_id}/goalGet Goals

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`include_completed`	query	no	boolean

Responses

Status	Description	Schema
`200`		—

POST/v2/team/{team_id}/goalCreate Goal

Parameters

Name	In	Required	Type
`team_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

Guests10

POST/v2/folder/{folder_id}/guest/{guest_id}Add Guest To Folder

Parameters

Name	In	Required	Type
`folder_id`	path	yes	number
`guest_id`	path	yes	number
`include_shared`	query	no	boolean

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/folder/{folder_id}/guest/{guest_id}Remove Guest From Folder

Parameters

Name	In	Required	Type
`folder_id`	path	yes	number
`guest_id`	path	yes	number
`include_shared`	query	no	boolean

Responses

Status	Description	Schema
`200`		—

POST/v2/list/{list_id}/guest/{guest_id}Add Guest To List

Parameters

Name	In	Required	Type
`list_id`	path	yes	number
`guest_id`	path	yes	number
`include_shared`	query	no	boolean

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/list/{list_id}/guest/{guest_id}Remove Guest From List

Parameters

Name	In	Required	Type
`list_id`	path	yes	number
`guest_id`	path	yes	number
`include_shared`	query	no	boolean

Responses

Status	Description	Schema
`200`		—

POST/v2/task/{task_id}/guest/{guest_id}Add Guest To Task

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`guest_id`	path	yes	number
`include_shared`	query	no	boolean
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/task/{task_id}/guest/{guest_id}Remove Guest From Task

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`guest_id`	path	yes	number
`include_shared`	query	no	boolean
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Responses

Status	Description	Schema
`200`		—

POST/v2/team/{team_id}/guestInvite Guest To Workspace

Parameters

Name	In	Required	Type
`team_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

GET/v2/team/{team_id}/guest/{guest_id}Get Guest

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`guest_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

PUT/v2/team/{team_id}/guest/{guest_id}Edit Guest On Workspace

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`guest_id`	path	yes	number

Request body

application/json

Responses

Status	Description	Schema
`200`		—

DELETE/v2/team/{team_id}/guest/{guest_id}Remove Guest From Workspace

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`guest_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

Lists11

GET/v2/folder/{folder_id}/listGet Lists

Parameters

Name	In	Required	Type
`folder_id`	path	yes	number
`archived`	query	no	boolean

Responses

Status	Description	Schema
`200`		—

POST/v2/folder/{folder_id}/listCreate List

Parameters

Name	In	Required	Type
`folder_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

POST/v2/folder/{folder_id}/list_template/{template_id}Create List From Template in Folder

Parameters

Name	In	Required	Type
`folder_id`	path	yes	string
`template_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`	List created successfully	`schema`
`400`	Bad request - Name is required	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Template, folder, or space not found	—
`500`	Internal server error	—

GET/v2/list/{list_id}Get List

Parameters

Name	In	Required	Type
`list_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

PUT/v2/list/{list_id}Update List

Parameters

Name	In	Required	Type
`list_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/list/{list_id}Delete List

Parameters

Name	In	Required	Type
`list_id`	path	yes	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

POST/v2/list/{list_id}/task/{task_id}Add Task To List

Parameters

Name	In	Required	Type
`list_id`	path	yes	number
`task_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—

DELETE/v2/list/{list_id}/task/{task_id}Remove Task From List

Parameters

Name	In	Required	Type
`list_id`	path	yes	number
`task_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—

GET/v2/space/{space_id}/listGet Folderless Lists

Parameters

Name	In	Required	Type
`space_id`	path	yes	number
`archived`	query	no	boolean

Responses

Status	Description	Schema
`200`		—

POST/v2/space/{space_id}/listCreate Folderless List

Parameters

Name	In	Required	Type
`space_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

POST/v2/space/{space_id}/list_template/{template_id}Create List From Template in Space

Parameters

Name	In	Required	Type
`space_id`	path	yes	string
`template_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`	List created successfully	—
`400`	Bad request - Name is required, or is already taken	—
`401`	Unauthorized	—
`403`	Forbidden	—
`404`	Template, folder, or space not found	—
`500`	Internal server error	—

Members2

GET/v2/list/{list_id}/memberGet List Members

Parameters

Name	In	Required	Type
`list_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

GET/v2/task/{task_id}/memberGet Task Members

Parameters

Name	In	Required	Type
`task_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—

Roles1

GET/v2/team/{team_id}/customrolesGet Custom Roles

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`include_members`	query	no	boolean

Responses

Status	Description	Schema
`200`		—

Shared Hierarchy1

GET/v2/team/{team_id}/sharedShared Hierarchy

Parameters

Name	In	Required	Type
`team_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

Spaces5

GET/v2/space/{space_id}Get Space

Parameters

Name	In	Required	Type
`space_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

PUT/v2/space/{space_id}Update Space

Parameters

Name	In	Required	Type
`space_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/space/{space_id}Delete Space

Parameters

Name	In	Required	Type
`space_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

GET/v2/team/{team_id}/spaceGet Spaces

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`archived`	query	no	boolean

Responses

Status	Description	Schema
`200`		—

POST/v2/team/{team_id}/spaceCreate Space

Parameters

Name	In	Required	Type
`team_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

Tags6

GET/v2/space/{space_id}/tagGet Space Tags

Parameters

Name	In	Required	Type
`space_id`	path	yes	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

POST/v2/space/{space_id}/tagCreate Space Tag

Parameters

Name	In	Required	Type
`space_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

PUT/v2/space/{space_id}/tag/{tag_name}Edit Space Tag

Parameters

Name	In	Required	Type
`space_id`	path	yes	number
`tag_name`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/space/{space_id}/tag/{tag_name}Delete Space Tag

Parameters

Name	In	Required	Type
`space_id`	path	yes	number
`tag_name`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

POST/v2/task/{task_id}/tag/{tag_name}Add Tag To Task

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`tag_name`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

DELETE/v2/task/{task_id}/tag/{tag_name}Remove Tag From Task

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`tag_name`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

Tasks10

GET/v2/list/{list_id}/taskGet Tasks

Parameters

Name	In	Required	Type
`list_id`	path	yes	number
`archived`	query	no	boolean
`include_markdown_description`	query	no	boolean
`page`	query	no	integer
`order_by`	query	no	string
`reverse`	query	no	boolean
`subtasks`	query	no	boolean
`statuses`	query	no	array
`include_closed`	query	no	boolean
`include_timl`	query	no	boolean
`assignees`	query	no	array
`watchers`	query	no	array
`tags`	query	no	array
`due_date_gt`	query	no	integer
`due_date_lt`	query	no	integer
`date_created_gt`	query	no	integer
`date_created_lt`	query	no	integer
`date_updated_gt`	query	no	integer
`date_updated_lt`	query	no	integer
`date_done_gt`	query	no	integer
`date_done_lt`	query	no	integer
`custom_fields`	query	no	array
`custom_field`	query	no	array
`custom_items`	query	no	array

Responses

Status	Description	Schema
`200`		—

POST/v2/list/{list_id}/taskCreate Task

Parameters

Name	In	Required	Type
`list_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

POST/v2/list/{list_id}/taskTemplate/{template_id}Create Task From Template

Parameters

Name	In	Required	Type
`list_id`	path	yes	number
`template_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

GET/v2/task/bulk_time_in_status/task_idsGet Bulk Tasks' Time in Status

Parameters

Name	In	Required	Type
`task_ids`	query	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

GET/v2/task/{task_id}Get Task

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number
`include_subtasks`	query	no	boolean
`include_markdown_description`	query	no	boolean
`custom_fields`	query	no	array

Responses

Status	Description	Schema
`200`		—

PUT/v2/task/{task_id}Update Task

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/task/{task_id}Delete Task

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`204`		—

POST/v2/task/{task_id}/mergeMerge Tasks

Parameters

Name	In	Required	Type
`task_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`	Tasks merged successfully	—
`400`	Bad request - invalid task IDs or other validation errors	—
`403`	Unauthorized to merge these tasks	—
`404`	One or more tasks not found	—

GET/v2/task/{task_id}/time_in_statusGet Task's Time in Status

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

GET/v2/team/{team_Id}/taskGet Filtered Team Tasks

Parameters

Name	In	Required	Type
`team_Id`	path	yes	number
`page`	query	no	integer
`order_by`	query	no	string
`reverse`	query	no	boolean
`subtasks`	query	no	boolean
`space_ids[]`	query	no	array
`project_ids[]`	query	no	array
`list_ids[]`	query	no	array
`statuses[]`	query	no	array
`include_closed`	query	no	boolean
`assignees[]`	query	no	array
`tags[]`	query	no	array
`due_date_gt`	query	no	integer
`due_date_lt`	query	no	integer
`date_created_gt`	query	no	integer
`date_created_lt`	query	no	integer
`date_updated_gt`	query	no	integer
`date_updated_lt`	query	no	integer
`date_done_gt`	query	no	integer
`date_done_lt`	query	no	integer
`custom_fields`	query	no	array
`parent`	query	no	string
`include_markdown_description`	query	no	boolean
`custom_items[]`	query	no	array

Responses

Status	Description	Schema
`200`		—

Task Checklists6

PUT/v2/checklist/{checklist_id}Edit Checklist

Parameters

Name	In	Required	Type
`checklist_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/checklist/{checklist_id}Delete Checklist

Parameters

Name	In	Required	Type
`checklist_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—

POST/v2/checklist/{checklist_id}/checklist_itemCreate Checklist Item

Parameters

Name	In	Required	Type
`checklist_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

PUT/v2/checklist/{checklist_id}/checklist_item/{checklist_item_id}Edit Checklist Item

Parameters

Name	In	Required	Type
`checklist_id`	path	yes	string
`checklist_item_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/checklist/{checklist_id}/checklist_item/{checklist_item_id}Delete Checklist Item

Parameters

Name	In	Required	Type
`checklist_id`	path	yes	string
`checklist_item_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—

POST/v2/task/{task_id}/checklistCreate Checklist

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

Task Relationships4

POST/v2/task/{task_id}/dependencyAdd Dependency

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/task/{task_id}/dependencyDelete Dependency

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`depends_on`	query	yes	string
`dependency_of`	query	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Responses

Status	Description	Schema
`200`		—

POST/v2/task/{task_id}/link/{links_to}Add Task Link

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`links_to`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Responses

Status	Description	Schema
`200`		—

DELETE/v2/task/{task_id}/link/{links_to}Delete Task Link

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`links_to`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Responses

Status	Description	Schema
`200`		—

Templates3

GET/v2/team/{team_id}/folder_templateGet Folder Templates

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`	Folder templates retrieved successfully.	—

GET/v2/team/{team_id}/list_templateGet List Templates

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`	List templates retrieved successfully.	—

GET/v2/team/{team_id}/taskTemplateGet Task Templates

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`page`	query	yes	integer
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

Workspaces3

GET/v2/teamGet Authorized Workspaces

Responses

Status	Description	Schema
`200`		—

GET/v2/team/{team_id}/planGet Workspace Plan

Parameters

Name	In	Required	Type
`team_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—

GET/v2/team/{team_id}/seatsGet Workspace seats

Parameters

Name	In	Required	Type
`team_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—

User Groups4

GET/v2/groupGet Groups

Parameters

Name	In	Required	Type
`team_id`	query	yes	number
`group_ids`	query	no	array

Responses

Status	Description	Schema
`200`		—

PUT/v2/group/{group_id}Update Group

Parameters

Name	In	Required	Type
`group_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/group/{group_id}Delete Group

Parameters

Name	In	Required	Type
`group_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—

POST/v2/team/{team_id}/groupCreate Group

Parameters

Name	In	Required	Type
`team_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

Time Tracking13

GET/v2/team/{team_Id}/time_entriesGet time entries within a date range

Parameters

Name	In	Required	Type
`team_Id`	path	yes	number
`start_date`	query	no	number
`end_date`	query	no	number
`assignee`	query	no	number
`include_task_tags`	query	no	boolean
`include_location_names`	query	no	boolean
`include_approval_history`	query	no	boolean
`include_approval_details`	query	no	boolean
`space_id`	query	no	number
`folder_id`	query	no	number
`list_id`	query	no	number
`task_id`	query	no	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number
`is_billable`	query	no	boolean
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`	If your time entry is associated with a task that uses custom task ids you can expect a `custom_id`` field in the body of the response. The task field will only be included if there is a task associated with a time entry.	—

POST/v2/team/{team_Id}/time_entriesCreate a time entry

Parameters

Name	In	Required	Type
`team_Id`	path	yes	number
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

POST/v2/team/{team_Id}/time_entries/startStart a time Entry

Parameters

Name	In	Required	Type
`team_Id`	path	yes	number
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

GET/v2/team/{team_id}/time_entries/currentGet running time entry

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`assignee`	query	no	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

POST/v2/team/{team_id}/time_entries/stopStop a time Entry

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

GET/v2/team/{team_id}/time_entries/tagsGet all tags from time entries

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

POST/v2/team/{team_id}/time_entries/tagsAdd tags from time entries

Parameters

Name	In	Required	Type
`team_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

PUT/v2/team/{team_id}/time_entries/tagsChange tag names from time entries

Parameters

Name	In	Required	Type
`team_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/team/{team_id}/time_entries/tagsRemove tags from time entries

Parameters

Name	In	Required	Type
`team_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

GET/v2/team/{team_id}/time_entries/{timer_id}Get singular time entry

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`timer_id`	path	yes	string
`include_task_tags`	query	no	boolean
`include_location_names`	query	no	boolean
`include_approval_history`	query	no	boolean
`include_approval_details`	query	no	boolean
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

PUT/v2/team/{team_id}/time_entries/{timer_id}Update a time Entry

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`timer_id`	path	yes	number
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/team/{team_id}/time_entries/{timer_id}Delete a time Entry

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`timer_id`	path	yes	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

GET/v2/team/{team_id}/time_entries/{timer_id}/historyGet time entry history

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`timer_id`	path	yes	string
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

Time Tracking (Legacy)4

GET/v2/task/{task_id}/timeGet tracked time

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

POST/v2/task/{task_id}/timeTrack time

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

PUT/v2/task/{task_id}/time/{interval_id}Edit time tracked

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`interval_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/task/{task_id}/time/{interval_id}Delete time tracked

Parameters

Name	In	Required	Type
`task_id`	path	yes	string
`interval_id`	path	yes	string
`custom_task_ids`	query	no	boolean
`team_id`	query	no	number
`Content-Type`	header	yes	string

Responses

Status	Description	Schema
`200`		—

Users4

POST/v2/team/{team_id}/userInvite User To Workspace

Parameters

Name	In	Required	Type
`team_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

GET/v2/team/{team_id}/user/{user_id}Get User

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`user_id`	path	yes	number
`include_shared`	query	no	boolean

Responses

Status	Description	Schema
`200`		—

PUT/v2/team/{team_id}/user/{user_id}Edit User On Workspace

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`user_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/team/{team_id}/user/{user_id}Remove User From Workspace

Parameters

Name	In	Required	Type
`team_id`	path	yes	number
`user_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

GET/v2/folder/{folder_id}/viewGet Folder Views

Parameters

Name	In	Required	Type
`folder_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

POST/v2/folder/{folder_id}/viewCreate Folder View

Parameters

Name	In	Required	Type
`folder_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

GET/v2/list/{list_id}/viewGet List Views

Parameters

Name	In	Required	Type
`list_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

POST/v2/list/{list_id}/viewCreate List View

Parameters

Name	In	Required	Type
`list_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

GET/v2/space/{space_id}/viewGet Space Views

Parameters

Name	In	Required	Type
`space_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

POST/v2/space/{space_id}/viewCreate Space View

Parameters

Name	In	Required	Type
`space_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

GET/v2/team/{team_id}/viewGet Workspace (Everything level) Views

Parameters

Name	In	Required	Type
`team_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

POST/v2/team/{team_id}/viewCreate Workspace (Everything level) View

Parameters

Name	In	Required	Type
`team_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

GET/v2/view/{view_id}Get View

Parameters

Name	In	Required	Type
`view_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—

PUT/v2/view/{view_id}Update View

Parameters

Name	In	Required	Type
`view_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/view/{view_id}Delete View

Parameters

Name	In	Required	Type
`view_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—

GET/v2/view/{view_id}/taskGet View Tasks

Parameters

Name	In	Required	Type
`view_id`	path	yes	string
`page`	query	yes	integer

Responses

Status	Description	Schema
`200`		—

Webhooks4

GET/v2/team/{team_id}/webhookGet Webhooks

Parameters

Name	In	Required	Type
`team_id`	path	yes	number

Responses

Status	Description	Schema
`200`		—

POST/v2/team/{team_id}/webhookCreate Webhook

Parameters

Name	In	Required	Type
`team_id`	path	yes	number

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

PUT/v2/webhook/{webhook_id}Update Webhook

Parameters

Name	In	Required	Type
`webhook_id`	path	yes	string

Request body

application/json (required)

Responses

Status	Description	Schema
`200`		—

DELETE/v2/webhook/{webhook_id}Delete Webhook

Parameters

Name	In	Required	Type
`webhook_id`	path	yes	string

Responses

Status	Description	Schema
`200`		—

Try it

Operation

API key

Developer reference

Base URLhttps://api.clickup.com/api

Rate limit

Rate limits are per personal or OAuth token and vary by the Workspace plan hosting the token: Free Forever, Unlimited, and Business get 100 requests per minute per token, Business Plus gets 1,000 requests per minute per token, and Enterprise gets 10,000 requests per minute per token. Exceeding the limit returns HTTP 429; every response reports live usage via X-RateLimit-Limit/-Remaining/-Reset headers.

Key endpoints

GET/v2/user
GET/v2/team
GET/v2/list/{list_id}/task
POST/v2/list/{list_id}/task
GET/v2/task/{task_id}

GreatAPIs Score

Embed this badge

Auth quickstart

Endpoints

Try it

Developer reference

People comparing ClickUp also look at…

Vector Express v2.0

CloudConvert

Cloudmersive Document and Data Conversion

CraftMyPDF

Html2PDF

iLovePDF