Elgato_dark/ToolJet
1
0
Fork 0
mirror of https://github.com/ToolJet/ToolJet synced 2026-05-24 09:28:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
ToolJet/marketplace/plugins/clickup/openapi-specs/clickup.json
Akshay 8ef5f0682d
Feature: Add QuickBooks Online marketplace plugin (#15903) 
* feat: add QuickBooks Online marketplace plugin

Add a QuickBooks Online Accounting API plugin with OAuth2 authentication,
86 API operations via OpenAPI spec, and @spec/ convention for DB-stored
spec files. Includes server-side spec hosting infrastructure and a fix
for duplicate footer rendering on marketplace OAuth2 datasource config pages.

* chore: update submodule pointers

* fix: use parent transaction for spec file DB operations

storeSpecFiles and updateSpecFilesForReload were wrapping each file
insert/update in a separate dbTransactionWrap call, creating independent
transactions instead of participating in the outer install/upgrade
transaction. This could leave orphan File entities if the plugin save
failed. Now uses the parent manager directly.

* fix: use sandbox API URL, remove testConnection, add state param

- Default to sandbox-quickbooks.api.intuit.com (development apps require it)
- Remove testConnection and customTesting (OAuth flow validates connection)
- Add state parameter to auth URL (required by QuickBooks)
- Add access_token validation guard in run()
- Preserve existing refresh_token if provider doesn't reissue
- Remove environment dropdown and company_id from manifest
- Add debug logging for OAuth flow tracing

* Chore: Migrate all OpenAPI plugins from external URLs to @spec/ convention (#15904)

* chore: migrate all OpenAPI plugins from external URLs to @spec/ convention

Downloads 78 OpenAPI spec files from external URLs (7 plugins from
adishM98/base-repo-testing personal repo, 2 from official provider repos,
1 from S3) and stores them locally in openapi-specs/ directories. Updates
all operations.json files to use @spec/<kind>/<name> references, which
are resolved to DB-stored specs at install time.

Eliminates runtime dependency on external GitHub repos for spec rendering.

* chore: remove one-time spec migration script

* POST string body

---------

Co-authored-by: Rudhra Deep Biswas <rudra21ultra@gmail.com>
Co-authored-by: gsmithun4 <gsmithun4@gmail.com>
2026-05-13 09:16:38 +05:30

36099 lines
No EOL
1.2 MiB
Raw Blame History

{
"openapi": "3.1.0",
"info": {
"title": "ClickUp API v2 Reference",
"description": "The ClickUp API enables you to programmatically access and manage your ClickUp resources.\n\n## Authentication\nThe API supports two authentication methods:\n- **Personal API Token**: Use for testing and personal integrations. Add token to requests with header: `Authorization: pk_...`\n- **OAuth 2.0**: Required for building apps for other users. Uses authorization code flow.\n\n## Getting Started\nOur [Getting Started Guide](https://developer.clickup.com/docs/index) provides a comprehensive overview of how to use the ClickUp API.\n",
"contact": {
},
"version": "2.0"
},
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
"servers": [
{
"url": "https://api.clickup.com/api",
"description": "ClickUp",
"variables": {
}
}
],
"paths": {
"/v2/task/{task_id}/attachment": {
"post": {
"summary": "Create Task Attachment",
"tags": [
"Attachments"
],
"description": "Upload a file to a task as an attachment. Files stored in the cloud cannot be used in this API request.\\\n \\\n***Note:** This request uses multipart/form-data as the content type.*",
"operationId": "CreateTaskAttachment",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hv"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by its custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"attachment": {
"type": "array",
"items": {
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateTaskAttachmentresponse",
"required": [
"id",
"version",
"date",
"title",
"extension",
"thumbnail_small",
"thumbnail_large",
"url"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"version": {
"type": "string"
},
"date": {
"type": "integer",
"contentEncoding": "int64"
},
"title": {
"type": "string"
},
"extension": {
"type": "string"
},
"thumbnail_small": {
"type": "string"
},
"thumbnail_large": {
"type": "string"
},
"url": {
"type": "string"
}
},
"examples": [
{
"id": "ac434d4e-8b1c-4571-951b-866b6d9f2ee6.png",
"version": "0",
"date": 1569988578766,
"title": "image.png",
"extension": "png",
"thumbnail_small": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png",
"thumbnail_large": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png",
"url": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png"
}
]
},
"example": {
"id": "ac434d4e-8b1c-4571-951b-866b6d9f2ee6.png",
"version": "0",
"date": 1569988578766,
"title": "image.png",
"extension": "png",
"thumbnail_small": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png",
"thumbnail_large": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png",
"url": "https://attachments-public.clickup.com/ac434d4e-8b1c-4571-951b-866b6d9f2ee6/logo_small.png"
}
}
}
}
},
"deprecated": false
}
},
"/v2/oauth/token": {
"post": {
"summary": "Get Access Token",
"tags": [
"Authorization"
],
"description": "These are the routes for authing the API and going through the [OAuth flow](doc:authentication).\\\n \\\nApplications utilizing a personal API token don't use this endpoint.\\\n \\\n***Note:** OAuth tokens are not supported when using the [**Try It** feature](doc:trytheapi) of our Reference docs. You can't try this endpoint from your web browser.*\n",
"operationId": "GetAccessToken",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"title": "GetAccessTokenrequest",
"required": [
"client_id",
"client_secret",
"code"
],
"type": "object",
"properties": {
"client_id": {
"type": "string",
"description": "OAuth app client id"
},
"client_secret": {
"type": "string",
"description": "OAuth app client secret"
},
"code": {
"type": "string",
"description": "Code given in redirect url"
}
},
"examples": [
{
"client_id": "your_client_id",
"client_secret": "your_client_secret",
"code": "authorization_code"
}
]
},
"example": {
"client_id": "your_client_id",
"client_secret": "your_client_secret",
"code": "authorization_code"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/paths/~1v2~1oauth~1token/post/requestBody/content/application~1json/schema"
},
"example": {
"client_id": "your_client_id",
"client_secret": "your_client_secret",
"code": "authorization_code"
}
}
}
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetAccessTokenresponse",
"required": [
"access_token"
],
"type": "object",
"properties": {
"access_token": {
"type": "string"
}
},
"examples": [
{
"access_token": "access token"
}
]
},
"example": {
"access_token": "access token"
}
}
}
}
},
"deprecated": false,
"security": [],
"x-hideTryItPanel": true
},
"parameters": []
},
"/v2/user": {
"get": {
"summary": "Get Authorized User",
"tags": [
"Authorization"
],
"description": "View the details of the authenticated user's ClickUp account.",
"operationId": "GetAuthorizedUser",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetAuthorizedUserresponse",
"type": "object",
"properties": {
"user": {
"title": "User",
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"color": {
"type": "string"
},
"profilePicture": {
"type": "string"
},
"initials": {
"type": "string"
},
"week_start_day": {
"type": "integer",
"contentEncoding": "int32",
"description": "The user's preferred start of the calendar week setting. \\ `0` is Sunday. \\ `1` is Monday."
},
"global_font_support": {
"type": "boolean"
},
"timezeone": {
"type": "string"
}
},
"examples": [
{
"id": 123,
"username": "John Doe",
"email": "user@company.com",
"color": "#000000",
"profilePicture": "https://clickup.com/avatar.jpg",
"initials": "JD",
"week_start_day": 0,
"global_font_support": false,
"timezone": "America/Los_Angeles"
}
]
}
},
"examples": [
{
"user": {
"id": 123,
"username": "John Doe",
"email": "user@company.com",
"color": "#000000",
"profilePicture": "https://clickup.com/avatar.jpg",
"initials": "JD",
"week_start_day": 0,
"global_font_support": false,
"timezone": "America/Los_Angeles"
}
}
]
},
"example": {
"user": {
"id": 123,
"username": "John Doe",
"email": "user@company.com",
"color": "#000000",
"profilePicture": "https://clickup.com/avatar.jpg",
"initials": "JD",
"week_start_day": 0,
"global_font_support": false,
"timezone": "America/Los_Angeles"
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team": {
"get": {
"summary": "Get Authorized Workspaces",
"tags": [
"Workspaces"
],
"description": "View the Workspaces available to the authenticated user.",
"operationId": "GetAuthorizedTeams",
"parameters": [],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetAuthorizedTeamsresponse",
"required": [
"teams"
],
"type": "object",
"properties": {
"teams": {
"type": "array",
"items": {
"title": "Team",
"required": [
"id",
"name",
"color",
"avatar",
"members"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"avatar": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"title": "Member",
"required": [
"user"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/paths/~1v2~1user/get/responses/200/content/application~1json/schema/properties/user"
}
},
"examples": [
{
"user": {
"id": 123,
"username": "John Doe",
"color": "#000000",
"profilePicture": "https://clickup.com/avatar.jpg"
}
}
]
},
"description": ""
}
},
"examples": [
{
"id": "1234",
"name": "My ClickUp Workspace",
"color": "#000000",
"avatar": "https://clickup.com/avatar.jpg",
"members": [
{
"user": {
"id": 123,
"username": "John Doe",
"color": "#000000",
"profilePicture": "https://clickup.com/avatar.jpg"
}
}
]
}
]
},
"description": ""
}
},
"examples": [
{
"teams": [
{
"id": "1234",
"name": "My ClickUp Workspace",
"color": "#000000",
"avatar": "https://clickup.com/avatar.jpg",
"members": [
{
"user": {
"id": 123,
"username": "John Doe",
"color": "#000000",
"profilePicture": "https://clickup.com/avatar.jpg"
}
}
]
}
]
}
]
},
"example": {
"teams": [
{
"id": "1234",
"name": "My ClickUp Workspace",
"color": "#000000",
"avatar": "https://clickup.com/avatar.jpg",
"members": [
{
"user": {
"id": 123,
"username": "John Doe",
"color": "#000000",
"profilePicture": "https://clickup.com/avatar.jpg"
}
}
]
}
]
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/task/{task_id}/checklist": {
"post": {
"summary": "Create Checklist",
"tags": [
"Task Checklists"
],
"description": "Add a new checklist to a task.",
"operationId": "CreateChecklist",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hz"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateChecklistrequest",
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"examples": [
{
"name": "Checklist"
}
]
},
"example": {
"name": "Checklist"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateChecklistresponse",
"required": [
"checklist"
],
"type": "object",
"properties": {
"checklist": {
"title": "Checklist",
"required": [
"id",
"task_id",
"name",
"orderindex",
"resolved",
"unresolved",
"items"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"task_id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"resolved": {
"type": "integer",
"contentEncoding": "int32"
},
"unresolved": {
"type": "integer",
"contentEncoding": "int32"
},
"items": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"examples": [
{
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683",
"task_id": "9hz",
"name": "Checklist",
"orderindex": 0,
"resolved": 0,
"unresolved": 0,
"items": []
}
]
}
},
"examples": [
{
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683",
"task_id": "9hz",
"name": "Checklist",
"orderindex": 0,
"resolved": 0,
"unresolved": 0,
"items": []
}
}
]
},
"example": {
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683",
"task_id": "9hz",
"name": "Checklist",
"orderindex": 0,
"resolved": 0,
"unresolved": 0,
"items": []
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/checklist/{checklist_id}": {
"put": {
"summary": "Edit Checklist",
"tags": [
"Task Checklists"
],
"description": "Rename a task checklist, or reorder a checklist so it appears above or below other checklists on a task. ",
"operationId": "EditChecklist",
"parameters": [
{
"name": "checklist_id",
"in": "path",
"description": "b8a8-48d8-a0c6-b4200788a683 (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"b955c4dc"
]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "EditChecklistrequest",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"position": {
"description": "Position refers to the order of appearance of checklists on a task.\\\n \\\nTo set a checklist to appear at the top of the checklists section of a task, use `\"position\": 0`.",
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"name": "Updated Checklist",
"position": 1
}
]
},
"example": {
"name": "Updated Checklist",
"position": 1
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"contentMediaType": "application/json"
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Checklist",
"tags": [
"Task Checklists"
],
"description": "Delete a checklist from a task.",
"operationId": "DeleteChecklist",
"parameters": [
{
"name": "checklist_id",
"in": "path",
"description": "b8a8-48d8-a0c6-b4200788a683 (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"b955c4dc"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/checklist/{checklist_id}/checklist_item": {
"post": {
"summary": "Create Checklist Item",
"tags": [
"Task Checklists"
],
"description": "Add a line item to a task checklist.",
"operationId": "CreateChecklistItem",
"parameters": [
{
"name": "checklist_id",
"in": "path",
"description": "b8a8-48d8-a0c6-b4200788a683 (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"b955c4dc"
]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateChecklistItemrequest",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"assignee": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"name": "Checklist Item",
"assignee": 183
}
]
},
"example": {
"name": "Checklist Item",
"assignee": 183
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateChecklistItemresponse",
"required": [
"checklist"
],
"type": "object",
"properties": {
"checklist": {
"title": "Checklist1",
"required": [
"id",
"task_id",
"name",
"date_created",
"orderindex",
"resolved",
"unresolved",
"items"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"task_id": {
"type": "string"
},
"name": {
"type": "string"
},
"date_created": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"resolved": {
"type": "integer",
"contentEncoding": "int32"
},
"unresolved": {
"type": "integer",
"contentEncoding": "int32"
},
"items": {
"type": "array",
"items": {
"title": "Item",
"required": [
"id",
"name",
"orderindex",
"assignee",
"resolved",
"parent",
"date_created",
"children"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"assignee": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1comment/get/responses/200/content/application~1json/schema/properties/comments/items/properties/assignee"
},
"resolved": {
"type": "boolean"
},
"parent": {
"type": [
"string",
"null"
]
},
"date_created": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"examples": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f",
"name": "Checklist Item",
"orderindex": 0,
"assignee": {
"id": 183,
"username": "John Doe",
"email": "example@email.com",
"color": "#827718",
"initials": "JD",
"profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg"
},
"resolved": false,
"parent": null,
"date_created": "1567711566859",
"children": []
}
]
},
"description": ""
}
},
"examples": [
{
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683",
"task_id": "9hv",
"name": "Checklist",
"date_created": "1567711563204",
"orderindex": 0,
"resolved": 0,
"unresolved": 1,
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f",
"name": "Checklist Item",
"orderindex": 0,
"assignee": {
"id": 183,
"username": "John Doe",
"email": "example@email.com",
"color": "#827718",
"initials": "JD",
"profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg"
},
"resolved": false,
"parent": null,
"date_created": "1567711566859",
"children": []
}
]
}
]
}
},
"examples": [
{
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683",
"task_id": "9hv",
"name": "Checklist",
"date_created": "1567711563204",
"orderindex": 0,
"resolved": 0,
"unresolved": 1,
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f",
"name": "Checklist Item",
"orderindex": 0,
"assignee": {
"id": 183,
"username": "John Doe",
"email": "example@email.com",
"color": "#827718",
"initials": "JD",
"profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg"
},
"resolved": false,
"parent": null,
"date_created": "1567711566859",
"children": []
}
]
}
}
]
},
"example": {
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683",
"task_id": "9hv",
"name": "Checklist",
"date_created": "1567711563204",
"orderindex": 0,
"resolved": 0,
"unresolved": 1,
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f",
"name": "Checklist Item",
"orderindex": 0,
"assignee": {
"id": 183,
"username": "John Doe",
"email": "example@email.com",
"color": "#827718",
"initials": "JD",
"profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg"
},
"resolved": false,
"parent": null,
"date_created": "1567711566859",
"children": []
}
]
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/checklist/{checklist_id}/checklist_item/{checklist_item_id}": {
"put": {
"summary": "Edit Checklist Item",
"tags": [
"Task Checklists"
],
"description": "Update an individual line item in a task checklist. \\\n \\\nYou can rename it, set the assignee, mark it as resolved, or nest it under another checklist item.",
"operationId": "EditChecklistItem",
"parameters": [
{
"name": "checklist_id",
"in": "path",
"description": "b8a8-48d8-a0c6-b4200788a683 (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"b955c4dc"
]
}
},
{
"name": "checklist_item_id",
"in": "path",
"description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"21e08dc8"
]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "EditChecklistItemrequest",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"assignee": {
"type": [
"string",
"null"
]
},
"resolved": {
"type": "boolean"
},
"parent": {
"description": "To nest a checklist item under another checklist item, include the other item's `checklist_item_id`.",
"type": [
"string",
"null"
]
}
},
"examples": [
{
"name": "Updated Checklist Item",
"assignee": null,
"resolved": true,
"parent": null
}
]
},
"example": {
"name": "Updated Checklist Item",
"assignee": null,
"resolved": true,
"parent": null
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "EditChecklistItemresponse",
"required": [
"checklist"
],
"type": "object",
"properties": {
"checklist": {
"title": "Checklist2",
"required": [
"id",
"task_id",
"name",
"date_created",
"orderindex",
"resolved",
"unresolved",
"items"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"task_id": {
"type": "string"
},
"name": {
"type": "string"
},
"date_created": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"resolved": {
"type": "integer",
"contentEncoding": "int32"
},
"unresolved": {
"type": "integer",
"contentEncoding": "int32"
},
"items": {
"type": "array",
"items": {
"title": "Item1",
"required": [
"id",
"name",
"orderindex",
"assignee",
"resolved",
"parent",
"date_created",
"children"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"assignee": {
"type": [
"string",
"null"
]
},
"resolved": {
"type": "boolean"
},
"parent": {
"type": [
"string",
"null"
]
},
"date_created": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"examples": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f",
"name": "Updated Checklist Item",
"orderindex": 0,
"assignee": null,
"resolved": true,
"parent": null,
"date_created": "1567711566859",
"children": []
}
]
},
"description": ""
}
},
"examples": [
{
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683",
"task_id": "9hv",
"name": "Checklist",
"date_created": "1567711563204",
"orderindex": 0,
"resolved": 1,
"unresolved": 0,
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f",
"name": "Updated Checklist Item",
"orderindex": 0,
"assignee": null,
"resolved": true,
"parent": null,
"date_created": "1567711566859",
"children": []
}
]
}
]
}
},
"examples": [
{
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683",
"task_id": "9hv",
"name": "Checklist",
"date_created": "1567711563204",
"orderindex": 0,
"resolved": 1,
"unresolved": 0,
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f",
"name": "Updated Checklist Item",
"orderindex": 0,
"assignee": null,
"resolved": true,
"parent": null,
"date_created": "1567711566859",
"children": []
}
]
}
}
]
},
"example": {
"checklist": {
"id": "b955c4dc-b8a8-48d8-a0c6-b4200788a683",
"task_id": "9hv",
"name": "Checklist",
"date_created": "1567711563204",
"orderindex": 0,
"resolved": 1,
"unresolved": 0,
"items": [
{
"id": "21e08dc8-e491-47f5-9fd8-d1dc4cedcc6f",
"name": "Updated Checklist Item",
"orderindex": 0,
"assignee": null,
"resolved": true,
"parent": null,
"date_created": "1567711566859",
"children": []
}
]
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Checklist Item",
"tags": [
"Task Checklists"
],
"description": "Delete a line item from a task checklist.",
"operationId": "DeleteChecklistItem",
"parameters": [
{
"name": "checklist_id",
"in": "path",
"description": "b8a8-48d8-a0c6-b4200788a683 (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"b955c4dc"
]
}
},
{
"name": "checklist_item_id",
"in": "path",
"description": "e491-47f5-9fd8-d1dc4cedcc6f (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"21e08dc8"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/task/{task_id}/comment": {
"get": {
"summary": "Get Task Comments",
"description": "View task comments. \\\n \\\nIf you do not include the `start` and `start_id` parameters, this endpoint will return the most recent 25 comments.\\\n \\\nUse the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments.",
"tags": [
"Comments"
],
"operationId": "GetTaskComments",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hz"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "start",
"in": "query",
"description": "Enter the `date` of a task comment using Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
},
{
"name": "start_id",
"in": "query",
"description": "Enter the Comment `id` of a task comment.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetTaskCommentsresponse",
"required": [
"comments"
],
"type": "object",
"properties": {
"comments": {
"type": "array",
"items": {
"title": "Comment",
"required": [
"id",
"comment",
"comment_text",
"user",
"resolved",
"assignee",
"assigned_by",
"reactions",
"date"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comment": {
"type": "array",
"items": {
"title": "Comment1",
"required": [
"text"
],
"type": "object",
"properties": {
"text": {
"type": "string"
}
},
"examples": [
{
"text": "Task comment content"
}
]
},
"description": ""
},
"comment_text": {
"type": "string"
},
"user": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user"
},
"resolved": {
"type": "boolean"
},
"assignee": {
"title": "Assignee",
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"examples": [
{
"id": 183,
"username": "John Doe",
"email": "example@email.com",
"color": "#827718",
"initials": "JD",
"profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg"
}
]
},
"assigned_by": {
"title": "AssignedBy",
"required": [
"id",
"username",
"initials",
"email",
"color",
"profilePicture"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"initials": {
"type": "string"
},
"email": {
"type": "string"
},
"color": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"examples": [
{
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
]
},
"reactions": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"date": {
"type": "string"
},
"reply_count": {
"type": "string",
"description": "For threaded comments, `reply_count` is always 0."
}
},
"examples": [
{
"id": "458",
"comment": [
{
"text": "Task comment content"
}
],
"comment_text": "Task comment content",
"user": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"assignee": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assigned_by": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"reactions": [],
"date": "1568036964079",
"reply_count": "1"
}
]
},
"description": ""
}
},
"examples": [
{
"comments": [
{
"id": "458",
"comment": [
{
"text": "Task comment content"
}
],
"comment_text": "Task comment content",
"user": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"assignee": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assigned_by": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"reactions": [],
"date": "1568036964079",
"reply_count": "1"
}
]
}
]
},
"example": {
"comments": [
{
"id": "458",
"comment": [
{
"text": "Task comment content"
}
],
"comment_text": "Task comment content",
"user": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"assignee": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assigned_by": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"reactions": [],
"date": "1568036964079",
"reply_count": "1"
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create Task Comment",
"tags": [
"Comments"
],
"description": "Add a new comment to a task.",
"operationId": "CreateTaskComment",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hz"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateTaskCommentrequest",
"required": [
"comment_text",
"notify_all"
],
"type": "object",
"properties": {
"comment_text": {
"type": "string"
},
"assignee": {
"type": "integer",
"contentEncoding": "int32"
},
"group_assignee": {
"type": "string",
"contentEncoding": "int32",
"description": ""
},
"notify_all": {
"description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.",
"type": "boolean"
}
},
"examples": [
{
"comment_text": "Task comment content",
"assignee": 183,
"group_assignee": "d01f92f-48ca-446d-88a1-0beb0e8f5f14",
"notify_all": true
}
]
},
"example": {
"comment_text": "Task comment content",
"assignee": 183,
"group_assignee": "dd01f92f-48ca-446d-88a1-0beb0e8f5f14",
"notify_all": true
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateTaskCommentresponse",
"required": [
"id",
"hist_id",
"date"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"hist_id": {
"type": "string"
},
"date": {
"type": "integer",
"contentEncoding": "int64"
}
},
"examples": [
{
"id": "458",
"hist_id": "26508",
"date": 1568036964079
}
]
},
"example": {
"id": "458",
"hist_id": "26508",
"date": 1568036964079
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/view/{view_id}/comment": {
"get": {
"summary": "Get Chat View Comments",
"description": "View comments from a Chat view. \\\n \\\nIf you do not include the `start` and `start_id` parameters, this endpoint will return the most recent 25 comments.\\\n \\\nUse the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments.",
"tags": [
"Comments"
],
"operationId": "GetChatViewComments",
"parameters": [
{
"name": "view_id",
"in": "path",
"description": "105 (string)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"3c"
]
}
},
{
"name": "start",
"in": "query",
"description": "Enter the `date` of a Chat view comment using Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
},
{
"name": "start_id",
"in": "query",
"description": "Enter the Comment `id` of a Chat view comment.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetChatViewCommentsresponse",
"required": [
"comments"
],
"type": "object",
"properties": {
"comments": {
"type": "array",
"items": {
"title": "Comment2",
"required": [
"id",
"comment",
"comment_text",
"user",
"resolved",
"assignee",
"assigned_by",
"reactions",
"date"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"comment": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1comment/get/responses/200/content/application~1json/schema/properties/comments/items/properties/comment/items"
},
"description": ""
},
"comment_text": {
"type": "string"
},
"user": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user"
},
"resolved": {
"type": "boolean"
},
"assignee": {
"type": [
"string",
"null"
]
},
"assigned_by": {
"type": [
"string",
"null"
]
},
"reactions": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"date": {
"type": "string"
},
"reply_count": {
"type": "string"
}
},
"examples": [
{
"id": "459",
"comment": [
{
"text": "View comment content"
}
],
"comment_text": "View comment content",
"user": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"assignee": null,
"assigned_by": null,
"reactions": [],
"date": "1568036964079",
"reply_count": "1"
}
]
},
"description": ""
}
},
"examples": [
{
"comments": [
{
"id": "459",
"comment": [
{
"text": "View comment content"
}
],
"comment_text": "View comment content",
"user": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"assignee": null,
"assigned_by": null,
"reactions": [],
"date": "1568036964079",
"reply_count": "1"
}
]
}
]
},
"example": {
"comments": [
{
"id": "459",
"comment": [
{
"text": "View comment content"
}
],
"comment_text": "View comment content",
"user": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"assignee": null,
"assigned_by": null,
"reactions": [],
"date": "1568036964079",
"reply_count": "1"
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create Chat View Comment",
"tags": [
"Comments"
],
"description": "Add a new comment to a Chat view.",
"operationId": "CreateChatViewComment",
"parameters": [
{
"name": "view_id",
"in": "path",
"description": "105 (string)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"3c"
]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateChatViewCommentrequest",
"required": [
"comment_text",
"notify_all"
],
"type": "object",
"properties": {
"comment_text": {
"type": "string"
},
"notify_all": {
"description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.",
"type": "boolean"
}
},
"examples": [
{
"comment_text": "View comment content",
"notify_all": true
}
]
},
"example": {
"comment_text": "View comment content",
"notify_all": true
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateChatViewCommentresponse",
"required": [
"id",
"hist_id",
"date"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"hist_id": {
"type": "string"
},
"date": {
"type": "integer",
"contentEncoding": "int64"
}
},
"examples": [
{
"id": "459",
"hist_id": "0a45e16e-4e2f-4a9e-99ec-3cf520b87eae",
"date": 1568037065216
}
]
},
"example": {
"id": "459",
"hist_id": "0a45e16e-4e2f-4a9e-99ec-3cf520b87eae",
"date": 1568037065216
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/list/{list_id}/comment": {
"get": {
"summary": "Get List Comments",
"description": "View the comments added to a List. \\\n \\\nIf you do not include the `start` and `start_id` parameters, this endpoint will return the most recent 25 comments.\\\n \\\nUse the `start` and `start id` parameters of the oldest comment to retrieve the next 25 comments.",
"tags": [
"Comments"
],
"operationId": "GetListComments",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [124]
}
},
{
"name": "start",
"in": "query",
"description": "Enter the `date` of a List info comment using Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
},
{
"name": "start_id",
"in": "query",
"description": "Enter the Comment `id` of a List info comment.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetListCommentsresponse",
"required": [
"comments"
],
"type": "object",
"properties": {
"comments": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1comment/get/responses/200/content/application~1json/schema/properties/comments/items"
},
"description": ""
}
},
"examples": [
{
"comments": [
{
"id": "462",
"comment": [
{
"text": "List comment content"
}
],
"comment_text": "List comment content",
"user": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"assignee": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assigned_by": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"reactions": [],
"date": "1568036964079",
"reply_count": "1"
}
]
}
]
},
"example": {
"comments": [
{
"id": "462",
"comment": [
{
"text": "List comment content"
}
],
"comment_text": "List comment content",
"user": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"assignee": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assigned_by": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"reactions": [],
"date": "1568036964079",
"reply_count": "1"
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create List Comment",
"tags": [
"Comments"
],
"description": "Add a comment to a List.",
"operationId": "CreateListComment",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [124]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateListCommentrequest",
"required": [
"comment_text",
"assignee",
"notify_all"
],
"type": "object",
"properties": {
"comment_text": {
"type": "string"
},
"assignee": {
"type": "integer",
"contentEncoding": "int32"
},
"notify_all": {
"description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment.",
"type": "boolean"
}
},
"examples": [
{
"comment_text": "List comment content",
"assignee": 183,
"notify_all": true
}
]
},
"example": {
"comment_text": "List comment content",
"assignee": 183,
"notify_all": true
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateListCommentresponse",
"required": [
"id",
"hist_id",
"date"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"hist_id": {
"type": "string"
},
"date": {
"type": "integer",
"contentEncoding": "int64"
}
},
"examples": [
{
"id": "462",
"hist_id": "5bbea9ad-7cc3-4038-a8bb-a89ac1337c08",
"date": 1568037341249
}
]
},
"example": {
"id": "462",
"hist_id": "5bbea9ad-7cc3-4038-a8bb-a89ac1337c08",
"date": 1568037341249
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/comment/{comment_id}": {
"put": {
"summary": "Update Comment",
"tags": [
"Comments"
],
"description": "Replace the content of a task commment, assign a comment, and mark a comment as resolved.",
"operationId": "UpdateComment",
"parameters": [
{
"name": "comment_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [456]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "UpdateCommentrequest",
"required": [
"comment_text",
"assignee",
"resolved"
],
"type": "object",
"properties": {
"comment_text": {
"type": "string"
},
"assignee": {
"type": "integer",
"contentEncoding": "int32"
},
"group_assignee": {
"type": "integer",
"contentEncoding": "int32",
"description": ""
},
"resolved": {
"description": "",
"type": "boolean"
}
},
"examples": [
{
"comment_text": "Updated comment content",
"assignee": 183,
"resolved": true
}
]
},
"example": {
"comment_text": "Updated comment content",
"assignee": 183,
"group_assignee": "dd01f92f-48ca-446d-88a1-0beb0e8f5f14",
"resolved": true
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Comment",
"tags": [
"Comments"
],
"description": "Delete a task comment.",
"operationId": "DeleteComment",
"parameters": [
{
"name": "comment_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [456]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/comment/{comment_id}/reply": {
"get": {
"summary": "Get Threaded Comments",
"description": "View threaded comments. The parent comment is not included in the response.",
"tags": [
"Comments"
],
"operationId": "GetThreadedComments",
"parameters": [
{
"name": "comment_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [456]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1comment/get/responses/200/content/application~1json/schema"
},
"example": {
"comments": [
{
"id": "458",
"comment": [
{
"text": "Task comment content"
}
],
"comment_text": "Task comment content",
"user": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"resolved": false,
"assignee": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assigned_by": {
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"reactions": [],
"date": "1568036964079",
"reply_count": "0"
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create Threaded Comment",
"tags": [
"Comments"
],
"description": "Create a threaded comment.",
"operationId": "CreateThreadedComment",
"parameters": [
{
"name": "comment_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [456]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1comment/post/requestBody/content/application~1json/schema"
},
"example": {
"comment_text": "Task comment content",
"assignee": 183,
"group_assignee": "d01f92f-48ca-446d-88a1-0beb0e8f5f14",
"notify_all": true
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
}
},
"/v2/list/{list_id}/field": {
"get": {
"summary": "Get List Custom Fields",
"tags": [
"Custom Fields"
],
"description": "View the Custom Fields you have access to in a specific List.",
"operationId": "GetAccessibleCustomFields",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetAccessibleCustomFieldsresponse",
"required": [
"fields"
],
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"title": "Field",
"required": [
"id",
"name",
"type",
"type_config",
"date_created",
"hide_from_guests"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"type_config": {
"title": "TypeConfig",
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"title": "Option",
"required": [
"id",
"color"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"color": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"value": {
"type": "integer",
"contentEncoding": "int32"
},
"type": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"id": "fb332c98-d7bc-4ee8-a3bd-b5ffaff98c3c",
"label": "one",
"color": null
}
]
},
"description": ""
},
"default": {
"oneOf": [
{
"type": [
"string",
"null"
]
},
{
"type": "integer",
"contentEncoding": "int32"
},
{
}
]
},
"precision": {
"type": "integer",
"contentEncoding": "int32"
},
"currency_type": {
"type": "string"
},
"placeholder": {
"type": [
"string",
"null"
]
},
"end": {
"type": "integer",
"contentEncoding": "int32"
},
"start": {
"type": "integer",
"contentEncoding": "int32"
},
"count": {
"type": "integer",
"contentEncoding": "int32"
},
"code_point": {
"type": "string"
},
"tracking": {
"title": "Tracking",
"required": [
"subtasks",
"checklists",
"assigned_comments"
],
"type": "object",
"properties": {
"subtasks": {
"type": "boolean"
},
"checklists": {
"type": "boolean"
},
"assigned_comments": {
"type": "boolean"
}
},
"examples": [
{
"subtasks": true,
"checklists": true,
"assigned_comments": true
}
]
},
"complete_on": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
}
]
},
"date_created": {
"type": "string"
},
"hide_from_guests": {
"type": "boolean"
}
},
"examples": [
{
"id": "03efda77-c7a0-42d3-8afd-fd546353c2f5",
"name": "Text Field",
"type": "text",
"type_config": {
},
"date_created": "1566400407303",
"hide_from_guests": false
}
]
},
"description": ""
}
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/folder/{folder_id}/field": {
"get": {
"summary": "Get Folder Custom Fields",
"tags": [
"Custom Fields"
],
"description": "View the Custom Fields you have access to in a Folder. Get Folder Custom Fields only returns Custom Fields created at the Folder level. Custom Fields created at the List level are not included.",
"operationId": "getFolderAvailableFields",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetFolderAvailableFieldsresponse",
"required": [
"fields"
],
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D~1field/get/responses/200/content/application~1json/schema/properties/fields/items"
},
"description": ""
}
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/space/{space_id}/field": {
"get": {
"summary": "Get Space Custom Fields",
"tags": [
"Custom Fields"
],
"description": "View the Custom Fields you have access to in a specific Space. Get Space Custom Fields only returns Custom Fields created at the Space level. Custom Fields created at the Folder and List level are not included.",
"operationId": "getSpaceAvailableFields",
"parameters": [
{
"name": "space_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetSpaceAvailableFieldsresponse",
"required": [
"fields"
],
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D~1field/get/responses/200/content/application~1json/schema/properties/fields/items"
},
"description": ""
}
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/field": {
"get": {
"summary": "Get Workspace Custom Fields",
"tags": [
"Custom Fields"
],
"description": "View the Custom Fields you have access to in a specific Workspace. Get Workspace Custom Fields only returns Custom Fields created at the Workspace level. Custom Fields created at the Space, Folder, and List level are not included.",
"operationId": "getTeamAvailableFields",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetTeamAvailableFieldsresponse",
"required": [
"fields"
],
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D~1field/get/responses/200/content/application~1json/schema/properties/fields/items"
},
"description": ""
}
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/task/{task_id}/field/{field_id}": {
"post": {
"summary": "Set Custom Field Value",
"description": "Add data to a Custom field on a task. \\\n \\\nYou'll need to know the `task_id` of the task you want to update, and the universal unique identifier (UUID) `field_id` of the Custom Field you want to set. \\\n \\\nYou can use [Get Accessible Custom Fields](ref:getaccessiblecustomfields) or the [Get Task](ref:gettask) endpoint to find the `field_id`.",
"tags": [
"Custom Fields"
],
"operationId": "SetCustomFieldValue",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "Enter the task ID of the task you want to update.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hv"
]
}
},
{
"name": "field_id",
"in": "path",
"description": "Enter the universal unique identifier (UUID) of the Custom Field you want to set.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"b955c4dc"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by its Custom Task ID, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "SetCustomFieldValuerequest",
"anyOf": [
{
"type": "object",
"title": "URL Custom Field",
"description": "The `value` must be a string with a valid URL.",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "https://clickup.com/api"
}
}
},
{
"type": "object",
"title": "Dropdown Custom Field",
"description": "Enter the universal unique identifier (UUID) of the dropdown menu option you want to set. You can find the UUIDs available for each Dropdown Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields) New Dropdown Custom Field options cannot be created from this request.",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "uuid1234"
}
}
},
{
"type": "object",
"title": "Email Custom Field",
"description": "The `value` must be a string with a valid email address.",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "user@company.com"
}
}
},
{
"type": "object",
"title": "Phone Custom Field",
"description": "The `value` must be a string with a valid country code.",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "+1 123 456 7890"
}
}
},
{
"type": "object",
"title": "Date Custom Field",
"description": "The `value` must be Unix time in milliseconds. To display the time in a Date Custom Field in ClickUp, you must include `time: true` in the `value_options` property.",
"properties": {
"value": {
"type": "integer",
"format": "int32",
"example": 1667367645000
},
"value_options": {
"type": "object",
"required": [
"time"
],
"properties": {
"time": {
"type": "boolean",
"example": true
}
}
}
}
},
{
"type": "object",
"title": "Short or Long Text Custom Field",
"description": "Enter a string of text.",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "This is short or long text in a Custom Field."
}
}
},
{
"type": "object",
"title": "Number Custom Field",
"description": "Enter a number.",
"required": [
"value"
],
"properties": {
"value": {
"type": "number",
"example": -28
}
}
},
{
"type": "object",
"title": "Money Custom Field",
"description": "You can set an amount, but not the currency of a Money Custom Field via the API. You can check the currency of a Money Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)",
"required": [
"value"
],
"properties": {
"value": {
"type": "number",
"example": 8000
}
}
},
{
"type": "object",
"title": "Task Relationship Custom Field",
"description": "Enter an array of task ids in the `add` property to add them to a Task Relationship Custom Field. Enter them into the `rem` property to remove tasks from the Relationship.",
"required": [
"value"
],
"properties": {
"value": {
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "string"
}
},
"rem": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
{
"type": "object",
"title": "People Custom Field",
"description": "Enter an array of user ids or a Team id in the `add` property to add them to a People Custom Field. Enter them into the `rem` property to remove users from a People Custom Field. You can get a list of people in the Workspace using [Get Authorized Teams (Workspaces).](ref:getauthorizedteams)",
"required": [
"value"
],
"properties": {
"value": {
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "number"
}
},
"rem": {
"type": "array",
"items": {
"type": "number"
}
}
}
}
}
},
{
"type": "object",
"title": "Emoji (Rating) Custom Field",
"description": "Enter an integer that is greater than or equal to zero and where the `count` property is greater than or equal to the `value`. You can find the `count` property for each Emoji (Rating) Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)",
"required": [
"value"
],
"properties": {
"value": {
"type": "integer",
"format": "int32",
"example": 4
}
}
},
{
"type": "object",
"title": "Manual Progress Custom Field",
"description": "Enter a number between the `start` and `end` values of each Manual Progress Custom Field. For example, for a field with `start: 10` and `end: 30`, sending `current: 20` will be displayed as 50% complete in ClickUp. You can find the `start` and `end` values for each Manual Progress Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)",
"required": [
"value"
],
"properties": {
"value": {
"type": "object",
"required": [
"current"
],
"properties": {
"current": {
"type": "number",
"example": 20
}
}
}
}
},
{
"type": "object",
"title": "Label Custom Field",
"description": "Enter an array of the universal unique identifiers (UUIDs) of the labels you want to apply. You can find the UUIDs available for each Label Custom Field using [Get Accessible Custom Fields.](ref:getaccessiblecustomfields)",
"required": [
"value"
],
"properties": {
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"uuid1234",
"uuid9876"
]
}
}
}
},
{
"type": "object",
"title": "Location Custom Field",
"description": "Include the latitude, longitude, and formatted address as defined in the [Google Maps Geocoding API.](https://developers.google.com/maps/documentation/geocoding/overview)",
"required": [
"value"
],
"properties": {
"value": {
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"lng": {
"type": "number"
}
}
},
"formatted_address": {
"type": "string"
}
}
}
}
},
{
"type": "object",
"title": "Button Custom Field",
"description": "Set a button Custom Field to `true` to \"click\" it. This will trigger the button's action as if it was clicked in the UI.",
"required": [
"value"
],
"properties": {
"value": {
"type": "boolean",
"example": true
}
}
}
]
},
"examples": {
"URL Custom Field": {
"value": {
"value": "https://clickup.com/api"
}
},
"Dropdown Custom Field": {
"value": {
"value": "uuid1234"
}
},
"Email Custom Field": {
"value": {
"value": "user@company.com"
}
},
"Phone Custom Field": {
"value": {
"value": "+1 201 555 0123"
}
},
"Date Custom Field": {
"value": {
"value": 1667367645000,
"value_options": {
"time": true
}
}
},
"Short or Long Text Custom Field": {
"value": {
"value": "This is short or long text in a Custom Field."
}
},
"Number Custom Field": {
"value": {
"value": -28
}
},
"Money Custom Field": {
"value": {
"value": 8000
}
},
"Task Relationship Custom Field": {
"value": {
"value": {
"add": [
"abcd1234",
"efghi5678"
],
"rem": [
"jklm9876",
"yuiop5678"
]
}
}
},
"People Custom Field": {
"value": {
"value": {
"add": [123, 456],
"rem": [987, 765]
}
}
},
"Emoji (Rating) Custom Field": {
"value": {
"value": 4
}
},
"Manual Progress Custom Field": {
"value": {
"value": {
"current": 20
}
}
},
"Label Custom Field": {
"value": {
"value": [
"uuid1234",
"uuid9876"
]
}
},
"Location Custom Field": {
"value": {
"value": {
"location": {
"lat": -28.016667,
"lng": 153.4
},
"formatted_address": "Gold Coast QLD, Australia"
}
}
},
"Button Custom Field": {
"value": {
"value": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Remove Custom Field Value",
"tags": [
"Custom Fields"
],
"description": "Remove the data from a Custom Field on a task. This does not delete the option from the Custom Field.",
"operationId": "RemoveCustomFieldValue",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hv"
]
}
},
{
"name": "field_id",
"in": "path",
"description": "b8a8-48d8-a0c6-b4200788a683 (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"b955c4dc"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/task/{task_id}/dependency": {
"post": {
"summary": "Add Dependency",
"tags": [
"Task Relationships"
],
"description": "Set a task as waiting on or blocking another task.",
"operationId": "AddDependency",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "This is the task which is waiting on or blocking another task.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hv"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n\\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "Use the `depends_on` parameter in the request body to specify the task that must be completed before the task in the path parameter.\\\n \\\nUse the `dependency_of` parameter in the request body to specify the task that's waiting for the task in the path parameter to be completed.\\\n \\\nYou can only use one per request.",
"content": {
"application/json": {
"schema": {
"title": "AddDependencyrequest",
"type": "object",
"properties": {
"depends_on": {
"type": "string"
},
"depedency_of": {
"type": "string"
}
},
"examples": [
{
"depends_on": "9hw"
}
]
},
"example": {
"depends_on": "9hw"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Dependency",
"tags": [
"Task Relationships"
],
"description": "Remove the dependency relationship between two or more tasks.",
"operationId": "DeleteDependency",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hv"
]
}
},
{
"name": "depends_on",
"in": "query",
"description": "",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"examples": [
"9hz"
]
}
},
{
"name": "dependency_of",
"in": "query",
"description": "",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string",
"examples": [
"9hz"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/task/{task_id}/link/{links_to}": {
"post": {
"summary": "Add Task Link",
"tags": [
"Task Relationships"
],
"description": "This is the equivalent of the feature _Task Links_ in the right-hand sidebar of a Task. It allows you to link two tasks together. General links or links to other objects than tasks are not supported.",
"operationId": "AddTaskLink",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "The task to initiate the link from.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hv"
]
}
},
{
"name": "links_to",
"in": "path",
"description": "The task to link to.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hz"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "AddTaskLinkresponse",
"required": [
"task"
],
"type": "object",
"properties": {
"task": {
"title": "Task",
"required": [
"id",
"name",
"status",
"orderindex",
"date_created",
"date_updated",
"date_closed",
"creator",
"assignees",
"checklists",
"tags",
"parent",
"priority",
"due_date",
"start_date",
"time_estimate",
"time_spent",
"list",
"folder",
"space",
"linked_tasks",
"url"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"orderindex": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"date_closed": {
"type": [
"string",
"null"
]
},
"creator": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator"
},
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"checklists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"parent": {
"type": [
"string",
"null"
]
},
"priority": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": [
"string",
"null"
]
},
"start_date": {
"type": [
"string",
"null"
]
},
"time_estimate": {
"type": [
"string",
"null"
]
},
"time_spent": {
"type": [
"string",
"null"
]
},
"list": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list"
},
"folder": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder"
},
"space": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space"
},
"linked_tasks": {
"type": "array",
"items": {
"title": "LinkedTask",
"required": [
"task_id",
"link_id",
"date_created",
"userid"
],
"type": "object",
"properties": {
"task_id": {
"type": "string"
},
"link_id": {
"type": "string"
},
"date_created": {
"type": "string"
},
"userid": {
"type": "string"
}
},
"examples": [
{
"task_id": "9hv",
"link_id": "9hz",
"date_created": "1587571108988",
"userid": "183"
}
]
},
"description": ""
},
"url": {
"type": "string"
}
},
"examples": [
{
"id": "9hv",
"name": "Task Name",
"status": {
"status": "in progress",
"color": "#d3d3d3",
"orderindex": 1,
"type": "custom"
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": null,
"due_date": null,
"start_date": null,
"time_estimate": null,
"time_spent": null,
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"linked_tasks": [
{
"task_id": "9hv",
"link_id": "9hz",
"date_created": "1587571108988",
"userid": "183"
}
],
"url": "https://app.clickup.com/t/9hx"
}
]
}
},
"examples": [
{
"task": {
"id": "9hv",
"name": "Task Name",
"status": {
"status": "in progress",
"color": "#d3d3d3",
"orderindex": 1,
"type": "custom"
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": null,
"due_date": null,
"start_date": null,
"time_estimate": null,
"time_spent": null,
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"linked_tasks": [
{
"task_id": "9hv",
"link_id": "9hz",
"date_created": "1587571108988",
"userid": "183"
}
],
"url": "https://app.clickup.com/t/9hx"
}
}
]
},
"example": {
"task": {
"id": "9hv",
"name": "Task Name",
"status": {
"status": "in progress",
"color": "#d3d3d3",
"orderindex": 1,
"type": "custom"
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": null,
"due_date": null,
"start_date": null,
"time_estimate": null,
"time_spent": null,
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"linked_tasks": [
{
"task_id": "9hv",
"link_id": "9hz",
"date_created": "1587571108988",
"userid": "183"
}
],
"url": "https://app.clickup.com/t/9hx"
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Task Link",
"tags": [
"Task Relationships"
],
"description": "Remove the link between two tasks.",
"operationId": "DeleteTaskLink",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hv"
]
}
},
{
"name": "links_to",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hz"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "DeleteTaskLinkresponse",
"required": [
"task"
],
"type": "object",
"properties": {
"task": {
"title": "Task1",
"required": [
"id",
"name",
"status",
"orderindex",
"date_created",
"date_updated",
"date_closed",
"creator",
"assignees",
"checklists",
"tags",
"parent",
"priority",
"due_date",
"start_date",
"time_estimate",
"time_spent",
"list",
"folder",
"space",
"linked_tasks",
"url"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"orderindex": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"date_closed": {
"type": [
"string",
"null"
]
},
"creator": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator"
},
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"checklists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"parent": {
"type": [
"string",
"null"
]
},
"priority": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": [
"string",
"null"
]
},
"start_date": {
"type": [
"string",
"null"
]
},
"time_estimate": {
"type": [
"string",
"null"
]
},
"time_spent": {
"type": [
"string",
"null"
]
},
"list": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list"
},
"folder": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder"
},
"space": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space"
},
"linked_tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"url": {
"type": "string"
}
},
"examples": [
{
"id": "9hv",
"name": "Task Name",
"status": {
"status": "in progress",
"color": "#d3d3d3",
"orderindex": 1,
"type": "custom"
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": null,
"due_date": null,
"start_date": null,
"time_estimate": null,
"time_spent": null,
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"linked_tasks": [],
"url": "https://app.clickup.com/t/9hx"
}
]
}
},
"examples": [
{
"task": {
"id": "9hv",
"name": "Task Name",
"status": {
"status": "in progress",
"color": "#d3d3d3",
"orderindex": 1,
"type": "custom"
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": null,
"due_date": null,
"start_date": null,
"time_estimate": null,
"time_spent": null,
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"linked_tasks": [],
"url": "https://app.clickup.com/t/9hx"
}
}
]
},
"example": {
"task": {
"id": "9hv",
"name": "Task Name",
"status": {
"status": "in progress",
"color": "#d3d3d3",
"orderindex": 1,
"type": "custom"
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": null,
"due_date": null,
"start_date": null,
"time_estimate": null,
"time_spent": null,
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"linked_tasks": [],
"url": "https://app.clickup.com/t/9hx"
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/space/{space_id}/folder": {
"get": {
"summary": "Get Folders",
"tags": [
"Folders"
],
"description": "View the Folders in a Space.",
"operationId": "GetFolders",
"parameters": [
{
"name": "space_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [789]
}
},
{
"name": "archived",
"in": "query",
"description": "",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [false]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"description": "",
"examples": [
{
"folders": [
{
"id": "457",
"name": "Updated Folder Name",
"orderindex": 0,
"override_statuses": false,
"hidden": false,
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"task_count": "0",
"lists": []
},
{
"id": "458",
"name": "Second Folder Name",
"orderindex": 1,
"override_statuses": false,
"hidden": false,
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"task_count": "0",
"lists": []
}
]
}
],
"contentMediaType": "application/json",
"title": "GetFoldersresponse",
"required": [
"folders"
],
"type": "object",
"properties": {
"folders": {
"title": "Folder5",
"required": [
"id",
"name",
"orderindex",
"override_statuses",
"hidden",
"space",
"task_count",
"lists"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"override_statuses": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"space": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space"
},
"task_count": {
"type": "string"
},
"lists": {
"type": "array",
"items": {
"type": "string"
}
}
},
"examples": [
{
"id": "1057",
"name": "Folder Name",
"orderindex": 5,
"override_statuses": true,
"hidden": false,
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"task_count": "20",
"lists": []
}
]
}
}
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create Folder",
"tags": [
"Folders"
],
"description": "Add a new Folder to a Space.",
"operationId": "CreateFolder",
"parameters": [
{
"name": "space_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [789]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateFolderrequest",
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"examples": [
{
"name": "New Folder Name"
}
]
},
"example": {
"name": "New Folder Name"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateFolderresponse",
"required": [
"id",
"name",
"orderindex",
"override_statuses",
"hidden",
"space",
"task_count"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"override_statuses": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"space": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space"
},
"task_count": {
"type": "string"
}
},
"examples": [
{
"id": "457",
"name": "New Folder Name",
"orderindex": 0,
"override_statuses": false,
"hidden": false,
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"task_count": "0"
}
]
},
"example": {
"id": "457",
"name": "New Folder Name",
"orderindex": 0,
"override_statuses": false,
"hidden": false,
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"task_count": "0"
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/folder/{folder_id}": {
"get": {
"summary": "Get Folder",
"tags": [
"Folders"
],
"description": "View the Lists within a Folder.",
"operationId": "GetFolder",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [457]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetFolderresponse",
"required": [
"id",
"name",
"orderindex",
"override_statuses",
"hidden",
"space",
"task_count",
"lists"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"override_statuses": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"space": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space"
},
"task_count": {
"type": "string"
},
"lists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"examples": [
{
"id": "457",
"name": "Updated Folder Name",
"orderindex": 0,
"override_statuses": false,
"hidden": false,
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"task_count": "0",
"lists": []
}
]
},
"example": {
"id": "457",
"name": "Updated Folder Name",
"orderindex": 0,
"override_statuses": false,
"hidden": false,
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"task_count": "0",
"lists": []
}
}
}
}
},
"deprecated": false
},
"put": {
"summary": "Update Folder",
"tags": [
"Folders"
],
"description": "Rename a Folder.",
"operationId": "UpdateFolder",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [457]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "UpdateFolderrequest",
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"examples": [
{
"name": "Updated Folder Name"
}
]
},
"example": {
"name": "Updated Folder Name"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "UpdateFolderresponse",
"required": [
"id",
"name",
"orderindex",
"override_statuses",
"hidden",
"space",
"task_count"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"override_statuses": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"space": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space"
},
"task_count": {
"type": "string"
}
},
"examples": [
{
"id": "457",
"name": "Updated Folder Name",
"orderindex": 0,
"override_statuses": false,
"hidden": false,
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"task_count": "0"
}
]
},
"example": {
"id": "457",
"name": "Updated Folder Name",
"orderindex": 0,
"override_statuses": false,
"hidden": false,
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"task_count": "0"
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Folder",
"tags": [
"Folders"
],
"description": "Delete a Folder from your Workspace.",
"operationId": "DeleteFolder",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [457]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/goal": {
"get": {
"summary": "Get Goals",
"tags": [
"Goals"
],
"description": "View the Goals available in a Workspace.",
"operationId": "GetGoals",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "include_completed",
"in": "query",
"description": "",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetGoalsresponse",
"required": [
"goals",
"folders"
],
"type": "object",
"properties": {
"goals": {
"type": "array",
"items": {
"title": "Goal2",
"required": [
"id",
"pretty_id",
"name",
"team_id",
"creator",
"owner",
"color",
"date_created",
"start_date",
"due_date",
"description",
"private",
"archived",
"multiple_owners",
"editor_token",
"date_updated",
"last_update",
"folder_id",
"pinned",
"owners",
"key_result_count",
"members",
"group_members",
"percent_completed"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"pretty_id": {
"type": "string"
},
"name": {
"type": "string"
},
"team_id": {
"type": "string"
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"owner": {
"type": [
"string",
"null"
]
},
"color": {
"type": "string"
},
"date_created": {
"type": "string"
},
"start_date": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": "string"
},
"description": {
"type": "string"
},
"private": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"multiple_owners": {
"type": "boolean"
},
"editor_token": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"last_update": {
"type": "string"
},
"folder_id": {
"type": [
"string",
"null"
]
},
"pinned": {
"type": "boolean"
},
"owners": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"key_result_count": {
"type": "integer",
"contentEncoding": "int32"
},
"members": {
"type": "array",
"items": {
"title": "Member1",
"required": [
"id",
"username",
"email",
"color",
"permission_level",
"profilePicture",
"initials",
"isCreator"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"color": {
"type": "string"
},
"permission_level": {
"type": "string"
},
"profilePicture": {
"type": "string"
},
"initials": {
"type": "string"
},
"isCreator": {
"type": "boolean"
}
},
"examples": [
{
"id": 182,
"username": "Jane Doe",
"email": "janedoe@gmail.com",
"color": "#827718",
"permission_level": "edit",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"initials": "JD",
"isCreator": true
}
]
},
"description": ""
},
"group_members": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"percent_completed": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930",
"pretty_id": "6",
"name": "Goal ABC",
"team_id": "512",
"creator": 182,
"owner": null,
"color": "#32a852",
"date_created": "1568044355026",
"start_date": null,
"due_date": "1568036964079",
"description": "Updated Goal Description",
"private": false,
"archived": false,
"multiple_owners": true,
"editor_token": "goal:792c3027-83a2-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485ed15e675",
"date_updated": "1626130440221",
"last_update": "1626132992152",
"folder_id": null,
"pinned": false,
"owners": [],
"key_result_count": 1,
"members": [
{
"id": 182,
"username": "Jane Doe",
"email": "janedoe@gmail.com",
"color": "#827718",
"permission_level": "edit",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"initials": "JD",
"isCreator": true
}
],
"group_members": [],
"percent_completed": 0
}
]
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"title": "Folder2",
"required": [
"id",
"name",
"team_id",
"private",
"date_created",
"creator",
"goal_count",
"members",
"goals"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"team_id": {
"type": "string"
},
"private": {
"type": "boolean"
},
"date_created": {
"type": "string"
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"goal_count": {
"type": "integer",
"contentEncoding": "int32"
},
"members": {
"type": "array",
"items": {
"title": "Member2",
"required": [
"id",
"email",
"username",
"color",
"permission_level",
"date_added",
"added_by",
"initials",
"profilePicture"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
},
"color": {
"type": "string"
},
"permission_level": {
"type": "string"
},
"date_added": {
"type": "integer",
"contentEncoding": "int64"
},
"added_by": {
"type": "integer",
"contentEncoding": "int32"
},
"initials": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"examples": [
{
"id": 182,
"email": "janedoe@gmail.com",
"username": "Jane Doe",
"color": "#827718",
"permission_level": "read",
"date_added": 1631599941928,
"added_by": 183,
"initials": "JD",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg"
}
]
},
"description": ""
},
"goals": {
"type": "array",
"items": {
"title": "Goal3",
"required": [
"id",
"pretty_id",
"name",
"team_id",
"creator",
"owner",
"color",
"date_created",
"start_date",
"due_date",
"description",
"private",
"archived",
"multiple_owners",
"editor_token",
"date_updated",
"last_update",
"folder_id",
"folder_access",
"pinned",
"owners",
"key_result_count",
"members",
"group_members",
"percent_completed"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"pretty_id": {
"type": "string"
},
"name": {
"type": "string"
},
"team_id": {
"type": "string"
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"owner": {
"type": [
"string",
"null"
]
},
"color": {
"type": "string"
},
"date_created": {
"type": "string"
},
"start_date": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": "string"
},
"description": {
"type": "string"
},
"private": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"multiple_owners": {
"type": "boolean"
},
"editor_token": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"last_update": {
"type": "string"
},
"folder_id": {
"type": "string"
},
"folder_access": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"owners": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"key_result_count": {
"type": "integer",
"contentEncoding": "int32"
},
"members": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1goal/get/responses/200/content/application~1json/schema/properties/goals/items/properties/members/items"
},
"description": ""
},
"group_members": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"percent_completed": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930",
"pretty_id": "8",
"name": "Q1 Goals",
"team_id": "512",
"creator": 182,
"owner": null,
"color": "#32a852",
"date_created": "1568044355026",
"start_date": null,
"due_date": "1568036964079",
"description": "Goal for Q1",
"private": false,
"archived": false,
"multiple_owners": true,
"editor_token": "goal:792c3027-83b5-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485fc22d477",
"date_updated": "1626130440221",
"last_update": "1626132992152",
"folder_id": "05921253-7737-44af-a1aa-36fd11244e6f",
"folder_access": true,
"pinned": false,
"owners": [],
"key_result_count": 1,
"members": [
{
"id": 182,
"username": "Jane Doe",
"email": "janedoe@gmail.com",
"color": "#827718",
"permission_level": "edit",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"initials": "JD",
"isCreator": true
}
],
"group_members": [],
"percent_completed": 1
}
]
},
"description": ""
}
},
"examples": [
{
"id": "05921253-7737-44af-a1aa-36fd11244e6f",
"name": "Quarterly Goals",
"team_id": "512",
"private": true,
"date_created": "1548802674671",
"creator": 182,
"goal_count": 1,
"members": [
{
"id": 182,
"email": "janedoe@gmail.com",
"username": "Jane Doe",
"color": "#827718",
"permission_level": "read",
"date_added": 1631599941928,
"added_by": 183,
"initials": "JD",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg"
}
],
"goals": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930",
"pretty_id": "8",
"name": "Q1 Goals",
"team_id": "512",
"creator": 182,
"owner": null,
"color": "#32a852",
"date_created": "1568044355026",
"start_date": null,
"due_date": "1568036964079",
"description": "Goal for Q1",
"private": false,
"archived": false,
"multiple_owners": true,
"editor_token": "goal:792c3027-83b5-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485fc22d477",
"date_updated": "1626130440221",
"last_update": "1626132992152",
"folder_id": "05921253-7737-44af-a1aa-36fd11244e6f",
"folder_access": true,
"pinned": false,
"owners": [],
"key_result_count": 1,
"members": [
{
"id": 182,
"username": "Jane Doe",
"email": "janedoe@gmail.com",
"color": "#827718",
"permission_level": "edit",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"initials": "JD",
"isCreator": true
}
],
"group_members": [],
"percent_completed": 1
}
]
}
]
},
"description": ""
}
},
"examples": [
{
"goals": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930",
"pretty_id": "6",
"name": "Goal ABC",
"team_id": "512",
"creator": 182,
"owner": null,
"color": "#32a852",
"date_created": "1568044355026",
"start_date": null,
"due_date": "1568036964079",
"description": "Updated Goal Description",
"private": false,
"archived": false,
"multiple_owners": true,
"editor_token": "goal:792c3027-83a2-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485ed15e675",
"date_updated": "1626130440221",
"last_update": "1626132992152",
"folder_id": null,
"pinned": false,
"owners": [],
"key_result_count": 1,
"members": [
{
"id": 182,
"username": "Jane Doe",
"email": "janedoe@gmail.com",
"color": "#827718",
"permission_level": "edit",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"initials": "JD",
"isCreator": true
}
],
"group_members": [],
"percent_completed": 0
}
],
"folders": [
{
"id": "05921253-7737-44af-a1aa-36fd11244e6f",
"name": "Quarterly Goals",
"team_id": "512",
"private": true,
"date_created": "1548802674671",
"creator": 182,
"goal_count": 1,
"members": [
{
"id": 182,
"email": "janedoe@gmail.com",
"username": "Jane Doe",
"color": "#827718",
"permission_level": "read",
"date_added": 1631599941928,
"added_by": 183,
"initials": "JD",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg"
}
],
"goals": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930",
"pretty_id": "8",
"name": "Q1 Goals",
"team_id": "512",
"creator": 182,
"owner": null,
"color": "#32a852",
"date_created": "1568044355026",
"start_date": null,
"due_date": "1568036964079",
"description": "Goal for Q1",
"private": false,
"archived": false,
"multiple_owners": true,
"editor_token": "goal:792c3027-83b5-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485fc22d477",
"date_updated": "1626130440221",
"last_update": "1626132992152",
"folder_id": "05921253-7737-44af-a1aa-36fd11244e6f",
"folder_access": true,
"pinned": false,
"owners": [],
"key_result_count": 1,
"members": [
{
"id": 182,
"username": "Jane Doe",
"email": "janedoe@gmail.com",
"color": "#827718",
"permission_level": "edit",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"initials": "JD",
"isCreator": true
}
],
"group_members": [],
"percent_completed": 1
}
]
}
]
}
]
},
"example": {
"goals": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930",
"pretty_id": "6",
"name": "Goal ABC",
"team_id": "512",
"creator": 182,
"owner": null,
"color": "#32a852",
"date_created": "1568044355026",
"start_date": null,
"due_date": "1568036964079",
"description": "Updated Goal Description",
"private": false,
"archived": false,
"multiple_owners": true,
"editor_token": "goal:792c3027-83a2-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485ed15e675",
"date_updated": "1626130440221",
"last_update": "1626132992152",
"folder_id": null,
"pinned": false,
"owners": [],
"key_result_count": 1,
"members": [
{
"id": 182,
"username": "Jane Doe",
"email": "janedoe@gmail.com",
"color": "#827718",
"permission_level": "edit",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"initials": "JD",
"isCreator": true
}
],
"group_members": [],
"percent_completed": 0
}
],
"folders": [
{
"id": "05921253-7737-44af-a1aa-36fd11244e6f",
"name": "Quarterly Goals",
"team_id": "512",
"private": true,
"date_created": "1548802674671",
"creator": 182,
"goal_count": 1,
"members": [
{
"id": 182,
"email": "janedoe@gmail.com",
"username": "Jane Doe",
"color": "#827718",
"permission_level": "read",
"date_added": 1631599941928,
"added_by": 183,
"initials": "JD",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg"
}
],
"goals": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930",
"pretty_id": "8",
"name": "Q1 Goals",
"team_id": "512",
"creator": 182,
"owner": null,
"color": "#32a852",
"date_created": "1568044355026",
"start_date": null,
"due_date": "1568036964079",
"description": "Goal for Q1",
"private": false,
"archived": false,
"multiple_owners": true,
"editor_token": "goal:792c3027-83b5-45de-be96-2f623b5f9078:1626303240249:38fd99e8-f989-4125-9a05-19ead0ed83a6:57bdc749-4ca6-4082-a78e-3485fc22d477",
"date_updated": "1626130440221",
"last_update": "1626132992152",
"folder_id": "05921253-7737-44af-a1aa-36fd11244e6f",
"folder_access": true,
"pinned": false,
"owners": [],
"key_result_count": 1,
"members": [
{
"id": 182,
"username": "Jane Doe",
"email": "janedoe@gmail.com",
"color": "#827718",
"permission_level": "edit",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"initials": "JD",
"isCreator": true
}
],
"group_members": [],
"percent_completed": 1
}
]
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create Goal",
"tags": [
"Goals"
],
"description": "Add a new Goal to a Workspace.",
"operationId": "CreateGoal",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateGoalrequest",
"required": [
"name",
"due_date",
"description",
"multiple_owners",
"owners",
"color"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"description": {
"type": "string"
},
"multiple_owners": {
"type": "boolean"
},
"owners": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": "Array of user IDs."
},
"color": {
"type": "string"
}
},
"examples": [
{
"name": "Goal Name",
"due_date": 1568036964079,
"description": "Goal Description",
"multiple_owners": true,
"owners": [183],
"color": "#32a852"
}
]
},
"example": {
"name": "Goal Name",
"due_date": 1568036964079,
"description": "Goal Description",
"multiple_owners": true,
"owners": [183],
"color": "#32a852"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateGoalresponse",
"required": [
"goal"
],
"type": "object",
"properties": {
"goal": {
"$ref": "#/paths/~1v2~1goal~1%7Bgoal_id%7D/get/responses/200/content/application~1json/schema/properties/goal"
}
},
"examples": [
{
"goal": {
"id": "e53a033c-900e-462d-a849-4a216b06d930",
"name": "Goal Name",
"team_id": "512",
"date_created": "1568044355026",
"start_date": null,
"due_date": "1568036964079",
"description": "Goal Description",
"private": false,
"archived": false,
"creator": 183,
"color": "#32a852",
"pretty_id": "6",
"multiple_owners": true,
"folder_id": null,
"members": [],
"owners": [
{
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
],
"key_results": [],
"percent_completed": 0,
"history": [],
"pretty_url": "https://app.clickup.com/512/goals/6"
}
}
]
},
"example": {
"goal": {
"id": "e53a033c-900e-462d-a849-4a216b06d930",
"name": "Goal Name",
"team_id": "512",
"date_created": "1568044355026",
"start_date": null,
"due_date": "1568036964079",
"description": "Goal Description",
"private": false,
"archived": false,
"creator": 183,
"color": "#32a852",
"pretty_id": "6",
"multiple_owners": true,
"folder_id": null,
"members": [],
"owners": [
{
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
],
"key_results": [],
"percent_completed": 0,
"history": [],
"pretty_url": "https://app.clickup.com/512/goals/6"
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/goal/{goal_id}": {
"get": {
"summary": "Get Goal",
"tags": [
"Goals"
],
"description": "View the details of a Goal including its Targets.",
"operationId": "GetGoal",
"parameters": [
{
"name": "goal_id",
"in": "path",
"description": "900e-462d-a849-4a216b06d930 (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"e53a033c"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetGoalresponse",
"required": [
"goal"
],
"type": "object",
"properties": {
"goal": {
"title": "Goal",
"required": [
"id",
"name",
"team_id",
"date_created",
"start_date",
"due_date",
"description",
"private",
"archived",
"creator",
"color",
"pretty_id",
"multiple_owners",
"folder_id",
"members",
"owners",
"key_results",
"percent_completed",
"history",
"pretty_url"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"team_id": {
"type": "string"
},
"date_created": {
"type": "string"
},
"start_date": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": "string"
},
"description": {
"type": "string"
},
"private": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"pretty_id": {
"type": "string"
},
"multiple_owners": {
"type": "boolean"
},
"folder_id": {
"type": [
"string",
"null"
]
},
"members": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"owners": {
"type": "array",
"items": {
"title": "Owner",
"required": [
"id",
"username",
"initials",
"email",
"color",
"profilePicture"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"initials": {
"type": "string"
},
"email": {
"type": "string"
},
"color": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"examples": [
{
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
]
},
"description": ""
},
"key_results": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"percent_completed": {
"type": "integer",
"contentEncoding": "int32"
},
"history": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"pretty_url": {
"type": "string"
}
},
"examples": [
{
"id": "e53a033c-900e-462d-a849-4a216b06d930",
"name": "Goal Name",
"team_id": "512",
"date_created": "1568044355026",
"start_date": null,
"due_date": "1568036964079",
"description": "Goal Description",
"private": false,
"archived": false,
"creator": 183,
"color": "#32a852",
"pretty_id": "6",
"multiple_owners": true,
"folder_id": null,
"members": [],
"owners": [
{
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
],
"key_results": [],
"percent_completed": 0,
"history": [],
"pretty_url": "https://app.clickup.com/512/goals/6"
}
]
}
},
"examples": [
{
"goal": {
"id": "e53a033c-900e-462d-a849-4a216b06d930",
"name": "Updated Goal Name",
"team_id": "512",
"date_created": "1568044355026",
"start_date": null,
"due_date": "1568036964079",
"description": "Updated Goal Description",
"private": false,
"archived": false,
"creator": 183,
"color": "#32a852",
"pretty_id": "6",
"multiple_owners": true,
"folder_id": null,
"members": [],
"owners": [
{
"id": 182,
"username": "Jane Doe",
"initials": "JD",
"email": "janedoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg"
}
],
"key_results": [],
"percent_completed": 0,
"history": [],
"pretty_url": "https://app.clickup.com/512/goals/6"
}
}
]
},
"example": {
"goal": {
"id": "e53a033c-900e-462d-a849-4a216b06d930",
"name": "Updated Goal Name",
"team_id": "512",
"date_created": "1568044355026",
"start_date": null,
"due_date": "1568036964079",
"description": "Updated Goal Description",
"private": false,
"archived": false,
"creator": 183,
"color": "#32a852",
"pretty_id": "6",
"multiple_owners": true,
"folder_id": null,
"members": [],
"owners": [
{
"id": 182,
"username": "Jane Doe",
"initials": "JD",
"email": "janedoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg"
}
],
"key_results": [],
"percent_completed": 0,
"history": [],
"pretty_url": "https://app.clickup.com/512/goals/6"
}
}
}
}
}
},
"deprecated": false
},
"put": {
"summary": "Update Goal",
"tags": [
"Goals"
],
"description": "Rename a Goal, set the due date, replace the description, add or remove owners, and set the Goal color.",
"operationId": "UpdateGoal",
"parameters": [
{
"name": "goal_id",
"in": "path",
"description": "900e-462d-a849-4a216b06d930 (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"e53a033c"
]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "UpdateGoalrequest",
"required": [
"name",
"due_date",
"description",
"rem_owners",
"add_owners",
"color"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"description": {
"type": "string"
},
"rem_owners": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": "Array of user IDs."
},
"add_owners": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": "Array of user IDs."
},
"color": {
"type": "string"
}
},
"examples": [
{
"name": "Updated Goal Name",
"due_date": 1568036964079,
"description": "Updated Goal Description",
"rem_owners": [183],
"add_owners": [184],
"color": "#32a852"
}
]
},
"example": {
"name": "Updated Goal Name",
"due_date": 1568036964079,
"description": "Updated Goal Description",
"rem_owners": [183],
"add_owners": [184],
"color": "#32a852"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "UpdateGoalresponse",
"required": [
"goal"
],
"type": "object",
"properties": {
"goal": {
"$ref": "#/paths/~1v2~1goal~1%7Bgoal_id%7D/get/responses/200/content/application~1json/schema/properties/goal"
}
},
"examples": [
{
"goal": {
"id": "e53a033c-900e-462d-a849-4a216b06d930",
"name": "Updated Goal Name",
"team_id": "512",
"date_created": "1568044355026",
"start_date": null,
"due_date": "1568036964079",
"description": "Updated Goal Description",
"private": false,
"archived": false,
"creator": 183,
"color": "#32a852",
"pretty_id": "6",
"multiple_owners": true,
"folder_id": null,
"members": [],
"owners": [
{
"id": 182,
"username": "Jane Doe",
"initials": "JD",
"email": "janedoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg"
}
],
"key_results": [],
"percent_completed": 0,
"history": [],
"pretty_url": "https://app.clickup.com/512/goals/6"
}
}
]
},
"example": {
"goal": {
"id": "e53a033c-900e-462d-a849-4a216b06d930",
"name": "Updated Goal Name",
"team_id": "512",
"date_created": "1568044355026",
"start_date": null,
"due_date": "1568036964079",
"description": "Updated Goal Description",
"private": false,
"archived": false,
"creator": 183,
"color": "#32a852",
"pretty_id": "6",
"multiple_owners": true,
"folder_id": null,
"members": [],
"owners": [
{
"id": 182,
"username": "Jane Doe",
"initials": "JD",
"email": "janedoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg"
}
],
"key_results": [],
"percent_completed": 0,
"history": [],
"pretty_url": "https://app.clickup.com/512/goals/6"
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Goal",
"tags": [
"Goals"
],
"description": "Remove a Goal from your Workspace.",
"operationId": "DeleteGoal",
"parameters": [
{
"name": "goal_id",
"in": "path",
"description": "900e-462d-a849-4a216b06d930 (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"e53a033c"
]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/goal/{goal_id}/key_result": {
"post": {
"summary": "Create Key Result",
"tags": [
"Goals"
],
"description": "Add a Target to a Goal.",
"operationId": "CreateKeyResult",
"parameters": [
{
"name": "goal_id",
"in": "path",
"description": "900e-462d-a849-4a216b06d930 (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"e53a033c"
]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateKeyResultrequest",
"required": [
"name",
"owners",
"type",
"steps_start",
"steps_end",
"unit",
"task_ids",
"list_ids"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"owners": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"type": {
"description": "Target (key result) types include: `number`, `currency`, `boolean`, `percentage`, or `automatic`.",
"type": "string"
},
"steps_start": {
"type": "integer",
"contentEncoding": "int32"
},
"steps_end": {
"type": "integer",
"contentEncoding": "int32"
},
"unit": {
"type": "string"
},
"task_ids": {
"description": "Enter an array of task IDs to link this target with one or more tasks.",
"type": "array",
"items": {
"type": "string"
}
},
"list_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Enter an array of List IDs to link this target with one or more Lists."
}
},
"examples": [
{
"name": "New Target Name",
"owners": [183],
"type": "number",
"steps_start": 0,
"steps_end": 10,
"unit": "km",
"task_ids": [],
"list_ids": []
}
]
},
"example": {
"name": "New Key Result Name",
"owners": [183],
"type": "number",
"steps_start": 0,
"steps_end": 10,
"unit": "km",
"task_ids": [],
"list_ids": []
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateKeyResultresponse",
"required": [
"key_result"
],
"type": "object",
"properties": {
"key_result": {
"title": "KeyResult",
"required": [
"id",
"goal_id",
"name",
"type",
"unit",
"creator",
"date_created",
"goal_pretty_id",
"percent_completed",
"completed",
"task_ids",
"subcategory_ids",
"owners",
"last_action"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"goal_id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"unit": {
"type": "string"
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"date_created": {
"type": "string"
},
"goal_pretty_id": {
"type": "string"
},
"percent_completed": {
"type": [
"string",
"null"
]
},
"completed": {
"type": "boolean"
},
"task_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"subcategory_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"owners": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1goal~1%7Bgoal_id%7D/get/responses/200/content/application~1json/schema/properties/goal/properties/owners/items"
},
"description": ""
},
"last_action": {
"title": "LastAction",
"required": [
"id",
"key_result_id",
"userid",
"date_modified",
"steps_taken",
"note",
"steps_before",
"steps_current"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key_result_id": {
"type": "string"
},
"userid": {
"type": "integer",
"contentEncoding": "int32"
},
"date_modified": {
"type": "string"
},
"steps_taken": {
"type": [
"string",
"null"
]
},
"note": {
"type": "string"
},
"steps_before": {
"type": [
"string",
"null"
]
},
"steps_current": {
"type": [
"string",
"null"
]
}
},
"examples": [
{
"id": "d3183d0f-5cbd-4158-b015-71465f1df269",
"key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
"userid": 183,
"date_modified": "1568062902048",
"steps_taken": null,
"note": "Created Key Result",
"steps_before": null,
"steps_current": null
}
]
}
},
"examples": [
{
"id": "947d46ed-8480-49bc-8c57-e569747efe93",
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"creator": 183,
"date_created": "1568062902048",
"goal_pretty_id": "6",
"percent_completed": null,
"completed": false,
"task_ids": [],
"subcategory_ids": [],
"owners": [
{
"id": 183,
"username": "John Doe",
"email": "example@email.com",
"color": "#827718",
"profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg",
"initials": "JK"
}
],
"last_action": {
"id": "d3183d0f-5cbd-4158-b015-71465f1df269",
"key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
"userid": 183,
"date_modified": "1568062902048",
"steps_taken": null,
"note": "Created Key Result",
"steps_before": null,
"steps_current": null
}
}
]
}
},
"examples": [
{
"key_result": {
"id": "947d46ed-8480-49bc-8c57-e569747efe93",
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"creator": 183,
"date_created": "1568062902048",
"goal_pretty_id": "6",
"percent_completed": null,
"completed": false,
"task_ids": [],
"subcategory_ids": [],
"owners": [
{
"id": 183,
"username": "John Doe",
"email": "example@email.com",
"color": "#827718",
"profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg",
"initials": "JK"
}
],
"last_action": {
"id": "d3183d0f-5cbd-4158-b015-71465f1df269",
"key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
"userid": 183,
"date_modified": "1568062902048",
"steps_taken": null,
"note": "Created Key Result",
"steps_before": null,
"steps_current": null
}
}
}
]
},
"example": {
"key_result": {
"id": "947d46ed-8480-49bc-8c57-e569747efe93",
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"creator": 183,
"date_created": "1568062902048",
"goal_pretty_id": "6",
"percent_completed": null,
"completed": false,
"task_ids": [],
"subcategory_ids": [],
"owners": [
{
"id": 183,
"username": "John Doe",
"email": "example@email.com",
"color": "#827718",
"profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg",
"initials": "JK"
}
],
"last_action": {
"id": "d3183d0f-5cbd-4158-b015-71465f1df269",
"key_result_id": "947d46ed-8480-49bc-8c57-e569747efe93",
"userid": 183,
"date_modified": "1568062902048",
"steps_taken": null,
"note": "Created Key Result",
"steps_before": null,
"steps_current": null
}
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/key_result/{key_result_id}": {
"put": {
"summary": "Edit Key Result",
"tags": [
"Goals"
],
"description": "Update a Target.",
"operationId": "EditKeyResult",
"parameters": [
{
"name": "key_result_id",
"in": "path",
"description": "8480-49bc-8c57-e569747efe93 (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"947d46ed"
]
}
}
],
"requestBody": {
"description": "All properties available in the Create Key Result endpoint may also be used along with the additional properties below.",
"content": {
"application/json": {
"schema": {
"title": "EditKeyResultrequest",
"required": [
"steps_current",
"note"
],
"type": "object",
"properties": {
"steps_current": {
"type": "integer",
"contentEncoding": "int32"
},
"note": {
"type": "string"
}
},
"examples": [
{
"steps_current": 5,
"note": "Target achieved"
}
]
},
"example": {
"steps_current": 5,
"note": "Target achieved"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "EditKeyResultresponse",
"required": [
"key_result"
],
"type": "object",
"properties": {
"key_result": {
"title": "KeyResult1",
"required": [
"id",
"goal_id",
"name",
"type",
"unit",
"creator",
"date_created",
"goal_pretty_id",
"percent_completed",
"completed",
"task_ids",
"subcategory_ids",
"owners",
"last_action"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"goal_id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"unit": {
"type": "string"
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"date_created": {
"type": "string"
},
"goal_pretty_id": {
"type": "string"
},
"percent_completed": {
"type": [
"string",
"null"
]
},
"completed": {
"type": "boolean"
},
"task_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"subcategory_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"owners": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1goal~1%7Bgoal_id%7D/get/responses/200/content/application~1json/schema/properties/goal/properties/owners/items"
},
"description": ""
},
"last_action": {
"title": "LastAction1",
"required": [
"id",
"key_result_id",
"userid",
"date_modified",
"steps_taken",
"note",
"steps_before",
"steps_current",
"steps_before_float",
"steps_taken_float",
"steps_current_float"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key_result_id": {
"type": "string"
},
"userid": {
"type": "integer",
"contentEncoding": "int32"
},
"date_modified": {
"type": "string"
},
"steps_taken": {
"type": [
"string",
"null"
]
},
"note": {
"type": "string"
},
"steps_before": {
"type": [
"string",
"null"
]
},
"steps_current": {
"type": [
"string",
"null"
]
},
"steps_before_float": {
"type": "integer",
"contentEncoding": "int32"
},
"steps_taken_float": {
"type": "integer",
"contentEncoding": "int32"
},
"steps_current_float": {
"type": [
"string",
"null"
]
}
},
"examples": [
{
"id": "e889858b-a023-46cc-968a-cac32fd04c1e",
"key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8",
"userid": 183,
"date_modified": "1568122776851",
"steps_taken": null,
"note": "Target achieved",
"steps_before": null,
"steps_current": null,
"steps_before_float": 0,
"steps_taken_float": 5,
"steps_current_float": null
}
]
}
},
"examples": [
{
"id": "947d46ed-8480-49bc-8c57-e569747efe93",
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"creator": 183,
"date_created": "1568062902048",
"goal_pretty_id": "6",
"percent_completed": null,
"completed": false,
"task_ids": [],
"subcategory_ids": [],
"owners": [
{
"id": 183,
"username": "John Doe",
"email": "example@email.com",
"color": "#827718",
"profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg",
"initials": "JK"
}
],
"last_action": {
"id": "e889858b-a023-46cc-968a-cac32fd04c1e",
"key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8",
"userid": 183,
"date_modified": "1568122776851",
"steps_taken": null,
"note": "Target achieved",
"steps_before": null,
"steps_current": null,
"steps_before_float": 0,
"steps_taken_float": 5,
"steps_current_float": null
}
}
]
}
},
"examples": [
{
"key_result": {
"id": "947d46ed-8480-49bc-8c57-e569747efe93",
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"creator": 183,
"date_created": "1568062902048",
"goal_pretty_id": "6",
"percent_completed": null,
"completed": false,
"task_ids": [],
"subcategory_ids": [],
"owners": [
{
"id": 183,
"username": "John Doe",
"email": "example@email.com",
"color": "#827718",
"profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg",
"initials": "JK"
}
],
"last_action": {
"id": "e889858b-a023-46cc-968a-cac32fd04c1e",
"key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8",
"userid": 183,
"date_modified": "1568122776851",
"steps_taken": null,
"note": "Target achieved",
"steps_before": null,
"steps_current": null,
"steps_before_float": 0,
"steps_taken_float": 5,
"steps_current_float": null
}
}
}
]
},
"example": {
"key_result": {
"id": "947d46ed-8480-49bc-8c57-e569747efe93",
"goal_id": "e53a033c-900e-462d-a849-4a216b06d930",
"name": "New Key Result Name",
"type": "number",
"unit": "km",
"creator": 183,
"date_created": "1568062902048",
"goal_pretty_id": "6",
"percent_completed": null,
"completed": false,
"task_ids": [],
"subcategory_ids": [],
"owners": [
{
"id": 183,
"username": "John Doe",
"email": "example@email.com",
"color": "#827718",
"profilePicture": "https://attachments.clickup.com/profilePictures/183_nx1.jpg",
"initials": "JK"
}
],
"last_action": {
"id": "e889858b-a023-46cc-968a-cac32fd04c1e",
"key_result_id": "19c7a55e-537e-4bc9-b741-08df05a5bda8",
"userid": 183,
"date_modified": "1568122776851",
"steps_taken": null,
"note": "Target achieved",
"steps_before": null,
"steps_current": null,
"steps_before_float": 0,
"steps_taken_float": 5,
"steps_current_float": null
}
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Key Result",
"tags": [
"Goals"
],
"description": "Delete a target from a Goal.",
"operationId": "DeleteKeyResult",
"parameters": [
{
"name": "key_result_id",
"in": "path",
"description": "8480-49bc-8c57-e569747efe93 (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"947d46ed"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/guest": {
"post": {
"summary": "Invite Guest To Workspace",
"tags": [
"Guests"
],
"description": "Invite a guest to join a Workspace. To invite a member to your Workspace, use the [Invite User to Workspace](ref:inviteusertoworkspace) endpoint. \\\n \\\nYou'll also need to grant the guest access to specific items using the following endpoints: [Add Guest to Folder](ref:addguesttofolder), [Add Guest to List](ref:addguesttolist), or [Add Guest to Task](ref:addguesttotask). \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*",
"operationId": "InviteGuestToWorkspace",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "InviteGuestToWorkspacerequest",
"required": [
"email"
],
"type": "object",
"properties": {
"email": {
"type": "string"
},
"can_edit_tags": {
"type": "boolean"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
},
"can_create_views": {
"type": "boolean"
},
"can_see_points_estimated": {
"type": "boolean"
},
"custom_role_id": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"email": "guest@example.com",
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_create_views": true,
"can_see_points_estimated": true,
"custom_role_id": 12345
}
]
},
"example": {
"email": "guest@example.com",
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_create_views": true,
"custom_role_id": 12345
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "InviteGuestToWorkspaceresponse",
"required": [
"team"
],
"type": "object",
"properties": {
"team": {
"title": "Team1",
"required": [
"id",
"name",
"color",
"avatar",
"members",
"roles"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"avatar": {
"type": [
"string",
"null"
]
},
"members": {
"type": "array",
"items": {
"title": "Member4",
"required": [
"user",
"invited_by",
"can_see_time_spent",
"can_see_time_estimated",
"can_edit_tags",
"can_create_views"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1guest~1%7Bguest_id%7D/put/responses/200/content/application~1json/schema/properties/guest/properties/user"
},
"invited_by": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
},
"can_edit_tags": {
"type": "boolean"
},
"can_create_views": {
"type": "boolean"
},
"can_see_points_estimated": {
"type": "boolean"
}
},
"examples": [
{
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"custom_role": {
"id": 12345,
"name": "guest custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"can_create_views": true,
"can_see_points_estimated": true
}
]
},
"description": ""
},
"roles": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user/post/responses/200/content/application~1json/schema/properties/team/properties/roles/items"
},
"description": ""
}
},
"examples": [
{
"id": "333",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": [
{
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"custom_role": {
"id": 12345,
"name": "guest custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_see_points_estimated": true,
"can_edit_tags": true,
"can_create_views": true
}
],
"roles": [
{
"id": 1,
"name": "owner",
"custom": false
},
{
"id": 2,
"name": "admin",
"custom": false
},
{
"id": 3,
"name": "member",
"custom": false
},
{
"id": 4,
"name": "guest",
"custom": false
},
{
"id": 998877,
"name": "member custom",
"inherited_role": 3,
"custom": true
},
{
"id": 112233,
"name": "admin custom",
"inherited_role": 2,
"custom": true
},
{
"id": 12345,
"name": "guest custom",
"inherited_role": 4,
"custom": true
}
]
}
]
}
},
"examples": [
{
"team": {
"id": "333",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": [
{
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"custom_role": {
"id": 12345,
"name": "guest custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_see_points_estimated": true,
"can_edit_tags": true,
"can_create_views": true
}
],
"roles": [
{
"id": 1,
"name": "owner",
"custom": false
},
{
"id": 2,
"name": "admin",
"custom": false
},
{
"id": 3,
"name": "member",
"custom": false
},
{
"id": 4,
"name": "guest",
"custom": false
},
{
"id": 998877,
"name": "member custom",
"inherited_role": 3,
"custom": true
},
{
"id": 112233,
"name": "admin custom",
"inherited_role": 2,
"custom": true
},
{
"id": 12345,
"name": "guest custom",
"inherited_role": 4,
"custom": true
}
]
}
}
]
},
"example": {
"team": {
"id": "333",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": [
{
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"custom_role": {
"id": 12345,
"name": "guest custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"can_create_views": true,
"can_see_points_estimated": true
}
],
"roles": [
{
"id": 1,
"name": "owner",
"custom": false
},
{
"id": 2,
"name": "admin",
"custom": false
},
{
"id": 3,
"name": "member",
"custom": false
},
{
"id": 4,
"name": "guest",
"custom": false
},
{
"id": 998877,
"name": "member custom",
"inherited_role": 3,
"custom": true
},
{
"id": 112233,
"name": "admin custom",
"inherited_role": 2,
"custom": true
},
{
"id": 12345,
"name": "guest custom",
"inherited_role": 4,
"custom": true
}
]
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/guest/{guest_id}": {
"get": {
"summary": "Get Guest",
"tags": [
"Guests"
],
"description": "View information about a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*",
"operationId": "GetGuest",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "guest_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [403]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"contentMediaType": "application/json"
}
}
}
}
},
"deprecated": false
},
"put": {
"summary": "Edit Guest On Workspace",
"tags": [
"Guests"
],
"description": "Configure options for a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*",
"operationId": "EditGuestOnWorkspace",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "guest_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [403]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "EditGuestOnWorkspacerequest",
"type": "object",
"properties": {
"can_see_points_estimated": {
"type": "boolean"
},
"can_edit_tags": {
"type": "boolean"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
},
"can_create_views": {
"type": "boolean"
},
"custom_role_id": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"can_see_points_estimated": true,
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_create_views": true,
"custom_role_id": 12345
}
]
},
"example": {
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_see_points_estimated": true,
"can_create_views": true,
"custom_role_id": 12345
}
}
},
"required": false
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "EditGuestOnWorkspaceresponse",
"required": [
"guest"
],
"type": "object",
"properties": {
"guest": {
"title": "Guest",
"type": "object",
"properties": {
"user": {
"title": "User5",
"required": [
"id",
"username",
"email",
"color",
"profilePicture",
"initials",
"role",
"custom_role",
"last_active",
"date_joined",
"date_invited"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": [
"string",
"null"
]
},
"email": {
"type": "string"
},
"color": {
"type": [
"string",
"null"
]
},
"profilePicture": {
"type": [
"string",
"null"
]
},
"initials": {
"type": "string"
},
"role": {
"type": "integer",
"contentEncoding": "int32"
},
"custom_role": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/user/properties/custom_role"
},
"last_active": {
"type": [
"string",
"null"
]
},
"date_joined": {
"type": [
"string",
"null"
]
},
"date_invited": {
"type": "string"
}
},
"examples": [
{
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"custom_role": {
"id": 12345,
"name": "guest custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
}
]
},
"invited_by": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
},
"can_see_points_estimated": {
"type": "boolean"
},
"can_edit_tags": {
"type": "boolean"
},
"can_create_views": {
"type": "boolean"
},
"shared": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/shared"
}
},
"examples": [
{
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"custom_role": {
"id": 12345,
"name": "guest custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_see_points_estimated": true,
"can_edit_tags": true,
"can_create_views": true,
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
]
}
},
"examples": [
{
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"custom_role": {
"id": 12345,
"name": "guest custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"can_create_views": true,
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
}
]
},
"example": {
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"custom_role": {
"id": 12345,
"name": "guest custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"can_create_views": true,
"can_see_points_estimated": true,
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Remove Guest From Workspace",
"tags": [
"Guests"
],
"description": "Revoke a guest's access to a Workspace. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*",
"operationId": "RemoveGuestFromWorkspace",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "guest_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [403]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "RemoveGuestFromWorkspaceresponse",
"required": [
"team"
],
"type": "object",
"properties": {
"team": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/delete/responses/200/content/application~1json/schema/properties/team"
}
},
"examples": [
{
"team": {
"id": "333",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
}
}
]
},
"example": {
"team": {
"id": "333",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/task/{task_id}/guest/{guest_id}": {
"post": {
"summary": "Add Guest To Task",
"tags": [
"Guests"
],
"description": "Share a task with a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*",
"operationId": "AddGuestToTask",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"c04"
]
}
},
{
"name": "guest_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [403]
}
},
{
"name": "include_shared",
"in": "query",
"description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [false]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "AddGuestToTaskrequest",
"required": [
"permission_level"
],
"type": "object",
"properties": {
"permission_level": {
"description": "Can be `read` (view only), `comment`, `edit`, or `create` (full).",
"type": "string"
}
},
"examples": [
{
"permission_level": "read"
}
]
},
"example": {
"permission_level": "read"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "AddGuestToTaskresponse",
"required": [
"guest"
],
"type": "object",
"properties": {
"guest": {
"title": "Guest1",
"required": [
"user",
"invited_by",
"can_see_time_spent",
"can_see_time_estimated",
"can_edit_tags",
"shared"
],
"type": "object",
"properties": {
"user": {
"title": "User7",
"required": [
"id",
"username",
"email",
"color",
"profilePicture",
"initials",
"role",
"last_active",
"date_joined",
"date_invited"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": [
"string",
"null"
]
},
"email": {
"type": "string"
},
"color": {
"type": [
"string",
"null"
]
},
"profilePicture": {
"type": [
"string",
"null"
]
},
"initials": {
"type": "string"
},
"role": {
"type": "integer",
"contentEncoding": "int32"
},
"last_active": {
"type": [
"string",
"null"
]
},
"date_joined": {
"type": [
"string",
"null"
]
},
"date_invited": {
"type": "string"
}
},
"examples": [
{
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
}
]
},
"invited_by": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
},
"can_edit_tags": {
"type": "boolean"
},
"shared": {
"title": "Shared1",
"required": [
"tasks",
"lists",
"folders"
],
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"title": "Task2",
"required": [
"id",
"name",
"status",
"orderindex",
"date_created",
"date_updated",
"date_closed",
"archived",
"creator",
"assignees",
"checklists",
"tags",
"parent",
"priority",
"due_date",
"start_date",
"points",
"time_estimate",
"custom_fields",
"dependencies",
"team_id",
"url",
"permission_level",
"list",
"folder",
"space"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"orderindex": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"date_closed": {
"type": [
"string",
"null"
]
},
"archived": {
"type": "boolean"
},
"creator": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator"
},
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"checklists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"parent": {
"type": [
"string",
"null"
]
},
"priority": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority"
},
"due_date": {
"type": "string"
},
"start_date": {
"type": [
"string",
"null"
]
},
"points": {
"type": [
"string",
"null"
]
},
"time_estimate": {
"type": [
"string",
"null"
]
},
"custom_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"dependencies": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"team_id": {
"type": "string"
},
"url": {
"type": "string"
},
"permission_level": {
"type": "string"
},
"list": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1task/get/responses/200/content/application~1json/schema/properties/tasks/items/properties/list"
},
"folder": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder"
},
"space": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space"
}
},
"examples": [
{
"id": "c04",
"name": "Task Name",
"status": {
"status": "Open",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"orderindex": "0",
"date_created": "1574718405408",
"date_updated": "1574722145869",
"date_closed": null,
"archived": false,
"creator": {
"id": 183,
"username": "Jerry",
"color": "#827718",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": {
"id": "1",
"priority": "urgent",
"color": "#f50000",
"orderindex": "1"
},
"due_date": "1508369194377",
"start_date": null,
"points": null,
"time_estimate": null,
"custom_fields": [],
"dependencies": [],
"team_id": "108",
"url": "https://app.clickup.com/t/c04",
"permission_level": "read",
"list": {
"id": "1752",
"name": "Shared with me",
"access": false
},
"folder": {
"id": "1217",
"name": "Shared with me",
"hidden": false,
"access": false
},
"space": {
"id": "380"
}
}
]
},
"description": ""
},
"lists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"examples": [
{
"tasks": [
{
"id": "c04",
"name": "Task Name",
"status": {
"status": "Open",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"orderindex": "0",
"date_created": "1574718405408",
"date_updated": "1574722145869",
"date_closed": null,
"archived": false,
"creator": {
"id": 183,
"username": "Jerry",
"color": "#827718",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": {
"id": "1",
"priority": "urgent",
"color": "#f50000",
"orderindex": "1"
},
"due_date": "1508369194377",
"start_date": null,
"points": null,
"time_estimate": null,
"custom_fields": [],
"dependencies": [],
"team_id": "108",
"url": "https://app.clickup.com/t/c04",
"permission_level": "read",
"list": {
"id": "1752",
"name": "Shared with me",
"access": false
},
"folder": {
"id": "1217",
"name": "Shared with me",
"hidden": false,
"access": false
},
"space": {
"id": "380"
}
}
],
"lists": [],
"folders": []
}
]
}
},
"examples": [
{
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [
{
"id": "c04",
"name": "Task Name",
"status": {
"status": "Open",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"orderindex": "0",
"date_created": "1574718405408",
"date_updated": "1574722145869",
"date_closed": null,
"archived": false,
"creator": {
"id": 183,
"username": "Jerry",
"color": "#827718",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": {
"id": "1",
"priority": "urgent",
"color": "#f50000",
"orderindex": "1"
},
"due_date": "1508369194377",
"start_date": null,
"points": null,
"time_estimate": null,
"custom_fields": [],
"dependencies": [],
"team_id": "108",
"url": "https://app.clickup.com/t/c04",
"permission_level": "read",
"list": {
"id": "1752",
"name": "Shared with me",
"access": false
},
"folder": {
"id": "1217",
"name": "Shared with me",
"hidden": false,
"access": false
},
"space": {
"id": "380"
}
}
],
"lists": [],
"folders": []
}
}
]
}
},
"examples": [
{
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [
{
"id": "c04",
"name": "Task Name",
"status": {
"status": "Open",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"orderindex": "0",
"date_created": "1574718405408",
"date_updated": "1574722145869",
"date_closed": null,
"archived": false,
"creator": {
"id": 183,
"username": "Jerry",
"color": "#827718",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": {
"id": "1",
"priority": "urgent",
"color": "#f50000",
"orderindex": "1"
},
"due_date": "1508369194377",
"start_date": null,
"points": null,
"time_estimate": null,
"custom_fields": [],
"dependencies": [],
"team_id": "108",
"url": "https://app.clickup.com/t/c04",
"permission_level": "read",
"list": {
"id": "1752",
"name": "Shared with me",
"access": false
},
"folder": {
"id": "1217",
"name": "Shared with me",
"hidden": false,
"access": false
},
"space": {
"id": "380"
}
}
],
"lists": [],
"folders": []
}
}
}
]
},
"example": {
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [
{
"id": "c04",
"name": "Task Name",
"status": {
"status": "Open",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"orderindex": "0",
"date_created": "1574718405408",
"date_updated": "1574722145869",
"date_closed": null,
"archived": false,
"creator": {
"id": 183,
"username": "Jerry",
"color": "#827718",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": {
"id": "1",
"priority": "urgent",
"color": "#f50000",
"orderindex": "1"
},
"due_date": "1508369194377",
"start_date": null,
"points": null,
"time_estimate": null,
"custom_fields": [],
"dependencies": [],
"team_id": "108",
"url": "https://app.clickup.com/t/c04",
"permission_level": "read",
"list": {
"id": "1752",
"name": "Shared with me",
"access": false
},
"folder": {
"id": "1217",
"name": "Shared with me",
"hidden": false,
"access": false
},
"space": {
"id": "380"
}
}
],
"lists": [],
"folders": []
}
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Remove Guest From Task",
"tags": [
"Guests"
],
"description": "Revoke a guest's access to a task. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*",
"operationId": "RemoveGuestFromTask",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"c04"
]
}
},
{
"name": "guest_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [403]
}
},
{
"name": "include_shared",
"in": "query",
"description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [false]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "RemoveGuestFromTaskresponse",
"required": [
"guest"
],
"type": "object",
"properties": {
"guest": {
"title": "Guest2",
"required": [
"user",
"invited_by",
"can_see_time_spent",
"can_see_time_estimated",
"can_edit_tags",
"shared"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/post/responses/200/content/application~1json/schema/properties/guest/properties/user"
},
"invited_by": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
},
"can_edit_tags": {
"type": "boolean"
},
"shared": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/shared"
}
},
"examples": [
{
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
]
}
},
"examples": [
{
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
}
]
},
"example": {
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/list/{list_id}/guest/{guest_id}": {
"post": {
"summary": "Add Guest To List",
"tags": [
"Guests"
],
"description": "Share a List with a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*",
"operationId": "AddGuestToList",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [1427]
}
},
{
"name": "guest_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [403]
}
},
{
"name": "include_shared",
"in": "query",
"description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [false]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "AddGuestToListrequest",
"required": [
"permission_level"
],
"type": "object",
"properties": {
"permission_level": {
"description": "Can be `read` (view only), `comment`, `edit`, or `create` (full).",
"type": "string"
}
},
"examples": [
{
"permission_level": "read"
}
]
},
"example": {
"permission_level": "read"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "AddGuestToListresponse",
"required": [
"guest"
],
"type": "object",
"properties": {
"guest": {
"title": "Guest3",
"required": [
"user",
"invited_by",
"can_see_time_spent",
"can_see_time_estimated",
"can_edit_tags",
"shared"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/post/responses/200/content/application~1json/schema/properties/guest/properties/user"
},
"invited_by": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
},
"can_edit_tags": {
"type": "boolean"
},
"shared": {
"title": "Shared3",
"required": [
"tasks",
"lists",
"folders"
],
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"lists": {
"type": "array",
"items": {
"title": "List3",
"required": [
"id",
"name",
"orderindex",
"status",
"priority",
"assignee",
"task_count",
"due_date",
"start_date",
"archived",
"override_statuses",
"statuses",
"permission_level"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"status": {
"type": [
"string",
"null"
]
},
"priority": {
"type": [
"string",
"null"
]
},
"assignee": {
"type": [
"string",
"null"
]
},
"task_count": {
"type": "string"
},
"due_date": {
"type": [
"string",
"null"
]
},
"start_date": {
"type": [
"string",
"null"
]
},
"archived": {
"type": "boolean"
},
"override_statuses": {
"type": "boolean"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"description": ""
},
"permission_level": {
"type": "string"
}
},
"examples": [
{
"id": "1427",
"name": "List Name",
"orderindex": 1,
"status": null,
"priority": null,
"assignee": null,
"task_count": "5",
"due_date": null,
"start_date": null,
"archived": false,
"override_statuses": true,
"statuses": [
{
"status": "Open",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "Closed",
"orderindex": 5,
"color": "#6bc950",
"type": "closed"
}
],
"permission_level": "read"
}
]
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"examples": [
{
"tasks": [],
"lists": [
{
"id": "1427",
"name": "List Name",
"orderindex": 1,
"status": null,
"priority": null,
"assignee": null,
"task_count": "5",
"due_date": null,
"start_date": null,
"archived": false,
"override_statuses": true,
"statuses": [
{
"status": "Open",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "Closed",
"orderindex": 5,
"color": "#6bc950",
"type": "closed"
}
],
"permission_level": "read"
}
],
"folders": []
}
]
}
},
"examples": [
{
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [],
"lists": [
{
"id": "1427",
"name": "List Name",
"orderindex": 1,
"status": null,
"priority": null,
"assignee": null,
"task_count": "5",
"due_date": null,
"start_date": null,
"archived": false,
"override_statuses": true,
"statuses": [
{
"status": "Open",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "Closed",
"orderindex": 5,
"color": "#6bc950",
"type": "closed"
}
],
"permission_level": "read"
}
],
"folders": []
}
}
]
}
},
"examples": [
{
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [],
"lists": [
{
"id": "1427",
"name": "List Name",
"orderindex": 1,
"status": null,
"priority": null,
"assignee": null,
"task_count": "5",
"due_date": null,
"start_date": null,
"archived": false,
"override_statuses": true,
"statuses": [
{
"status": "Open",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "Closed",
"orderindex": 5,
"color": "#6bc950",
"type": "closed"
}
],
"permission_level": "read"
}
],
"folders": []
}
}
}
]
},
"example": {
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [],
"lists": [
{
"id": "1427",
"name": "List Name",
"orderindex": 1,
"status": null,
"priority": null,
"assignee": null,
"task_count": "5",
"due_date": null,
"start_date": null,
"archived": false,
"override_statuses": true,
"statuses": [
{
"status": "Open",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "Closed",
"orderindex": 5,
"color": "#6bc950",
"type": "closed"
}
],
"permission_level": "read"
}
],
"folders": []
}
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Remove Guest From List",
"tags": [
"Guests"
],
"description": "Revoke a guest's access to a List.\\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*",
"operationId": "RemoveGuestFromList",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [1427]
}
},
{
"name": "guest_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [403]
}
},
{
"name": "include_shared",
"in": "query",
"description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [false]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "RemoveGuestFromListresponse",
"required": [
"guest"
],
"type": "object",
"properties": {
"guest": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/delete/responses/200/content/application~1json/schema/properties/guest"
}
},
"examples": [
{
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
}
]
},
"example": {
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/folder/{folder_id}/guest/{guest_id}": {
"post": {
"summary": "Add Guest To Folder",
"tags": [
"Guests"
],
"description": "Share a Folder with a guest. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*",
"operationId": "AddGuestToFolder",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [1057]
}
},
{
"name": "guest_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [403]
}
},
{
"name": "include_shared",
"in": "query",
"description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [false]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "AddGuestToFolderrequest",
"required": [
"permission_level"
],
"type": "object",
"properties": {
"permission_level": {
"description": "Can be `read` (view only), `comment`, `edit`, or `create` (full).",
"type": "string"
}
},
"examples": [
{
"permission_level": "read"
}
]
},
"example": {
"permission_level": "read"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "AddGuestToFolderresponse",
"required": [
"guest"
],
"type": "object",
"properties": {
"guest": {
"title": "Guest5",
"required": [
"user",
"invited_by",
"can_see_time_spent",
"can_see_time_estimated",
"can_edit_tags",
"shared"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/post/responses/200/content/application~1json/schema/properties/guest/properties/user"
},
"invited_by": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
},
"can_edit_tags": {
"type": "boolean"
},
"shared": {
"title": "Shared5",
"required": [
"tasks",
"lists",
"folders"
],
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"lists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"title": "Folder4",
"required": [
"id",
"name",
"orderindex",
"override_statuses",
"hidden",
"task_count",
"archived",
"statuses",
"lists",
"permission_level"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"override_statuses": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
},
"task_count": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"description": ""
},
"lists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"permission_level": {
"type": "string"
}
},
"examples": [
{
"id": "1057",
"name": "Folder Name",
"orderindex": 5,
"override_statuses": true,
"hidden": false,
"task_count": "20",
"archived": false,
"statuses": [
{
"status": "Open",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "Closed",
"orderindex": 5,
"color": "#6bc950",
"type": "closed"
}
],
"lists": [],
"permission_level": "read"
}
]
},
"description": ""
}
},
"examples": [
{
"tasks": [],
"lists": [],
"folders": [
{
"id": "1057",
"name": "Folder Name",
"orderindex": 5,
"override_statuses": true,
"hidden": false,
"task_count": "20",
"archived": false,
"statuses": [
{
"status": "Open",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "Closed",
"orderindex": 5,
"color": "#6bc950",
"type": "closed"
}
],
"lists": [],
"permission_level": "read"
}
]
}
]
}
},
"examples": [
{
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [],
"lists": [],
"folders": [
{
"id": "1057",
"name": "Folder Name",
"orderindex": 5,
"override_statuses": true,
"hidden": false,
"task_count": "20",
"archived": false,
"statuses": [
{
"status": "Open",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "Closed",
"orderindex": 5,
"color": "#6bc950",
"type": "closed"
}
],
"lists": [],
"permission_level": "read"
}
]
}
}
]
}
},
"examples": [
{
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [],
"lists": [],
"folders": [
{
"id": "1057",
"name": "Folder Name",
"orderindex": 5,
"override_statuses": true,
"hidden": false,
"task_count": "20",
"archived": false,
"statuses": [
{
"status": "Open",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "Closed",
"orderindex": 5,
"color": "#6bc950",
"type": "closed"
}
],
"lists": [],
"permission_level": "read"
}
]
}
}
}
]
},
"example": {
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [],
"lists": [],
"folders": [
{
"id": "1057",
"name": "Folder Name",
"orderindex": 5,
"override_statuses": true,
"hidden": false,
"task_count": "20",
"archived": false,
"statuses": [
{
"status": "Open",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "Closed",
"orderindex": 5,
"color": "#6bc950",
"type": "closed"
}
],
"lists": [],
"permission_level": "read"
}
]
}
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Remove Guest From Folder",
"tags": [
"Guests"
],
"description": "Revoke a guest's access to a Folder. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*",
"operationId": "RemoveGuestFromFolder",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [1057]
}
},
{
"name": "guest_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [403]
}
},
{
"name": "include_shared",
"in": "query",
"description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [false]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "RemoveGuestFromFolderresponse",
"required": [
"guest"
],
"type": "object",
"properties": {
"guest": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1guest~1%7Bguest_id%7D/delete/responses/200/content/application~1json/schema/properties/guest"
}
},
"examples": [
{
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
}
]
},
"example": {
"guest": {
"user": {
"id": 184,
"username": null,
"email": "guest@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 4,
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"can_see_time_spent": true,
"can_see_time_estimated": true,
"can_edit_tags": true,
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/folder/{folder_id}/list": {
"get": {
"summary": "Get Lists",
"tags": [
"Lists"
],
"description": "View the Lists within a Folder.",
"operationId": "GetLists",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [456]
}
},
{
"name": "archived",
"in": "query",
"description": "",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [false]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetListsresponse",
"required": [
"lists"
],
"type": "object",
"properties": {
"lists": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D~1list/get/responses/200/content/application~1json/schema/properties/lists/items"
},
"description": ""
}
}
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create List",
"tags": [
"Lists"
],
"description": "Add a new List to a Folder.",
"operationId": "CreateList",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [456]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateListrequest",
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"content": {
"type": "string"
},
"markdown_content": {
"type": "string",
"description": "Use `markdown_content` instead of `content` to format your List description."
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"due_date_time": {
"type": "boolean"
},
"priority": {
"type": "integer",
"contentEncoding": "int32"
},
"assignee": {
"description": "Include a `user_id` to assign this List.",
"type": "integer",
"contentEncoding": "int32"
},
"status": {
"description": "**Status** refers to the List color rather than the task Statuses available in the List.",
"type": "string"
}
},
"examples": [
{
"name": "New List Name",
"content": "New List Content",
"markdown_content": "# This is markdown\n ***bold and italicized text***",
"due_date": 1567780450202,
"due_date_time": false,
"priority": 1,
"assignee": 183,
"status": "red"
}
]
},
"example": {
"name": "New List Name",
"content": "New List Content",
"markdown_content": "# This is markdown\n ***bold and italicized text***",
"due_date": 1567780450202,
"due_date_time": false,
"priority": 1,
"assignee": 183,
"status": "red"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateListresponse",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"content": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"priority": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/priority"
},
"assignee": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D~1list/post/responses/200/content/application~1json/schema/properties/assignee"
},
"task_count": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": "string"
},
"due_date_time": {
"type": "boolean"
},
"start_date": {
"type": [
"string",
"null"
]
},
"start_date_time": {
"type": [
"string",
"null"
]
},
"folder": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder"
},
"space": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"description": ""
},
"inbound_address": {
"type": "string"
}
},
"examples": [
{
"id": "124",
"name": "New List Name",
"orderindex": 1,
"content": "New List Content",
"status": {
"status": "red",
"color": "#e50000",
"hide_label": true
},
"priority": {
"priority": "urgent",
"color": "#f50000"
},
"assignee": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"task_count": null,
"due_date": "1567780450202",
"due_date_time": false,
"start_date": null,
"start_date_time": null,
"folder": {
"id": "456",
"name": "Folder Name",
"hidden": false,
"access": true
},
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "complete",
"orderindex": 1,
"color": "#6bc950",
"type": "closed"
}
],
"inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com"
}
]
},
"example": {
"id": "124",
"name": "New List Name",
"orderindex": 1,
"content": "New List Content",
"status": {
"status": "red",
"color": "#e50000",
"hide_label": true
},
"priority": {
"priority": "urgent",
"color": "#f50000"
},
"assignee": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"task_count": null,
"due_date": "1567780450202",
"due_date_time": false,
"start_date": null,
"start_date_time": null,
"folder": {
"id": "456",
"name": "Folder Name",
"hidden": false,
"access": true
},
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "complete",
"orderindex": 1,
"color": "#6bc950",
"type": "closed"
}
],
"inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com"
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/space/{space_id}/folder_template/{template_id}": {
"post": {
"summary": "Create Folder from template",
"description": "Create a new Folder using a Folder template within a Space. This endpoint allows you to create a folder with all its nested assets (lists, tasks, etc.) from a predefined template available in your Workspace. Publicly shared templates must be [added to your Workspace](https://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library) before you can use them with the public API.\nThis request can be run asynchronously or synchronously via the `return_immediately` parameter.\n",
"operationId": "CreateFolderFromTemplate",
"tags": [
"Folders"
],
"parameters": [
{
"in": "path",
"name": "space_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the Space where the Folder will be created"
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the Folder template to use."
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the new Folder"
},
"options": {
"type": "object",
"description": "Options for creating the Folder",
"properties": {
"return_immediately": {
"type": "boolean",
"description": "Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n",
"default": true
},
"content": {
"type": "string",
"description": "List description"
},
"time_estimate": {
"type": "boolean",
"description": "Include time (hours, minutes and seconds)"
},
"automation": {
"type": "boolean",
"description": "Import automation options"
},
"include_views": {
"type": "boolean",
"description": "Import views"
},
"old_due_date": {
"type": "boolean",
"description": "Import tasks due dates"
},
"old_start_date": {
"type": "boolean",
"description": "Import tasks start dates"
},
"old_followers": {
"type": "boolean",
"description": "Import tasks watchers"
},
"comment_attachments": {
"type": "boolean",
"description": "Import tasks comment attachments"
},
"recur_settings": {
"type": "boolean",
"description": "Import tasks recurring settings"
},
"old_tags": {
"type": "boolean",
"description": "Import tasks tags"
},
"old_statuses": {
"type": "boolean",
"description": "Import tasks status settings"
},
"subtasks": {
"type": "boolean",
"description": "Import tasks subtasks"
},
"custom_type": {
"type": "boolean",
"description": "Import tasks types"
},
"old_assignees": {
"type": "boolean",
"description": "Import tasks assignees"
},
"attachments": {
"type": "boolean",
"description": "Import tasks attachments"
},
"comment": {
"type": "boolean",
"description": "Import tasks comments"
},
"old_status": {
"type": "boolean",
"description": "Import tasks current statuses"
},
"external_dependencies": {
"type": "boolean",
"description": "Import tasks external dependencies"
},
"internal_dependencies": {
"type": "boolean",
"description": "Import tasks internal dependencies"
},
"priority": {
"type": "boolean",
"description": "Import tasks priority"
},
"custom_fields": {
"type": "boolean",
"description": "Import tasks Custom Fields"
},
"old_checklists": {
"type": "boolean",
"description": "Import tasks checklists"
},
"relationships": {
"type": "boolean",
"description": "Import tasks relationships"
},
"old_subtask_assignees": {
"type": "boolean",
"description": "Import tasks subtasks and assignees combination"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Project start date for remapping dates"
},
"due_date": {
"type": "string",
"format": "date-time",
"description": "Project due date for remapping dates"
},
"remap_start_date": {
"type": "boolean",
"description": "Remap start dates"
},
"skip_weekends": {
"type": "boolean",
"description": "Skip weekends when remapping dates"
},
"archived": {
"type": "integer",
"enum": [1, 2, null],
"description": "Include archived tasks (1 or 2 or null)"
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Folder created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the created Folder"
},
"folder": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the Folder"
},
"name": {
"type": "string",
"description": "Name of the Folder"
},
"orderindex": {
"type": "integer",
"description": "Order index of the Folder"
},
"override_statuses": {
"type": "boolean",
"description": "Whether the Folder overrides default statuses"
},
"hidden": {
"type": "boolean",
"description": "Whether the Folder is hidden"
},
"space": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the Space containing the Folder"
},
"name": {
"type": "string",
"description": "Name of the Space"
},
"access": {
"type": "boolean",
"description": "Whether the user has access to the Space"
}
}
},
"task_count": {
"type": "string",
"description": "Number of tasks in the Folder"
},
"archived": {
"type": "boolean",
"description": "Whether the Folder is archived"
},
"statuses": {
"type": "array",
"description": "List of statuses available in the Folder",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the status"
},
"status": {
"type": "string",
"description": "Name of the status"
},
"orderindex": {
"type": "integer",
"description": "Order index of the status"
},
"color": {
"type": "string",
"description": "Color code for the status"
},
"type": {
"type": "string",
"description": "Type of the status (closed, custom, open)"
}
}
}
},
"lists": {
"type": "array",
"description": "Lists contained in the Folder",
"items": {
"type": "object"
}
},
"permission_level": {
"type": "string",
"description": "Permission level for the current user"
}
}
}
},
"example": {
"id": 90114316773,
"folder": {
"id": "90114316773",
"name": "Projects",
"orderindex": 0,
"override_statuses": true,
"hidden": false,
"space": {
"id": "90112667046",
"name": "Client Facing",
"access": true
},
"task_count": "0",
"archived": false,
"statuses": [
{
"id": "c90114316773_syqLtYOY",
"status": "complete",
"orderindex": 2,
"color": "#008844",
"type": "closed"
},
{
"id": "c90114316773_g9uxhsQM",
"status": "in progress",
"orderindex": 1,
"color": "#1090e0",
"type": "custom"
},
{
"id": "c90114316773_DCnaeiSB",
"status": "to do",
"orderindex": 0,
"color": "#87909e",
"type": "open"
}
],
"lists": [],
"permission_level": "create"
}
}
}
}
}
},
"400": {
"description": "Bad request - Name is required",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Name is required"
},
"ECODE": {
"type": "string",
"example": "OAUTH_119"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Template or space not found"
},
"500": {
"description": "Internal server error"
}
}
}
},
"/v2/space/{space_id}/list": {
"get": {
"summary": "Get Folderless Lists",
"tags": [
"Lists"
],
"description": "View the Lists in a Space that aren't located in a Folder.",
"operationId": "GetFolderlessLists",
"parameters": [
{
"name": "space_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [789]
}
},
{
"name": "archived",
"in": "query",
"description": "",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [false]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetFolderlessListsresponse",
"required": [
"lists"
],
"type": "object",
"properties": {
"lists": {
"type": "array",
"items": {
"title": "List4",
"required": [
"id",
"name",
"orderindex",
"content",
"status",
"priority",
"assignee",
"task_count",
"due_date",
"start_date",
"folder",
"space",
"archived",
"override_statuses",
"permission_level"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"content": {
"type": "string"
},
"status": {
"oneOf": [
{
"title": "Status11",
"type": "object",
"properties": {
"status": {
"type": "string"
},
"color": {
"type": "string"
},
"hide_label": {
"type": "boolean"
}
},
"examples": [
{
"status": "red",
"color": "#e50000",
"hide_label": true
}
]
},
{
"type": [
"string",
"null"
]
},
{
}
],
"examples": [
{
"status": "red",
"color": "#e50000",
"hide_label": true
}
]
},
"priority": {
"oneOf": [
{
"title": "Priority4",
"type": "object",
"properties": {
"priority": {
"type": "string"
},
"color": {
"type": "string"
}
},
"examples": [
{
"priority": "high",
"color": "#f50000"
}
]
},
{
"type": [
"string",
"null"
]
},
{
}
],
"examples": [
{
"priority": "high",
"color": "#f50000"
}
]
},
"assignee": {
"type": [
"string",
"null"
]
},
"task_count": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": [
"string",
"null"
]
},
"start_date": {
"type": [
"string",
"null"
]
},
"folder": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder"
},
"space": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space"
},
"archived": {
"type": "boolean"
},
"override_statuses": {
"type": "boolean"
},
"permission_level": {
"type": "string"
}
},
"examples": [
{
"id": "124",
"name": "Updated List Name",
"orderindex": 1,
"content": "Updated List Content",
"status": {
"status": "red",
"color": "#e50000",
"hide_label": true
},
"priority": {
"priority": "high",
"color": "#f50000"
},
"assignee": null,
"task_count": null,
"due_date": "1567780450202",
"start_date": null,
"folder": {
"id": "456",
"name": "Folder Name",
"hidden": false,
"access": true
},
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"archived": false,
"override_statuses": false,
"permission_level": "create"
}
]
},
"description": ""
}
}
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create Folderless List",
"tags": [
"Lists"
],
"description": "Add a new List in a Space.",
"operationId": "CreateFolderlessList",
"parameters": [
{
"name": "space_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [789]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateFolderlessListrequest",
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"content": {
"type": "string"
},
"markdown_content": {
"type": "string",
"description": "Use `markdown_content` instead of `content` to format your List description."
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"due_date_time": {
"type": "boolean"
},
"priority": {
"type": "integer",
"contentEncoding": "int32"
},
"assignee": {
"description": "Include a `user_id` to add a List owner.",
"type": "integer",
"contentEncoding": "int32"
},
"status": {
"description": "**Status** refers to the List color rather than the task Statuses available in the List.",
"type": "string"
}
},
"examples": [
{
"name": "New List Name",
"content": "New List Content",
"due_date": 1567780450202,
"due_date_time": false,
"priority": 1,
"assignee": 183,
"status": "red"
}
]
},
"example": {
"name": "New List Name",
"content": "New List Content",
"markdown_content": "# This is markdown\n ***bold and italicized text***",
"due_date": 1567780450202,
"due_date_time": false,
"priority": 1,
"assignee": 183,
"status": "red"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateFolderlessListresponse",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"content": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"priority": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/priority"
},
"assignee": {
"title": "Assignee3",
"required": [
"id",
"color",
"username",
"initials",
"profilePicture"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"username": {
"type": "string"
},
"initials": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"examples": [
{
"id": 183,
"color": "#827718",
"username": "John Doe",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
}
]
},
"task_count": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": "string"
},
"due_date_time": {
"type": "boolean"
},
"start_date": {
"type": [
"string",
"null"
]
},
"start_date_time": {
"type": [
"string",
"null"
]
},
"folder": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder"
},
"space": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"description": ""
},
"inbound_address": {
"type": "string"
}
},
"examples": [
{
"id": "124",
"name": "New List Name",
"orderindex": 1,
"content": "New List Content",
"status": {
"status": "red",
"color": "#e50000",
"hide_label": true
},
"priority": {
"priority": "urgent",
"color": "#f50000"
},
"assignee": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"task_count": null,
"due_date": "1567780450202",
"due_date_time": false,
"start_date": null,
"start_date_time": null,
"folder": {
"id": "457",
"name": "hidden",
"hidden": true,
"access": true
},
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "complete",
"orderindex": 1,
"color": "#6bc950",
"type": "closed"
}
],
"inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com"
}
]
},
"example": {
"id": "124",
"name": "New List Name",
"orderindex": 1,
"content": "New List Content",
"status": {
"status": "red",
"color": "#e50000",
"hide_label": true
},
"priority": {
"priority": "urgent",
"color": "#f50000"
},
"assignee": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"task_count": null,
"due_date": "1567780450202",
"due_date_time": false,
"start_date": null,
"start_date_time": null,
"folder": {
"id": "457",
"name": "hidden",
"hidden": true,
"access": true
},
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "complete",
"orderindex": 1,
"color": "#6bc950",
"type": "closed"
}
],
"inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com"
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/list/{list_id}": {
"get": {
"summary": "Get List",
"tags": [
"Lists"
],
"description": "View information about a List.",
"operationId": "GetList",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "The List ID. To find the List ID, right-click the List in your Sidebar, select Copy link, and paste the link in your URL. The last string in the URL is your List ID.",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [124]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetListresponse",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"content": {
"type": "string"
},
"status": {
"title": "Status5",
"required": [
"status",
"color",
"hide_label"
],
"type": "object",
"properties": {
"status": {
"type": "string"
},
"color": {
"type": "string"
},
"hide_label": {
"type": "boolean"
}
},
"examples": [
{
"status": "red",
"color": "#e50000",
"hide_label": true
}
]
},
"priority": {
"title": "Priority1",
"required": [
"priority",
"color"
],
"type": "object",
"properties": {
"priority": {
"type": "string"
},
"color": {
"type": "string"
}
},
"examples": [
{
"priority": "urgent",
"color": "#f50000"
}
]
},
"assignee": {
"type": [
"string",
"null"
]
},
"task_count": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": "string"
},
"due_date_time": {
"type": "boolean"
},
"start_date": {
"type": [
"string",
"null"
]
},
"start_date_time": {
"type": [
"string",
"null"
]
},
"folder": {
"title": "Folder3",
"required": [
"id",
"name",
"hidden",
"access"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"access": {
"type": "boolean"
}
},
"examples": [
{
"id": "1217",
"name": "Shared with me",
"hidden": false,
"access": false
}
]
},
"space": {
"title": "Space2",
"required": [
"id",
"name",
"access"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"access": {
"type": "boolean"
}
},
"examples": [
{
"id": "789",
"name": "Space Name",
"access": true
}
]
},
"inbound_address": {
"type": "string"
},
"archived": {
"type": "boolean"
},
"override_statuses": {
"type": "boolean"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"description": ""
},
"permission_level": {
"type": "string"
}
},
"examples": [
{
"id": "124",
"name": "Updated List Name",
"orderindex": 1,
"content": "Updated List Content",
"status": {
"status": "red",
"color": "#e50000",
"hide_label": true
},
"priority": {
"priority": "high",
"color": "#f50000"
},
"assignee": null,
"due_date": "1567780450202",
"due_date_time": true,
"start_date": null,
"start_date_time": null,
"folder": {
"id": "456",
"name": "Folder Name",
"hidden": false,
"access": true
},
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"inbound_address": "add.task.124.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com",
"archived": false,
"override_statuses": false,
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "complete",
"orderindex": 1,
"color": "#6bc950",
"type": "closed"
}
],
"permission_level": "create"
}
]
},
"example": {
"id": "124",
"name": "Updated List Name",
"orderindex": 1,
"content": "Updated List Content",
"status": {
"status": "red",
"color": "#e50000",
"hide_label": true
},
"priority": {
"priority": "high",
"color": "#f50000"
},
"assignee": null,
"task_count": 10,
"due_date": "1567780450202",
"due_date_time": true,
"start_date": null,
"start_date_time": null,
"folder": {
"id": "456",
"name": "Folder Name",
"hidden": false,
"access": true
},
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"inbound_address": "add.task.124.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com",
"archived": false,
"override_statuses": false,
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "complete",
"orderindex": 1,
"color": "#6bc950",
"type": "closed"
}
],
"permission_level": "create"
}
}
}
}
},
"deprecated": false
},
"put": {
"summary": "Update List",
"tags": [
"Lists"
],
"description": "Rename a List, update the List Info description, set a due date/time, set the List's priority, set an assignee, set or remove the List color.",
"operationId": "UpdateList",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"124"
]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "UpdateListrequest",
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"content": {
"type": "string"
},
"markdown_content": {
"type": "string",
"description": "Use `markdown_content` instead of `content` to format your List description."
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"due_date_time": {
"type": "boolean"
},
"priority": {
"type": "integer",
"contentEncoding": "int32"
},
"assignee": {
"type": "string"
},
"status": {
"description": "**Status** refers to the List color rather than the task Statuses available in the List.",
"type": "string"
},
"unset_status": {
"description": "By default, this is `false.` To remove the List color use `unset_status: true`.",
"type": "boolean"
}
},
"examples": [
{
"name": "Updated List Name",
"content": "Updated List Content",
"markdown_content": "# This is markdown\n ***bold and italicized text***",
"due_date": 1567780450202,
"due_date_time": true,
"priority": 2,
"assignee": "none",
"status": "red",
"unset_status": true
}
]
},
"example": {
"name": "Updated List Name",
"content": "Updated List Content",
"markdown_content": "# This is markdown\n ***bold and italicized text***",
"due_date": 1567780450202,
"due_date_time": true,
"priority": 2,
"assignee": "none",
"status": "red",
"unset_status": true
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "UpdateListresponse",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"content": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"priority": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/priority"
},
"assignee": {
"type": [
"string",
"null"
]
},
"task_count": {
"type": [
"string",
"null"
]
},
"due_date": {
"type": "string"
},
"due_date_time": {
"type": "boolean"
},
"start_date": {
"type": [
"string",
"null"
]
},
"start_date_time": {
"type": [
"string",
"null"
]
},
"folder": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder"
},
"space": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/space"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"description": ""
},
"inbound_address": {
"type": "string"
}
},
"examples": [
{
"id": "124",
"name": "Updated List Name",
"orderindex": 1,
"content": "Updated List Content",
"status": {
"status": "red",
"color": "#e50000",
"hide_label": true
},
"priority": {
"priority": "high",
"color": "#f50000"
},
"assignee": null,
"task_count": null,
"due_date": "1567780450202",
"due_date_time": true,
"start_date": null,
"start_date_time": null,
"folder": {
"id": "456",
"name": "Folder Name",
"hidden": false,
"access": true
},
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "complete",
"orderindex": 1,
"color": "#6bc950",
"type": "closed"
}
],
"inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com"
}
]
},
"example": {
"id": "124",
"name": "Updated List Name",
"orderindex": 1,
"content": "Updated List Content",
"status": {
"status": "red",
"color": "#e50000",
"hide_label": true
},
"priority": {
"priority": "high",
"color": "#f50000"
},
"assignee": null,
"task_count": null,
"due_date": "1567780450202",
"due_date_time": true,
"start_date": null,
"start_date_time": null,
"folder": {
"id": "456",
"name": "Folder Name",
"hidden": false,
"access": true
},
"space": {
"id": "789",
"name": "Space Name",
"access": true
},
"statuses": [
{
"status": "to do",
"orderindex": 0,
"color": "#d3d3d3",
"type": "open"
},
{
"status": "complete",
"orderindex": 1,
"color": "#6bc950",
"type": "closed"
}
],
"inbound_address": "add.task.1389.ac725f.31518a6a-05bb-4997-92a6-1dcfe2f527ca@tasks.clickup.com"
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete List",
"tags": [
"Lists"
],
"description": "Delete a List from your Workspace.",
"operationId": "DeleteList",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [124]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/list/{list_id}/task/{task_id}": {
"post": {
"summary": "Add Task To List",
"tags": [
"Lists"
],
"description": "Add a task to an additional List. \\\n \\\n***Note:** This endpoint requires the [Tasks in Multiple List ClickApp](https://help.clickup.com/hc/en-us/articles/6309958824727-Tasks-in-Multiple-Lists) to be enabled.*",
"operationId": "AddTaskToList",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hz"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Remove Task From List",
"tags": [
"Lists"
],
"description": "Remove a task from an additional List. You can't remove a task from its home List. \\\n \\\n***Note:** This endpoint requires the [Tasks in Multiple List ClickApp](https://help.clickup.com/hc/en-us/articles/6309958824727-Tasks-in-Multiple-Lists) to be enabled.*",
"operationId": "RemoveTaskFromList",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hz"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/task/{task_id}/member": {
"get": {
"summary": "Get Task Members",
"tags": [
"Members"
],
"description": "View the people who have access to a task. Responses do not include people with inherited Hierarchy permission to the task.",
"operationId": "GetTaskMembers",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hz"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetTaskMembersresponse",
"required": [
"members"
],
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"title": "Member5",
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture",
"profileInfo"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"color": {
"type": [
"string",
"null"
]
},
"initials": {
"type": "string"
},
"profilePicture": {
"type": "string"
},
"profileInfo": {
"title": "ProfileInfo",
"required": [
"display_profile",
"verified_ambassador",
"verified_consultant",
"top_tier_user",
"viewed_verified_ambassador",
"viewed_verified_consultant",
"viewed_top_tier_user"
],
"type": "object",
"properties": {
"display_profile": {
"type": [
"string",
"null"
]
},
"verified_ambassador": {
"type": [
"string",
"null"
]
},
"verified_consultant": {
"type": [
"string",
"null"
]
},
"top_tier_user": {
"type": [
"string",
"null"
]
},
"viewed_verified_ambassador": {
"type": [
"string",
"null"
]
},
"viewed_verified_consultant": {
"type": [
"string",
"null"
]
},
"viewed_top_tier_user": {
"type": [
"string",
"null"
]
}
},
"examples": [
{
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null,
"viewed_top_tier_user": null
}
]
}
},
"examples": [
{
"id": 812,
"username": "John Doe",
"email": "john@example.com",
"color": "#FFFFFF",
"initials": "JD",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg",
"profileInfo": {
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null,
"viewed_top_tier_user": null
}
}
]
},
"description": ""
}
},
"examples": [
{
"members": [
{
"id": 812,
"username": "John Doe",
"email": "john@example.com",
"color": "#FFFFFF",
"initials": "JD",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg",
"profileInfo": {
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null,
"viewed_top_tier_user": null
}
},
{
"id": 813,
"username": "Jane Doe",
"email": "jane@example.com",
"color": null,
"initials": "JD",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/813_nx1.jpg",
"profileInfo": {
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null,
"viewed_top_tier_user": null
}
}
]
}
]
},
"example": {
"members": [
{
"id": 812,
"username": "John Doe",
"email": "john@example.com",
"color": "#FFFFFF",
"initials": "JD",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg",
"profileInfo": {
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null,
"viewed_top_tier_user": null
}
},
{
"id": 813,
"username": "Jane Doe",
"email": "jane@example.com",
"color": null,
"initials": "JD",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/813_nx1.jpg",
"profileInfo": {
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null,
"viewed_top_tier_user": null
}
}
]
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/list/{list_id}/member": {
"get": {
"summary": "Get List Members",
"tags": [
"Members"
],
"description": "Get Workspace members who have access to a List.",
"operationId": "GetListMembers",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetListMembersresponse",
"required": [
"members"
],
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1member/get/responses/200/content/application~1json/schema/properties/members/items"
},
"description": ""
}
},
"examples": [
{
"members": [
{
"id": 812,
"username": "John Doe",
"email": "john@example.com",
"color": "#FFFFFF",
"initials": "JD",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg",
"profileInfo": {
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null,
"viewed_top_tier_user": null
}
},
{
"id": 813,
"username": "Jane Doe",
"email": "jane@example.com",
"color": null,
"initials": "JD",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/813_nx1.jpg",
"profileInfo": {
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null,
"viewed_top_tier_user": null
}
}
]
}
]
},
"example": {
"members": [
{
"id": 812,
"username": "John Doe",
"email": "john@example.com",
"color": "#FFFFFF",
"initials": "JD",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg",
"profileInfo": {
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null,
"viewed_top_tier_user": null
}
},
{
"id": 813,
"username": "Jane Doe",
"email": "jane@example.com",
"color": null,
"initials": "JD",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/813_nx1.jpg",
"profileInfo": {
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null,
"viewed_top_tier_user": null
}
}
]
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/customroles": {
"get": {
"summary": "Get Custom Roles",
"tags": [
"Roles"
],
"description": "View the Custom Roles available in a Workspace.",
"operationId": "GetCustomRoles",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "include_members",
"in": "query",
"description": "",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetCustomRolesresponse",
"required": [
"custom_roles"
],
"type": "object",
"properties": {
"custom_roles": {
"type": "array",
"items": {
"title": "CustomRole2",
"required": [
"id",
"team_id",
"name",
"inherited_role",
"date_created",
"members"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"team_id": {
"type": "string"
},
"name": {
"type": "string"
},
"inherited_role": {
"type": "integer",
"contentEncoding": "int32"
},
"date_created": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
}
},
"examples": [
{
"id": 4547089,
"team_id": "301539",
"name": "guest custom",
"inherited_role": 4,
"date_created": "1651189835671",
"members": [12345, 67899]
}
]
},
"description": ""
}
},
"examples": [
{
"custom_roles": [
{
"id": 4547089,
"team_id": "301539",
"name": "guest custom",
"inherited_role": 4,
"date_created": "1651189835671",
"members": [12345, 67899]
},
{
"id": 6715664,
"team_id": "301539",
"name": "member custom",
"inherited_role": 3,
"date_created": "1651189901020",
"members": [5553, 98989]
},
{
"id": 2957195,
"team_id": "301539",
"name": "admin custom",
"inherited_role": 2,
"date_created": "1651189904868",
"members": [47474, 818181]
}
]
}
]
},
"example": {
"custom_roles": [
{
"id": 4547089,
"team_id": "301539",
"name": "guest custom",
"inherited_role": 4,
"date_created": "1651189835671",
"members": [12345, 67899]
},
{
"id": 6715664,
"team_id": "301539",
"name": "member custom",
"inherited_role": 3,
"date_created": "1651189901020",
"members": [5553, 98989]
},
{
"id": 2957195,
"team_id": "301539",
"name": "admin custom",
"inherited_role": 2,
"date_created": "1651189904868",
"members": [47474, 818181]
}
]
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/shared": {
"get": {
"summary": "Shared Hierarchy",
"tags": [
"Shared Hierarchy"
],
"description": "View the tasks, Lists, and Folders that have been shared with the authenticated user.",
"operationId": "SharedHierarchy",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "SharedHierarchyresponse",
"required": [
"shared"
],
"type": "object",
"properties": {
"shared": {
"title": "Shared7",
"required": [
"tasks",
"lists",
"folders"
],
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"lists": {
"type": "array",
"items": {
"title": "List6",
"required": [
"id",
"name",
"orderindex",
"content",
"status",
"priority",
"assignee",
"task_count",
"due_date",
"start_date",
"archived"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"content": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"priority": {
"type": [
"string",
"null"
]
},
"assignee": {
"type": [
"string",
"null"
]
},
"task_count": {
"type": "string"
},
"due_date": {
"type": [
"string",
"null"
]
},
"start_date": {
"type": [
"string",
"null"
]
},
"archived": {
"type": "boolean"
}
},
"examples": [
{
"id": "1421",
"name": "Shared List",
"orderindex": 0,
"content": null,
"status": null,
"priority": null,
"assignee": null,
"task_count": "0",
"due_date": null,
"start_date": null,
"archived": false
}
]
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"title": "Folder11",
"required": [
"id",
"name",
"orderindex",
"content",
"task_count",
"due_date",
"archived"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"content": {
"type": [
"string",
"null"
]
},
"task_count": {
"type": "string"
},
"due_date": {
"type": [
"string",
"null"
]
},
"archived": {
"type": "boolean"
}
},
"examples": [
{
"id": "1058",
"name": "Shared Folder",
"orderindex": 0,
"content": null,
"task_count": "0",
"due_date": null,
"archived": false
}
]
},
"description": ""
}
},
"examples": [
{
"tasks": [],
"lists": [
{
"id": "1421",
"name": "Shared List",
"orderindex": 0,
"content": null,
"status": null,
"priority": null,
"assignee": null,
"task_count": "0",
"due_date": null,
"start_date": null,
"archived": false
}
],
"folders": [
{
"id": "1058",
"name": "Shared Folder",
"orderindex": 0,
"content": null,
"task_count": "0",
"due_date": null,
"archived": false
}
]
}
]
}
},
"examples": [
{
"shared": {
"tasks": [],
"lists": [
{
"id": "1421",
"name": "Shared List",
"orderindex": 0,
"content": null,
"status": null,
"priority": null,
"assignee": null,
"task_count": "0",
"due_date": null,
"start_date": null,
"archived": false
}
],
"folders": [
{
"id": "1058",
"name": "Shared Folder",
"orderindex": 0,
"content": null,
"task_count": "0",
"due_date": null,
"archived": false
}
]
}
}
]
},
"example": {
"shared": {
"tasks": [],
"lists": [
{
"id": "1421",
"name": "Shared List",
"orderindex": 0,
"content": null,
"status": null,
"priority": null,
"assignee": null,
"task_count": "0",
"due_date": null,
"start_date": null,
"archived": false
}
],
"folders": [
{
"id": "1058",
"name": "Shared Folder",
"orderindex": 0,
"content": null,
"task_count": "0",
"due_date": null,
"archived": false
}
]
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/space": {
"get": {
"summary": "Get Spaces",
"tags": [
"Spaces"
],
"description": "View the Spaces avialable in a Workspace. You can only get member info in private Spaces.",
"operationId": "GetSpaces",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "archived",
"in": "query",
"description": "",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [false]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetSpacesresponse",
"required": [
"spaces"
],
"type": "object",
"properties": {
"spaces": {
"type": "array",
"items": {
"title": "Space13",
"required": [
"id",
"name",
"private",
"statuses",
"multiple_assignees",
"features"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"private": {
"type": "boolean"
},
"color": {
"type": "string"
},
"avatar": {
"type": "string"
},
"admin_can_manage": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"members": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1team/get/responses/200/content/application~1json/schema/properties/teams/items/properties/members/items"
},
"description": "",
"user": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"color": {
"type": "string"
},
"profilePicture": {
"type": "string"
},
"initials": {
"type": "string"
}
}
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"description": ""
},
"multiple_assignees": {
"type": "boolean"
},
"features": {
"title": "Features4",
"required": [
"due_dates",
"time_tracking",
"tags",
"time_estimates",
"checklists"
],
"type": "object",
"properties": {
"due_dates": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/due_dates"
},
"time_tracking": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/time_tracking"
},
"tags": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/tags"
},
"time_estimates": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/time_estimates"
},
"checklists": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/checklists"
},
"custom_fields": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/custom_fields"
},
"remap_dependencies": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/remap_dependencies"
},
"dependency_warning": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/dependency_warning"
},
"portfolios": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/portfolios"
}
},
"examples": [
{
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": false
},
"tags": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"checklists": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"portfolios": {
"enabled": false
}
}
]
}
},
"examples": [
{
"id": "790",
"name": "Updated Space Name",
"private": false,
"color": null,
"avatar": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg",
"admin_can_manage": true,
"archived": false,
"members": [
{
"user": {
"id": 12312312,
"username": "John Jones",
"color": null,
"profilePicture": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg",
"initials": "JJ"
}
}
],
"statuses": [
{
"status": "to do",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"status": "complete",
"type": "closed",
"orderindex": 1,
"color": "#6bc950"
}
],
"multiple_assignees": false,
"features": {
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": false
},
"tags": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"checklists": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"portfolios": {
"enabled": false
}
}
}
]
},
"description": ""
}
},
"examples": [
{
"spaces": [
{
"id": "790",
"name": "Updated Space Name",
"private": false,
"color": null,
"avatar": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg",
"admin_can_manage": true,
"archived": false,
"members": [
{
"user": {
"id": "12312312,",
"username": "John Jones,",
"color": null,
"profilePicture": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg,",
"initials": "JJ"
}
}
],
"statuses": [
{
"status": "to do",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"status": "complete",
"type": "closed",
"orderindex": 1,
"color": "#6bc950"
}
],
"multiple_assignees": false,
"features": {
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": false
},
"tags": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"checklists": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"portfolios": {
"enabled": false
}
}
},
{
"id": "791",
"name": "Second Space Name",
"private": false,
"statuses": [
{
"status": "Open",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"status": "Closed",
"type": "closed",
"orderindex": 1,
"color": "#6bc950"
}
],
"multiple_assignees": true,
"features": {
"due_dates": {
"enabled": true,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": true
},
"tags": {
"enabled": true
},
"time_estimates": {
"enabled": true
},
"checklists": {
"enabled": true
}
}
}
]
}
]
},
"example": {
"spaces": [
{
"id": "790",
"name": "Updated Space Name",
"private": false,
"color": null,
"avatar": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg",
"admin_can_manage": true,
"archived": false,
"members": [
{
"user": {
"id": "12312312,",
"username": "John Jones,",
"color": null,
"profilePicture": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg,",
"initials": "JJ"
}
}
],
"statuses": [
{
"status": "to do",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"status": "complete",
"type": "closed",
"orderindex": 1,
"color": "#6bc950"
}
],
"multiple_assignees": false,
"features": {
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": false
},
"tags": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"checklists": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"portfolios": {
"enabled": false
}
}
},
{
"id": "791",
"name": "Second Space Name",
"private": false,
"statuses": [
{
"status": "Open",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"status": "Closed",
"type": "closed",
"orderindex": 1,
"color": "#6bc950"
}
],
"multiple_assignees": true,
"features": {
"due_dates": {
"enabled": true,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": true
},
"tags": {
"enabled": true
},
"time_estimates": {
"enabled": true
},
"checklists": {
"enabled": true
}
}
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create Space",
"tags": [
"Spaces"
],
"description": "Add a new Space to a Workspace.",
"operationId": "CreateSpace",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateSpacerequest",
"required": [
"name",
"multiple_assignees",
"features"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"multiple_assignees": {
"type": "boolean"
},
"features": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features"
}
},
"examples": [
{
"name": "New Space Name",
"multiple_assignees": true,
"features": {
"due_dates": {
"enabled": true,
"start_date": false,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": false
},
"tags": {
"enabled": true
},
"time_estimates": {
"enabled": true
},
"checklists": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": true
},
"dependency_warning": {
"enabled": true
},
"portfolios": {
"enabled": true
}
}
}
]
},
"example": {
"name": "New Space Name",
"multiple_assignees": true,
"features": {
"due_dates": {
"enabled": true,
"start_date": false,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": false
},
"tags": {
"enabled": true
},
"time_estimates": {
"enabled": true
},
"checklists": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": true
},
"dependency_warning": {
"enabled": true
},
"portfolios": {
"enabled": true
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateSpaceresponse",
"required": [
"id",
"name",
"private",
"statuses",
"multiple_assignees",
"features",
"archived"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"private": {
"type": "boolean"
},
"statuses": {
"type": "array",
"items": {
"title": "Status15",
"required": [
"id",
"status",
"type",
"orderindex",
"color"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
},
"type": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
}
},
"examples": [
{
"id": "p16911531_p8y2WNC6",
"status": "to do",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
}
]
},
"description": ""
},
"multiple_assignees": {
"type": "boolean"
},
"features": {
"title": "Features1",
"required": [
"due_dates",
"sprints",
"points",
"custom_items",
"tags",
"time_estimates",
"checklists",
"zoom",
"milestones",
"custom_fields",
"remap_dependencies",
"dependency_warning",
"multiple_assignees",
"portfolios",
"emails"
],
"type": "object",
"properties": {
"due_dates": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/due_dates"
},
"sprints": {
"title": "Sprints",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": false
}
]
},
"points": {
"title": "Points",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": false
}
]
},
"custom_items": {
"title": "CustomItems",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": false
}
]
},
"tags": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/tags"
},
"time_estimates": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/time_estimates"
},
"checklists": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/checklists"
},
"zoom": {
"title": "Zoom",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": false
}
]
},
"milestones": {
"title": "Milestones",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": false
}
]
},
"custom_fields": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/custom_fields"
},
"remap_dependencies": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/remap_dependencies"
},
"dependency_warning": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/dependency_warning"
},
"multiple_assignees": {
"title": "MultipleAssignees",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": true
}
]
},
"portfolios": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features/properties/portfolios"
},
"emails": {
"title": "Emails",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": true
}
]
}
},
"examples": [
{
"due_dates": {
"enabled": true,
"start_date": false,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"sprints": {
"enabled": false
},
"points": {
"enabled": false
},
"custom_items": {
"enabled": false
},
"tags": {
"enabled": true
},
"time_estimates": {
"enabled": true
},
"checklists": {
"enabled": true
},
"zoom": {
"enabled": false
},
"milestones": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": true
},
"dependency_warning": {
"enabled": true
},
"multiple_assignees": {
"enabled": true
},
"portfolios": {
"enabled": true
},
"emails": {
"enabled": true
}
}
]
},
"archived": {
"type": "boolean"
}
},
"examples": [
{
"id": "790",
"name": "New Space Name",
"private": false,
"statuses": [
{
"id": "p16911531_p8y2WNC6",
"status": "to do",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"id": "p17911545_ABo7jSsf",
"status": "complete",
"type": "closed",
"orderindex": 1,
"color": "#6bc950"
}
],
"multiple_assignees": true,
"features": {
"due_dates": {
"enabled": true,
"start_date": false,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"sprints": {
"enabled": false
},
"points": {
"enabled": false
},
"custom_items": {
"enabled": false
},
"tags": {
"enabled": true
},
"time_estimates": {
"enabled": true
},
"checklists": {
"enabled": true
},
"zoom": {
"enabled": false
},
"milestones": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": true
},
"dependency_warning": {
"enabled": true
},
"multiple_assignees": {
"enabled": true
},
"portfolios": {
"enabled": true
},
"emails": {
"enabled": true
}
},
"archived": false
}
]
},
"example": {
"id": "790",
"name": "New Space Name",
"private": false,
"statuses": [
{
"id": "p16911531_p8y2WNC6",
"status": "to do",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"id": "p17911545_ABo7jSsf",
"status": "complete",
"type": "closed",
"orderindex": 1,
"color": "#6bc950"
}
],
"multiple_assignees": true,
"features": {
"due_dates": {
"enabled": true,
"start_date": false,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"sprints": {
"enabled": false
},
"points": {
"enabled": false
},
"custom_items": {
"enabled": false
},
"tags": {
"enabled": true
},
"time_estimates": {
"enabled": true
},
"checklists": {
"enabled": true
},
"zoom": {
"enabled": false
},
"milestones": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": true
},
"dependency_warning": {
"enabled": true
},
"multiple_assignees": {
"enabled": true
},
"portfolios": {
"enabled": true
},
"emails": {
"enabled": true
}
},
"archived": false
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/space/{space_id}": {
"get": {
"summary": "Get Space",
"tags": [
"Spaces"
],
"description": "View the Spaces available in a Workspace.",
"operationId": "GetSpace",
"parameters": [
{
"name": "space_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [790]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetSpaceresponse",
"required": [
"id",
"name",
"private",
"statuses",
"multiple_assignees",
"features"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"private": {
"type": "boolean"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"description": ""
},
"multiple_assignees": {
"type": "boolean"
},
"features": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features"
}
},
"examples": [
{
"id": "790",
"name": "Updated Space Name",
"private": false,
"statuses": [
{
"status": "to do",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"status": "complete",
"type": "closed",
"orderindex": 1,
"color": "#6bc950"
}
],
"multiple_assignees": false,
"features": {
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": false
},
"tags": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"checklists": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"portfolios": {
"enabled": false
}
}
}
]
},
"example": {
"id": "790",
"name": "Updated Space Name",
"private": false,
"statuses": [
{
"status": "to do",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"status": "complete",
"type": "closed",
"orderindex": 1,
"color": "#6bc950"
}
],
"multiple_assignees": false,
"features": {
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": false
},
"tags": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"checklists": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"portfolios": {
"enabled": false
}
}
}
}
}
}
},
"deprecated": false
},
"put": {
"summary": "Update Space",
"tags": [
"Spaces"
],
"description": "Rename, set the Space color, and enable ClickApps for a Space.",
"operationId": "UpdateSpace",
"parameters": [
{
"name": "space_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [790]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "UpdateSpacerequest",
"required": [
"name",
"color",
"private",
"admin_can_manage",
"multiple_assignees",
"features"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"private": {
"type": "boolean"
},
"admin_can_manage": {
"description": "***Note:** Allowing or restricting admins from managing private Spaces using `\"admin_can_manage\"` is an [Enterprise Plan](https://clickup.com/pricing) feature.*",
"type": "boolean"
},
"multiple_assignees": {
"type": "boolean"
},
"features": {
"title": "Features",
"required": [
"due_dates",
"time_tracking",
"tags",
"time_estimates",
"checklists",
"custom_fields",
"remap_dependencies",
"dependency_warning",
"portfolios"
],
"type": "object",
"properties": {
"due_dates": {
"title": "DueDates",
"required": [
"enabled",
"start_date",
"remap_due_dates",
"remap_closed_due_date"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"start_date": {
"type": "boolean"
},
"remap_due_dates": {
"type": "boolean"
},
"remap_closed_due_date": {
"type": "boolean"
}
},
"examples": [
{
"enabled": true,
"start_date": false,
"remap_due_dates": true,
"remap_closed_due_date": false
}
]
},
"time_tracking": {
"title": "TimeTracking",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": false
}
]
},
"tags": {
"title": "Tags",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": true
}
]
},
"time_estimates": {
"title": "TimeEstimates",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": true
}
]
},
"checklists": {
"title": "Checklists",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": true
}
]
},
"custom_fields": {
"title": "CustomFields",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": true
}
]
},
"remap_dependencies": {
"title": "RemapDependencies",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": true
}
]
},
"dependency_warning": {
"title": "DependencyWarning",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": true
}
]
},
"portfolios": {
"title": "Portfolios",
"required": [
"enabled"
],
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"examples": [
{
"enabled": true
}
]
}
},
"examples": [
{
"due_dates": {
"enabled": true,
"start_date": false,
"remap_due_dates": true,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": false
},
"tags": {
"enabled": true
},
"time_estimates": {
"enabled": true
},
"checklists": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": true
},
"dependency_warning": {
"enabled": true
},
"portfolios": {
"enabled": true
}
}
]
}
},
"examples": [
{
"name": "Updated Space Name",
"color": "#7B68EE",
"private": false,
"admin_can_manage": false,
"multiple_assignees": false,
"features": {
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": false
},
"tags": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"checklists": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"portfolios": {
"enabled": false
}
}
}
]
},
"example": {
"name": "Updated Space Name",
"color": "#7B68EE",
"private": false,
"admin_can_manage": false,
"multiple_assignees": false,
"features": {
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": false
},
"tags": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"checklists": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"portfolios": {
"enabled": false
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "UpdateSpaceresponse",
"required": [
"id",
"name",
"private",
"statuses",
"multiple_assignees",
"features"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"private": {
"type": "boolean"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"description": ""
},
"multiple_assignees": {
"type": "boolean"
},
"features": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D/put/requestBody/content/application~1json/schema/properties/features"
}
},
"examples": [
{
"id": "790",
"name": "Updated Space Name",
"private": false,
"statuses": [
{
"status": "to do",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"status": "complete",
"type": "closed",
"orderindex": 1,
"color": "#6bc950"
}
],
"multiple_assignees": false,
"features": {
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": false
},
"tags": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"checklists": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"portfolios": {
"enabled": false
}
}
}
]
},
"example": {
"id": "790",
"name": "Updated Space Name",
"private": false,
"statuses": [
{
"status": "to do",
"type": "open",
"orderindex": 0,
"color": "#d3d3d3"
},
{
"status": "complete",
"type": "closed",
"orderindex": 1,
"color": "#6bc950"
}
],
"multiple_assignees": false,
"features": {
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"time_tracking": {
"enabled": false
},
"tags": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"checklists": {
"enabled": true
},
"custom_fields": {
"enabled": true
},
"remap_dependencies": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"portfolios": {
"enabled": false
}
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Space",
"tags": [
"Spaces"
],
"description": "Delete a Space from your Workspace.",
"operationId": "DeleteSpace",
"parameters": [
{
"name": "space_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [790]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/space/{space_id}/tag": {
"get": {
"summary": "Get Space Tags",
"tags": [
"Tags"
],
"description": "View the task Tags available in a Space.",
"operationId": "GetSpaceTags",
"parameters": [
{
"name": "space_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [512]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetSpaceTagsresponse",
"required": [
"tags"
],
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items"
},
"description": ""
}
},
"examples": [
{
"tags": [
{
"name": "Tag name",
"tag_fg": "#000000",
"tag_bg": "#000000"
}
]
}
]
},
"example": {
"tags": [
{
"name": "Tag name",
"tag_fg": "#000000",
"tag_bg": "#000000"
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create Space Tag",
"tags": [
"Tags"
],
"description": "Add a new task Tag to a Space.",
"operationId": "CreateSpaceTag",
"parameters": [
{
"name": "space_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [512]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateSpaceTagrequest",
"required": [
"tag"
],
"type": "object",
"properties": {
"tag": {
"title": "Tag",
"required": [
"name",
"tag_fg",
"tag_bg"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tag_fg": {
"type": "string"
},
"tag_bg": {
"type": "string"
}
},
"examples": [
{
"name": "Tag Name",
"tag_fg": "#000000",
"tag_bg": "#000000"
}
]
}
},
"examples": [
{
"tag": {
"name": "Tag Name",
"tag_fg": "#000000",
"tag_bg": "#000000"
}
}
]
},
"example": {
"tag": {
"name": "Tag Name",
"tag_fg": "#000000",
"tag_bg": "#000000"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/space/{space_id}/tag/{tag_name}": {
"put": {
"summary": "Edit Space Tag",
"tags": [
"Tags"
],
"description": "Update a task Tag.",
"operationId": "EditSpaceTag",
"parameters": [
{
"name": "space_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [512]
}
},
{
"name": "tag_name",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"name"
]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "EditSpaceTagrequest",
"required": [
"tag"
],
"type": "object",
"properties": {
"tag": {
"title": "Tag1",
"required": [
"name",
"fg_color",
"bg_color"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"fg_color": {
"type": "string"
},
"bg_color": {
"type": "string"
}
},
"examples": [
{
"name": "Updated Tag",
"fg_color": "#ffffff",
"bg_color": "#ffffff"
}
]
}
},
"examples": [
{
"tag": {
"name": "Updated Tag",
"fg_color": "#ffffff",
"bg_color": "#ffffff"
}
}
]
},
"example": {
"tag": {
"name": "Tag name",
"tag_fg": "#000000",
"tag_bg": "#000000"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "EditSpaceTagresponse",
"required": [
"tag"
],
"type": "object",
"properties": {
"tag": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D~1tag~1%7Btag_name%7D/put/requestBody/content/application~1json/schema/properties/tag"
}
},
"examples": [
{
"tag": {
"name": "Updated Tag",
"fg_color": "#ffffff",
"bg_color": "#ffffff"
}
}
]
},
"example": {
"tag": {
"name": "Updated Tag",
"fg_color": "#ffffff",
"bg_color": "#ffffff"
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Space Tag",
"tags": [
"Tags"
],
"description": "Delete a task Tag from a Space.",
"operationId": "DeleteSpaceTag",
"parameters": [
{
"name": "space_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [512]
}
},
{
"name": "tag_name",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"name"
]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "DeleteSpaceTagrequest",
"required": [
"tag"
],
"type": "object",
"properties": {
"tag": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D~1tag/post/requestBody/content/application~1json/schema/properties/tag"
}
},
"examples": [
{
"tag": {
"name": "Tag name",
"tag_fg": "#000000",
"tag_bg": "#000000"
}
}
]
},
"example": {
"tag": {
"name": "Tag name",
"tag_fg": "#000000",
"tag_bg": "#000000"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/task/{task_id}/tag/{tag_name}": {
"post": {
"summary": "Add Tag To Task",
"tags": [
"Tags"
],
"description": "Add a Tag to a task.",
"operationId": "AddTagToTask",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"abc"
]
}
},
{
"name": "tag_name",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"name"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Remove Tag From Task",
"tags": [
"Tags"
],
"description": "Remove a Tag from a task. This does not delete the Tag from the Space.",
"operationId": "RemoveTagFromTask",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"abc"
]
}
},
{
"name": "tag_name",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"name"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/list/{list_id}/task": {
"get": {
"summary": "Get Tasks",
"tags": [
"Tasks"
],
"description": "View the tasks in a List. Responses are limited to 100 tasks per page. You can only view task information of tasks you can access. \\\n \\\nThis endpoint only includes tasks where the specified `list_id` is their home List. Tasks added to the `list_id` with a different home List are not included in the response by default. To include tasks that exist in multiple lists, use the `include_timl` parameter. \\\n \\\nThe `time_spent` field displays time tracked in milliseconds, and is only included in the response for tasks with time entries.",
"operationId": "GetTasks",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "To find the list_id: \\ 1. In the Sidebar, hover over the List and click the **ellipsis ...** menu. \\ 2. Select **Copy link.** \\ 3. Use the copied URL to find the list_id. The list_id is the number that follows /li in the URL.",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "archived",
"in": "query",
"description": "",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [false]
}
},
{
"name": "include_markdown_description",
"in": "query",
"description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "page",
"in": "query",
"description": "Page to fetch (starts at 0).",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
},
{
"name": "order_by",
"in": "query",
"description": "Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "reverse",
"in": "query",
"description": "Tasks are displayed in reverse order.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "subtasks",
"in": "query",
"description": "Include or exclude subtasks. By default, subtasks are excluded.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "statuses",
"in": "query",
"description": "Filter by statuses. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "include_closed",
"in": "query",
"description": "Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "include_timl",
"in": "query",
"description": "Include Tasks in Multiple Lists. By default, tasks that exist in multiple lists are excluded from the response.\\\n \\\nTo include tasks that exist in multiple lists, use `include_timl: true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "assignees",
"in": "query",
"description": "Filter by Assignees. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "watchers",
"in": "query",
"description": "Filter by watchers.",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "tags",
"in": "query",
"description": "Filter by tags. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "due_date_gt",
"in": "query",
"description": "Filter by due date greater than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
},
{
"name": "due_date_lt",
"in": "query",
"description": "Filter by due date less than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
},
{
"name": "date_created_gt",
"in": "query",
"description": "Filter by date created greater than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
},
{
"name": "date_created_lt",
"in": "query",
"description": "Filter by date created less than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
},
{
"name": "date_updated_gt",
"in": "query",
"description": "Filter by date updated greater than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
},
{
"name": "date_updated_lt",
"in": "query",
"description": "Filter by date updated less than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
},
{
"name": "date_done_gt",
"in": "query",
"description": "Filter by date done greater than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
},
{
"name": "date_done_lt",
"in": "query",
"description": "Filter by date done less than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
},
{
"name": "custom_fields",
"in": "query",
"description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"\u003C\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "custom_field",
"in": "query",
"description": "Include tasks with specific values in only one Custom Field. This Custom Field can be a Custom Relationship.",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "custom_items",
"in": "query",
"description": "Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace.",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "number"
}
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"example": [
{
"tasks": [
{
"id": "9hx",
"name": "New Task Name",
"status": {
"status": "Open",
"color": "#d3d3d3",
"orderindex": 0,
"type": "open"
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"date_done": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"watchers": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": {
"color": "#f8ae00",
"id": "2",
"orderindex": "2",
"priority": "high"
},
"due_date": null,
"start_date": null,
"time_estimate": null,
"time_spent": 7200000,
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"url": "https://app.clickup.com/t/9hx"
},
{
"id": "9hz",
"name": "Second task",
"status": {
"status": "Open",
"color": "#d3d3d3",
"orderindex": 0,
"type": "open"
},
"orderindex": "2.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"date_done": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"watchers": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": null,
"due_date": null,
"points": 3,
"time_estimate": null,
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"url": "https://app.clickup.com/t/9hz"
}
]
}
],
"title": "GetTasksresponse",
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"title": "TaskWithMixedOrderIndexType",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_item_id": {
"type": [
"number",
"null"
]
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"markdown_description": {
"type": "string"
},
"orderindex": {
"type": [
"string",
"number"
]
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"date_closed": {
"type": [
"string",
"null"
]
},
"date_done": {
"type": [
"string",
"null"
]
},
"creator": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator"
},
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"watchers": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"checklists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"parent": {
"type": [
"string",
"null"
]
},
"priority": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority"
},
"due_date": {
"type": [
"string",
"null"
]
},
"start_date": {
"type": [
"string",
"null"
]
},
"points": {
"type": [
"number"
]
},
"time_estimate": {
"type": [
"string",
"null"
]
},
"time_spent": {
"type": [
"string"
]
},
"custom_fields": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/custom_fields/items"
},
"list": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list"
},
"folder": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder"
},
"space": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space"
},
"url": {
"type": "string"
}
},
"examples": [
{
"id": "9hx",
"name": "New Task Name",
"custom_item_id": null,
"status": {
"status": "Open",
"color": "#d3d3d3",
"orderindex": 0,
"type": "open"
},
"markdown_description": "Task description",
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"date_done": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"watchers": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": {
"color": "#f8ae00",
"id": "3",
"orderindex": "3",
"priority": "normal"
},
"due_date": null,
"start_date": null,
"time_estimate": null,
"time_spent": 7200000,
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"url": "https://app.clickup.com/t/9hx"
}
]
},
"description": ""
},
"last_page": {
"type": "boolean"
}
},
"examples": [
{
"tasks": [
{
"id": "9hx",
"custom_item_id": null,
"name": "New Task Name",
"status": {
"status": "Open",
"color": "#d3d3d3",
"orderindex": 0,
"type": "open"
},
"markdown_description": "Task description",
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"date_done": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"watchers": [],
"checklists": {
"id": "595495f8-4557-41b7-a527-f808664816a0",
"task_id": "86cv5pkvr",
"name": "Checklist on a task",
"date_created": "1714661812846",
"orderindex": "1",
"creator": 2770032,
"resolved": 0,
"unresolved": 2,
"items": []
},
"tags": [],
"parent": null,
"priority": {
"color": "#f8ae00",
"id": "2",
"orderindex": "2",
"priority": "high"
},
"due_date": null,
"start_date": null,
"points": 3,
"time_estimate": null,
"time_spent": 7200000,
"custom_fields": {
"id": "0a52c486-5f05-403b-b4fd-c512ff05131c",
"name": "My Text Custom field",
"type": "text",
"type_config": {
},
"date_created": "1622176979540",
"hide_from_guests": false,
"value": {
"value": "This is a string of text added to a Custom Field."
},
"required": true
},
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"url": "https://app.clickup.com/t/9hx"
},
{
"id": "9hz",
"custom_item_id": null,
"name": "Second task",
"status": {
"status": "Open",
"color": "#d3d3d3",
"orderindex": 0,
"type": "open"
},
"orderindex": "2.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"date_done": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"watchers": [],
"checklists": {
"id": "de159781-452c-4ef3-a3ac-0df4bf18aae2",
"name": "Checklist item 1",
"orderindex": 0,
"assignee": null,
"group_assignee": null,
"resolved": false,
"parent": null,
"date_created": "1714661817234",
"children": []
},
"tags": [],
"parent": null,
"priority": null,
"due_date": null,
"start_date": null,
"points": 3,
"time_estimate": null,
"custom_fields": {
"id": "0a52c486-5f05-403b-b4fd-c512ff05131c",
"name": "My Text Custom field",
"type": "text",
"type_config": {
},
"date_created": "1622176979540",
"hide_from_guests": false,
"value": {
"value": "This is a string of text added to a Custom Field."
},
"required": true
},
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"url": "https://app.clickup.com/t/9hz"
}
]
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create Task",
"tags": [
"Tasks"
],
"description": "Create a new task.",
"operationId": "CreateTask",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateTaskrequest",
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"assignees": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"archived": {
"type": "boolean"
},
"group_assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": "Assign multiple user groups to the task."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"status": {
"type": "string"
},
"priority": {
"type": [
"integer",
"null"
],
"contentEncoding": "int32"
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"due_date_time": {
"type": "boolean"
},
"time_estimate": {
"type": "integer",
"contentEncoding": "int32"
},
"start_date": {
"type": "integer",
"contentEncoding": "int64"
},
"start_date_time": {
"type": "boolean"
},
"points": {
"type": "number",
"description": "Add Sprint Points to the task."
},
"notify_all": {
"type": "boolean",
"description": "If `notify_all` is true, notifications will be sent to everyone including the creator of the comment."
},
"parent": {
"description": "You can create a subtask by including an existing task ID.\\\n \\\nThe `parent` task ID you include can be a subtask, but must be in the same List specified in the path parameter.",
"type": [
"string",
"null"
]
},
"markdown_content": {
"type": "string",
"description": "Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`."
},
"links_to": {
"description": "Include a task ID to create a linked dependency with your new task.",
"type": [
"string",
"null"
]
},
"check_required_custom_fields": {
"description": "When creating a task via API any required Custom Fields are ignored by default (`false`).\\\n \\\nYou can enforce required Custom Fields by including `check_required_custom_fields: true`.",
"type": "boolean"
},
"custom_fields": {
"type": "array",
"items": {
"title": "CustomFields6",
"required": [
"id",
"value"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"value": {
"oneOf": [
{
"type": "integer",
"contentEncoding": "int32"
},
{
"type": "string"
}
]
}
},
"examples": [
{
"id": "0a52c486-5f05-403b-b4fd-c512ff05131c",
"value": 23
}
]
},
"description": "[Filter by Custom Fields.](doc:filtertasks)"
},
"custom_item_id": {
"type": "number",
"description": "The custom task type ID for this task. A value of `null` (default) creates a standard task type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)."
}
},
"examples": [
{
"name": "New Task Name",
"description": "New Task Description",
"assignees": [183],
"archived": false,
"group_assignees": [
"dd01f92f-48ca-446d-88a1-0beb0e8f5f14"
],
"tags": [
"tag name 1"
],
"status": "Open",
"priority": 3,
"due_date": 1508369194377,
"due_date_time": false,
"time_estimate": 8640000,
"start_date": 1567780450202,
"start_date_time": false,
"points": 3,
"notify_all": true,
"parent": null,
"links_to": null,
"check_required_custom_fields": true,
"custom_fields": [
{
"id": "0a52c486-5f05-403b-b4fd-c512ff05131c",
"value": 23
},
{
"id": "03efda77-c7a0-42d3-8afd-fd546353c2f5",
"value": "Text field input"
}
]
}
]
},
"example": {
"name": "New Task Name",
"description": "New Task Description",
"markdown_description": "New Task Description",
"assignees": [183],
"archived": false,
"group_assignees": [
"dd01f92f-48ca-446d-88a1-0beb0e8f5f14"
],
"email_assignees": [
"dd01f92f-48ca-446d-88a1-0beb0e8f5f13"
],
"tags": [
"tag name 1"
],
"status": "Open",
"priority": 3,
"due_date": 1508369194377,
"due_date_time": false,
"time_estimate": 8640000,
"start_date": 1567780450202,
"start_date_time": false,
"points": 3,
"notify_all": true,
"parent": null,
"links_to": null,
"check_required_custom_fields": true,
"custom_fields": [
{
"id": "0a52c486-5f05-403b-b4fd-c512ff05131c",
"value": "This is a string of text added to a Custom Field."
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateTaskresponse.yaml",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_id": {
"type": [
"string",
"null"
]
},
"custom_item_id": {
"type": [
"number",
"null"
],
"description": "The custom task type ID for this task. A value of `null` (default) creates a standard task type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)."
},
"name": {
"type": "string"
},
"text_content": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"orderindex": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"date_closed": {
"type": [
"string",
"null"
]
},
"creator": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator"
},
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"archived": {
"type": "boolean"
},
"group_assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"email_assignees": {
"type": "string"
},
"checklists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"parent": {
"type": [
"string",
"null"
]
},
"priority": [
{
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority"
}
],
"due_date": {
"type": [
"string",
"null"
]
},
"start_date": {
"type": [
"string",
"null"
]
},
"points": {
"type": [
"number"
]
},
"time_estimate": {
"type": [
"string",
"null"
]
},
"time_spent": {
"type": [
"string",
"null"
]
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/custom_fields/items"
},
"description": ""
},
"list": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list"
},
"folder": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder"
},
"space": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space"
},
"url": {
"type": "string"
}
}
},
"example": {
"id": "9hx",
"custom_id": null,
"custom_item_id": null,
"name": "New Task Name",
"text_content": "New Task Content",
"description": "New Task Content",
"markdown_description": "New Task Content",
"status": {
"status": "in progress",
"color": "#d3d3d3",
"orderindex": 1,
"type": "custom"
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"date_done": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"archived": false,
"group_assignees": [],
"email_assignees": [],
"checklists": [],
"tags": [],
"parent": "abc1234",
"priority": {
"color": "6fddff",
"id": "3",
"orderindex": "3",
"priority": "normal"
},
"due_date": null,
"start_date": null,
"points": 3,
"time_estimate": null,
"time_spent": null,
"custom_fields": [
{
"id": "0a52c486-5f05-403b-b4fd-c512ff05131c",
"name": "My Text Custom field",
"type": "text",
"type_config": {
},
"date_created": "1622176979540",
"hide_from_guests": false,
"value": {
"value": "This is a string of text added to a Custom Field."
},
"required": true
}
],
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"url": "https://app.clickup.com/t/9hx"
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/task/{task_id}": {
"get": {
"summary": "Get Task",
"tags": [
"Tasks"
],
"description": "View information about a task. You can only view task information of tasks you can access. \\\n \\\nTasks with attachments will return an \"attachments\" response. \\\n \\\nDocs attached to a task are not returned.",
"operationId": "GetTask",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hz"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by its custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "include_subtasks",
"in": "query",
"description": "Include subtasks, default false",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "include_markdown_description",
"in": "query",
"description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "custom_fields",
"in": "query",
"description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"},{\"field_id\":\"jklmnop123456\",\"operator\":\"\u003C\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. If you want to include tasks with specific values in only one Custom Field, use `custom_field` instead.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:filtertasks)",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetTaskresponse",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_id": {
"type": [
"string",
"null"
]
},
"custom_item_id": {
"type": [
"number",
"null"
],
"description": "The custom task type ID for this task. A value of `null` represents task type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)."
},
"name": {
"type": "string"
},
"text_content": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"title": "Status",
"required": [
"status",
"color",
"orderindex",
"type"
],
"type": "object",
"properties": {
"status": {
"type": "string"
},
"color": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"type": {
"type": "string"
}
},
"examples": [
{
"status": "in progress",
"color": "#d3d3d3",
"orderindex": 1,
"type": "custom"
}
]
},
"orderindex": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"date_closed": {
"type": [
"string",
"null"
]
},
"creator": {
"title": "Creator",
"required": [
"id",
"username",
"color",
"profilePicture"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"color": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"examples": [
{
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
]
},
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"watchers": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"checklists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"parent": {
"type": [
"string",
"null"
]
},
"priority": {
"title": "Priority",
"type": [
"object",
"null"
],
"properties": {
"color": {
"type": "string"
},
"id": {
"type": "string"
},
"orderindex": {
"type": "string"
},
"priority": {
"type": "string"
}
},
"examples": [
{
"color": "#f8ae00",
"id": "3",
"orderindex": "3",
"priority": "normal"
}
]
},
"due_date": {
"type": [
"string",
"null"
]
},
"start_date": {
"type": [
"string",
"null"
]
},
"points": {
"type": [
"number"
]
},
"time_estimate": {
"type": [
"string",
"null"
]
},
"time_spent": {
"type": [
"string",
"null"
]
},
"custom_fields": {
"type": "array",
"items": {
"title": "CustomFields8",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"type_config": {
"title": "TypeConfig1",
"type": "object",
"properties": {
"single_user": {
"type": "boolean"
},
"include_groups": {
"type": "boolean"
},
"include_guests": {
"type": "boolean"
},
"include_team_members": {
"type": "boolean"
}
},
"examples": [
{
}
]
},
"date_created": {
"type": "string"
},
"hide_from_guests": {
"type": "boolean"
},
"value": {
"oneOf": [
{
"title": "Value",
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
},
"profilePicture": {
"type": [
"string",
"null"
]
}
}
},
{
"title": "Value1",
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
},
"profilePicture": {
"type": [
"string",
"null"
]
}
},
"examples": [
{
"id": 183,
"username": "John Doe",
"email": "john@example.com",
"color": "#7b68ee",
"initials": "JD",
"profilePicture": null
}
]
},
{
"title": "Value2",
"required": [
"value"
],
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"example": [
"This is a text CF"
]
}
],
"examples": [
{
"id": 183,
"username": "John Doe",
"email": "john@example.com",
"color": "#7b68ee",
"initials": "JD",
"profilePicture": null
},
{
"value": null
}
]
},
"value_richtext": {
"type": "string"
},
"value_markdown": {
"type": "string"
},
"required": {
"type": "boolean"
}
}
},
"description": ""
},
"list": {
"title": "List",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"examples": [
{
"id": "123"
}
]
},
"folder": {
"title": "Folder",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"examples": [
{
"id": "456"
}
]
},
"space": {
"title": "Space",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"examples": [
{
"id": "789"
}
]
},
"url": {
"type": "string"
},
"markdown_description": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"title": "Attachment",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"date": {
"type": "bigint"
},
"title": {
"type": "string"
},
"type": {
"type": "int"
},
"source": {
"type": "int"
},
"version": {
"type": "int"
},
"extension": {
"type": "string"
},
"thumbnail_small": {
"type": "string"
},
"thumbnail_medium": {
"type": "string"
},
"thumbnail_large": {
"type": "string"
},
"is_folder": {
"type": "boolean"
},
"mimetype": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"parent_id": {
"type": "string"
},
"size": {
"type": "bigint"
},
"total_comments": {
"type": "int"
},
"resolved_comments": {
"type": "int"
},
"user": {
"type": "string",
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user"
},
"deleted": {
"type": "boolean"
},
"orientation": {
"type": "string"
},
"url": {
"type": "string"
},
"email_data": {
"type": "object"
},
"url_w_query": {
"type": "string"
},
"url_w_host": {
"type": "string"
}
},
"examples": [
{
"id": "62447c77-2086-4cda-b274-f53eccf0547b.csv",
"date": 1711570108374,
"title": "Canny - Exported posts - 2024-03-09.csv",
"type": 1,
"source": 1,
"version": 0,
"extension": "csv",
"thumbnail_small": null,
"thumbnail_medium": null,
"thumbnail_large": null,
"is_folder": null,
"mimetype": "text/csv",
"hidden": false,
"parent_id": "36fjfqy",
"size": 140970,
"total_comments": 0,
"resolved_comments": 0,
"user": [
{
"id": [
{
"type": "integer",
"contentEncoding": "int32"
}
],
"username": {
"type": "string"
},
"initials": {
"type": "string"
},
"email": {
"type": "string"
},
"color": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
}
],
"deleted": false,
"orientation": null,
"url": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv",
"email_data": null,
"url_w_query": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv?view=open",
"url_w_host": "https://t6931406.p.clickup-attachments.com/t6931406/62447c77-2086-4cda-b274-f53eccf0547b/Canny%20-%20Exported%20posts%20-%202024-03-09.csv"
}
]
}
}
}
}
}
}
}
},
"deprecated": false
},
"put": {
"summary": "Update Task",
"tags": [
"Tasks"
],
"description": "Update a task by including one or more fields in the request body.",
"operationId": "UpdateTask",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hx"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by its custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "***Note:** To update Custom Fields on a task, you must use the Set Custom Field endpoint.*",
"content": {
"application/json": {
"schema": {
"title": "UpdateTaskrequest",
"type": "object",
"properties": {
"custom_item_id": {
"type": [
"number",
"null"
],
"description": "The custom task type ID for this task. A value of `null` (default) sets the task type to type \"Task\".\\\n \\\nTo get a list of available custom task type IDs for your Workspace, use the [Get Custom Task Types endpoint](ref:getcustomitems)."
},
"name": {
"type": "string"
},
"description": {
"description": "To clear the task description, include `Description` with `\" \"`.",
"type": "string"
},
"markdown_content": {
"type": "string",
"description": "Markdown formatted description for the task. If both `markdown_content` and `description` are provided, `markdown_content` will be used instead of `description`."
},
"status": {
"type": "string"
},
"priority": {
"type": "integer",
"contentEncoding": "int32"
},
"due_date": {
"type": "integer",
"contentEncoding": "int64"
},
"due_date_time": {
"type": "boolean"
},
"parent": {
"description": "You can move a subtask to another parent task by including `\"parent\"` with a valid `task id`.\\\n \\\nYou cannot convert a subtask to a task by setting `\"parent\"` to `null`.",
"type": "string"
},
"time_estimate": {
"type": "integer",
"contentEncoding": "int32"
},
"start_date": {
"type": "integer",
"contentEncoding": "int64"
},
"start_date_time": {
"type": "boolean"
},
"points": {
"type": "number",
"description": "Update the task's Sprint Points."
},
"assignees": {
"title": "Assignees",
"required": [
"add",
"rem"
],
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"rem": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
}
},
"examples": [
{
"add": [182],
"rem": [183]
}
]
},
"group_assignees": {
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"rem": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
}
}
},
"watchers": {
"title": "Watchers",
"required": [
"add",
"rem"
],
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"rem": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
}
},
"examples": [
{
"add": [182, 121],
"rem": [183, 122]
}
]
},
"archived": {
"type": "boolean"
}
},
"examples": [
{
"name": "Updated Task Name",
"description": "Updated Task Content",
"status": "in progress",
"priority": 1,
"due_date": 1508369194377,
"due_date_time": false,
"parent": "abc1234",
"time_estimate": 8640000,
"start_date": 1567780450202,
"start_date_time": false,
"points": 3,
"assignees": {
"add": [182],
"rem": [183]
},
"group_assignees": {
"add": [
"dd01f92f-48ca-446d-88a1-0beb0e8f5f14"
],
"rem": [
"dd01f92f-48ca-446d-88a1-0beb0e8f5f13"
]
},
"watchers": {
"add": [182],
"rem": [183]
},
"archived": false
}
]
},
"example": {
"name": "Updated Task Name",
"description": "Updated Task Content",
"status": "in progress",
"priority": 3,
"due_date": 1508369194377,
"due_date_time": false,
"parent": "abc1234",
"time_estimate": 8640000,
"start_date": 1567780450202,
"start_date_time": false,
"points": 3,
"assignees": {
"add": [182],
"rem": [183]
},
"group_assignees": {
"add": [
"dd01f92f-48ca-446d-88a1-0beb0e8f5f14"
],
"rem": [
"dd01f92f-48ca-446d-88a1-0beb0e8f5f13"
]
},
"archived": false
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "UpdateTaskresponse",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_id": {
"type": [
"string",
"null"
]
},
"custom_item_id": {
"type": [
"number",
"null"
]
},
"name": {
"type": "string"
},
"text_content": {
"type": "string"
},
"description": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"archived": {
"type": "boolean"
},
"orderindex": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"date_closed": {
"type": [
"string",
"null"
]
},
"creator": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator"
},
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"group_assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"checklists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"parent": {
"type": "string"
},
"priority": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority"
},
"due_date": {
"type": [
"string",
"null"
]
},
"start_date": {
"type": [
"string",
"null"
]
},
"points": {
"type": [
"number"
]
},
"time_estimate": {
"type": [
"string",
"null"
]
},
"time_spent": {
"type": [
"string",
"null"
]
},
"custom_fields": {
"type": "array",
"items": {
"title": "CustomFields7",
"required": [
"id",
"name",
"type",
"type_config",
"date_created",
"hide_from_guests",
"required"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"type_config": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/custom_fields/items/properties/type_config"
},
"date_created": {
"type": "string"
},
"hide_from_guests": {
"type": "boolean"
},
"value": {
"type": "string"
},
"required": {
"type": "boolean"
}
},
"examples": [
{
"id": "0a52c486-5f05-403b-b4fd-c512ff05131c",
"name": "My Number field",
"type": "checkbox",
"type_config": {
},
"date_created": "1622176979540",
"hide_from_guests": false,
"value": "23",
"required": true
}
]
},
"description": ""
},
"list": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list"
},
"folder": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder"
},
"space": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space"
},
"url": {
"type": "string"
}
},
"examples": [
{
"id": "9hx",
"custom_id": null,
"name": "Updated Task Name",
"text_content": "Updated Task Content",
"description": "Updated Task Content",
"status": {
"status": "in progress",
"color": "#d3d3d3",
"orderindex": 1,
"type": "custom"
},
"archived": false,
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"group_assignees": [],
"checklists": [],
"tags": [],
"parent": "abc1234",
"priority": {
"color": "#f8ae00",
"id": "3",
"orderindex": "3",
"priority": "normal"
},
"due_date": null,
"start_date": null,
"points": 3,
"time_estimate": null,
"time_spent": null,
"custom_fields": [
{
"id": "0a52c486-5f05-403b-b4fd-c512ff05131c",
"name": "My Number field",
"type": "checkbox",
"type_config": {
},
"date_created": "1622176979540",
"hide_from_guests": false,
"value": "23",
"required": true
},
{
"id": "03efda77-c7a0-42d3-8afd-fd546353c2f5",
"name": "My Text field",
"type": "short_text",
"type_config": {
},
"date_created": "1622176979540",
"hide_from_guests": false,
"value": "Text field input",
"required": false
},
{
"id": "f4d2a20d-6759-4420-b853-222dbe2589d5",
"name": "My People",
"type": "users",
"type_config": {
"single_user": true,
"include_groups": true,
"include_guests": true,
"include_team_members": true
},
"date_created": "1618440378816",
"hide_from_guests": false,
"required": false
}
],
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"url": "https://app.clickup.com/t/9hx"
}
]
},
"example": {
"id": "9hx",
"custom_id": null,
"custom_item_id": null,
"name": "Updated Task Name",
"text_content": "Updated Task Content",
"description": "Updated Task Content",
"markdown_description": "Updates Task Content",
"status": {
"status": "in progress",
"color": "#d3d3d3",
"orderindex": 1,
"type": "custom"
},
"archived": false,
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"group_assignees": [],
"checklists": [],
"tags": [],
"parent": "abc1234",
"priority": {
"color": "#f8ae00",
"id": "3",
"orderindex": "3",
"priority": "normal"
},
"due_date": null,
"start_date": null,
"points": 3,
"time_estimate": null,
"time_spent": null,
"custom_fields": [
{
"id": "0a52c486-5f05-403b-b4fd-c512ff05131c",
"name": "My Number field",
"type": "checkbox",
"type_config": {
},
"date_created": "1622176979540",
"hide_from_guests": false,
"value": "23",
"required": true
},
{
"id": "03efda77-c7a0-42d3-8afd-fd546353c2f5",
"name": "My Text field",
"type": "short_text",
"type_config": {
},
"date_created": "1622176979540",
"hide_from_guests": false,
"value": "Text field input",
"required": false
},
{
"id": "f4d2a20d-6759-4420-b853-222dbe2589d5",
"name": "My People",
"type": "users",
"type_config": {
"single_user": true,
"include_groups": true,
"include_guests": true,
"include_team_members": true
},
"date_created": "1618440378816",
"hide_from_guests": false,
"required": false
}
],
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"url": "https://app.clickup.com/t/9hx"
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Task",
"tags": [
"Tasks"
],
"description": "Delete a task from your Workspace.",
"operationId": "DeleteTask",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9xh"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by its custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"204": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_Id}/task": {
"get": {
"summary": "Get Filtered Team Tasks",
"tags": [
"Tasks"
],
"description": "View the tasks that meet specific criteria from a Workspace. Responses are limited to 100 tasks per page. \\\n \\\nYou can only view task information of tasks you can access. \\\n \\\n Our Try It modal currently supports filtering by two or more Lists, Folders, or Spaces. To filter by a single List, Folder, or Space, we recommend using a free app like [Postman](https://www.postman.com/) to test our public API.",
"operationId": "GetFilteredTeamTasks",
"parameters": [
{
"name": "team_Id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "page",
"in": "query",
"description": "Page to fetch (starts at 0).",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32"
}
},
{
"name": "order_by",
"in": "query",
"description": "Order by a particular field. By default, tasks are ordered by `created`.\\\n \\\nOptions include: `id`, `created`, `updated`, and `due_date`.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "reverse",
"in": "query",
"description": "Tasks are displayed in reverse order.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "subtasks",
"in": "query",
"description": "Include or exclude subtasks. By default, subtasks are excluded.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "space_ids[]",
"in": "query",
"description": "Filter by Spaces. For example: \\\n \\\n`?space_ids[]=1234&space_ids[]=6789`",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "project_ids[]",
"in": "query",
"description": "Filter by Folders. For example: \\\n \\\n`?project_ids[]=1234&project_ids[]=6789`",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "list_ids[]",
"in": "query",
"description": "Filter by Lists. For example: \\\n \\\n`?list_ids[]=1234&list_ids[]=6789` ",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "statuses[]",
"in": "query",
"description": "Filter by statuses. Use `%20` to represent a space character. To include closed tasks, use the `include_closed` parameter. \\\n \\\nFor example: \\\n \\\n`?statuses[]=to%20do&statuses[]=in%20progress`",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "include_closed",
"in": "query",
"description": "Include or excluse closed tasks. By default, they are excluded.\\\n \\\nTo include closed tasks, use `include_closed: true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "assignees[]",
"in": "query",
"description": "Filter by Assignees using people's ClickUp user id. For example: \\\n \\\n`?assignees[]=1234&assignees[]=5678`",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "tags[]",
"in": "query",
"description": "Filter by tags. User `%20` to represent a space character. For example: \\\n \\\n`?tags[]=tag1&tags[]=this%20tag`",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "due_date_gt",
"in": "query",
"description": "Filter by due date greater than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int64"
}
},
{
"name": "due_date_lt",
"in": "query",
"description": "Filter by due date less than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int64"
}
},
{
"name": "date_created_gt",
"in": "query",
"description": "Filter by date created greater than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int64"
}
},
{
"name": "date_created_lt",
"in": "query",
"description": "Filter by date created less than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int64"
}
},
{
"name": "date_updated_gt",
"in": "query",
"description": "Filter by date updated greater than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int64"
}
},
{
"name": "date_updated_lt",
"in": "query",
"description": "Filter by date updated less than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int64"
}
},
{
"name": "date_done_gt",
"in": "query",
"description": "Filter by date done greater than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int64"
}
},
{
"name": "date_done_lt",
"in": "query",
"description": "Filter by date done less than Unix time in milliseconds.",
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int64"
}
},
{
"name": "custom_fields",
"in": "query",
"description": "Include tasks with specific values in one or more Custom Fields. Custom Relationships are included.\\\n \\\nFor example: `?custom_fields=[{\"field_id\":\"abcdefghi12345678\",\"operator\":\"=\",\"value\":\"1234\"}{\"field_id\":\"jklmnop123456\",\"operator\":\"\u003C\",\"value\":\"5\"}]`\\\n \\\nOnly set Custom Field values display in the `value` property of the `custom_fields` parameter. The `=` operator isn't supported with Label Custom Fields.\\\n \\\nLearn more about [filtering using Custom Fields.](doc:taskfilters)",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "parent",
"in": "query",
"description": "Include the parent task ID to return subtasks.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "include_markdown_description",
"in": "query",
"description": "To return task descriptions in Markdown format, use `?include_markdown_description=true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "custom_items[]",
"in": "query",
"description": "Filter by custom task types. For example: \\\n \\\n`?custom_items[]=0&custom_items[]=1300` \\\n \\\nIncluding `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace.",
"style": "form",
"explode": true,
"schema": {
"type": "array",
"items": {
"type": "number"
}
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetFilteredTeamTasksresponse",
"required": [
"tasks"
],
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"title": "Task3",
"required": [
"id",
"custom_id",
"name",
"text_content",
"description",
"status",
"orderindex",
"date_created",
"date_updated",
"date_closed",
"date_done",
"creator",
"assignees",
"watchers",
"checklists",
"tags",
"parent",
"priority",
"due_date",
"start_date",
"points",
"time_estimate",
"custom_fields",
"dependencies",
"linked_tasks",
"team_id",
"url",
"permission_level",
"list",
"project",
"folder",
"space"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_id": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"text_content": {
"type": "string"
},
"description": {
"type": "string"
},
"markdown_description": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"orderindex": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"date_closed": {
"type": "string"
},
"date_done": {
"type": [
"string",
"null"
]
},
"creator": {
"title": "Creator5",
"required": [
"id",
"username",
"color",
"email",
"profilePicture"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"examples": [
{
"id": 123,
"username": "John Doe",
"color": "#000000",
"email": "johndoe@website.com",
"profilePicture": "https://clickup.com/avatar.jpg"
}
]
},
"assignees": {
"type": "array",
"items": {
"title": "Assignees1",
"required": [
"id",
"username",
"color",
"email",
"profilePicture"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"examples": [
{
"id": 123,
"username": "John Doe",
"color": "#000000",
"email": "johndoe@website.com",
"profilePicture": "https://clickup.com/avatar.jpg"
}
]
},
"description": ""
},
"watchers": {
"type": "array",
"items": {
"title": "Watchers1",
"required": [
"id",
"username",
"color",
"email",
"profilePicture"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"examples": [
{
"id": 123,
"username": "John Doe",
"color": "#000000",
"email": "johndoe@website.com",
"profilePicture": "https://clickup.com/avatar.jpg"
}
]
},
"description": ""
},
"checklists": {
"type": "array",
"items": {
"title": "Checklists6",
"required": [
"id",
"task_id",
"name",
"date_created",
"orderindex",
"creator",
"resolved",
"unresolved",
"items"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"task_id": {
"type": "string"
},
"name": {
"type": "string"
},
"date_created": {
"type": "string"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"resolved": {
"type": "integer",
"contentEncoding": "int32"
},
"unresolved": {
"type": "integer",
"contentEncoding": "int32"
},
"items": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1checklist~1%7Bchecklist_id%7D~1checklist_item~1%7Bchecklist_item_id%7D/put/responses/200/content/application~1json/schema/properties/checklist/properties/items/items"
},
"description": ""
}
},
"examples": [
{
"id": "d41340bc-2f17-43cc-ae71-86628f45825f",
"task_id": "3cxv9f",
"name": "Checklist",
"date_created": "1618455803730",
"orderindex": 1,
"creator": 2770032,
"resolved": 0,
"unresolved": 1,
"items": [
{
"id": "9398cb3d-55a4-4c45-ab46-2a47a371e375",
"name": "checklist item 1",
"orderindex": 0,
"assignee": null,
"resolved": false,
"parent": null,
"date_created": "1618455810454",
"children": []
}
]
}
]
},
"description": ""
},
"tags": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items"
},
"description": ""
},
"parent": {
"type": "string"
},
"priority": {
"type": "integer",
"contentEncoding": "int32"
},
"due_date": {
"type": "string"
},
"start_date": {
"type": "string"
},
"points": {
"type": "number"
},
"time_estimate": {
"type": "number"
},
"custom_fields": {
"type": "array",
"items": {
"title": "CustomFields9",
"required": [
"id",
"name",
"type",
"type_config",
"date_created",
"hide_from_guests",
"required"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"type_config": {
"type": "object"
},
"date_created": {
"type": "string"
},
"hide_from_guests": {
"type": "boolean"
},
"required": {
"type": "boolean"
}
},
"examples": [
{
"id": "be43f58e-989e-4233-9f25-27584f094b74",
"name": "Location type Custom Field",
"type": "location",
"type_config": {
},
"date_created": "1617765143523",
"hide_from_guests": false,
"required": false
}
]
},
"description": ""
},
"dependencies": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"linked_tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"team_id": {
"type": "string"
},
"url": {
"type": "string"
},
"permission_level": {
"type": "string"
},
"list": {
"title": "List2",
"required": [
"id",
"name",
"access"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"access": {
"type": "boolean"
}
},
"examples": [
{
"id": "1752",
"name": "Shared with me",
"access": false
}
]
},
"project": {
"title": "Project",
"required": [
"id",
"name",
"hidden",
"access"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"access": {
"type": "boolean"
}
},
"examples": [
{
"id": "1",
"name": "Folder",
"hidden": false,
"access": true
}
]
},
"folder": {
"$ref": "#/paths/~1v2~1list~1%7Blist_id%7D/get/responses/200/content/application~1json/schema/properties/folder"
},
"space": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space"
}
},
"examples": [
{
"id": "av1",
"custom_id": null,
"name": "My First Task",
"text_content": "Task description",
"description": "Task description",
"markdown_description": "Task description",
"status": {
"status": "Open",
"type": "open",
"orderindex": 1,
"color": "#000000"
},
"orderindex": "1.0000",
"date_created": "1508369194377",
"date_updated": "1508369194377",
"date_closed": "1508369194377",
"creator": {
"id": 123,
"username": "John Doe",
"color": "#000000",
"email": "johndoe@website.com",
"profilePicture": "https://clickup.com/avatar.jpg"
},
"assignees": [
{
"id": 123,
"username": "John Doe",
"color": "#000000",
"email": "johndoe@website.com",
"profilePicture": "https://clickup.com/avatar.jpg"
}
],
"watchers": [
{
"id": 123,
"username": "John Doe",
"color": "#000000",
"email": "johndoe@website.com",
"profilePicture": "https://clickup.com/avatar.jpg"
}
],
"checklists": [
{
"id": "d41340bc-2f17-43cc-ae71-86628f45825f",
"task_id": "3cxv9f",
"name": "Checklist",
"date_created": "1618455803730",
"orderindex": 1,
"creator": 2770032,
"resolved": 0,
"unresolved": 1,
"items": [
{
"id": "9398cb3d-55a4-4c45-ab46-2a47a371e375",
"name": "checklist item 1",
"orderindex": 0,
"assignee": null,
"resolved": false,
"parent": null,
"date_created": "1618455810454",
"children": []
}
]
}
],
"tags": [
{
"name": "tagged",
"tag_fg": "#000000",
"tag_bg": "#000000"
}
],
"parent": "av2",
"priority": 1,
"due_date": "1508369194377",
"start_date": "1508369194377",
"points": 3,
"time_estimate": 1.2,
"custom_fields": [
{
"id": "be43f58e-989e-4233-9f25-27584f094b74",
"name": "Location type Custom Field",
"type": "location",
"type_config": {
},
"date_created": "1617765143523",
"hide_from_guests": false,
"required": false
}
],
"dependencies": [],
"linked_tasks": [],
"team_id": "1234",
"url": "https://app.clickup.com/t/av1",
"permission_level": "create",
"list": {
"id": "1",
"name": "List",
"access": true
},
"project": {
"id": "1",
"name": "Folder",
"hidden": false,
"access": true
},
"folder": {
"id": "1",
"name": "Folder",
"hidden": false,
"access": true
},
"space": {
"id": "1"
}
}
]
},
"description": ""
}
},
"examples": [
{
"tasks": [
{
"id": "av1",
"custom_id": null,
"name": "My First Task",
"text_content": "Task description",
"description": "Task description",
"markdown_description": "Task description",
"status": {
"status": "Open",
"type": "open",
"orderindex": 1,
"color": "#000000"
},
"orderindex": "1.0000",
"date_created": "1508369194377",
"date_updated": "1508369194377",
"date_closed": "1508369194377",
"date_done": "1508369194377",
"creator": {
"id": 123,
"username": "John Doe",
"color": "#000000",
"email": "johndoe@website.com",
"profilePicture": "https://clickup.com/avatar.jpg"
},
"assignees": [
{
"id": 123,
"username": "John Doe",
"color": "#000000",
"email": "johndoe@website.com",
"profilePicture": "https://clickup.com/avatar.jpg"
}
],
"watchers": [
{
"id": 123,
"username": "John Doe",
"color": "#000000",
"email": "johndoe@website.com",
"profilePicture": "https://clickup.com/avatar.jpg"
}
],
"checklists": [
{
"id": "d41340bc-2f17-43cc-ae71-86628f45825f",
"task_id": "3cxv9f",
"name": "Checklist",
"date_created": "1618455803730",
"orderindex": 1,
"creator": 2770032,
"resolved": 0,
"unresolved": 1,
"items": [
{
"id": "9398cb3d-55a4-4c45-ab46-2a47a371e375",
"name": "checklist item 1",
"orderindex": 0,
"assignee": null,
"resolved": false,
"parent": null,
"date_created": "1618455810454",
"children": []
}
]
}
],
"tags": [
{
"name": "tagged",
"tag_fg": "#000000",
"tag_bg": "#000000"
}
],
"parent": "av2",
"priority": 1,
"due_date": "1508369194377",
"start_date": "1508369194377",
"points": 3,
"time_estimate": 1.2,
"custom_fields": [
{
"id": "be43f58e-989e-4233-9f25-27584f094b74",
"name": "Location type Custom Field",
"type": "location",
"type_config": {
},
"date_created": "1617765143523",
"hide_from_guests": false,
"required": false
}
],
"dependencies": [],
"linked_tasks": [],
"team_id": "1234",
"url": "https://app.clickup.com/t/av1",
"permission_level": "create",
"list": {
"id": "1",
"name": "List",
"access": true
},
"project": {
"id": "1",
"name": "Folder",
"hidden": false,
"access": true
},
"folder": {
"id": "1",
"name": "Folder",
"hidden": false,
"access": true
},
"space": {
"id": "1"
}
}
]
}
]
},
"example": {
"tasks": [
{
"id": "av1",
"custom_id": null,
"name": "My First Task",
"text_content": "Task description",
"description": "Task description",
"markdown_description": "Task description",
"status": {
"status": "Open",
"type": "open",
"orderindex": 1,
"color": "#000000"
},
"orderindex": "1.0000",
"date_created": "1508369194377",
"date_updated": "1508369194377",
"date_closed": "1508369194377",
"date_done": "1508369194377",
"creator": {
"id": 123,
"username": "John Doe",
"color": "#000000",
"email": "johndoe@website.com",
"profilePicture": "https://clickup.com/avatar.jpg"
},
"assignees": [
{
"id": 123,
"username": "John Doe",
"color": "#000000",
"email": "johndoe@website.com",
"profilePicture": "https://clickup.com/avatar.jpg"
}
],
"watchers": [
{
"id": 123,
"username": "John Doe",
"color": "#000000",
"email": "johndoe@website.com",
"profilePicture": "https://clickup.com/avatar.jpg"
}
],
"checklists": [
{
"id": "d41340bc-2f17-43cc-ae71-86628f45825f",
"task_id": "3cxv9f",
"name": "Checklist",
"date_created": "1618455803730",
"orderindex": 1,
"creator": 2770032,
"resolved": 0,
"unresolved": 1,
"items": [
{
"id": "9398cb3d-55a4-4c45-ab46-2a47a371e375",
"name": "checklist item 1",
"orderindex": 0,
"assignee": null,
"resolved": false,
"parent": null,
"date_created": "1618455810454",
"children": []
}
]
}
],
"tags": [
{
"name": "tagged",
"tag_fg": "#000000",
"tag_bg": "#000000"
}
],
"parent": "av2",
"priority": 1,
"due_date": "1508369194377",
"start_date": "1508369194377",
"points": 3,
"time_estimate": 1.2,
"custom_fields": [
{
"id": "be43f58e-989e-4233-9f25-27584f094b74",
"name": "Location type Custom Field",
"type": "location",
"type_config": {
},
"date_created": "1617765143523",
"hide_from_guests": false,
"required": false
}
],
"dependencies": [],
"linked_tasks": [],
"team_id": "1234",
"url": "https://app.clickup.com/t/av1",
"permission_level": "create",
"list": {
"id": "1",
"name": "List",
"access": true
},
"project": {
"id": "1",
"name": "Folder",
"hidden": false,
"access": true
},
"folder": {
"id": "1",
"name": "Folder",
"hidden": false,
"access": true
},
"space": {
"id": "1"
}
}
]
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/task/{task_id}/merge": {
"post": {
"summary": "Merge Tasks",
"description": "Merge multiple tasks into a target task. The target task is specified by the task_id parameter, while the source tasks to be merged are provided in the request body. Custom Task IDs are not supported.",
"tags": [
"Tasks"
],
"operationId": "mergeTasks",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "ID of the target task that other tasks will be merged into.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hv"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"source_task_ids"
],
"properties": {
"source_task_ids": {
"type": "array",
"description": "Array of task IDs to merge into the target task.",
"items": {
"type": "string"
},
"examples": [
[
"abc123",
"def456"
]
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Tasks merged successfully"
},
"400": {
"description": "Bad request - invalid task IDs or other validation errors"
},
"403": {
"description": "Unauthorized to merge these tasks"
},
"404": {
"description": "One or more tasks not found"
}
}
}
},
"/v2/task/{task_id}/time_in_status": {
"get": {
"summary": "Get Task's Time in Status",
"tags": [
"Tasks"
],
"description": "View how long a task has been in each status. The Total time in Status ClickApp must first be enabled by the Workspace owner or an admin.",
"operationId": "GetTask'sTimeinStatus",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hz"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetTasksTimeinStatusresponse",
"required": [
"current_status",
"status_history"
],
"type": "object",
"properties": {
"current_status": {
"title": "CurrentStatus",
"required": [
"status",
"color",
"total_time"
],
"type": "object",
"properties": {
"status": {
"type": "string"
},
"color": {
"type": "string"
},
"total_time": {
"title": "TotalTime",
"required": [
"by_minute",
"since"
],
"type": "object",
"properties": {
"by_minute": {
"type": "integer",
"contentEncoding": "int32"
},
"since": {
"type": "string"
}
},
"examples": [
{
"by_minute": 21708,
"since": "1604004423494"
}
]
}
},
"examples": [
{
"status": "open",
"color": "#d3d3d3",
"total_time": {
"by_minute": 21708,
"since": "1604004423494"
}
}
]
},
"status_history": {
"type": "array",
"items": {
"title": "StatusHistory",
"required": [
"status",
"color",
"type",
"total_time",
"orderindex"
],
"type": "object",
"properties": {
"status": {
"type": "string"
},
"color": {
"type": "string"
},
"type": {
"type": "string"
},
"total_time": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/current_status/properties/total_time"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"status": "open",
"color": "#d3d3d3",
"type": "open",
"total_time": {
"by_minute": 21707,
"since": "1604004423494"
},
"orderindex": 0
}
]
},
"description": ""
}
},
"examples": [
{
"current_status": {
"status": "open",
"color": "#d3d3d3",
"total_time": {
"by_minute": 21708,
"since": "1604004423494"
}
},
"status_history": [
{
"status": "open",
"color": "#d3d3d3",
"type": "open",
"total_time": {
"by_minute": 21707,
"since": "1604004423494"
},
"orderindex": 0
},
{
"status": "active status",
"color": "#5CF1D4",
"type": "custom",
"total_time": {
"by_minute": 23274,
"since": "1602607941692"
},
"orderindex": 4
}
]
}
]
},
"example": {
"current_status": {
"status": "open",
"color": "#d3d3d3",
"total_time": {
"by_minute": 21708,
"since": "1604004423494"
}
},
"status_history": [
{
"status": "open",
"color": "#d3d3d3",
"type": "open",
"total_time": {
"by_minute": 21707,
"since": "1604004423494"
},
"orderindex": 0
},
{
"status": "active status",
"color": "#5CF1D4",
"type": "custom",
"total_time": {
"by_minute": 23274,
"since": "1602607941692"
},
"orderindex": 4
}
]
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/task/bulk_time_in_status/task_ids": {
"get": {
"summary": "Get Bulk Tasks' Time in Status",
"tags": [
"Tasks"
],
"description": "View how long two or more tasks have been in each status. The Total time in Status ClickApp must first be enabled by the Workspace owner or an admin.",
"operationId": "GetBulkTasks'TimeinStatus",
"parameters": [
{
"name": "task_ids",
"in": "query",
"description": "Include this paramater once per `task_id`.\nYou can include up to 100 task ids per request.\nFor example: `task_ids=3cuh&task_ids=g4fs`",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetBulkTasksTimeinStatusresponse",
"required": [
"27075wz",
"20bbn28"
],
"type": "object",
"properties": {
"27075wz": {
"title": "27075wz",
"required": [
"current_status",
"status_history"
],
"type": "object",
"properties": {
"current_status": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/current_status"
},
"status_history": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/status_history/items"
},
"description": ""
}
},
"examples": [
{
"current_status": {
"status": "open",
"color": "#d3d3d3",
"total_time": {
"by_minute": 21830,
"since": "1604004423496"
}
},
"status_history": [
{
"status": "open",
"color": "#d3d3d3",
"type": "open",
"total_time": {
"by_minute": 21829,
"since": "1604004423494"
},
"orderindex": 0
},
{
"status": "active status #2",
"color": "#5CF1D4",
"type": "custom",
"total_time": {
"by_minute": 23274,
"since": "1602607941692"
},
"orderindex": 4
}
]
}
]
},
"20bbn28": {
"title": "20bbn28",
"required": [
"current_status",
"status_history"
],
"type": "object",
"properties": {
"current_status": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/current_status"
},
"status_history": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1time_in_status/get/responses/200/content/application~1json/schema/properties/status_history/items"
},
"description": ""
}
},
"examples": [
{
"current_status": {
"status": "open",
"color": "#d3d3d3",
"total_time": {
"by_minute": 21830,
"since": "1604004420924"
}
},
"status_history": [
{
"status": "open",
"color": "#d3d3d3",
"type": "open",
"total_time": {
"by_minute": 22276,
"since": "1604004420925"
},
"orderindex": 0
},
{
"status": "active status #2",
"color": "#5CF1D4",
"type": "custom",
"total_time": {
"by_minute": 40109,
"since": "1601597828835"
},
"orderindex": 4
}
]
}
]
}
},
"examples": [
{
"27075wz": {
"current_status": {
"status": "open",
"color": "#d3d3d3",
"total_time": {
"by_minute": 21830,
"since": "1604004423494"
}
},
"status_history": [
{
"status": "open",
"color": "#d3d3d3",
"type": "open",
"total_time": {
"by_minute": 21829,
"since": "1604004423494"
},
"orderindex": 0
},
{
"status": "active status #2",
"color": "#5CF1D4",
"type": "custom",
"total_time": {
"by_minute": 23274,
"since": "1602607941692"
},
"orderindex": 4
}
]
},
"20bbn28": {
"current_status": {
"status": "open",
"color": "#d3d3d3",
"total_time": {
"by_minute": 21830,
"since": "1604004420925"
}
},
"status_history": [
{
"status": "open",
"color": "#d3d3d3",
"type": "open",
"total_time": {
"by_minute": 22276,
"since": "1604004420925"
},
"orderindex": 0
},
{
"status": "active status #2",
"color": "#5CF1D4",
"type": "custom",
"total_time": {
"by_minute": 40109,
"since": "1601597828835"
},
"orderindex": 4
}
]
}
}
]
},
"example": {
"27075wz": {
"current_status": {
"status": "open",
"color": "#d3d3d3",
"total_time": {
"by_minute": 21830,
"since": "1604004423494"
}
},
"status_history": [
{
"status": "open",
"color": "#d3d3d3",
"type": "open",
"total_time": {
"by_minute": 21829,
"since": "1604004423494"
},
"orderindex": 0
},
{
"status": "active status #2",
"color": "#5CF1D4",
"type": "custom",
"total_time": {
"by_minute": 23274,
"since": "1602607941692"
},
"orderindex": 4
}
]
},
"20bbn28": {
"current_status": {
"status": "open",
"color": "#d3d3d3",
"total_time": {
"by_minute": 21830,
"since": "1604004420925"
}
},
"status_history": [
{
"status": "open",
"color": "#d3d3d3",
"type": "open",
"total_time": {
"by_minute": 22276,
"since": "1604004420925"
},
"orderindex": 0
},
{
"status": "active status #2",
"color": "#5CF1D4",
"type": "custom",
"total_time": {
"by_minute": 40109,
"since": "1601597828835"
},
"orderindex": 4
}
]
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/taskTemplate": {
"get": {
"summary": "Get Task Templates",
"tags": [
"Templates"
],
"description": "View the task templates available in a Workspace.",
"operationId": "GetTaskTemplates",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32",
"examples": [0]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetTaskTemplatesresponse",
"required": [
"templates"
],
"type": "object",
"properties": {
"templates": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"examples": [
{
"templates": []
}
]
},
"example": {
"templates": []
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/list/{list_id}/taskTemplate/{template_id}": {
"post": {
"summary": "Create Task From Template",
"description": "Create a new task using a task template defined in your workspace. Publicly shared templates must be [added to your Workspace](https://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library) before you can use them with the public API.\n",
"operationId": "CreateTaskFromTemplate",
"tags": [
"Tasks"
],
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [512]
}
},
{
"name": "template_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hz"
]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateTaskFromTemplaterequest",
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"examples": [
{
"name": "New task name"
}
]
},
"example": {
"name": "New task name"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"contentMediaType": "application/json"
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/folder/{folder_id}/list_template/{template_id}": {
"post": {
"summary": "Create List From Template in Folder",
"tags": [
"Lists"
],
"description": "Create a new list using a list template in a Folder. Publicly shared templates must be [added to your Workspace](https://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library) before you can use them with the public API.\nThis request runs synchronously by default with `return_immediately=true`.\nThe request returns the future List ID immediatly, but the List may not be created when the response is sent.\nSmall templates can be applied synchronously, which guarantees that all sub objects are created.\nIn case of a timeout on synchronous requests, the objects from the template will continue to be created past the timeout.\n",
"operationId": "CreateFolderListFromTemplate",
"parameters": [
{
"in": "path",
"name": "folder_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the Folder where the List will be created"
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the template to use"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the new List"
},
"options": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/requestBody/content/application~1json/schema/properties/options"
}
}
}
}
}
},
"responses": {
"200": {
"description": "List created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1v2~1space~1%7Bspace_id%7D~1list_template~1%7Btemplate_id%7D/post/responses/200/content/application~1json/schema"
}
}
}
},
"400": {
"description": "Bad request - Name is required",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Name is required"
},
"ECODE": {
"type": "string",
"example": "OAUTH_117"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Template, folder, or space not found"
},
"500": {
"description": "Internal server error"
}
}
}
},
"/v2/space/{space_id}/list_template/{template_id}": {
"post": {
"summary": "Create List From Template in Space.",
"tags": [
"Lists"
],
"description": "Create a new List using a List template within a Space. Publicly shared templates must be [added to your Workspace](https://help.clickup.com/hc/en-us/articles/6326023965591-Add-a-template-to-your-library) before you can use them with the public API.\nThis request can be run asynchronously or synchronously via the `return_immediately` parameter.\n",
"operationId": "CreateSpaceListFromTemplate",
"parameters": [
{
"in": "path",
"name": "space_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the Space where the List will be created"
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the template to use"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "Name of the new List"
},
"options": {
"type": "object",
"description": "Options for creating the List",
"properties": {
"return_immediately": {
"type": "boolean",
"description": "Flag if newly created Object ID should be returned without waiting for the asset itself and all its nested assets to be applied. If set to true, access checks are performed before returning, but the object might not be fully created yet. In case of a timeout on syncronous requests, the of objects from the template will continue to be created past the timeout.\n",
"default": true
},
"content": {
"type": "string",
"description": "List description"
},
"time_estimate": {
"type": "number",
"description": "Include time (hours, minutes and seconds)"
},
"automation": {
"type": "boolean",
"description": "Import automation settings"
},
"include_views": {
"type": "boolean",
"description": "Import views"
},
"old_due_date": {
"type": "boolean",
"description": "Import tasks' due dates"
},
"old_start_date": {
"type": "boolean",
"description": "Import tasks' start dates"
},
"old_followers": {
"type": "boolean",
"description": "Import tasks' watchers"
},
"comment_attachments": {
"type": "boolean",
"description": "Import tasks' comment attachments"
},
"recur_settings": {
"type": "boolean",
"description": "Import tasks' recurring settings"
},
"old_tags": {
"type": "boolean",
"description": "Import tasks' tags"
},
"old_statuses": {
"type": "boolean",
"description": "Import tasks' status settings"
},
"subtasks": {
"type": "boolean",
"description": "Import tasks' subtasks"
},
"custom_type": {
"type": "boolean",
"description": "Import tasks' task types"
},
"old_assignees": {
"type": "boolean",
"description": "Import tasks' assignees"
},
"attachments": {
"type": "boolean",
"description": "Import tasks' attachments"
},
"comment": {
"type": "boolean",
"description": "Import tasks' comments"
},
"old_status": {
"type": "boolean",
"description": "Import tasks' current statuses"
},
"external_dependencies": {
"type": "boolean",
"description": "Import tasks' external dependencies"
},
"internal_dependencies": {
"type": "boolean",
"description": "Import tasks' internal dependencies"
},
"priority": {
"type": "boolean",
"description": "Import tasks' priorities"
},
"custom_fields": {
"type": "boolean",
"description": "Import tasks' Custom Fields"
},
"old_checklists": {
"type": "boolean",
"description": "Import tasks' checklists"
},
"relationships": {
"type": "boolean",
"description": "Import tasks' relationships"
},
"old_subtask_assignees": {
"type": "boolean",
"description": "Import tasks' subtask assignees"
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Project start date for remapping dates"
},
"due_date": {
"type": "string",
"format": "date-time",
"description": "Project due date for remapping dates"
},
"remap_start_date": {
"type": "boolean",
"description": "Remap start dates"
},
"skip_weekends": {
"type": "boolean",
"description": "Skip weekends when remapping dates"
},
"archived": {
"type": "integer",
"enum": [1, 2, null],
"description": "Include archived tasks"
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "List created successfully",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Response object returned when a new List is created from a template in a Folder or Space.",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the newly created List",
"example": "901107394085"
},
"list": {
"type": "object",
"description": "Detailed information about the created List",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the List (matches parent id)",
"example": "901107394085"
},
"name": {
"type": "string",
"description": "Display name of the List",
"example": "API Folder in Space"
},
"deleted": {
"type": "boolean",
"description": "Indicates if the List has been marked as deleted",
"example": true
},
"orderindex": {
"type": "integer",
"description": "Position of the List relative to other Lists in the same container",
"example": 0
},
"priority": {
"type": "string",
"description": "Priority level of the List, if applicable",
"nullable": true,
"example": null
},
"assignee": {
"type": "string",
"description": "Default assignee for the List, if applicable",
"nullable": true,
"example": null
},
"due_date": {
"type": "string",
"format": "date-time",
"description": "Default due date for tasks in the List",
"nullable": true,
"example": null
},
"start_date": {
"type": "string",
"format": "date-time",
"description": "Default start date for tasks in the List",
"nullable": true,
"example": null
},
"folder": {
"type": "object",
"description": "Information about the parent Folder containing this List, if applicable",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the parent Folder",
"example": "90114317916"
},
"name": {
"type": "string",
"description": "Display name of the parent Folder",
"example": "hidden"
},
"hidden": {
"type": "boolean",
"description": "Indicates if the Folder is hidden from standard views",
"example": true
},
"access": {
"type": "boolean",
"description": "Indicates if the current user has access to this Folder",
"example": true
}
}
},
"space": {
"type": "object",
"description": "Information about the Workspace Space containing this List",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the Space",
"example": "90112667046"
},
"name": {
"type": "string",
"description": "Display name of the Space",
"example": "API Test Space"
},
"access": {
"type": "boolean",
"description": "Indicates if the current user has access to this Space",
"example": true
}
}
},
"inbound_address": {
"type": "string",
"description": "Email address that can be used to create tasks in this List via email",
"example": "abc-list@tasks.clickup.com"
},
"archived": {
"type": "boolean",
"description": "Indicates if the List is archived",
"example": false
},
"override_statuses": {
"type": "boolean",
"description": "Indicates if this List uses custom statuses instead of Space default statuses",
"example": true
},
"statuses": {
"type": "array",
"description": "List of available statuses for tasks in this List",
"items": {
"type": "object",
"description": "Status configuration object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the status",
"example": "sc901107394085_DCnaeiSB"
},
"status": {
"type": "string",
"description": "Display name of the status",
"example": "to do"
},
"orderindex": {
"type": "integer",
"description": "Position of this status in the status list",
"example": 0
},
"color": {
"type": "string",
"description": "Color code associated with this status",
"example": "#87909e"
},
"type": {
"type": "string",
"description": "Category of the status (e.g., open, closed, in progress)",
"example": "open"
},
"status_group": {
"type": "string",
"description": "TODO - Identifier for grouping related statuses",
"example": "subcat_901107394085"
}
}
}
},
"permission_level": {
"type": "string",
"description": "Access level the current user has for this List (e.g., create, edit, view)",
"example": "create"
}
}
}
}
}
}
}
},
"400": {
"description": "Bad request - Name is required, or is already taken",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"example": "Name is required"
},
"ECODE": {
"type": "string",
"example": "OAUTH_117"
}
}
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Template, folder, or space not found"
},
"500": {
"description": "Internal server error"
}
}
}
},
"/v2/team/{team_id}/seats": {
"get": {
"summary": "Get Workspace seats",
"tags": [
"Workspaces"
],
"description": "View the used, total, and available member and guest seats for a Workspace.",
"operationId": "GetWorkspaceseats",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetWorkspaceseatsresponse",
"required": [
"members",
"guests"
],
"type": "object",
"properties": {
"members": {
"title": "Members",
"required": [
"filled_members_seats",
"total_member_seats",
"empty_member_seats"
],
"type": "object",
"properties": {
"filled_members_seats": {
"type": "integer",
"contentEncoding": "int32"
},
"total_member_seats": {
"type": "integer",
"contentEncoding": "int32"
},
"empty_member_seats": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"filled_members_seats": 9,
"total_member_seats": 9,
"empty_member_seats": 0
}
]
},
"guests": {
"title": "Guests",
"required": [
"filled_guest_seats",
"total_guest_seats",
"empty_guest_seats"
],
"type": "object",
"properties": {
"filled_guest_seats": {
"type": "integer",
"contentEncoding": "int32"
},
"total_guest_seats": {
"oneOf": [
{
"type": "integer",
"contentEncoding": "int32"
},
{
"type": "string",
"enum": [
"Infinity"
]
}
]
},
"empty_guest_seats": {
"oneOf": [
{
"type": "integer",
"contentEncoding": "int32"
},
{
"type": "string",
"enum": [
"Infinity"
]
}
]
}
},
"examples": [
{
"filled_guest_seats": 2,
"total_guest_seats": 50,
"empty_guest_seats": 48
},
{
"filled_guest_seats": 2,
"total_guest_seats": "Infinity",
"empty_guest_seats": "Infinity"
}
]
}
},
"examples": [
{
"members": {
"filled_members_seats": 9,
"total_member_seats": 9,
"empty_member_seats": 0
},
"guests": {
"filled_guest_seats": 2,
"total_guest_seats": 50,
"empty_guest_seats": 48
}
},
{
"members": {
"filled_members_seats": 9,
"total_member_seats": 9,
"empty_member_seats": 0
},
"guests": {
"filled_guest_seats": 2,
"total_guest_seats": "Infinity",
"empty_guest_seats": "Infinity"
}
}
]
},
"example": {
"members": {
"filled_members_seats": 9,
"total_member_seats": 9,
"empty_member_seats": 0
},
"guests": {
"filled_guest_seats": 2,
"total_guest_seats": 50,
"empty_guest_seats": 48
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/plan": {
"get": {
"summary": "Get Workspace Plan",
"tags": [
"Workspaces"
],
"description": "View the current [Plan](https://clickup.com/pricing) for the specified Workspace.",
"operationId": "GetWorkspaceplan",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetWorkspaceplanresponse",
"type": "object",
"properties": {
"plan_name": {
"type": "string"
},
"plan_id": {
"type": "integer"
}
},
"examples": [
{
"plan_name": "Enterprise",
"plan_id": 4
}
]
},
"example": {
"plan_name": "Enterprise",
"plan_id": 4
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/group": {
"post": {
"summary": "Create Group",
"tags": [
"User Groups"
],
"description": "This endpoint creates a [User Group](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups) within a Workspace.\\\n \\\nUser Groups are used to organize and manage users within a Workspace.\\\n \\\nIn the API documentation, `team_id` refers to the Workspace ID, and `group_id` refers to the User Group ID.\\\n \\\n**Note:** Adding a guest with view-only permissions to a Team automatically converts them to a paid guest.\\\n \\\nIf no paid guest seats are available, an additional member seat will be added, increasing the number of paid guest seats.\\\n \\\nThis change incurs a prorated charge based on the billing cycle.",
"operationId": "CreateUserGroup",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateTeamrequest",
"required": [
"name",
"members"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"handle": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
}
},
"examples": [
{
"name": "New team name",
"handle": "newteamname",
"members": [123456, 987654]
}
]
},
"example": {
"name": "New User Group name",
"handle": "newusergroupname",
"members": [123456, 987654]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateTeamresponse",
"required": [
"id",
"team_id",
"userid",
"name",
"handle",
"date_created",
"initials",
"members",
"avatar"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"team_id": {
"type": "string"
},
"userid": {
"type": "integer",
"contentEncoding": "int32"
},
"name": {
"type": "string"
},
"handle": {
"type": "string"
},
"date_created": {
"type": "string"
},
"initials": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"title": "Members1",
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"examples": [
{
"id": 185,
"username": "Sam",
"email": "sam@example.com",
"color": "#4169E1",
"initials": "S",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
}
]
},
"description": ""
},
"avatar": {
"$ref": "#/paths/~1v2~1group~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/properties/avatar"
}
},
"examples": [
{
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d",
"team_id": "301540",
"userid": 301828,
"name": "User group",
"handle": "usergroup",
"date_created": "1640122639829",
"initials": "U",
"members": [
{
"id": 185,
"username": "Sam",
"email": "sam@example.com",
"color": "#4169E1",
"initials": "S",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
{
"id": 186,
"username": "Alex",
"email": "alex@example.com",
"color": "#4169E1",
"initials": "A",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
}
],
"avatar": {
"attachment_id": null,
"color": null,
"source": null,
"icon": null
}
}
]
},
"example": {
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d",
"team_id": "301540",
"userid": 301828,
"name": "User group",
"handle": "usergroup",
"date_created": "1640122639829",
"initials": "U",
"members": [
{
"id": 185,
"username": "Sam",
"email": "sam@example.com",
"color": "#4169E1",
"initials": "S",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
{
"id": 186,
"username": "Alex",
"email": "alex@example.com",
"color": "#4169E1",
"initials": "A",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
}
],
"avatar": {
"attachment_id": null,
"color": null,
"source": null,
"icon": null
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/custom_item": {
"get": {
"summary": "Get Custom Task Types",
"tags": [
"Custom Task Types"
],
"description": "View the custom task types available in a Workspace.",
"operationId": "GetCustomItems",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetCustomItemsResponse",
"type": "object",
"properties": {
"custom_items": {
"type": "array",
"items": {
"title": "Custom Item",
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32",
"description": "Custom task type ID."
},
"name": {
"type": "string",
"description": "Custom task type name."
},
"name_plural": {
"type": "string",
"description": "Custom task type plural name."
},
"description": {
"type": "string",
"description": "Custom task type description."
}
},
"examples": [
{
"id": 1300,
"name": "Bug",
"name_plural": "Bugs",
"description": "Custom task type for bugs."
}
]
},
"description": "Array of custom task types."
}
},
"examples": [
{
"custom_items": [
{
"id": "1300-900e-462d-a849-4a216b06d930",
"name": "Bug",
"name_plural": "Bugs",
"description": "Custom item type for bugs."
}
]
}
]
},
"example": [
{
"custom_items": [
{
"id": 1300,
"name": "Bug",
"name_plural": "Bugs",
"description": "Custom item type for bugs."
}
]
}
]
}
}
}
},
"deprecated": false
}
},
"/v2/group/{group_id}": {
"put": {
"summary": "Update Group",
"tags": [
"User Groups"
],
"description": "This endpoint is used to manage [User Groups](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups), which are groups of users within your Workspace.\\\n \\\nIn our API, `team_id` in the path refers to the Workspace ID, and `group_id` refers to the ID of a User Group.\\\n \\\n**Note:** Adding a guest with view-only permissions to a User Group automatically converts them to a paid guest.\\\n \\\nIf you don't have any paid guest seats available, a new member seat is automatically added to increase the number of paid guest seats.\\\n \\\nThis incurs a prorated charge based on your billing cycle.",
"operationId": "UpdateTeam",
"parameters": [
{
"name": "group_id",
"in": "path",
"description": "User Group ID",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"C9C58BE9"
]
}
}
],
"requestBody": {
"description": "The group handle can be updated, which is used to @mention a User Group within the Workspace.\\\n \\\nModify Group members by using the \"add\" and \"rem\" parameters with an array of user IDs to include or exclude members.",
"content": {
"application/json": {
"schema": {
"title": "UpdateTeamrequest",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"handle": {
"type": "string"
},
"members": {
"title": "Members2",
"required": [
"add",
"rem"
],
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"rem": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
}
},
"examples": [
{
"add": [123456, 987654],
"rem": [159753]
}
]
}
},
"examples": [
{
"name": "New User Group Name",
"handle": "newusergroupname",
"members": {
"add": [123456, 987654],
"rem": [159753]
}
}
]
},
"example": {
"name": "New User Group Name",
"handle": "newusergroupname",
"members": {
"add": [123456, 987654],
"rem": [159753]
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "UpdateTeamresponse",
"required": [
"id",
"team_id",
"userid",
"name",
"handle",
"date_created",
"initials",
"members",
"avatar"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"team_id": {
"type": "string"
},
"userid": {
"type": "integer",
"contentEncoding": "int32"
},
"name": {
"type": "string"
},
"handle": {
"type": "string"
},
"date_created": {
"type": "string"
},
"initials": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"title": "Members3",
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
},
"profilePicture": {
"type": [
"string",
"null"
]
}
},
"examples": [
{
"id": 201,
"username": "Jim Halpert",
"email": "jim@example.com",
"color": "#40BC86",
"initials": "JH",
"profilePicture": null
}
]
},
"description": ""
},
"avatar": {
"title": "Avatar",
"required": [
"attachment_id",
"color",
"source",
"icon"
],
"type": "object",
"properties": {
"attachment_id": {
"type": [
"string",
"null"
]
},
"color": {
"type": [
"string",
"null"
]
},
"source": {
"type": [
"string",
"null"
]
},
"icon": {
"type": [
"string",
"null"
]
}
},
"examples": [
{
"attachment_id": null,
"color": null,
"source": null,
"icon": null
}
]
}
},
"examples": [
{
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d",
"team_id": "123456",
"userid": 301828,
"name": "New User Group Name",
"handle": "newusergroupname",
"date_created": "1640122639829",
"initials": "NN",
"members": [
{
"id": 201,
"username": "Jim Halpert",
"email": "jim@example.com",
"color": "#40BC86",
"initials": "JH",
"profilePicture": null
},
{
"id": 202,
"username": "Dwight Shrute",
"email": "dwight@example.com",
"color": "#FF8600",
"initials": "DS",
"profilePicture": null
}
],
"avatar": {
"attachment_id": null,
"color": null,
"source": null,
"icon": null
}
}
]
},
"example": {
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d",
"team_id": "123456",
"userid": 301828,
"name": "New User Group Name",
"handle": "newusergroupname",
"date_created": "1640122639829",
"initials": "NN",
"members": [
{
"id": 201,
"username": "Jim Halpert",
"email": "jim@example.com",
"color": "#40BC86",
"initials": "JH",
"profilePicture": null
},
{
"id": 202,
"username": "Dwight Shrute",
"email": "dwight@example.com",
"color": "#FF8600",
"initials": "DS",
"profilePicture": null
}
],
"avatar": {
"attachment_id": null,
"color": null,
"source": null,
"icon": null
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Group",
"tags": [
"User Groups"
],
"description": "This endpoint is used to remove a [User Group](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups) from your Workspace.\\\n \\\nIn our API documentation, `team_id` refers to the id of a Workspace, and `group_id` refers to the id of a user group.",
"operationId": "DeleteTeam",
"parameters": [
{
"name": "group_id",
"in": "path",
"description": "User Group ID",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"C9C58BE9"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/group": {
"get": {
"summary": "Get Groups",
"tags": [
"User Groups"
],
"description": "This endpoint is used to view [User Groups](https://docs.clickup.com/en/articles/4010016-teams-how-to-create-user-groups) in your Workspace.\\\n \\\nIn our API documentation, `team_id` refers to the ID of a Workspace, and `group_id` refers to the ID of a User Group.",
"operationId": "GetTeams1",
"parameters": [
{
"name": "team_id",
"in": "query",
"description": "Workspace ID",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "group_ids",
"in": "query",
"description": "Enter one or more User Group IDs to retrieve information about specific User Group.",
"style": "form",
"explode": true,
"schema": {
"type": "string",
"examples": [
"C9C58BE9-7C73-4002-A6A9-310014852858"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetTeamsresponse",
"required": [
"groups"
],
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"title": "Group",
"required": [
"id",
"team_id",
"userid",
"name",
"handle",
"date_created",
"initials",
"members",
"avatar"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"team_id": {
"type": "string"
},
"userid": {
"type": "integer",
"contentEncoding": "int32"
},
"name": {
"type": "string"
},
"handle": {
"type": "string"
},
"date_created": {
"type": "string"
},
"initials": {
"type": "string"
},
"members": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1group~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/properties/members/items"
},
"description": ""
},
"avatar": {
"$ref": "#/paths/~1v2~1group~1%7Bgroup_id%7D/put/responses/200/content/application~1json/schema/properties/avatar"
}
},
"examples": [
{
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d",
"team_id": "123456",
"userid": 301123,
"name": "product team",
"handle": "product",
"date_created": "1640122639829",
"initials": "PT",
"members": [
{
"id": 183,
"username": "Jerry",
"email": "jerry@example.com",
"color": "#40BC86",
"initials": "J",
"profilePicture": null
},
{
"id": 184,
"username": "Sam",
"email": "sam@example.com",
"color": "#FF8600",
"initials": "S",
"profilePicture": null
}
],
"avatar": {
"attachment_id": null,
"color": null,
"source": null,
"icon": null
}
}
]
},
"description": ""
}
},
"examples": [
{
"groups": [
{
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d",
"team_id": "123456",
"userid": 301123,
"name": "product team",
"handle": "product",
"date_created": "1640122639829",
"initials": "PT",
"members": [
{
"id": 183,
"username": "Jerry",
"email": "jerry@example.com",
"color": "#40BC86",
"initials": "J",
"profilePicture": null
},
{
"id": 184,
"username": "Sam",
"email": "sam@example.com",
"color": "#FF8600",
"initials": "S",
"profilePicture": null
}
],
"avatar": {
"attachment_id": null,
"color": null,
"source": null,
"icon": null
}
},
{
"id": "fd31be63-41f2-4320-9043-9786fdf643d6",
"team_id": "301540",
"userid": 301828,
"name": "HR department",
"handle": "hr-dept",
"date_created": "1627087990293",
"initials": "HD",
"members": [
{
"id": 183,
"username": "Jerry",
"email": "jerry@example.com",
"color": "#40BC86",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
}
],
"avatar": {
"attachment_id": null,
"color": null,
"source": null,
"icon": null
}
}
]
}
]
},
"example": {
"groups": [
{
"id": "4bfdfcec-6f4f-40a7-b0d6-22660d51870d",
"team_id": "123456",
"userid": 301123,
"name": "product managers",
"handle": "product",
"date_created": "1640122639829",
"initials": "PT",
"members": [
{
"id": 183,
"username": "Jerry",
"email": "jerry@example.com",
"color": "#40BC86",
"initials": "J",
"profilePicture": null
},
{
"id": 184,
"username": "Sam",
"email": "sam@example.com",
"color": "#FF8600",
"initials": "S",
"profilePicture": null
}
],
"avatar": {
"attachment_id": null,
"color": null,
"source": null,
"icon": null
}
},
{
"id": "fd31be63-41f2-4320-9043-9786fdf643d6",
"team_id": "301540",
"userid": 301828,
"name": "HR department",
"handle": "hr-dept",
"date_created": "1627087990293",
"initials": "HD",
"members": [
{
"id": 183,
"username": "Jerry",
"email": "jerry@example.com",
"color": "#40BC86",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
}
],
"avatar": {
"attachment_id": null,
"color": null,
"source": null,
"icon": null
}
}
]
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/task/{task_id}/time": {
"get": {
"summary": "Get tracked time",
"tags": [
"Time Tracking (Legacy)"
],
"description": "***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*",
"operationId": "Gettrackedtime",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hv"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "Gettrackedtimeresponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"title": "Datum",
"required": [
"user",
"time",
"intervals"
],
"type": "object",
"properties": {
"user": {
"title": "User13",
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
},
"profilePicture": {
"type": [
"string",
"null"
]
}
},
"examples": [
{
"id": 1,
"username": "John Doe",
"email": "johndoe@gmail.com",
"color": "#795548",
"initials": "JD",
"profilePicture": null
}
]
},
"time": {
"type": "integer",
"contentEncoding": "int32"
},
"intervals": {
"type": "array",
"items": {
"title": "Interval",
"required": [
"id",
"start",
"end",
"time",
"source",
"date_added"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"start": {
"type": [
"string",
"null"
]
},
"end": {
"type": [
"string",
"null"
]
},
"time": {
"type": "string"
},
"source": {
"type": "string"
},
"date_added": {
"type": "string"
}
},
"examples": [
{
"id": "318",
"start": null,
"end": null,
"time": "1000000",
"source": "chrome",
"date_added": "1569983937761"
}
]
},
"description": ""
}
},
"examples": [
{
"user": {
"id": 1,
"username": "John Doe",
"email": "johndoe@gmail.com",
"color": "#795548",
"initials": "JD",
"profilePicture": null
},
"time": 1000000,
"intervals": [
{
"id": "318",
"start": null,
"end": null,
"time": "1000000",
"source": "chrome",
"date_added": "1569983937761"
}
]
}
]
},
"description": ""
}
},
"examples": [
{
"data": [
{
"user": {
"id": 1,
"username": "John Doe",
"email": "johndoe@gmail.com",
"color": "#795548",
"initials": "JD",
"profilePicture": null
},
"time": 1000000,
"intervals": [
{
"id": "318",
"start": null,
"end": null,
"time": "1000000",
"source": "chrome",
"date_added": "1569983937761"
}
]
}
]
}
]
},
"example": {
"data": [
{
"user": {
"id": 1,
"username": "John Doe",
"email": "johndoe@gmail.com",
"color": "#795548",
"initials": "JD",
"profilePicture": null
},
"time": 1000000,
"intervals": [
{
"id": "318",
"start": null,
"end": null,
"time": "1000000",
"source": "chrome",
"date_added": "1569983937761"
}
]
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Track time",
"tags": [
"Time Tracking (Legacy)"
],
"description": "***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*",
"operationId": "Tracktime",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hv"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "Include the total time or the start time and end time.\\\n \\\nThe total time is in milliseconds and `\"start\"` and `\"end\"` values are Unix time in milliseconds.",
"content": {
"application/json": {
"schema": {
"title": "Tracktimerequest",
"required": [
"start",
"end",
"time"
],
"type": "object",
"properties": {
"start": {
"type": "integer",
"contentEncoding": "int64"
},
"end": {
"type": "integer",
"contentEncoding": "int64"
},
"time": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"start": 1567780450202,
"end": 1508369194377,
"time": 8640000
}
]
},
"example": {
"start": 1567780450202,
"end": 1508369194377,
"time": 8640000
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "Tracktimeresponse",
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"examples": [
{
"id": "123"
}
]
},
"example": {
"id": "123"
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/task/{task_id}/time/{interval_id}": {
"put": {
"summary": "Edit time tracked",
"tags": [
"Time Tracking (Legacy)"
],
"description": "***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*",
"operationId": "Edittimetracked",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hv"
]
}
},
{
"name": "interval_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"123"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "Edit the start, end, or total time of a time tracked entry.",
"content": {
"application/json": {
"schema": {
"title": "Edittimetrackedrequest",
"required": [
"start",
"end",
"time"
],
"type": "object",
"properties": {
"start": {
"type": "integer",
"contentEncoding": "int64"
},
"end": {
"type": "integer",
"contentEncoding": "int64"
},
"time": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"start": 1567780450202,
"end": 1508369194377,
"time": 8640000
}
]
},
"example": {
"start": 1567780450202,
"end": 1508369194377,
"time": 8640000
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete time tracked",
"tags": [
"Time Tracking (Legacy)"
],
"description": "***Note:** This is a legacy time tracking endpoint. We recommend using the Time Tracking API endpoints to manage time entries.*",
"operationId": "Deletetimetracked",
"parameters": [
{
"name": "task_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"9hv"
]
}
},
{
"name": "interval_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"123"
]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_Id}/time_entries": {
"get": {
"summary": "Get time entries within a date range",
"tags": [
"Time Tracking"
],
"description": "View time entries filtered by start and end date. \\\n \\\nBy default, this endpoint returns time entries from the last 30 days created by the authenticated user. \\\n \\\nTo retrieve time entries for other users, you must include the `assignee` query parameter. \\\n \\\nOnly one of the following location filters can be included at a time: `space_id`, `folder_id`, `list_id`, or `task_id`. \\\n \\\n***Note:** A time entry that has a negative duration means that timer is currently running for that user.*",
"operationId": "Gettimeentrieswithinadaterange",
"parameters": [
{
"name": "team_Id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "start_date",
"in": "query",
"description": "Unix time in milliseconds",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double"
}
},
{
"name": "end_date",
"in": "query",
"description": "Unix time in milliseconds",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double"
}
},
{
"name": "assignee",
"in": "query",
"description": "Filter by `user_id`. For multiple assignees, separate `user_id` using commas.\\\n \\\n **Example:** `assignee=1234,9876`\\\n \\\n***Note:** Only Workspace Owners/Admins have access to do this.*",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double"
}
},
{
"name": "include_task_tags",
"in": "query",
"description": "Include task tags in the response for time entries associated with tasks.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "include_location_names",
"in": "query",
"description": "Include the names of the List, Folder, and Space along with the `list_id`,`folder_id`, and `space_id`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "include_approval_history",
"in": "query",
"description": "Include the history of the approval for each time entry. Adds status changes, notes, and approvers.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "include_approval_details",
"in": "query",
"description": "Include the details of the approval for each time entry. Adds Approver ID, Approved Time, List of Approvers, and Approval Status.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "space_id",
"in": "query",
"description": "Only include time entries associated with tasks in a specific Space.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double"
}
},
{
"name": "folder_id",
"in": "query",
"description": "Only include time entries associated with tasks in a specific Folder.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double"
}
},
{
"name": "list_id",
"in": "query",
"description": "Only include time entries associated with tasks in a specific List.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double"
}
},
{
"name": "task_id",
"in": "query",
"description": "Only include time entries associated with a specific task.",
"style": "form",
"explode": true,
"schema": {
"type": "string"
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "is_billable",
"in": "query",
"description": "Include only billable time entries by using a value of `true` or only non-billable time entries by using a value of `false`.\\\n \\\nFor example: `?is_billable=true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "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.",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "Gettimeentrieswithinadaterangeresponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"title": "Datum1",
"required": [
"id",
"task",
"wid",
"user",
"billable",
"start",
"end",
"duration",
"description",
"tags",
"source",
"at",
"task_location",
"task_tags",
"task_url"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"task": {
"title": "Task4",
"required": [
"id",
"custom_id",
"name",
"status",
"custom_type"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"custom_type": {
"type": [
"string",
"null"
]
}
},
"examples": [
{
"id": "1vwwavv",
"custom_id": "JOSH-917",
"name": "woof",
"status": {
"status": "open yes",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"custom_type": null
}
]
},
"wid": {
"type": "string"
},
"user": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user"
},
"billable": {
"type": "boolean"
},
"start": {
"type": "string"
},
"end": {
"type": "string"
},
"duration": {
"type": "string"
},
"description": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"source": {
"type": "string"
},
"at": {
"type": "string"
},
"approval_id": {
"type": "string",
"description": "ID of the associated approval"
},
"approval": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval"
},
"task_location": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1%7Btimer_id%7D/get/responses/200/content/application~1json/schema/properties/data/properties/task_location"
},
"task_tags": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1%7Btimer_id%7D/get/responses/200/content/application~1json/schema/properties/data/properties/task_tags/items"
},
"description": ""
},
"task_url": {
"type": "string"
}
},
"examples": [
{
"id": "1963465985517105840",
"task": {
"id": "1vwwavv",
"custom_id": "JOSH-917",
"name": "woof",
"status": {
"status": "open yes",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"custom_type": null
},
"wid": "300702",
"user": {
"id": 1,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1592841559129",
"end": "1592845899021",
"duration": "4339892",
"description": "",
"tags": [],
"source": "clickup",
"at": "1592845899021",
"approval_id": "2d539936-119a-4927-9770-179f0a72e2e5",
"approval": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval"
},
"task_location": {
"list_id": 1560300071,
"folder_id": 468300080,
"space_id": 22800253,
"list_name": "List",
"folder_name": "Folder",
"space_name": "Space"
},
"task_tags": [
{
"name": "content-request",
"tag_fg": "#800000",
"tag_bg": "#2ecd6f",
"creator": 301828
},
{
"name": "marketing-okr",
"tag_fg": "#800000",
"tag_bg": "#7C4DFF",
"creator": 301828
}
],
"task_url": "https://staging.clickup.com/t/1vwwavv"
}
]
},
"description": ""
}
},
"examples": [
{
"data": [
{
"id": "1963465985517105840",
"task": {
"id": "1vwwavv",
"custom_id": "JOSH-917",
"name": "woof",
"status": {
"status": "open yes",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"custom_type": null
},
"wid": "300702",
"user": {
"id": 1,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": 1592841559129,
"end": 1592845899021,
"duration": "4339892",
"description": "",
"tags": [],
"source": "clickup",
"at": "1592845899021",
"approval_id": "2d539936-119a-4927-9770-179f0a72e2e5",
"approval": {
"title": "Approval",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the approval"
},
"workspace_id": {
"type": "integer",
"description": "ID of the workspace this approval belongs to"
},
"status": {
"type": "string",
"description": "Current status of the approval (e.g., 'approved', 'pending')"
},
"data": {
"type": "object",
"properties": {
"end_of_week": {
"type": "integer",
"description": "Timestamp for the end of the week"
},
"start_of_week": {
"type": "integer",
"description": "Timestamp for the start of the week"
}
}
},
"user": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1time/get/responses/200/content/application~1json/schema/properties/data/items/properties/user"
},
"approvers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of the user who can approve the request"
}
}
}
},
"approver_id": {
"type": "integer",
"description": "ID of the user who approved the request"
},
"approved_at": {
"type": "integer",
"description": "Timestamp when the approval was granted"
},
"history": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the history entry"
},
"field": {
"type": "string",
"description": "Field that was changed"
},
"before": {
"type": "string",
"description": "Previous value"
},
"after": {
"type": "string",
"description": "New value"
},
"created_at": {
"type": "integer",
"description": "Timestamp when the change was made"
},
"user": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D~1time/get/responses/200/content/application~1json/schema/properties/data/items/properties/user"
}
}
}
}
},
"examples": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"workspace_id": 12345,
"status": "approved",
"data": {
"end_of_week": 1672531199000,
"start_of_week": 1671926400000
},
"user": {
"id": 101,
"username": "john.smith",
"initials": "JS",
"avatar": {
"color": "#4287f5",
"picture_url": null
}
},
"approvers": [
{
"id": 101
},
{
"id": 102
}
],
"approver_id": 101,
"approved_at": 1672012800000,
"history": [
{
"id": "987fcdeb-51a2-3456-789a-bcdef0123456",
"field": "submission",
"before": null,
"after": null,
"created_at": 1671987600000,
"user": {
"id": 101,
"username": "john.smith",
"role": "submitter"
}
},
{
"id": "456abcde-f123-4567-89ab-cdef01234567",
"field": "status",
"before": "pending",
"after": "approved",
"created_at": 1672012800000,
"user": {
"id": 102,
"username": "jane.doe",
"role": "approver"
}
}
]
}
]
},
"task_location": {
"list_id": 1560300071,
"folder_id": 468300080,
"space_id": 22800253,
"list_name": "List",
"folder_name": "Folder",
"space_name": "Space"
},
"task_tags": [
{
"name": "content-request",
"tag_fg": "#800000",
"tag_bg": "#2ecd6f",
"creator": 301828
},
{
"name": "marketing-okr",
"tag_fg": "#800000",
"tag_bg": "#7C4DFF",
"creator": 301828
}
],
"task_url": "https://staging.clickup.com/t/1vwwavv"
}
]
}
]
},
"example": {
"data": [
{
"id": "1963465985517105840",
"task": {
"id": "1vwwavv",
"custom_id": "JOSH-917",
"name": "woof",
"status": {
"status": "open yes",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"custom_type": null
},
"wid": "300702",
"user": {
"id": 1,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": 1592841559129,
"end": 1592845899021,
"duration": "4339892",
"description": "",
"tags": [],
"source": "clickup",
"at": "1592845899021",
"task_location": {
"list_id": 1560300071,
"folder_id": 468300080,
"space_id": 22800253,
"list_name": "List",
"folder_name": "Folder",
"space_name": "Space"
},
"task_tags": [
{
"name": "content-request",
"tag_fg": "#800000",
"tag_bg": "#2ecd6f",
"creator": 301828
},
{
"name": "marketing-okr",
"tag_fg": "#800000",
"tag_bg": "#7C4DFF",
"creator": 301828
}
],
"task_url": "https://staging.clickup.com/t/1vwwavv"
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create a time entry",
"tags": [
"Time Tracking"
],
"description": "Create a time entry. \\\n \\\n***Note:** A time entry that has a negative duration means that timer is currently running for that user.*",
"operationId": "Createatimeentry",
"parameters": [
{
"name": "team_Id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "Associate a time entry with a task using the `tid` parameter.",
"content": {
"application/json": {
"schema": {
"title": "Createatimeentryrequest",
"required": [
"start",
"duration"
],
"type": "object",
"properties": {
"description": {
"type": "string"
},
"tags": {
"description": "Users on the Business Plan and above can include a time tracking label.",
"type": "array",
"items": {
"title": "Tags6",
"required": [
"name",
"tag_fg",
"tag_bg"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tag_fg": {
"type": "string"
},
"tag_bg": {
"type": "string"
}
},
"examples": [
{
"name": "Tag name",
"tag_fg": "#000000",
"tag_bg": "#000000"
}
]
}
},
"start": {
"type": "integer",
"contentEncoding": "int64"
},
"stop": {
"type": "integer",
"contentEncoding": "int64",
"description": "The `duration` parameter can be used instead of the `stop` parameter. "
},
"end": {
"type": "integer",
"contentEncoding": "int64"
},
"billable": {
"type": "boolean"
},
"duration": {
"description": "When there are values for both `start` and `end`, `duration` is ignored. The `stop` parameter can be used instead of the `duration` parameter.",
"type": "integer",
"contentEncoding": "int32"
},
"assignee": {
"description": "Workspace owners and admins can include any user id. Workspace members can only include their own user id.",
"type": "integer",
"contentEncoding": "int32"
},
"tid": {
"type": "string"
}
},
"examples": [
{
"description": "from api",
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
],
"start": 1595282645000,
"end": 1595282660000,
"billable": true,
"duration": 50000,
"assignee": 1,
"tid": "task_id"
}
]
},
"example": {
"description": "from api",
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
],
"start": 1595282645000,
"billable": true,
"duration": 50000,
"assignee": 1,
"tid": "task_id"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "Createatimeentryresponse",
"required": [
"description",
"tags",
"start",
"billable",
"duration",
"assignee",
"tid"
],
"type": "object",
"properties": {
"description": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items"
},
"description": ""
},
"start": {
"type": "integer",
"contentEncoding": "int64"
},
"billable": {
"type": "boolean"
},
"duration": {
"type": "integer",
"contentEncoding": "int32"
},
"assignee": {
"type": "integer",
"contentEncoding": "int32"
},
"tid": {
"type": "string"
}
},
"examples": [
{
"description": "from api",
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#BF55EC"
}
],
"start": 1595282645000,
"billable": true,
"duration": 50000,
"assignee": 1,
"tid": "task_id"
}
]
},
"example": {
"description": "from api",
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#BF55EC"
}
],
"start": 1595282645000,
"billable": true,
"duration": 50000,
"assignee": 1,
"tid": "task_id"
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/time_entries/{timer_id}": {
"get": {
"summary": "Get singular time entry",
"tags": [
"Time Tracking"
],
"description": "View a single time entry. \\\n \\\n***Note:** A time entry that has a negative duration means that timer is currently running for that user.*",
"operationId": "Getsingulartimeentry",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "timer_id",
"in": "path",
"description": "The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"1963465985517105840"
]
}
},
{
"name": "include_task_tags",
"in": "query",
"description": "Include task tags in the response for time entries associated with tasks.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "include_location_names",
"in": "query",
"description": "Include the names of the List, Folder, and Space along with `list_id`,`folder_id`, and `space_id`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "include_approval_history",
"in": "query",
"description": "Include the history of the approval for the time entry.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "include_approval_details",
"in": "query",
"description": "Include the details of the approval for the time entry.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "Getsingulartimeentryresponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "",
"title": "Datum2",
"required": [
"id",
"wid",
"user",
"billable",
"start",
"end",
"duration",
"description",
"tags",
"source",
"at",
"task_location",
"task_tags",
"task_url"
],
"properties": {
"id": {
"type": "string"
},
"wid": {
"type": "string"
},
"user": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user"
},
"billable": {
"type": "boolean"
},
"start": {
"type": "string"
},
"end": {
"type": "string"
},
"duration": {
"type": "string"
},
"description": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"source": {
"type": "string"
},
"at": {
"type": "string"
},
"approval_id": {
"type": "string",
"description": "ID of the associated approval"
},
"approval": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval"
},
"task_location": {
"title": "TaskLocation",
"required": [
"list_id",
"folder_id",
"space_id",
"list_name",
"folder_name",
"space_name"
],
"type": "object",
"properties": {
"list_id": {
"type": "integer",
"contentEncoding": "int32"
},
"folder_id": {
"type": "integer",
"contentEncoding": "int32"
},
"space_id": {
"type": "integer",
"contentEncoding": "int32"
},
"list_name": {
"type": "string"
},
"folder_name": {
"type": "string"
},
"space_name": {
"type": "string"
}
},
"examples": [
{
"list_id": 1560300071,
"folder_id": 468300080,
"space_id": 22800253,
"list_name": "List",
"folder_name": "Folder",
"space_name": "Space"
}
]
},
"task_tags": {
"type": "array",
"items": {
"title": "TaskTag",
"required": [
"name",
"tag_fg",
"tag_bg",
"creator"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tag_fg": {
"type": "string"
},
"tag_bg": {
"type": "string"
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"name": "content-request",
"tag_fg": "#800000",
"tag_bg": "#2ecd6f",
"creator": 301828
}
]
},
"description": ""
},
"task_url": {
"type": "string"
}
},
"examples": [
{
"id": "timer_id",
"wid": "workspace_id",
"user": {
"id": 1,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1592841559129",
"end": "1592845899021",
"duration": "4339892",
"description": "",
"tags": [],
"source": "clickup",
"at": "1592845899021",
"approval_id": "2d539936-119a-4927-9770-179f0a72e2e5",
"approval": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval"
},
"task_location": {
"list_id": 1560300071,
"folder_id": 468300080,
"space_id": 22800253,
"list_name": "List",
"folder_name": "Folder",
"space_name": "Space"
},
"task_tags": [
{
"name": "content-request",
"tag_fg": "#800000",
"tag_bg": "#2ecd6f",
"creator": 301828
},
{
"name": "marketing-okr",
"tag_fg": "#800000",
"tag_bg": "#7C4DFF",
"creator": 301828
}
],
"task_url": "https://staging.clickup.com/t/rnmuwz7"
}
]
}
},
"examples": [
{
"data": [
{
"id": "timer_id",
"wid": "workspace_id",
"user": {
"id": 1,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1592841559129",
"end": "1592845899021",
"duration": "4339892",
"description": "",
"tags": [],
"source": "clickup",
"at": "1592845899021",
"approval_id": "2d539936-119a-4927-9770-179f0a72e2e5",
"approval": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/get/responses/200/content/application~1json/schema/examples/0/data/0/approval"
},
"task_location": {
"list_id": 1560300071,
"folder_id": 468300080,
"space_id": 22800253,
"list_name": "List",
"folder_name": "Folder",
"space_name": "Space"
},
"task_tags": [
{
"name": "content-request",
"tag_fg": "#800000",
"tag_bg": "#2ecd6f",
"creator": 301828
},
{
"name": "marketing-okr",
"tag_fg": "#800000",
"tag_bg": "#7C4DFF",
"creator": 301828
}
],
"task_url": "https://staging.clickup.com/t/rnmuwz7"
}
]
}
]
},
"example": {
"data": [
{
"id": "timer_id",
"wid": "workspace_id",
"user": {
"id": 1,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1592841559129",
"end": "1592845899021",
"duration": "4339892",
"description": "",
"source": "clickup",
"at": "1592845899021",
"task_location": {
"list_id": 1560300071,
"folder_id": 468300080,
"space_id": 22800253,
"list_name": "List",
"folder_name": "Folder",
"space_name": "Space"
},
"task_tags": [
{
"name": "content-request",
"tag_fg": "#800000",
"tag_bg": "#2ecd6f",
"creator": 301828
},
{
"name": "marketing-okr",
"tag_fg": "#800000",
"tag_bg": "#7C4DFF",
"creator": 301828
}
],
"task_url": "https://staging.clickup.com/t/rnmuwz7"
}
]
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete a time Entry",
"tags": [
"Time Tracking"
],
"description": "Delete a time entry from a Workspace.",
"operationId": "DeleteatimeEntry",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "timer_id",
"in": "path",
"description": "Array of timer ids to delete separated by commas",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "DeleteatimeEntryresponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data"
}
},
"examples": [
{
"data": {
"id": "timer_id",
"task": {
"id": "task_id",
"name": "test task",
"status": {
"status": "to do",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"custom_type": null
},
"wid": "workspace_id",
"user": {
"id": 1,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1595289395842",
"end": 1595289452790,
"duration": 56948,
"description": "",
"tags": [],
"source": "clickup",
"at": 1595289452790
}
}
]
},
"example": {
"data": {
"id": "timer_id",
"task": {
"id": "task_id",
"name": "test task",
"status": {
"status": "to do",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"custom_type": null
},
"wid": "workspace_id",
"user": {
"id": 1,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1595289395842",
"end": 1595289452790,
"duration": 56948,
"description": "",
"tags": [],
"source": "clickup",
"at": 1595289452790
}
}
}
}
}
},
"deprecated": false
},
"put": {
"summary": "Update a time Entry",
"tags": [
"Time Tracking"
],
"description": "Update the details of a time entry.",
"operationId": "UpdateatimeEntry",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "timer_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [2.0046733445400036e+18]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "Accessible tag actions are `[\"replace\", \"add\", \"remove\"]`",
"content": {
"application/json": {
"schema": {
"title": "UpdateatimeEntryrequest",
"required": [
"tags",
"tid"
],
"type": "object",
"properties": {
"description": {
"type": "string"
},
"tags": {
"description": "Users on the Business Plan and above can include a time tracking label.",
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items"
}
},
"tag_action": {
"type": "string"
},
"start": {
"type": "integer",
"contentEncoding": "int64",
"description": "When providing `start`, you must also provide `end`."
},
"end": {
"type": "integer",
"contentEncoding": "int64",
"description": "When providing `end`, you must also provide `start`."
},
"tid": {
"type": "string"
},
"billable": {
"type": "boolean"
},
"duration": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"description": "",
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
],
"tag_action": "add",
"start": 1595289395842,
"end": 1595289495842,
"tid": "task_id",
"billable": true,
"duration": 100000
}
]
},
"example": {
"description": "",
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
],
"tag_action": "add",
"start": 1595289395842,
"end": 1595289495842,
"tid": "task_id",
"billable": true,
"duration": 100000
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"contentMediaType": "application/json"
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/time_entries/{timer_id}/history": {
"get": {
"summary": "Get time entry history",
"tags": [
"Time Tracking"
],
"description": "View a list of changes made to a time entry.",
"operationId": "Gettimeentryhistory",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "timer_id",
"in": "path",
"description": "The ID of a time entry. \\\n \\\nThis can be found using the [Get Time Entries Within a Date Range](ref:gettimeentrieswithinadaterange) endpoint.",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"1963465985517105840"
]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"contentMediaType": "application/json"
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/time_entries/current": {
"get": {
"summary": "Get running time entry",
"tags": [
"Time Tracking"
],
"description": "View a time entry that's currently tracking time for the authenticated user. \\\n \\\n***Note:** A time entry that has a negative duration means that timer is currently running for that user.*",
"operationId": "Getrunningtimeentry",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "assignee",
"in": "query",
"description": "user id",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double"
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "Getrunningtimeentryresponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"title": "Data",
"required": [
"id",
"task",
"wid",
"user",
"billable",
"start",
"duration",
"description",
"tags",
"at"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"task": {
"title": "Task5",
"required": [
"id",
"name",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
}
},
"examples": [
{
"id": "task_id",
"name": "task_name",
"status": {
"status": "to do",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
}
}
]
},
"wid": {
"type": "string"
},
"user": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user"
},
"billable": {
"type": "boolean"
},
"start": {
"type": "string"
},
"duration": {
"type": "integer",
"contentEncoding": "int32"
},
"description": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"at": {
"type": "string"
}
},
"examples": [
{
"id": "timer_id",
"task": {
"id": "task_id",
"name": "task_name",
"status": {
"status": "to do",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
}
},
"wid": "workspace_id",
"user": {
"id": 300528,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1595293042560",
"duration": -25655,
"description": "",
"tags": [],
"at": "1595293042560"
}
]
}
},
"examples": [
{
"data": {
"id": "timer_id",
"task": {
"id": "task_id",
"name": "task_name",
"status": {
"status": "to do",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
}
},
"wid": "workspace_id",
"user": {
"id": 300528,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1595293042560",
"duration": -25655,
"description": "",
"tags": [],
"at": "1595293042560"
}
}
]
},
"example": {
"data": {
"id": "timer_id",
"task": {
"id": "task_id",
"name": "task_name",
"status": {
"status": "to do",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
}
},
"wid": "workspace_id",
"user": {
"id": 300528,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1595293042560",
"duration": -25655,
"description": "",
"tags": [],
"at": "1595293042560"
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/time_entries/tags": {
"delete": {
"summary": "Remove tags from time entries",
"tags": [
"Time Tracking"
],
"description": "Remove labels from time entries. This does not remove the label from a Workspace.",
"operationId": "Removetagsfromtimeentries",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "Removetagsfromtimeentriesrequest",
"required": [
"time_entry_ids",
"tags"
],
"type": "object",
"properties": {
"time_entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tags": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries~1start/post/requestBody/content/application~1json/schema/properties/tags/items"
},
"description": ""
}
},
"examples": [
{
"time_entry_ids": [
"timer_id"
],
"tags": [
{
"name": "name of tag"
}
]
}
]
},
"example": {
"time_entry_ids": [
"timer_id"
],
"tags": [
{
"name": "name of tag"
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"get": {
"summary": "Get all tags from time entries",
"tags": [
"Time Tracking"
],
"description": "View all the labels that have been applied to time entries in a Workspace.",
"operationId": "Getalltagsfromtimeentries",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "Getalltagsfromtimeentriesresponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"title": "Data1",
"required": [
"name",
"creator",
"tag_bg",
"tag_fg"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"creator": {
"type": "integer",
"contentEncoding": "int32"
},
"tag_bg": {
"type": "string"
},
"tag_fg": {
"type": "string"
}
},
"examples": [
{
"name": "name of tag",
"creator": 1,
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
]
},
"description": ""
}
},
"examples": [
{
"data": [
{
"name": "name of tag",
"creator": 1,
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
]
}
]
},
"example": {
"data": [
{
"name": "name of tag",
"creator": 1,
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Add tags from time entries",
"tags": [
"Time Tracking"
],
"description": "Add a label to a time entry.",
"operationId": "Addtagsfromtimeentries",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "Addtagsfromtimeentriesrequest",
"required": [
"time_entry_ids",
"tags"
],
"type": "object",
"properties": {
"time_entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tags": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_Id%7D~1time_entries/post/requestBody/content/application~1json/schema/properties/tags/items"
},
"description": ""
}
},
"examples": [
{
"time_entry_ids": [
"timer_id"
],
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
]
}
]
},
"example": {
"time_entry_ids": [
"timer_id"
],
"tags": [
{
"name": "name of tag",
"tag_bg": "#BF55EC",
"tag_fg": "#FFFFFF"
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"put": {
"summary": "Change tag names from time entries",
"tags": [
"Time Tracking"
],
"description": "Rename an time entry label.",
"operationId": "Changetagnamesfromtimeentries",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "Changetagnamesfromtimeentriesrequest",
"required": [
"name",
"new_name",
"tag_bg",
"tag_fg"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"new_name": {
"type": "string"
},
"tag_bg": {
"type": "string"
},
"tag_fg": {
"type": "string"
}
},
"examples": [
{
"name": "old tag name",
"new_name": "new tag name",
"tag_bg": "#000000",
"tag_fg": "#000000"
}
]
},
"example": {
"name": "old tag name",
"new_name": "new tag name",
"tag_bg": "#000000",
"tag_fg": "#000000"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_Id}/time_entries/start": {
"post": {
"summary": "Start a time Entry",
"tags": [
"Time Tracking"
],
"description": "Start a timer for the authenticated user.",
"operationId": "StartatimeEntry",
"parameters": [
{
"name": "team_Id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "custom_task_ids",
"in": "query",
"description": "If you want to reference a task by it's custom task id, this value must be `true`.",
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [true]
}
},
{
"name": "team_id",
"in": "query",
"description": "When the `custom_task_ids` parameter is set to `true`, the Workspace ID must be provided using the `team_id` parameter.\n \\\nFor example: `custom_task_ids=true&team_id=123`.",
"style": "form",
"explode": true,
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "For Workspaces on the Free Forever or Unlimited Plan, either the `timer_id` parameter or the `\"tid\"` field in the body of the request are required fields.",
"content": {
"application/json": {
"schema": {
"title": "StartatimeEntryrequest",
"type": "object",
"properties": {
"description": {
"type": "string"
},
"tags": {
"description": "Users on the Business Plan and above can include a time tracking label.",
"type": "array",
"items": {
"title": "Tags10",
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"examples": [
{
"name": "name of tag"
}
]
}
},
"tid": {
"type": "string"
},
"billable": {
"type": "boolean"
}
},
"examples": [
{
"description": "from api",
"tags": [
{
"name": "tag1"
}
],
"tid": "task_id",
"billable": false
}
]
},
"example": {
"description": "from api",
"tags": [
{
"name": "tag1"
}
],
"tid": "task_id",
"billable": false
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "StartatimeEntryresponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"title": "Data2",
"required": [
"id",
"task",
"wid",
"user",
"billable",
"start",
"duration",
"description",
"tags",
"at"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"task": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/task"
},
"wid": {
"type": "string"
},
"user": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1time_entries~1stop/post/responses/200/content/application~1json/schema/properties/data/properties/user"
},
"billable": {
"type": "boolean"
},
"start": {
"type": "string"
},
"duration": {
"type": "integer",
"contentEncoding": "int32"
},
"description": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"at": {
"type": "integer",
"contentEncoding": "int64"
}
},
"examples": [
{
"id": "timer_id",
"task": {
"id": "task_id",
"name": "test task",
"status": {
"status": "to do",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"custom_type": null
},
"wid": "workspace_id",
"user": {
"id": 1,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1595289395842",
"duration": -53,
"description": "",
"tags": [],
"at": 1595289452790
}
]
}
},
"examples": [
{
"data": {
"id": "timer_id",
"task": {
"id": "task_id",
"name": "test task",
"status": {
"status": "to do",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"custom_type": null
},
"wid": "workspace_id",
"user": {
"id": 1,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1595289395842",
"duration": -53,
"description": "",
"tags": [],
"at": 1595289452790
}
}
]
},
"example": {
"data": {
"id": "timer_id",
"task": {
"id": "task_id",
"name": "test task",
"status": {
"status": "to do",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"custom_type": null
},
"wid": "workspace_id",
"user": {
"id": 1,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1595289395842",
"duration": -53,
"description": "",
"tags": [],
"at": 1595289452790
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/time_entries/stop": {
"post": {
"summary": "Stop a time Entry",
"tags": [
"Time Tracking"
],
"description": "Stop a timer that's currently running for the authenticated user.",
"operationId": "StopatimeEntry",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "Content-Type",
"in": "header",
"description": "",
"required": true,
"style": "simple",
"schema": {
"const": "application/json",
"type": "string",
"examples": [
"application/json"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "StopatimeEntryresponse",
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"title": "Data3",
"required": [
"id",
"task",
"wid",
"user",
"billable",
"start",
"end",
"duration",
"description",
"tags",
"source",
"at"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"task": {
"title": "Task6",
"required": [
"id",
"name",
"status",
"custom_type"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"custom_type": {
"type": [
"string",
"null"
]
}
},
"examples": [
{
"id": "task_id",
"name": "test task",
"status": {
"status": "to do",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"custom_type": null
}
]
},
"wid": {
"type": "string"
},
"user": {
"title": "User2",
"required": [
"id",
"username",
"initials",
"email",
"color",
"profilePicture"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"initials": {
"type": "string"
},
"email": {
"type": "string"
},
"color": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"examples": [
{
"id": 183,
"username": "John Doe",
"initials": "JD",
"email": "johndoe@gmail.com",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
]
},
"billable": {
"type": "boolean"
},
"start": {
"type": "string"
},
"end": {
"type": "integer",
"contentEncoding": "int64"
},
"duration": {
"type": "integer",
"contentEncoding": "int32"
},
"description": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"source": {
"type": "string"
},
"at": {
"type": "integer",
"contentEncoding": "int64"
}
},
"examples": [
{
"id": "timer_id",
"task": {
"id": "task_id",
"name": "test task",
"status": {
"status": "to do",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"custom_type": null
},
"wid": "workspace_id",
"user": {
"id": 1,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1595289395842",
"end": 1595289452790,
"duration": 56948,
"description": "",
"tags": [],
"source": "clickup",
"at": 1595289452790
}
]
}
},
"examples": [
{
"data": {
"id": "timer_id",
"task": {
"id": "task_id",
"name": "test task",
"status": {
"status": "to do",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"custom_type": null
},
"wid": "workspace_id",
"user": {
"id": 1,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1595289395842",
"end": 1595289452790,
"duration": 56948,
"description": "",
"tags": [],
"source": "clickup",
"at": 1595289452790
}
}
]
},
"example": {
"data": {
"id": "timer_id",
"task": {
"id": "task_id",
"name": "test task",
"status": {
"status": "to do",
"color": "#d3d3d3",
"type": "open",
"orderindex": 0
},
"custom_type": null
},
"wid": "workspace_id",
"user": {
"id": 1,
"username": "first_name last_name",
"email": "test@gmail.com",
"color": "#08c7e0",
"initials": "JK",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"billable": false,
"start": "1595289395842",
"end": 1595289452790,
"duration": 56948,
"description": "",
"tags": [],
"source": "clickup",
"at": 1595289452790
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/user": {
"post": {
"summary": "Invite User To Workspace",
"tags": [
"Users"
],
"description": "Invite someone to join your Workspace as a member. To invite someone as a guest, use the [Invite Guest](ref:inviteguesttoworkspace) endpoint.\\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*",
"operationId": "InviteUserToWorkspace",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "InviteUserToWorkspacerequest",
"required": [
"email",
"admin"
],
"type": "object",
"properties": {
"email": {
"type": "string"
},
"admin": {
"type": "boolean"
},
"custom_role_id": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"email": "user@example.com",
"admin": true,
"custom_role_id": 112233
}
]
},
"example": {
"email": "user@example.com",
"admin": true
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "InviteUserToWorkspaceresponse",
"required": [
"team"
],
"type": "object",
"properties": {
"team": {
"title": "Team3",
"required": [
"id",
"name",
"color",
"avatar",
"members",
"roles"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"avatar": {
"type": [
"string",
"null"
]
},
"members": {
"type": "array",
"items": {
"title": "Members5",
"required": [
"user",
"invited_by"
],
"type": "object",
"properties": {
"user": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1guest~1%7Bguest_id%7D/put/responses/200/content/application~1json/schema/properties/guest/properties/user"
},
"invited_by": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member/properties/invited_by"
}
},
"examples": [
{
"user": {
"id": 184,
"username": null,
"email": "user@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 2,
"custom_role": {
"id": 112233,
"name": "admin custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
}
}
]
},
"description": ""
},
"roles": {
"type": "array",
"items": {
"title": "Role",
"required": [
"id",
"name",
"custom"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"name": {
"type": "string"
},
"custom": {
"type": "boolean"
},
"inherited_role": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"id": 1,
"name": "owner",
"custom": false
}
]
},
"description": ""
}
},
"examples": [
{
"id": "333",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": [
{
"user": {
"id": 184,
"username": null,
"email": "user@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 2,
"custom_role": {
"id": 112233,
"name": "admin custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
}
}
],
"roles": [
{
"id": 1,
"name": "owner",
"custom": false
},
{
"id": 2,
"name": "admin",
"custom": false
},
{
"id": 3,
"name": "member",
"custom": false
},
{
"id": 4,
"name": "guest",
"custom": false
},
{
"id": 998877,
"name": "member custom",
"inherited_role": 3,
"custom": true
},
{
"id": 112233,
"name": "admin custom",
"inherited_role": 2,
"custom": true
},
{
"id": 12345,
"name": "guest custom",
"inherited_role": 4,
"custom": true
}
]
}
]
}
},
"examples": [
{
"team": {
"id": "333",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": [
{
"user": {
"id": 184,
"username": null,
"email": "user@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 2,
"custom_role": {
"id": 112233,
"name": "admin custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
}
}
],
"roles": [
{
"id": 1,
"name": "owner",
"custom": false
},
{
"id": 2,
"name": "admin",
"custom": false
},
{
"id": 3,
"name": "member",
"custom": false
},
{
"id": 4,
"name": "guest",
"custom": false
},
{
"id": 998877,
"name": "member custom",
"inherited_role": 3,
"custom": true
},
{
"id": 112233,
"name": "admin custom",
"inherited_role": 2,
"custom": true
},
{
"id": 12345,
"name": "guest custom",
"inherited_role": 4,
"custom": true
}
]
}
}
]
},
"example": {
"team": {
"id": "333",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": [
{
"user": {
"id": 184,
"username": null,
"email": "user@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 2,
"custom_role": {
"id": 112233,
"name": "admin custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
}
}
],
"roles": [
{
"id": 1,
"name": "owner",
"custom": false
},
{
"id": 2,
"name": "admin",
"custom": false
},
{
"id": 3,
"name": "member",
"custom": false
},
{
"id": 4,
"name": "guest",
"custom": false
},
{
"id": 998877,
"name": "member custom",
"inherited_role": 3,
"custom": true
},
{
"id": 112233,
"name": "admin custom",
"inherited_role": 2,
"custom": true
},
{
"id": 12345,
"name": "guest custom",
"inherited_role": 4,
"custom": true
}
]
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/user/{user_id}": {
"get": {
"summary": "Get User",
"tags": [
"Users"
],
"description": "View information about a user in a Workspace. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*",
"operationId": "GetUser",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "user_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [403]
}
},
{
"name": "include_shared",
"in": "query",
"description": "Exclude details of items shared with the guest by setting this parameter to `false`. By default this parameter is set to `true`.",
"required": false,
"style": "form",
"explode": true,
"schema": {
"type": "boolean",
"examples": [false]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetUserresponse",
"type": "object",
"properties": {
"member": {
"title": "Member7",
"type": "object",
"properties": {
"user": {
"title": "User21",
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"color": {
"type": [
"string",
"null"
]
},
"profilePicture": {
"type": [
"string",
"null"
]
},
"initials": {
"type": "string"
},
"role": {
"description": "Owner = 1, Admin = 2, Member = 3, Guest = 4",
"type": "integer",
"contentEncoding": "int32"
},
"custom_role": {
"title": "CustomRole",
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"name": {
"type": "string"
}
},
"examples": [
{
"id": 12345,
"name": "guest custom"
}
]
},
"last_active": {
"type": [
"string",
"null"
]
},
"date_joined": {
"type": [
"string",
"null"
]
},
"date_invited": {
"type": "string"
}
},
"examples": [
{
"id": 184,
"username": "User Name",
"email": "user@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 3,
"custom_role": {
"id": 998877,
"name": "member custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
}
]
},
"invited_by": {
"title": "InvitedBy",
"type": "object",
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"examples": [
{
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
}
]
},
"shared": {
"title": "Shared",
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"lists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"examples": [
{
"tasks": [],
"lists": [],
"folders": []
}
]
}
},
"examples": [
{
"user": {
"id": 184,
"username": "User Name",
"email": "user@example.com",
"color": null,
"profilePicture": null,
"initials": "UN",
"role": 3,
"custom_role": {
"id": 998877,
"name": "member custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
]
}
},
"examples": [
{
"member": {
"user": {
"id": 184,
"username": "User Name",
"email": "user@example.com",
"color": null,
"profilePicture": null,
"initials": "UN",
"role": 3,
"custom_role": {
"id": 998877,
"name": "member custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
}
]
},
"example": {
"member": {
"user": {
"id": 184,
"username": "User Name",
"email": "user@example.com",
"color": null,
"profilePicture": null,
"initials": "UN",
"role": 3,
"custom_role": {
"id": 998877,
"name": "member custom"
},
"last_active": "1688667338000",
"date_joined": "1657131338000",
"date_invited": "1657044938000"
},
"invited_by": {
"id": 183,
"username": "Jerry",
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
}
}
}
}
},
"deprecated": false
},
"put": {
"summary": "Edit User On Workspace",
"tags": [
"Users"
],
"description": "Update a user's name and role. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*",
"operationId": "EditUserOnWorkspace",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "user_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [403]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "EditUserOnWorkspacerequest",
"required": [
"username",
"admin",
"custom_role_id"
],
"type": "object",
"properties": {
"username": {
"type": "string"
},
"admin": {
"type": "boolean"
},
"custom_role_id": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"username": "User Name",
"admin": false,
"custom_role_id": 998877
}
]
},
"example": {
"username": "User Name",
"admin": false,
"custom_role_id": 998877
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "EditUserOnWorkspaceresponse",
"required": [
"member"
],
"type": "object",
"properties": {
"member": {
"$ref": "#/paths/~1v2~1team~1%7Bteam_id%7D~1user~1%7Buser_id%7D/get/responses/200/content/application~1json/schema/properties/member"
}
},
"examples": [
{
"member": {
"user": {
"id": 184,
"username": "User Name",
"email": "user@example.com",
"color": null,
"profilePicture": null,
"initials": "UN",
"role": 3,
"custom_role": {
"id": 998877,
"name": "member custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
}
]
},
"example": {
"member": {
"user": {
"id": 184,
"username": "User Name",
"email": "user@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 3,
"custom_role": {
"id": 998877,
"name": "member custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://attachments.clickup.com/profilePictures/profile.jpg"
},
"shared": {
"tasks": [],
"lists": [],
"folders": []
}
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Remove User From Workspace",
"tags": [
"Users"
],
"description": "Deactivate a user from a Workspace. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*",
"operationId": "RemoveUserFromWorkspace",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
},
{
"name": "user_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [403]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "RemoveUserFromWorkspaceresponse",
"required": [
"team"
],
"type": "object",
"properties": {
"team": {
"title": "Team2",
"required": [
"id",
"name",
"color",
"avatar",
"members"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"avatar": {
"type": [
"string",
"null"
]
},
"members": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"examples": [
{
"id": "333",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
}
]
}
},
"examples": [
{
"team": {
"id": "333",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
}
}
]
},
"example": {
"team": {
"id": "333",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/view": {
"get": {
"summary": "Get Workspace (Everything level) Views",
"tags": [
"Views"
],
"description": "View the task and page views available at the Everything Level of a Workspace.",
"operationId": "GetTeamViews",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetTeamViewsresponse",
"required": [
"views"
],
"type": "object",
"properties": {
"views": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view"
},
"description": ""
}
},
"examples": [
{
"views": [
{
"id": "3c-105",
"name": "New View Name",
"type": "list",
"parent": {
"id": "512",
"type": 7
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
]
}
]
},
"example": {
"views": [
{
"id": "3c-105",
"name": "New View Name",
"type": "list",
"parent": {
"id": "512",
"type": 7
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"field": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create Workspace (Everything level) View",
"tags": [
"Views"
],
"description": "Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view at the Everything Level of a Workspace.",
"operationId": "CreateTeamView",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateTeamViewrequest",
"required": [
"name",
"type",
"grouping",
"divide",
"sorting",
"filters",
"columns",
"team_sidebar",
"settings"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."
},
"grouping": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping"
},
"divide": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide"
},
"sorting": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting"
},
"filters": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters"
},
"columns": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns"
},
"team_sidebar": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar"
},
"settings": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings"
}
},
"examples": [
{
"name": "New Team View Name",
"type": "list",
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
]
},
"example": {
"name": "New Everything level View",
"type": "list",
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"field": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateTeamViewresponse",
"required": [
"view"
],
"type": "object",
"properties": {
"view": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view"
}
},
"examples": [
{
"view": {
"id": "3c-105",
"name": "New Team View Name",
"type": "list",
"parent": {
"id": "512",
"type": 7
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
]
},
"example": {
"view": {
"id": "3c-105",
"name": "New Team View Name",
"type": "list",
"parent": {
"id": "512",
"type": 7
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"field": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/space/{space_id}/view": {
"get": {
"summary": "Get Space Views",
"tags": [
"Views"
],
"description": "View the task and page views available for a Space.",
"operationId": "GetSpaceViews",
"parameters": [
{
"name": "space_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [790]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetSpaceViewsresponse",
"required": [
"views"
],
"type": "object",
"properties": {
"views": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view"
},
"description": ""
}
},
"examples": [
{
"views": [
{
"id": "3c-106",
"name": "New Space View Name",
"type": "list",
"parent": {
"id": "790",
"type": 4
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
]
}
]
},
"example": {
"views": [
{
"id": "3c-106",
"name": "New Space View Name",
"type": "list",
"parent": {
"id": "790",
"type": 4
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create Space View",
"tags": [
"Views"
],
"description": "Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Space.",
"operationId": "CreateSpaceView",
"parameters": [
{
"name": "space_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [790]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateSpaceViewrequest",
"required": [
"name",
"type",
"grouping",
"divide",
"sorting",
"filters",
"columns",
"team_sidebar",
"settings"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."
},
"grouping": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping"
},
"divide": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide"
},
"sorting": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting"
},
"filters": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters"
},
"columns": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns"
},
"team_sidebar": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar"
},
"settings": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings"
}
},
"examples": [
{
"name": "New Space View Name",
"type": "list",
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
]
},
"example": {
"name": "New Space View Name",
"type": "list",
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateSpaceViewresponse",
"required": [
"view"
],
"type": "object",
"properties": {
"view": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view"
}
},
"examples": [
{
"view": {
"id": "3c-106",
"name": "New Space View Name",
"type": "list",
"parent": {
"id": "790",
"type": 4
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": {
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
]
},
"example": {
"view": {
"id": "3c-106",
"name": "New Space View Name",
"type": "list",
"parent": {
"id": "790",
"type": 4
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/folder/{folder_id}/view": {
"get": {
"summary": "Get Folder Views",
"tags": [
"Views"
],
"description": "View the task and page views available for a Folder.",
"operationId": "GetFolderViews",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [457]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetFolderViewsresponse",
"required": [
"views"
],
"type": "object",
"properties": {
"views": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view"
},
"description": ""
}
},
"examples": [
{
"views": [
{
"id": "3c-107",
"name": "New Folder View Name",
"type": "list",
"parent": {
"id": "457",
"type": 5
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
]
}
]
},
"example": {
"views": [
{
"id": "3c-107",
"name": "New Folder View Name",
"type": "list",
"parent": {
"id": "457",
"type": 5
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create Folder View",
"tags": [
"Views"
],
"description": "Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a Folder.",
"operationId": "CreateFolderView",
"parameters": [
{
"name": "folder_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [457]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateFolderViewrequest",
"required": [
"name",
"type",
"grouping",
"divide",
"sorting",
"filters",
"columns",
"team_sidebar",
"settings"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."
},
"grouping": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping"
},
"divide": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide"
},
"sorting": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting"
},
"filters": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters"
},
"columns": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns"
},
"team_sidebar": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar"
},
"settings": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings"
}
},
"examples": [
{
"name": "New Folder View Name",
"type": "list",
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
]
},
"example": {
"name": "New Folder View Name",
"type": "list",
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateFolderViewresponse",
"required": [
"view"
],
"type": "object",
"properties": {
"view": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view"
}
},
"examples": [
{
"view": {
"id": "3c-107",
"name": "New Folder View Name",
"type": "list",
"parent": {
"id": "457",
"type": 5
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
]
},
"example": {
"view": {
"id": "3c-107",
"name": "New Folder View Name",
"type": "list",
"parent": {
"id": "457",
"type": 5
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/list/{list_id}/view": {
"get": {
"summary": "Get List Views",
"tags": [
"Views"
],
"description": "View the task and page views available for a List.\u003Cbr\u003E Views and required views are separate responses.",
"operationId": "GetListViews",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [124]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetListViewsresponse",
"required": [
"views"
],
"type": "object",
"properties": {
"views": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view"
},
"description": ""
}
},
"examples": [
{
"views": [
{
"id": "3c-107",
"name": "New List View Name",
"type": "list",
"parent": {
"id": "124",
"type": 6
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
]
}
]
},
"example": {
"views": [
{
"id": "3c-107",
"name": "New List View Name",
"type": "list",
"parent": {
"id": "124",
"type": 6
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create List View",
"tags": [
"Views"
],
"description": "Add a List, Board, Calendar, Table, Timeline, Workload, Activity, Map, Chat, or Gantt view to a List.",
"operationId": "CreateListView",
"parameters": [
{
"name": "list_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [124]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "CreateListViewrequest",
"required": [
"name",
"type",
"grouping",
"divide",
"sorting",
"filters",
"columns",
"team_sidebar",
"settings"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"description": "The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`."
},
"grouping": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping"
},
"divide": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide"
},
"sorting": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting"
},
"filters": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters"
},
"columns": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns"
},
"team_sidebar": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar"
},
"settings": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings"
}
},
"examples": [
{
"name": "New List View Name",
"type": "list",
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
]
},
"example": {
"name": "New List View Name",
"type": "list",
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateListViewresponse",
"required": [
"view"
],
"type": "object",
"properties": {
"view": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view"
}
},
"examples": [
{
"view": {
"id": "3c-108",
"name": "New List View Name",
"type": "list",
"parent": {
"id": "124",
"type": 6
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
]
},
"example": {
"view": {
"id": "3c-108",
"name": "New List View Name",
"type": "list",
"parent": {
"id": "124",
"type": 6
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/view/{view_id}": {
"get": {
"summary": "Get View",
"tags": [
"Views"
],
"description": "View information about a specific task or page view.",
"operationId": "GetView",
"parameters": [
{
"name": "view_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"3c-105"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetViewresponse",
"required": [
"view"
],
"type": "object",
"properties": {
"view": {
"title": "View",
"required": [
"id",
"name",
"type",
"parent",
"grouping",
"divide",
"sorting",
"filters",
"columns",
"team_sidebar",
"settings"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"parent": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/parent"
},
"grouping": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/grouping"
},
"divide": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/divide"
},
"sorting": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/sorting"
},
"filters": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/filters"
},
"columns": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/columns"
},
"team_sidebar": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/team_sidebar"
},
"settings": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/put/requestBody/content/application~1json/schema/properties/settings"
}
},
"examples": [
{
"id": "3c-105",
"name": "New Team View Name",
"type": "list",
"parent": {
"id": "512",
"type": 7
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": {
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
]
}
},
"examples": [
{
"view": {
"id": "3c-105",
"name": "New View Name",
"type": "list",
"parent": {
"id": "512",
"type": 7
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
]
},
"example": {
"view": {
"id": "3c-105",
"name": "New View Name",
"type": "list",
"parent": {
"id": "512",
"type": 7
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
}
}
}
},
"deprecated": false
},
"put": {
"summary": "Update View",
"tags": [
"Views"
],
"description": "Rename a view, update the grouping, sorting, filters, columns, and settings of a view.",
"operationId": "UpdateView",
"parameters": [
{
"name": "view_id",
"in": "path",
"description": "",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"3c"
]
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"title": "UpdateViewrequest",
"required": [
"name",
"type",
"parent",
"grouping",
"divide",
"sorting",
"filters",
"columns",
"team_sidebar",
"settings"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"parent": {
"title": "Parent",
"description": "The parent parameter specifies where the view is located in the ClickUp Hierarchy. Both `id` and `type` are required. \\\n \\\nThe `id` is the id of the Workspace, Space, Folder, or List where the view is located. \\\n \\\nThe `type` value indciates the level of the Hierarchy where the view is located.",
"required": [
"id",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the Workspace, Space, Folder, or List where the view is located."
},
"type": {
"type": "integer",
"description": "The level of the Hierarchy where the view is created. \\\n \\\nOptions include: \\\n \\\nWorkspace (Everything Level): `7` \\\n \\\nSpace: `4` \\\n \\\nFolder: `5` \\\n \\\nList: `6`",
"contentEncoding": "int32"
}
},
"examples": [
{
"id": "512",
"type": 7
}
]
},
"grouping": {
"title": "Grouping",
"required": [
"field",
"dir",
"collapsed",
"ignore"
],
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Set the field to group by.\\\n \\\nOptions include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`."
},
"dir": {
"description": "Set a group sort order using `1` or `-1`.\\\n \\\nFor example, use `1`show tasks with urgent priority at the top of your view, and tasks with no priority at the bottom.\\\n \\\nUse `-1` to reverse the order to show tasks with no priority at the top of your view.",
"type": "integer",
"contentEncoding": "int32"
},
"collapsed": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"ignore": {
"type": "boolean"
}
},
"examples": [
{
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
}
]
},
"divide": {
"title": "Divide",
"required": [
"collapsed"
],
"type": "object",
"properties": {
"field": {
"type": [
"null"
]
},
"dir": {
"type": [
"null"
]
},
"collapsed": {
"type": [
"boolean"
]
}
},
"examples": [
{
"field": null,
"dir": null,
"collapsed": []
}
]
},
"sorting": {
"title": "Sorting",
"required": [
"fields"
],
"type": "object",
"properties": {
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "Include an array of fields to sort by.\\\n \\\n You can sort by the same fields available when [filtering a view](doc:filter-views)."
}
},
"examples": [
{
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
}
]
},
"filters": {
"title": "Filters",
"required": [
"op",
"fields",
"search",
"show_closed"
],
"type": "object",
"properties": {
"op": {
"type": "string",
"description": "The available operator (`op``) values are `AND`` and `OR``."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "View the list of [fields available](doc:filter-views) to filter by."
},
"search": {
"type": "string"
},
"show_closed": {
"type": "boolean"
}
},
"examples": [
{
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
}
]
},
"columns": {
"title": "Columns",
"description": "Custom Fields added to a view at the Everything level will be added to all tasks in your Workspace. Once Custom Fields are added to one of these views, you cannot move it to another level of the Hierarchy.",
"required": [
"fields"
],
"type": "object",
"properties": {
"fields": {
"description": "Custom Fields require the `cf_` prefix and must be formatted as a JSON object. Example: `cf_eb1234567890-c676-4c10-9012-345678901234`",
"type": "array",
"items": {
"type": "string"
}
}
},
"examples": [
{
"fields": []
}
]
},
"team_sidebar": {
"title": "TeamSidebar",
"required": [
"assignees",
"assigned_comments",
"unassigned_tasks"
],
"type": "object",
"properties": {
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"assigned_comments": {
"type": "boolean"
},
"unassigned_tasks": {
"type": "boolean"
}
},
"examples": [
{
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
}
]
},
"settings": {
"title": "Settings",
"required": [
"show_task_locations",
"show_subtasks",
"show_subtask_parent_names",
"show_closed_subtasks",
"show_assignees",
"show_images",
"collapse_empty_columns",
"me_comments",
"me_subtasks",
"me_checklists"
],
"type": "object",
"properties": {
"show_task_locations": {
"type": "boolean"
},
"show_subtasks": {
"description": "Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed.",
"type": "integer",
"contentEncoding": "int32"
},
"show_subtask_parent_names": {
"type": "boolean"
},
"show_closed_subtasks": {
"type": "boolean"
},
"show_assignees": {
"type": "boolean"
},
"show_images": {
"type": "boolean"
},
"collapse_empty_columns": {
"type": [
"string",
"null"
]
},
"me_comments": {
"type": "boolean"
},
"me_subtasks": {
"type": "boolean"
},
"me_checklists": {
"type": "boolean"
}
},
"examples": [
{
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
]
}
},
"examples": [
{
"name": "New View Name",
"type": "list",
"parent": {
"id": "512",
"type": 7
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
]
},
"example": {
"name": "New View Name",
"type": "list",
"parent": {
"id": "512",
"type": 7
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "UpdateViewresponse",
"required": [
"view"
],
"type": "object",
"properties": {
"view": {
"$ref": "#/paths/~1v2~1view~1%7Bview_id%7D/get/responses/200/content/application~1json/schema/properties/view"
}
},
"examples": [
{
"view": {
"id": "3c-105",
"name": "New View Name",
"type": "list",
"parent": {
"id": "512",
"type": 7
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": []
},
"filters": {
"op": "AND",
"fields": [],
"search": "",
"show_closed": false
},
"columns": {
"fields": []
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
]
},
"example": {
"view": {
"id": "3c-105",
"name": "New View Name",
"type": "list",
"parent": {
"id": "512",
"type": 7
},
"grouping": {
"field": "status",
"dir": 1,
"collapsed": [],
"ignore": false
},
"divide": {
"field": null,
"dir": null,
"collapsed": []
},
"sorting": {
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"dir": -1,
"idx": 0
}
]
},
"filters": {
"op": "AND",
"fields": [
{
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2",
"op": "EQ",
"determinor": null,
"idx": 0,
"values": "123"
}
],
"search": "",
"show_closed": false
},
"columns": {
"fields": [
{
"field": "assignee",
"idx": 0,
"width": 160,
"hidden": true,
"name": null,
"display": null
}
]
},
"team_sidebar": {
"assignees": [],
"assigned_comments": false,
"unassigned_tasks": false
},
"settings": {
"show_task_locations": false,
"show_subtasks": 3,
"show_subtask_parent_names": false,
"show_closed_subtasks": false,
"show_assignees": true,
"show_images": true,
"collapse_empty_columns": null,
"me_comments": true,
"me_subtasks": true,
"me_checklists": true
}
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete View",
"tags": [
"Views"
],
"operationId": "DeleteView",
"parameters": [
{
"name": "view_id",
"in": "path",
"description": "105 (string)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"3c"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/view/{view_id}/task": {
"get": {
"summary": "Get View Tasks",
"tags": [
"Views"
],
"description": "See all visible tasks in a view in ClickUp.",
"operationId": "GetViewTasks",
"parameters": [
{
"name": "view_id",
"in": "path",
"description": "105 (string)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"3c"
]
}
},
{
"name": "page",
"in": "query",
"description": "",
"required": true,
"style": "form",
"explode": true,
"schema": {
"type": "integer",
"contentEncoding": "int32",
"examples": [0]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetViewTasksresponse",
"required": [
"tasks",
"last_page"
],
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"title": "Task9",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"custom_item_id": {
"type": [
"number",
"null"
]
},
"name": {
"type": "string"
},
"status": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/status"
},
"markdown_description": {
"type": "string"
},
"orderindex": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"date_closed": {
"type": [
"string",
"null"
]
},
"date_done": {
"type": [
"string",
"null"
]
},
"creator": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/creator"
},
"assignees": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"watchers": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"checklists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"parent": {
"type": [
"string",
"null"
]
},
"priority": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/priority"
},
"due_date": {
"type": [
"string",
"null"
]
},
"start_date": {
"type": [
"string",
"null"
]
},
"points": {
"type": [
"number"
]
},
"time_estimate": {
"type": [
"string",
"null"
]
},
"time_spent": {
"type": [
"string"
]
},
"custom_fields": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/custom_fields/items"
},
"list": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/list"
},
"folder": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/folder"
},
"space": {
"$ref": "#/paths/~1v2~1task~1%7Btask_id%7D/get/responses/200/content/application~1json/schema/properties/space"
},
"url": {
"type": "string"
}
},
"examples": [
{
"id": "9hx",
"name": "New Task Name",
"custom_item_id": null,
"status": {
"status": "Open",
"color": "#d3d3d3",
"orderindex": 0,
"type": "open"
},
"markdown_description": "Task description",
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"date_done": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"watchers": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": {
"color": "#f8ae00",
"id": "3",
"orderindex": "3",
"priority": "normal"
},
"due_date": null,
"start_date": null,
"time_estimate": null,
"time_spent": 7200000,
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"url": "https://app.clickup.com/t/9hx"
}
]
},
"description": ""
},
"last_page": {
"type": "boolean"
}
},
"examples": [
{
"tasks": [
{
"id": "9hx",
"name": "New Task Name",
"status": {
"status": "Open",
"color": "#d3d3d3",
"orderindex": 0,
"type": "open"
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"date_done": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": {
"color": "#f8ae00",
"id": "3",
"orderindex": "3",
"priority": "normal"
},
"due_date": null,
"start_date": null,
"points": 3,
"time_estimate": null,
"time_spent": null,
"custom_fields": {
"id": "0a52c486-5f05-403b-b4fd-c512ff05131c",
"name": "My Text Custom field",
"type": "text",
"type_config": {
},
"date_created": "1622176979540",
"hide_from_guests": false,
"value": {
"value": "This is a string of text added to a Custom Field."
},
"required": true
},
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"url": "https://app.clickup.com/t/9hx"
},
{
"id": "9hz",
"name": "Second task",
"status": {
"status": "Open",
"color": "#d3d3d3",
"orderindex": 0,
"type": "open"
},
"orderindex": "2.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"date_done": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": null,
"due_date": null,
"start_date": null,
"points": 3,
"time_estimate": null,
"time_spent": null,
"custom_fields": {
"id": "0a52c486-5f05-403b-b4fd-c512ff05131c",
"name": "My Text Custom field",
"type": "text",
"type_config": {
},
"date_created": "1622176979540",
"hide_from_guests": false,
"value": {
"value": "This is a string of text added to a Custom Field."
},
"required": true
},
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"url": "https://app.clickup.com/t/9hz"
}
],
"last_page": true
}
]
},
"example": {
"tasks": [
{
"id": "9hx",
"name": "New Task Name",
"status": {
"status": "Open",
"color": "#d3d3d3",
"orderindex": 0,
"type": "open"
},
"orderindex": "1.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"date_done": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": {
"color": "#f8ae00",
"id": "3",
"orderindex": "3",
"priority": "normal"
},
"due_date": null,
"start_date": null,
"points": 3,
"time_estimate": null,
"time_spent": null,
"custom_fields": {
"id": "0a52c486-5f05-403b-b4fd-c512ff05131c",
"name": "My Text Custom field",
"type": "text",
"type_config": {
},
"date_created": "1622176979540",
"hide_from_guests": false,
"value": {
"value": "This is a string of text added to a Custom Field."
},
"required": true
},
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"url": "https://app.clickup.com/t/9hx"
},
{
"id": "9hz",
"name": "Second task",
"status": {
"status": "Open",
"color": "#d3d3d3",
"orderindex": 0,
"type": "open"
},
"orderindex": "2.00000000000000000000000000000000",
"date_created": "1567780450202",
"date_updated": "1567780450202",
"date_closed": null,
"date_done": null,
"creator": {
"id": 183,
"username": "John Doe",
"color": "#827718",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"assignees": [],
"checklists": [],
"tags": [],
"parent": null,
"priority": null,
"due_date": null,
"start_date": null,
"points": 3,
"time_estimate": null,
"time_spent": null,
"custom_fields": {
"id": "0a52c486-5f05-403b-b4fd-c512ff05131c",
"name": "My Text Custom field",
"type": "text",
"type_config": {
},
"date_created": "1622176979540",
"hide_from_guests": false,
"value": {
"value": "This is a string of text added to a Custom Field."
},
"required": true
},
"list": {
"id": "123"
},
"folder": {
"id": "456"
},
"space": {
"id": "789"
},
"url": "https://app.clickup.com/t/9hz"
}
],
"last_page": true
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/team/{team_id}/webhook": {
"get": {
"summary": "Get Webhooks",
"tags": [
"Webhooks"
],
"description": "View the webhooks created via the API for a Workspace. This endpoint returns webhooks created by the authenticated user.",
"operationId": "GetWebhooks",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "GetWebhooksresponse",
"required": [
"webhooks"
],
"type": "object",
"properties": {
"webhooks": {
"type": "array",
"items": {
"$ref": "#/paths/~1v2~1webhook~1%7Bwebhook_id%7D/put/responses/200/content/application~1json/schema/properties/webhook"
},
"description": ""
}
},
"examples": [
{
"webhooks": [
{
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"userid": 183,
"team_id": 108,
"endpoint": "https://yourdomain.com/webhook",
"client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO",
"events": [
"taskCreated",
"taskUpdated",
"taskDeleted",
"taskPriorityUpdated",
"taskStatusUpdated",
"taskAssigneeUpdated",
"taskDueDateUpdated",
"taskTagUpdated",
"taskMoved",
"taskCommentPosted",
"taskCommentUpdated",
"taskTimeEstimateUpdated",
"taskTimeTrackedUpdated",
"listCreated",
"listUpdated",
"listDeleted",
"folderCreated",
"folderUpdated",
"folderDeleted",
"spaceCreated",
"spaceUpdated",
"spaceDeleted",
"goalCreated",
"goalUpdated",
"goalDeleted",
"keyResultCreated",
"keyResultUpdated",
"keyResultDeleted"
],
"task_id": null,
"list_id": null,
"folder_id": null,
"space_id": null,
"health": {
"status": "failing",
"fail_count": 5
},
"secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA"
}
]
}
]
},
"example": {
"webhooks": [
{
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"userid": 183,
"team_id": 108,
"endpoint": "https://yourdomain.com/webhook",
"client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO",
"events": [
"taskCreated",
"taskUpdated",
"taskDeleted",
"taskPriorityUpdated",
"taskStatusUpdated",
"taskAssigneeUpdated",
"taskDueDateUpdated",
"taskTagUpdated",
"taskMoved",
"taskCommentPosted",
"taskCommentUpdated",
"taskTimeEstimateUpdated",
"taskTimeTrackedUpdated",
"listCreated",
"listUpdated",
"listDeleted",
"folderCreated",
"folderUpdated",
"folderDeleted",
"spaceCreated",
"spaceUpdated",
"spaceDeleted",
"goalCreated",
"goalUpdated",
"goalDeleted",
"keyResultCreated",
"keyResultUpdated",
"keyResultDeleted"
],
"task_id": null,
"list_id": null,
"folder_id": null,
"space_id": null,
"health": {
"status": "failing",
"fail_count": 5
},
"secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA"
}
]
}
}
}
}
},
"deprecated": false
},
"post": {
"summary": "Create Webhook",
"tags": [
"Webhooks"
],
"description": "Set up a webhook to monitor for events.\u003Cbr\u003E We do not have a dedicated IP address for webhooks. We use our domain name and dynamic addressing.",
"operationId": "CreateWebhook",
"parameters": [
{
"name": "team_id",
"in": "path",
"description": "Workspace ID",
"required": true,
"style": "simple",
"schema": {
"type": "number",
"contentEncoding": "double",
"examples": [123]
}
}
],
"requestBody": {
"description": "You can subscribe to specific events, and one specific location per webhook. [Learn more](doc:webhooks).",
"content": {
"application/json": {
"schema": {
"title": "CreateWebhookrequest",
"required": [
"endpoint",
"events"
],
"type": "object",
"properties": {
"endpoint": {
"type": "string"
},
"events": {
"type": "array",
"description": "See [documentation](doc:webhooks#task-webhooks) for available event options. Use `*` to subscribe to all events.",
"items": {
"type": "string"
}
},
"space_id": {
"type": "integer"
},
"folder_id": {
"type": "integer"
},
"list_id": {
"type": "integer"
},
"task_id": {
"type": "string"
}
},
"examples": [
{
"endpoint": "https://yourdomain.com/webhook",
"events": [
"taskCreated",
"taskUpdated",
"taskDeleted",
"taskPriorityUpdated",
"taskStatusUpdated",
"taskAssigneeUpdated",
"taskDueDateUpdated",
"taskTagUpdated",
"taskMoved",
"taskCommentPosted",
"taskCommentUpdated",
"taskTimeEstimateUpdated",
"taskTimeTrackedUpdated",
"listCreated",
"listUpdated",
"listDeleted",
"folderCreated",
"folderUpdated",
"folderDeleted",
"spaceCreated",
"spaceUpdated",
"spaceDeleted",
"goalCreated",
"goalUpdated",
"goalDeleted",
"keyResultCreated",
"keyResultUpdated",
"keyResultDeleted"
],
"space_id": 1234,
"folder_id": 5678,
"list_id": 9876,
"task_id": "abc1234"
}
]
},
"example": {
"endpoint": "https://yourdomain.com/webhook",
"events": [
"taskCreated",
"taskUpdated",
"taskDeleted",
"taskPriorityUpdated",
"taskStatusUpdated",
"taskAssigneeUpdated",
"taskDueDateUpdated",
"taskTagUpdated",
"taskMoved",
"taskCommentPosted",
"taskCommentUpdated",
"taskTimeEstimateUpdated",
"taskTimeTrackedUpdated",
"listCreated",
"listUpdated",
"listDeleted",
"folderCreated",
"folderUpdated",
"folderDeleted",
"spaceCreated",
"spaceUpdated",
"spaceDeleted",
"goalCreated",
"goalUpdated",
"goalDeleted",
"keyResultCreated",
"keyResultUpdated",
"keyResultDeleted"
],
"space_id": 1234,
"folder_id": 5678,
"list_id": 9876,
"task_id": "abc1234"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "CreateWebhookresponse",
"required": [
"id",
"webhook"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"webhook": {
"$ref": "#/paths/~1v2~1webhook~1%7Bwebhook_id%7D/put/responses/200/content/application~1json/schema/properties/webhook"
}
},
"examples": [
{
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"webhook": {
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"userid": 183,
"team_id": 108,
"endpoint": "https://yourdomain.com/webhook",
"client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO",
"events": [
"taskCreated",
"taskUpdated",
"taskDeleted",
"taskPriorityUpdated",
"taskStatusUpdated",
"taskAssigneeUpdated",
"taskDueDateUpdated",
"taskTagUpdated",
"taskMoved",
"taskCommentPosted",
"taskCommentUpdated",
"taskTimeEstimateUpdated",
"taskTimeTrackedUpdated",
"listCreated",
"listUpdated",
"listDeleted",
"folderCreated",
"folderUpdated",
"folderDeleted",
"spaceCreated",
"spaceUpdated",
"spaceDeleted",
"goalCreated",
"goalUpdated",
"goalDeleted",
"keyResultCreated",
"keyResultUpdated",
"keyResultDeleted"
],
"task_id": null,
"list_id": null,
"folder_id": null,
"space_id": null,
"health": {
"status": "active",
"fail_count": 0
},
"secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA"
}
}
]
},
"example": {
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"webhook": {
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"userid": 183,
"team_id": 108,
"endpoint": "https://yourdomain.com/webhook",
"client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO",
"events": [
"taskCreated",
"taskUpdated",
"taskDeleted",
"taskPriorityUpdated",
"taskStatusUpdated",
"taskAssigneeUpdated",
"taskDueDateUpdated",
"taskTagUpdated",
"taskMoved",
"taskCommentPosted",
"taskCommentUpdated",
"taskTimeEstimateUpdated",
"taskTimeTrackedUpdated",
"listCreated",
"listUpdated",
"listDeleted",
"folderCreated",
"folderUpdated",
"folderDeleted",
"spaceCreated",
"spaceUpdated",
"spaceDeleted",
"goalCreated",
"goalUpdated",
"goalDeleted",
"keyResultCreated",
"keyResultUpdated",
"keyResultDeleted"
],
"task_id": null,
"list_id": null,
"folder_id": null,
"space_id": null,
"health": {
"status": "active",
"fail_count": 0
},
"secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA"
}
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v2/webhook/{webhook_id}": {
"put": {
"summary": "Update Webhook",
"tags": [
"Webhooks"
],
"description": "Update a webhook to change the events to be monitored.",
"operationId": "UpdateWebhook",
"parameters": [
{
"name": "webhook_id",
"in": "path",
"description": "e506-4a29-9d42-26e504e3435e (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"4b67ac88"
]
}
}
],
"requestBody": {
"description": "To subscribe to specific events, pass an array of `events` that you want to subscribe to, or use the wildcard character `\"*\"` to subscribe to everything.\\\n \\\nIf you don't specify any events, all events will be sent to the webhook.",
"content": {
"application/json": {
"schema": {
"title": "UpdateWebhookrequest",
"required": [
"endpoint",
"events",
"status"
],
"type": "object",
"properties": {
"endpoint": {
"type": "string"
},
"events": {
"type": "string"
},
"status": {
"type": "string"
}
},
"examples": [
{
"endpoint": "https://yourdomain.com/webhook",
"events": "*",
"status": "active"
}
]
},
"example": {
"endpoint": "https://yourdomain.com/webhook",
"events": "*",
"status": "active"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"title": "UpdateWebhookresponse",
"required": [
"id",
"webhook"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"webhook": {
"title": "Webhook",
"required": [
"id",
"userid",
"team_id",
"endpoint",
"client_id",
"events",
"task_id",
"list_id",
"folder_id",
"space_id",
"health",
"secret"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"userid": {
"type": "integer",
"contentEncoding": "int32"
},
"team_id": {
"type": "integer",
"contentEncoding": "int32"
},
"endpoint": {
"type": "string"
},
"client_id": {
"type": "string"
},
"events": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"task_id": {
"type": [
"string",
"null"
]
},
"list_id": {
"type": [
"string",
"null"
]
},
"folder_id": {
"type": [
"string",
"null"
]
},
"space_id": {
"type": [
"string",
"null"
]
},
"health": {
"title": "Health",
"required": [
"status",
"fail_count"
],
"type": "object",
"properties": {
"status": {
"type": "string"
},
"fail_count": {
"type": "integer",
"contentEncoding": "int32"
}
},
"examples": [
{
"status": "active",
"fail_count": 0
}
]
},
"secret": {
"type": "string"
}
},
"examples": [
{
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"userid": 183,
"team_id": 108,
"endpoint": "https://yourdomain.com/webhook",
"client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO",
"events": [
"taskCreated",
"taskUpdated",
"taskDeleted",
"taskPriorityUpdated",
"taskStatusUpdated",
"taskAssigneeUpdated",
"taskDueDateUpdated",
"taskTagUpdated",
"taskMoved",
"taskCommentPosted",
"taskCommentUpdated",
"taskTimeEstimateUpdated",
"taskTimeTrackedUpdated",
"listCreated",
"listUpdated",
"listDeleted",
"folderCreated",
"folderUpdated",
"folderDeleted",
"spaceCreated",
"spaceUpdated",
"spaceDeleted",
"goalCreated",
"goalUpdated",
"goalDeleted",
"keyResultCreated",
"keyResultUpdated",
"keyResultDeleted"
],
"task_id": null,
"list_id": null,
"folder_id": null,
"space_id": null,
"health": {
"status": "active",
"fail_count": 0
},
"secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA"
}
]
}
},
"examples": [
{
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"webhook": {
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"userid": 183,
"team_id": 108,
"endpoint": "https://yourdomain.com/webhook",
"client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO",
"events": [
"taskCreated",
"taskUpdated",
"taskDeleted",
"taskPriorityUpdated",
"taskStatusUpdated",
"taskAssigneeUpdated",
"taskDueDateUpdated",
"taskTagUpdated",
"taskMoved",
"taskCommentPosted",
"taskCommentUpdated",
"taskTimeEstimateUpdated",
"taskTimeTrackedUpdated",
"listCreated",
"listUpdated",
"listDeleted",
"folderCreated",
"folderUpdated",
"folderDeleted",
"spaceCreated",
"spaceUpdated",
"spaceDeleted",
"goalCreated",
"goalUpdated",
"goalDeleted",
"keyResultCreated",
"keyResultUpdated",
"keyResultDeleted"
],
"task_id": null,
"list_id": null,
"folder_id": null,
"space_id": null,
"health": {
"status": "active",
"fail_count": 0
},
"secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA"
}
}
]
},
"example": {
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"webhook": {
"id": "4b67ac88-e506-4a29-9d42-26e504e3435e",
"userid": 183,
"team_id": 108,
"endpoint": "https://yourdomain.com/webhook",
"client_id": "QVOQP06ZXC6CMGVFKB0ZT7J9Y7APOYGO",
"events": [
"taskCreated",
"taskUpdated",
"taskDeleted",
"taskPriorityUpdated",
"taskStatusUpdated",
"taskAssigneeUpdated",
"taskDueDateUpdated",
"taskTagUpdated",
"taskMoved",
"taskCommentPosted",
"taskCommentUpdated",
"taskTimeEstimateUpdated",
"taskTimeTrackedUpdated",
"listCreated",
"listUpdated",
"listDeleted",
"folderCreated",
"folderUpdated",
"folderDeleted",
"spaceCreated",
"spaceUpdated",
"spaceDeleted",
"goalCreated",
"goalUpdated",
"goalDeleted",
"keyResultCreated",
"keyResultUpdated",
"keyResultDeleted"
],
"task_id": null,
"list_id": null,
"folder_id": null,
"space_id": null,
"health": {
"status": "active",
"fail_count": 0
},
"secret": "O94IM25S7PXBPYTMNXLLET230SRP0S89COR7B1YOJ2ZIE8WQNK5UUKEF26W0Z5GA"
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"summary": "Delete Webhook",
"tags": [
"Webhooks"
],
"description": "Delete a webhook to stop monitoring the events and locations of the webhook.",
"operationId": "DeleteWebhook",
"parameters": [
{
"name": "webhook_id",
"in": "path",
"description": "e506-4a29-9d42-26e504e3435e (uuid)",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"examples": [
"4b67ac88"
]
}
}
],
"responses": {
"200": {
"description": "",
"headers": {
},
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"deprecated": false
},
"parameters": []
},
"/v3/workspaces/{workspaceId}/docs": {
"get": {
"operationId": "searchDocs",
"summary": "Search Docs",
"description": "View the Docs in your Workspace. You can only view information of Docs you can access.",
"parameters": [
{
"name": "workspaceId",
"required": true,
"in": "path",
"description": "The ID of your Workspace.",
"schema": {
"type": "number"
}
},
{
"name": "id",
"required": false,
"in": "query",
"description": "Filter results to a single Doc with the given Doc ID.",
"schema": {
"type": "string"
}
},
{
"name": "creator",
"required": false,
"in": "query",
"description": "Filter results to Docs created by the user with the given user ID.",
"schema": {
"type": "number"
}
},
{
"name": "deleted",
"required": false,
"in": "query",
"description": "Filter results to return deleted Docs.",
"schema": {
"default": "false",
"type": "boolean"
}
},
{
"name": "archived",
"required": false,
"in": "query",
"description": "Filter results to return archived Docs.",
"schema": {
"default": "false",
"type": "boolean"
}
},
{
"name": "parent_id",
"required": false,
"in": "query",
"description": "Filter results to children of a parent Doc with the given parent Doc ID.",
"schema": {
"type": "string"
}
},
{
"name": "parent_type",
"required": false,
"in": "query",
"description": "Filter results to children of the given parent Doc type. For example, `SPACE`, `FOLDER`, `LIST`, `EVERYTHING`, `WORKSPACE`.",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "The maximum number of results to retrieve for each page.",
"schema": {
"minimum": 10,
"maximum": 100,
"default": 50,
"type": "number"
}
},
{
"name": "next_cursor",
"required": false,
"in": "query",
"description": "The cursor to use to get the next page of results.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Search results",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"docs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"date_created": {
"type": "number"
},
"date_updated": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "number",
"enum": []
},
"parent": {
"$ref": "#/paths/~1v3~1workspaces~1%7BworkspaceId%7D~1docs/post/responses/201/content/application~1json/schema/properties/parent"
},
"public": {
"type": "boolean"
},
"workspace_id": {
"type": "number"
},
"creator": {
"type": "number"
},
"deleted": {
"type": "boolean"
},
"date_deleted": {
"type": "number"
},
"deleted_by": {
"type": "number"
},
"archived": {
"type": "boolean"
},
"archived_by": {
"type": "number"
},
"date_archived": {
"type": "number"
}
},
"required": [
"id",
"date_created",
"name",
"type",
"parent",
"public",
"workspace_id",
"creator",
"deleted",
"archived"
]
}
},
"next_cursor": {
"type": "string"
}
},
"required": [
"docs"
]
}
}
}
}
},
"tags": [
"Docs"
]
},
"post": {
"operationId": "createDoc",
"summary": "Create Doc",
"description": "Create a new Doc. ",
"parameters": [
{
"name": "workspaceId",
"required": true,
"in": "path",
"description": "The ID of the Workspace.",
"schema": {
"type": "number"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the new Doc."
},
"parent": {
"description": "The parent of the new Doc.",
"allOf": [
{
"$ref": "#/paths/~1v3~1workspaces~1%7BworkspaceId%7D~1docs/post/responses/201/content/application~1json/schema/properties/parent"
}
]
},
"visibility": {
"type": "string",
"description": "The visibility of the new Doc. For example, `PUBLIC` or `PRIVATE`."
},
"create_page": {
"type": "boolean",
"description": "Create a new page when creating the Doc.",
"default": true
}
}
}
}
}
},
"responses": {
"201": {
"description": "Doc created",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"date_created": {
"type": "number"
},
"date_updated": {
"type": "number"
},
"name": {
"type": "string"
},
"type": {
"type": "number",
"enum": []
},
"parent": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "number",
"description": "The parent Doc type. Use `4` for Space, `5` for Folder, `6` for List, `7` for Everything, and `12` for Workspace."
}
},
"required": [
"id",
"type"
]
},
"public": {
"type": "boolean"
},
"workspace_id": {
"type": "number"
},
"archived": {
"type": "boolean"
},
"archived_by": {
"type": "number"
},
"creator": {
"type": "number"
},
"date_archived": {
"type": "number"
},
"date_deleted": {
"type": "number"
},
"deleted": {
"type": "boolean"
},
"deleted_by": {
"type": "number"
},
"page_defaults": {
"type": "object",
"properties": {
"font": {
"type": "string"
},
"font_size": {
"type": "number"
},
"line_height": {
"type": "number"
},
"page_width": {
"type": "number"
},
"paragraph_spacing": {
"type": "number"
},
"show_author_header": {
"type": "boolean"
},
"show_contributor_header": {
"type": "boolean"
},
"show_cover_header": {
"type": "boolean"
},
"show_date_header": {
"type": "boolean"
},
"show_page_outline": {
"type": "boolean"
},
"show_sub_pages": {
"type": "boolean"
},
"sub_page_size": {
"type": "string"
},
"show_sub_title_header": {
"type": "boolean"
},
"show_title_icon_header": {
"type": "boolean"
},
"show_relationships": {
"type": "boolean"
},
"show_relationships_compact": {
"type": "boolean"
},
"show_sub_pages_author": {
"type": "boolean"
},
"show_sub_pages_thumbnail": {
"type": "boolean"
},
"show_sub_pages_compact": {
"type": "boolean"
},
"sub_pages_style": {
"type": "string"
}
}
}
},
"required": [
"id",
"date_created",
"name",
"type",
"parent",
"public",
"workspace_id",
"creator"
]
}
}
}
}
},
"tags": [
"Docs"
]
}
},
"/v3/workspaces/{workspaceId}/docs/{docId}": {
"get": {
"operationId": "getDoc",
"summary": "Get Doc",
"description": "View information about a Doc.",
"parameters": [
{
"name": "workspaceId",
"required": true,
"in": "path",
"description": "The ID of the Workspace.",
"schema": {
"type": "number"
}
},
{
"name": "docId",
"required": true,
"in": "path",
"description": "The ID of the Doc.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Doc found",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1v3~1workspaces~1%7BworkspaceId%7D~1docs/post/responses/201/content/application~1json/schema"
}
}
}
},
"404": {
"description": "Doc not found"
}
},
"tags": [
"Docs"
]
}
},
"/v3/workspaces/{workspaceId}/docs/{docId}/pageListing": {
"get": {
"operationId": "getDocPageListing",
"summary": "Get Doc PageListing",
"description": "View the PageListing for a Doc.",
"parameters": [
{
"name": "workspaceId",
"required": true,
"in": "path",
"description": "The ID of the Workspace.",
"schema": {
"type": "number"
}
},
{
"name": "docId",
"required": true,
"in": "path",
"description": "The ID of the Doc.",
"schema": {
"type": "string"
}
},
{
"name": "max_page_depth",
"required": false,
"in": "query",
"description": "The maximum depth to retrieve pages and subpages. A value less than 0 does not limit the depth.",
"schema": {
"default": "-1",
"type": "number"
}
}
],
"responses": {
"200": {
"description": "PageListing found",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"doc_id": {
"type": "string"
},
"parent_page_id": {
"type": "string"
},
"workspace_id": {
"type": "number"
},
"name": {
"type": "string"
},
"pages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"doc_id": {
"type": "string"
},
"name": {
"type": "string"
},
"pages": {
"description": "More nested documents witht the same object structure.",
"type": "array"
}
}
}
}
},
"required": [
"id",
"doc_id",
"workspace_id",
"name"
],
"example": [
{
"id": "8cht190-271",
"doc_id": "8cht190-831",
"workspace_id": 9011234080,
"name": "Fantastic Marketing doc"
},
{
"id": "8cht190-311",
"doc_id": "8cht190-831",
"workspace_id": 9011234080,
"name": "Another doc",
"pages": [
{
"id": "8cht190-331",
"doc_id": "8cht190-831",
"parent_page_id": "8cht190-311",
"workspace_id": 9011234080,
"name": "sub page",
"pages": [
{
"id": "8cht190-351",
"doc_id": "8cht190-831",
"parent_page_id": "8cht190-331",
"workspace_id": 9011234080,
"name": "2nd sub page"
}
]
}
]
}
]
}
}
}
}
},
"404": {
"description": "PageListing not found"
}
},
"tags": [
"Docs"
]
}
},
"/v3/workspaces/{workspaceId}/docs/{docId}/pages": {
"get": {
"operationId": "getDocPages",
"summary": "Get Doc pages",
"description": "View pages belonging to a Doc.",
"parameters": [
{
"name": "workspaceId",
"required": true,
"in": "path",
"description": "The ID of the Workspace.",
"schema": {
"type": "number"
}
},
{
"name": "docId",
"required": true,
"in": "path",
"description": "The ID of the Doc.",
"schema": {
"type": "string"
}
},
{
"name": "max_page_depth",
"required": false,
"in": "query",
"description": "The maximum depth to retrieve pages and subpages. A value less than 0 does not limit the depth.",
"schema": {
"default": "-1",
"type": "number"
}
},
{
"name": "content_format",
"required": false,
"in": "query",
"description": "The format to return the page content in. For example, `text/md` for markdown or `text/plain` for plain.",
"schema": {
"default": "text/md",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Pages found",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/paths/~1v3~1workspaces~1%7BworkspaceId%7D~1docs~1%7BdocId%7D~1pages/post/responses/201/content/application~1json/schema"
}
}
}
}
}
},
"tags": [
"Docs"
]
},
"post": {
"operationId": "createPage",
"summary": "Create page",
"description": "Create a page in a Doc.",
"parameters": [
{
"name": "workspaceId",
"required": true,
"in": "path",
"description": "The ID of the Workspace.",
"schema": {
"type": "number"
}
},
{
"name": "docId",
"required": true,
"in": "path",
"description": "The ID of the Doc.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"parent_page_id": {
"type": "string",
"description": "The ID of the parent page. If this is a root page in the Doc, `parent_page_id` will not be returned.",
"default": null
},
"name": {
"type": "string",
"description": "The name of the new page.",
"default": ""
},
"sub_title": {
"type": "string",
"description": "The subtitle of the new page.",
"default": null
},
"content": {
"type": "string",
"description": "The content of the new page.",
"default": ""
},
"content_format": {
"type": "string",
"description": "The format the page content is in. For example, `text/md` for markdown or `text/plain` for plain.",
"default": "text/md"
}
}
}
}
}
},
"responses": {
"201": {
"description": "Page created",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"doc_id": {
"type": "string"
},
"parent_page_id": {
"type": "string"
},
"workspace_id": {
"type": "number"
},
"name": {
"type": "string"
},
"pages": {
"type": "array",
"description": "More nested documents with the same object structure."
},
"sub_title": {
"type": "string"
},
"date_created": {
"type": "number"
},
"date_updated": {
"type": "number"
},
"content": {
"type": "string"
},
"avatar": {
"type": "object",
"properties": {
"color": {
"type": "string"
},
"value": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"creator_id": {
"type": "number"
},
"deleted": {
"type": "boolean"
},
"deleted_by": {
"type": "number"
},
"date_deleted": {
"type": "number"
},
"date_edited": {
"type": "number"
},
"edited_by": {
"type": "number"
},
"archived": {
"type": "boolean"
},
"archived_by": {
"type": "number"
},
"date_archived": {
"type": "number"
},
"authors": {
"type": "array",
"items": {
"type": "number"
}
},
"contributors": {
"type": "array",
"items": {
"type": "number"
}
},
"cover": {
"type": "object",
"properties": {
"color": {
"type": "string"
},
"image_url": {
"type": "string"
},
"position": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"required": [
"x",
"y"
]
}
}
},
"protected": {
"type": "boolean"
},
"protected_by": {
"type": "number"
},
"protected_note": {
"type": "string"
},
"presentation_details": {
"$ref": "#/paths/~1v3~1workspaces~1%7BworkspaceId%7D~1docs/post/responses/201/content/application~1json/schema/properties/page_defaults"
}
},
"required": [
"id",
"doc_id",
"workspace_id",
"name",
"date_created",
"content",
"creator_id",
"authors"
]
}
}
}
}
},
"tags": [
"Docs"
]
}
},
"/v3/workspaces/{workspaceId}/docs/{docId}/pages/{pageId}": {
"get": {
"operationId": "getPage",
"summary": "Get page",
"description": "View the information about a page in a Doc. Due to markdown format limitations, some content elements [will not be displayed exactly as they appear in ClickUp.](doc:docsimportexportlimitations/)",
"parameters": [
{
"name": "workspaceId",
"required": true,
"in": "path",
"description": "The ID of the Workspace.",
"schema": {
"type": "number"
}
},
{
"name": "docId",
"required": true,
"in": "path",
"description": "The ID of the Doc.",
"schema": {
"type": "string"
}
},
{
"name": "pageId",
"required": true,
"in": "path",
"description": "The ID of the page.",
"schema": {
"type": "string"
}
},
{
"name": "content_format",
"required": false,
"in": "query",
"description": "The format to return the page content in. For example, `text/md` for markdown or `text/plain` for plain.",
"schema": {
"default": "text/md",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Page found",
"content": {
"application/json": {
"schema": {
"$ref": "#/paths/~1v3~1workspaces~1%7BworkspaceId%7D~1docs~1%7BdocId%7D~1pages/post/responses/201/content/application~1json/schema"
}
}
}
},
"404": {
"description": "Page not found"
}
},
"tags": [
"Docs"
]
},
"put": {
"operationId": "editPage",
"summary": "Edit page",
"description": "Edit a page in a Doc.",
"parameters": [
{
"name": "workspaceId",
"required": true,
"in": "path",
"description": "The ID of the Workspace.",
"schema": {
"type": "number"
}
},
{
"name": "docId",
"required": true,
"in": "path",
"description": "The ID of the Doc.",
"schema": {
"type": "string"
}
},
{
"name": "pageId",
"required": true,
"in": "path",
"description": "The ID of the page.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The updated name of the page."
},
"sub_title": {
"type": "string",
"description": "The updated subtitle of the page."
},
"content": {
"type": "string",
"description": "The updated content of the page."
},
"content_edit_mode": {
"type": "string",
"description": "The strategy for updating content on the page. For example, `replace`, `append`, or `prepend`.",
"default": "replace"
},
"content_format": {
"type": "string",
"description": "The format the page content is in. For example, `text/md` for markdown and `text/plain` for plain.",
"default": "text/md"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Page updated",
"content": {
"application/json": {
"schema": {
"type": "object",
"examples": [
{
}
],
"contentMediaType": "application/json"
},
"example": {
}
}
}
}
},
"tags": [
"Docs"
]
}
},
"/v3/workspaces/{workspace_id}/auditlogs": {
"post": {
"summary": "Create Workspace-level audit logs",
"description": "Create Workspace-level audit logs. Audit logs can only be created by the Workspace owner on Enterprise Plans.",
"operationId": "CreateWorkspaceAuditLog",
"tags": [
"Audit Logs"
],
"responses": {
"200": {
"content": {
"application/json": {
}
},
"description": ""
}
},
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"applicability"
],
"properties": {
"filter": {
"description": "A filter containing the criteria to filter logs by.",
"allOf": [
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"description": "The ID of the Workspace.",
"required": true
},
"userId": {
"description": "The user ID. This can be a single user or multiple.",
"type": "array",
"items": {
"type": "string"
}
},
"userEmail": {
"description": "User emails. This can be a single email or multiple.",
"type": "array",
"items": {
"type": "string"
}
},
"eventType": {
"description": "Types of events to filter by. Options include `USER_LOGIN`, `USER_LOGOUT`, `CHANGE_2FA`, `CHANGE_PASSWORD`, `CHANGE_EMAIL`, `JOIN_WORKSPACE`, `LEAVE_WORKSPACE`, `REMOVE_FROM_WORKSPACE`, `RESET_PASSWORD`, `ROLE_CHANGE`, `SCIM_PROVISION`, `SCIM_DEPROVISION`, `SCIM_UPDATE`, `ADVANCED_SETTINGS_UPDATED`, `CHANGE_ROLE_PERMISSIONS`, `INVITE_TO_WORKSPACE`, `CHANGE_USER_ROLE`, `CHANGE_SSO_POLICY`, `CHANGE_2FA_POLICY`, `CUSTOM_ROLE_CREATED`, `CUSTOM_ROLE_UPDATED`, `CUSTOM_ROLE_DELETED`, `SCIM_GROUP_CREATED`, `SCIM_GROUP_UPDATED`, `SCIM_GROUP_DELETED`, `GROUP_CREATED`, `GROUP_DELETED`, `GROUP_EDITED`, `GROUP_MEMBER_ADDED`, `GROUP_MEMBER_REMOVED`, `SSO_CONFIG_UPDATED`, `TASK_CREATED`, `TASK_ARCHIVED`, `TASK_DELETED`, `TASK_RESTORED`, `TASK_UNARCHIVED`, `TASK_STATUS_CHANGED`, `TASK_PRIORITY_CHANGED`, `TASK_ASSIGNEES_CHANGED`, and `TASK_CUSTOM_FIELD_VALUES_CHANGED`.",
"type": "array",
"items": {
"type": "string"
}
},
"eventStatus": {
"type": "string",
"description": "Status of events you're filtering by. Options include `success`, `failed`, `started`, `completed`, `error`, `system_error`."
},
"startTime": {
"type": "number",
"description": "The start time to begin paginating your logs."
},
"endTime": {
"type": "number",
"description": "The end time to begin paginating your logs."
}
}
}
]
},
"applicability": {
"type": "string",
"description": "Type of logs to filter by. Options include `auth-and-security` and `user-activity`. Most use cases will use `auth-and-security`."
},
"pagination": {
"description": "The pagination request determines where logs should start and how many to return.",
"allOf": [
{
"type": "object",
"properties": {
"pageRows": {
"type": "number",
"description": "The number of rows to return."
},
"pageTimestamp": {
"type": "number",
"description": "The timestamp to index on. This should be the timestamp of the last row on the previous page. If you are requesting the first page, this should be the current timestamp."
},
"pageDirection": {
"type": "string",
"description": "Pagination direction. This should be set to `before` for most use cases. Options include `before` and `after`."
}
}
}
]
}
}
},
"examples": {
"Required": {
"value": {
"applicability": "auth-and-security"
}
},
"All": {
"value": {
"applicability": "auth-and-security",
"filter": {
"workspaceId": "123456",
"userId": [
"182"
],
"userEmail": [
"user@company.com"
],
"eventType": [
"CHANGE_PASSWORD"
],
"eventStatus": "failed",
"startTime": 1718754539000
},
"endTime": 1727221739000,
"pagination": {
"pageRows": 10,
"pageTimestamp": 1727221739000,
"pageDirection": "before"
}
}
}
}
}
}
}
}
},
"/v3/workspaces/{workspace_id}/{object_type}/{object_id}/acls": {
"patch": {
"summary": "Update privacy and access of an object or location",
"description": "Update the privacy and access settings of an object or location in the Workspace. Note that sharing an item may incur charges.",
"tags": [
"Privacy and access"
],
"operationId": "UpdatePrivacyAndAccess",
"responses": {
"200": {
"content": {
"application/json": {
}
},
"description": ""
}
},
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "object_type",
"description": "Any object that can be shared in a Workspace. For example, `customField`, `dashboard`, `folder`, `goal`, `goalFolder`,`list`, `space`, `task`, and `view`.",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "object_id",
"description": "The ID of the object to share.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"entries": {
"description": "The user or user group (Team) you wish to give, remove, or edit permissions.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "The ID of user or user group (Team) you wish to give, remove, or edit permissions.",
"type": "string"
},
"kind": {
"description": "The type of ID. Options are `user` or `group`.",
"type": "string"
},
"permission_level": {
"description": "The permission level you wish to give to user or user group (Team). `1`=read, `3`=comment, `4`=edit, `5`=create, and `null`=remove access.",
"type": "number"
}
}
}
},
"private": {
"description": "The privacy of an object or location.",
"type": "boolean"
}
}
}
}
},
"required": true
}
}
},
"/v3/workspaces/{workspace_id}/chat/channels": {
"get": {
"operationId": "getChatChannels",
"description": "This endpoint retrieves the Channels in a Workspace.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannels200Response"
}
}
},
"description": ""
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Retrieve Channels",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelsWorkspaceIdPath"
}
},
{
"in": "query",
"description": "Format of the Channel Description (Default: text/md)",
"name": "description_format",
"required": false,
"schema": {
"$ref": "#/components/schemas/ChatTextFormat"
}
},
{
"in": "query",
"description": "Used to request the next or previous page of results",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "The maximum number of results to fetch for this page.",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelsLimitQuery"
}
},
{
"in": "query",
"description": "Only return Channels the user is following",
"name": "is_follower",
"required": false,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelsIsFollowerQuery"
}
},
{
"in": "query",
"description": "Include DMs/Group DMs that have been explicitly closed.",
"name": "include_hidden",
"required": false,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelsIncludeHiddenQuery"
}
},
{
"in": "query",
"description": "Only return Channels with comments since the given timestamp",
"name": "with_comment_since",
"required": false,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelsWithCommentSinceQuery"
}
},
{
"in": "query",
"description": "Type of Channel (Channel, DM, Group DM) to return",
"name": "room_types",
"required": false,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelsRoomTypesQuery"
}
}
]
},
"post": {
"operationId": "createChatChannel",
"description": "This endpoint creates a new Channel not tied to a Space, Folder, or List. If a Channel with the specified name already exists it returns it.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerCreateChatChannel200Response"
}
}
},
"description": ""
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerCreateChatChannel201Response"
}
}
},
"description": ""
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Create a Channel",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerCreateChatChannelWorkspaceIdPath"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatCreateChatChannel"
}
}
},
"required": true
}
}
},
"/v3/workspaces/{workspace_id}/chat/channels/location": {
"post": {
"operationId": "createLocationChatChannel",
"description": "This endpoint creates a Channel and when a Channel already exists on the requested location, it returns it.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerCreateLocationChatChannel200Response"
}
}
},
"description": ""
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerCreateLocationChatChannel201Response"
}
}
},
"description": ""
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Create a Channel on a Space, Folder, or List",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerCreateLocationChatChannelWorkspaceIdPath"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatCreateLocationChatChannel"
}
}
},
"required": true
}
}
},
"/v3/workspaces/{workspace_id}/chat/channels/direct_message": {
"post": {
"operationId": "createDirectMessageChatChannel",
"description": "This endpoint creates a new Direct Message between up to 10 users. If a Direct Message between those users already exists it returns it.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerCreateDirectMessageChatChannel200Response"
}
}
},
"description": ""
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerCreateDirectMessageChatChannel201Response"
}
}
},
"description": ""
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Create a Direct Message",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerCreateDirectMessageChatChannelWorkspaceIdPath"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatCreateDirectMessageChatChannel"
}
}
},
"required": true
}
}
},
"/v3/workspaces/{workspace_id}/chat/channels/{channel_id}": {
"get": {
"operationId": "getChatChannel",
"description": "This endpoint retrieves a specific Channel given its ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannel200Response"
}
}
},
"description": ""
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiErrorResponse"
}
}
},
"description": "Returns when the requested {channelId} was not found."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Retrieves a single Channel by ID.",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelWorkspaceIdPath"
}
},
{
"in": "path",
"name": "channel_id",
"description": "The ID of the specified Channel.",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "Format of the Channel Description (Default: text/md)",
"name": "description_format",
"required": false,
"schema": {
"$ref": "#/components/schemas/ChatTextFormat"
}
}
]
},
"patch": {
"operationId": "updateChatChannel",
"description": "This endpoint updates a single Channel.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerUpdateChatChannel200Response"
}
}
},
"description": ""
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiErrorResponse"
}
}
},
"description": "Invalid update request for {channelId}."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiErrorResponse"
}
}
},
"description": "Returns when the requested {channelId} was not found when updating a Channel"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Update a Channel",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerUpdateChatChannelWorkspaceIdPath"
}
},
{
"in": "path",
"name": "channel_id",
"description": "The ID of the specified Channel.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatUpdateChatChannel"
}
}
},
"required": true
}
},
"delete": {
"operationId": "deleteChatChannel",
"description": "This endpoint deletes a Channel. Applies to Channels tied to a Space, Folder, or List or not tied to locations.",
"responses": {
"204": {
"content": {
"application/json": {
}
},
"description": "The Channel was deleted."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiErrorResponse"
}
}
},
"description": "Returns when the requested {channelId} was not found when deleting a Channel"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Delete a Channel",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerDeleteChatChannelWorkspaceIdPath"
}
},
{
"in": "path",
"name": "channel_id",
"description": "The ID of the specified Channel.",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/followers": {
"get": {
"operationId": "getChatChannelFollowers",
"description": "This endpoint retrieves followers of a specific Channel given its ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelFollowers200Response"
}
}
},
"description": ""
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiErrorResponse"
}
}
},
"description": "Returns when the specified {channelId} was not found."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Retrieve followers of a Channel (based on Channel ID)",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelFollowersWorkspaceIdPath"
}
},
{
"in": "path",
"name": "channel_id",
"description": "The ID of the specified Channel.",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "The cursor to use to fetch the next page of results.",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "The maximum number of results to fetch for this page.",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelFollowersLimitQuery"
}
}
]
}
},
"/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/members": {
"get": {
"operationId": "getChatChannelMembers",
"description": "This endpoint retrieves members of a specific Channel given its ID.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelMembers200Response"
}
}
},
"description": ""
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Retrieve members of a Channel (based on Channel ID)",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelMembersWorkspaceIdPath"
}
},
{
"in": "path",
"name": "channel_id",
"description": "The ID of the specified Channel.",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "The cursor to use to fetch the next page of results.",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "The maximum number of results to fetch for this page.",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelMembersLimitQuery"
}
}
]
}
},
"/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/messages": {
"get": {
"operationId": "getChatMessages",
"description": "This endpoint retrieves messages for a specified Channel.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessages200Response"
}
}
},
"description": ""
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Returns when the specified {channelId} was not found."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Retrieve Channel messages",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessagesWorkspaceIdPath"
}
},
{
"in": "path",
"name": "channel_id",
"description": "The ID of the Channel where the messages live.",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "The cursor to use to fetch the next page of results.",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "The maximum number of results to fetch for this page.",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessagesLimitQuery"
}
},
{
"in": "query",
"description": "Format of the message content (Default: text/md)",
"name": "content_format",
"required": false,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessagesContentFormatQuery"
}
}
]
},
"post": {
"operationId": "createChatMessage",
"description": "This endpoint creates a top level message.",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentCreateChatMessageResponse"
}
}
},
"description": "The message is created."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Returns when {channelId} was not found."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Send a message",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerCreateChatMessageWorkspaceIdPath"
}
},
{
"in": "path",
"name": "channel_id",
"description": "The ID of the Channel or direct message.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentCreateChatMessage"
}
}
},
"required": true
}
}
},
"/v3/workspaces/{workspace_id}/chat/messages/{message_id}": {
"patch": {
"operationId": "patchChatMessage",
"description": "This endpoint updates a message.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPatchChatMessageResponse"
}
}
},
"description": "The message that was updated."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Returns when the request is invalid."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Returns when {messageId} was not found."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Update a message",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerPatchChatMessageWorkspaceIdPath"
}
},
{
"in": "path",
"name": "message_id",
"description": "The ID of the specified message",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPatchChatMessage"
}
}
},
"required": true
}
},
"delete": {
"operationId": "deleteChatMessage",
"description": "This endpoint deletes a message.",
"responses": {
"204": {
"content": {
"application/json": {
}
},
"description": "The message was deleted"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Deletes a message.",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerDeleteChatMessageWorkspaceIdPath"
}
},
{
"in": "path",
"name": "message_id",
"description": "The ID of the specified message",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions": {
"get": {
"operationId": "getChatMessageReactions",
"description": "This endpoint retrieves reactions for a message",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageReactions200Response"
}
}
},
"description": ""
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Returns when the specified {messageId} was not found"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Retrieve reactions for a message",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageReactionsWorkspaceIdPath"
}
},
{
"in": "path",
"name": "message_id",
"description": "The ID of the specified message",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "The cursor to use to fetch the next page of results.",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "The maximum number of results to fetch for this page.",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageReactionsLimitQuery"
}
}
]
},
"post": {
"operationId": "createChatReaction",
"description": "This endpoint creates a message reaction using lower case emoji names.",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatReaction"
}
}
},
"description": "The message reaction is created."
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Returns when the reaction {reaction} is not supported or already exists."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Returns when the message {messageId} is not found."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Create a message reaction",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerCreateChatReactionWorkspaceIdPath"
}
},
{
"in": "path",
"name": "message_id",
"description": "The ID of the specified message",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentCreateChatReaction"
}
}
},
"required": true
}
}
},
"/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions/{reaction}": {
"delete": {
"operationId": "deleteChatReaction",
"description": "This endpoint deletes a message reaction.",
"responses": {
"204": {
"content": {
"application/json": {
}
},
"description": "The message reaction was deleted"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Returns when the reaction {reaction} is not supported."
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Returns when the message {messageId} or the reaction {reaction} is not found."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Delete a message reaction",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerDeleteChatReactionWorkspaceIdPath"
}
},
{
"in": "path",
"name": "message_id",
"description": "The ID of the specified message",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "reaction",
"description": "The name of the reaction to be deleted.",
"required": true,
"schema": {
"type": "string"
}
}
]
}
},
"/v3/workspaces/{workspace_id}/chat/messages/{message_id}/replies": {
"get": {
"operationId": "getChatMessageReplies",
"description": "This endpoint retrieves replies to a message.",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageReplies200Response"
}
}
},
"description": ""
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Returns when the specified {messageId} was not found."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Retrieve replies to a message",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageRepliesWorkspaceIdPath"
}
},
{
"in": "path",
"name": "message_id",
"description": "The ID of the specified message",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "The cursor to use to fetch the next page of results.",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "The maximum number of results to fetch for this page.",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageRepliesLimitQuery"
}
},
{
"in": "query",
"description": "Format of the message content (Default: text/md)",
"name": "content_format",
"required": false,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageRepliesContentFormatQuery"
}
}
]
},
"post": {
"operationId": "createReplyMessage",
"description": "This endpoint creates a reply message.",
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentCreateReplyMessageResponse"
}
}
},
"description": "The reply message is created."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Create a reply message",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerCreateReplyMessageWorkspaceIdPath"
}
},
{
"in": "path",
"name": "message_id",
"description": "The ID of the specified message",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentCreateChatMessage"
}
}
},
"required": true
}
}
},
"/v3/workspaces/{workspace_id}/chat/messages/{message_id}/tagged_users": {
"get": {
"operationId": "getChatMessageTaggedUsers",
"description": "This endpoint retrieves tagged users for a message",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageTaggedUsers200Response"
}
}
},
"description": ""
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Returns when the specified {messageId} was not found"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentPublicApiErrorResponse"
}
}
},
"description": "Generic Error response"
}
},
"summary": "Retrieve tagged users for a message",
"tags": [
"Chat (Experimental)"
],
"parameters": [
{
"in": "path",
"name": "workspace_id",
"description": "The ID of the Workspace.",
"required": true,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageTaggedUsersWorkspaceIdPath"
}
},
{
"in": "path",
"name": "message_id",
"description": "The ID of the specified message",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "The cursor to use to fetch the next page of results.",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
},
{
"in": "query",
"description": "The maximum number of results to fetch for this page.",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageTaggedUsersLimitQuery"
}
}
]
}
}
},
"components": {
"schemas": {
"ChatPublicApiChatChannelsControllerGetChatChannelsWorkspaceIdPath": {
"type": "integer"
},
"ChatTextFormat": {
"type": "string",
"enum": [
"text/md",
"text/plain"
]
},
"ChatPublicApiChatChannelsControllerGetChatChannelsLimitQuery": {
"minimum": 1,
"maximum": 100,
"default": 50,
"type": "integer"
},
"ChatPublicApiChatChannelsControllerGetChatChannelsIsFollowerQuery": {
"default": false,
"type": "boolean"
},
"ChatPublicApiChatChannelsControllerGetChatChannelsIncludeHiddenQuery": {
"default": false,
"type": "boolean"
},
"ChatPublicApiChatChannelsControllerGetChatChannelsWithCommentSinceQuery": {
"type": "number"
},
"ChatPublicApiChatChannelsControllerGetChatChannelsRoomTypesQuery": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CHANNEL",
"DM",
"GROUP_DM"
]
}
},
"ChatPublicApiChatChannelsControllerGetChatChannels200Response": {
"allOf": [
{
"$ref": "#/components/schemas/ChatPaginatedResponse"
},
{
"type": "object",
"description": "The list of Channels.",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatChannel"
}
}
}
}
]
},
"ChatPaginatedResponse": {
"type": "object",
"properties": {
"next_cursor": {
"type": "string",
"description": "The next cursor to use for pagination."
}
},
"required": [
"next_cursor"
]
},
"ChatChannel": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string",
"description": "The full Description of the Channel.",
"format": "RichText"
},
"topic": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ChatRoomType"
},
"visibility": {
"$ref": "#/components/schemas/ChatRoomVisibility"
},
"parent": {
"description": "Parent information",
"allOf": [
{
"$ref": "#/components/schemas/ChatRoomParentDTO"
}
]
},
"creator": {
"type": "string",
"description": "ID of the user who created this Channel"
},
"created_at": {
"type": "string",
"description": "Timestamp of when this Channel was created"
},
"updated_at": {
"type": "string",
"description": "Timestamp of the last update in this Channel - Deprecated in favor of latest_comment_at",
"deprecated": true
},
"workspace_id": {
"type": "string",
"description": "Workspace ID of the Channel"
},
"archived": {
"type": "boolean"
},
"latest_comment_at": {
"type": "string",
"description": "Timestamp of the last comment in this Channel. Optional in the case of a new Channel with no comments yet"
},
"is_canonical_channel": {
"type": "boolean",
"description": "Is this the canonical channel for the parent location?"
},
"is_hidden": {
"type": "boolean",
"description": "Has the user hidden this Channel from their sidebar? Currently only an option for DM/Group DM."
},
"default_view": {
"description": "Data about the default view that the Channel should open in",
"allOf": [
{
"$ref": "#/components/schemas/ChatDefaultViewDTO"
}
]
},
"channel_type": {
"$ref": "#/components/schemas/ChatSubcategoryType"
},
"counts": {
"description": "Counts relevant to the user requesting the Channel",
"allOf": [
{
"$ref": "#/components/schemas/ChatLastReadAtData"
}
]
},
"chat_room_category": {
"type": "string",
"description": "The category of the Channel, e.g. a welcome channel, (in the future, maybe) a ClickBot channel, etc.",
"enum": [
"WELCOME_CHANNEL"
]
},
"links": {
"description": "The links to elements of the Channel.",
"allOf": [
{
"$ref": "#/components/schemas/ChatChannelLinks"
}
]
}
},
"required": [
"id",
"name",
"type",
"visibility",
"parent",
"creator",
"created_at",
"updated_at",
"workspace_id",
"archived",
"links"
]
},
"ChatRoomType": {
"type": "string",
"description": "The type of the Channel",
"enum": [
"CHANNEL",
"DM",
"GROUP_DM"
]
},
"ChatRoomVisibility": {
"type": "string",
"description": "The visibility of the Channel",
"enum": [
"PUBLIC",
"PRIVATE"
]
},
"ChatRoomParentDTO": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "number"
}
},
"required": [
"id",
"type"
]
},
"ChatDefaultViewDTO": {
"type": "object",
"properties": {
"type": {
"type": "number"
},
"view_id": {
"type": "string"
},
"standard": {
"type": "boolean"
}
},
"required": [
"type",
"view_id",
"standard"
]
},
"ChatSubcategoryType": {
"type": "number",
"description": "Type of channel (chat, project, etc.) aka subcategory_type",
"enum": [1, 2, 3]
},
"ChatLastReadAtData": {
"type": "object",
"properties": {
"parent_id": {
"type": "string"
},
"parent_type": {
"type": "string",
"enum": [
"attachment",
"attachmentAccess",
"approval",
"banWorkspace",
"checklist",
"checklistItem",
"checklistTemplateAccess",
"comment",
"commentsLastReadAt",
"customField",
"customFieldAccess",
"customItem",
"dashboard",
"dashboardAccess",
"doc",
"docAccess",
"folder",
"folderDescendantsSet",
"folderTemplateAccess",
"form",
"formulaValue",
"foundationalJob",
"goal",
"goalAccess",
"goalFolder",
"goalFolderAccess",
"hierarchy",
"list",
"listDescendantsSet",
"listDescendantsPoints",
"listDescendantsTimeEstimates",
"listTemplateAccess",
"notepad",
"page",
"pageAccess",
"post",
"reminder",
"reminderAccess",
"rolledUpFieldValue",
"space",
"spaceDescendantsSet",
"spaceTemplateAccess",
"task",
"taskAccess",
"taskHistory",
"taskTemplateAccess",
"template",
"user",
"userAccess",
"userGroup",
"userHierarchy",
"view",
"viewAccess",
"viewTemplateAccess",
"whiteboard",
"whiteboardAccess",
"widget",
"workspace",
"workspaceDescendantsSet"
]
},
"root_parent_id": {
"type": "string"
},
"root_parent_type": {
"type": "string",
"enum": [
"attachment",
"attachmentAccess",
"approval",
"banWorkspace",
"checklist",
"checklistItem",
"checklistTemplateAccess",
"comment",
"commentsLastReadAt",
"customField",
"customFieldAccess",
"customItem",
"dashboard",
"dashboardAccess",
"doc",
"docAccess",
"folder",
"folderDescendantsSet",
"folderTemplateAccess",
"form",
"formulaValue",
"foundationalJob",
"goal",
"goalAccess",
"goalFolder",
"goalFolderAccess",
"hierarchy",
"list",
"listDescendantsSet",
"listDescendantsPoints",
"listDescendantsTimeEstimates",
"listTemplateAccess",
"notepad",
"page",
"pageAccess",
"post",
"reminder",
"reminderAccess",
"rolledUpFieldValue",
"space",
"spaceDescendantsSet",
"spaceTemplateAccess",
"task",
"taskAccess",
"taskHistory",
"taskTemplateAccess",
"template",
"user",
"userAccess",
"userGroup",
"userHierarchy",
"view",
"viewAccess",
"viewTemplateAccess",
"whiteboard",
"whiteboardAccess",
"widget",
"workspace",
"workspaceDescendantsSet"
]
},
"date": {
"type": "number",
"description": "When the user last read comments to this object, set in the past to mark comments as unread. Should be a timestamp in milliseconds."
},
"_version_vector": {
"deprecated": true,
"allOf": [
{
"$ref": "#/components/schemas/ChatCommentVersionVector"
}
]
},
"version": {
"type": "number",
"description": "The version of the object when the last read at object was last updated."
},
"has_unread": {
"type": "boolean",
"description": "Whether the user has unread comments on this object. (Optional)"
},
"num_unread": {
"type": "number",
"description": "How many unread comments there are on this object. (Optional)"
},
"latest_comment_at": {
"type": "number",
"description": "The date of the latest comment on this object. (Optional)"
},
"badge_count": {
"type": "number",
"description": "The badge count for this object. (Optional)"
},
"thread_count": {
"type": "number",
"description": "The number of unread threads on this object. (Optional)"
},
"mention_count": {
"type": "number",
"description": "The number of mentions on this object. (Optional)"
}
},
"required": [
"parent_id",
"parent_type",
"root_parent_id",
"root_parent_type",
"date",
"_version_vector"
]
},
"ChatCommentVersionVector": {
"type": "object",
"properties": {
"object_id": {
"type": "string"
},
"object_type": {
"type": "string"
},
"vector": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatCommentVector"
}
},
"workspace_id": {
"type": "number"
}
},
"required": [
"object_id",
"object_type",
"vector",
"workspace_id"
]
},
"ChatCommentVector": {
"type": "object",
"properties": {
"master_id": {
"type": "number"
},
"version": {
"type": "number"
},
"deleted": {
"type": "boolean"
}
},
"required": [
"master_id",
"version",
"deleted"
]
},
"ChatChannelLinks": {
"type": "object",
"properties": {
"members": {
"type": "string",
"description": "The link to the members of the Channel."
},
"followers": {
"type": "string",
"description": "The link to the followers of the Channel."
}
},
"required": [
"members",
"followers"
]
},
"ChatPublicApiErrorResponse": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "The HTTP Status code for the error"
},
"message": {
"type": "string",
"description": "The message describing the error",
"example": "Generic error message"
},
"trace_id": {
"type": "integer",
"description": "Unique trace ID for tracking the request. Used for troubleshooting errors",
"example": 123456789,
"nullable": true
},
"timestamp": {
"type": "integer",
"description": "The time of the error (Unix epoch milliseconds timestamp).",
"example": 1671534256138
}
},
"required": [
"status",
"message",
"trace_id",
"timestamp"
]
},
"ChatPublicApiChatChannelsControllerCreateChatChannelWorkspaceIdPath": {
"type": "integer"
},
"ChatCreateChatChannel": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The description for the Channel being created."
},
"name": {
"type": "string",
"description": "The name for the Channel being created."
},
"topic": {
"type": "string",
"description": "The topic of the Channel being created."
},
"user_ids": {
"type": "array",
"description": "Optionally specify unique user IDs, up to 100.",
"items": {
"type": "string"
},
"maxItems": 100,
"uniqueItems": true
},
"visibility": {
"type": "string",
"description": "The visibility of the Channel being created. If not specified, the Channel is PUBLIC.",
"enum": [
"PUBLIC",
"PRIVATE"
]
}
},
"required": [
"name"
]
},
"ChatPublicApiChatChannelsControllerCreateChatChannel200Response": {
"type": "object",
"description": "The existing Channel that is matching the creation request.",
"properties": {
"data": {
"$ref": "#/components/schemas/ChatChannel"
}
},
"required": [
"data"
]
},
"ChatPublicApiChatChannelsControllerCreateChatChannel201Response": {
"type": "object",
"description": "The new Channel.",
"properties": {
"data": {
"$ref": "#/components/schemas/ChatChannel"
}
},
"required": [
"data"
]
},
"ChatPublicApiChatChannelsControllerGetChatChannelWorkspaceIdPath": {
"type": "integer"
},
"ChatPublicApiChatChannelsControllerGetChatChannel200Response": {
"type": "object",
"description": "The requested Channel.",
"properties": {
"data": {
"$ref": "#/components/schemas/ChatChannel"
}
},
"required": [
"data"
]
},
"ChatPublicApiChatChannelsControllerUpdateChatChannelWorkspaceIdPath": {
"type": "integer"
},
"ChatUpdateChatChannel": {
"type": "object",
"properties": {
"content_format": {
"type": "string",
"description": "The format of content field values (Default: text/md)",
"default": "text/md",
"enum": [
"text/md",
"text/plain"
]
},
"description": {
"type": "string",
"description": "The updated description of the Channel."
},
"location": {
"description": "The updated location of the Channel: Space, Folder, or List",
"allOf": [
{
"$ref": "#/components/schemas/ChatChannelLocation"
}
]
},
"name": {
"type": "string",
"description": "The updated name of the Channel."
},
"topic": {
"type": "string",
"description": "The updated topic of the Channel."
},
"visibility": {
"type": "string",
"description": "The updated visibility of the Channel.",
"enum": [
"PUBLIC",
"PRIVATE"
]
}
}
},
"ChatChannelLocation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the hierarchy entity where the Channel is to be located"
},
"type": {
"type": "string",
"description": "The type of the location. Must be a Space, Folder, or List.",
"enum": [
"folder",
"list",
"space"
]
}
},
"required": [
"id",
"type"
]
},
"ChatPublicApiChatChannelsControllerUpdateChatChannel200Response": {
"type": "object",
"description": "The Channel was successfully updated.",
"properties": {
"data": {
"$ref": "#/components/schemas/ChatChannel"
}
},
"required": [
"data"
]
},
"ChatPublicApiChatChannelsControllerDeleteChatChannelWorkspaceIdPath": {
"type": "integer"
},
"ChatPublicApiChatChannelsControllerGetChatChannelFollowersWorkspaceIdPath": {
"type": "integer"
},
"ChatPublicApiChatChannelsControllerGetChatChannelFollowersLimitQuery": {
"minimum": 1,
"maximum": 100,
"default": 50,
"type": "integer"
},
"ChatPublicApiChatChannelsControllerGetChatChannelFollowers200Response": {
"allOf": [
{
"$ref": "#/components/schemas/ChatPaginatedResponse"
},
{
"type": "object",
"description": "The list of Channel followers.",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatSimpleUser"
}
}
}
}
]
},
"ChatSimpleUser": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email of the user."
},
"id": {
"type": "string",
"description": "ID of the user."
},
"initials": {
"type": "string",
"description": "Initials of the user."
},
"name": {
"type": "string",
"description": "Name of the user."
},
"username": {
"type": "string",
"description": "Userame of the user."
}
},
"required": [
"email",
"id"
]
},
"ChatPublicApiChatChannelsControllerGetChatChannelMembersWorkspaceIdPath": {
"type": "integer"
},
"ChatPublicApiChatChannelsControllerGetChatChannelMembersLimitQuery": {
"minimum": 1,
"maximum": 100,
"default": 50,
"type": "integer"
},
"ChatPublicApiChatChannelsControllerGetChatChannelMembers200Response": {
"allOf": [
{
"$ref": "#/components/schemas/ChatPaginatedResponse"
},
{
"type": "object",
"description": "The list of Channel members.",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatSimpleUser"
}
}
}
}
]
},
"ChatPublicApiChatChannelsControllerCreateDirectMessageChatChannelWorkspaceIdPath": {
"type": "integer"
},
"ChatCreateDirectMessageChatChannel": {
"type": "object",
"properties": {
"user_ids": {
"type": "array",
"description": "The unique user IDs of participants in the Direct Message, up to 10. A Self DM is created when no user IDs are provided",
"items": {
"type": "string"
},
"maxItems": 10,
"uniqueItems": true
}
}
},
"ChatPublicApiChatChannelsControllerCreateDirectMessageChatChannel200Response": {
"type": "object",
"description": "The existing Direct Message that is matching the creation request.",
"properties": {
"data": {
"$ref": "#/components/schemas/ChatChannel"
}
},
"required": [
"data"
]
},
"ChatPublicApiChatChannelsControllerCreateDirectMessageChatChannel201Response": {
"type": "object",
"description": "The new Direct Message.",
"properties": {
"data": {
"$ref": "#/components/schemas/ChatChannel"
}
},
"required": [
"data"
]
},
"ChatPublicApiChatChannelsControllerCreateLocationChatChannelWorkspaceIdPath": {
"type": "integer"
},
"ChatCreateLocationChatChannel": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The description for the Channel being created."
},
"topic": {
"type": "string",
"description": "The topic of the Channel being created."
},
"user_ids": {
"type": "array",
"description": "Optionally specify unique user IDs, up to 100.",
"items": {
"type": "string"
},
"maxItems": 100,
"uniqueItems": true
},
"visibility": {
"type": "string",
"description": "The visibility of the Channel being created. If not specified, the Channel is PUBLIC.",
"enum": [
"PUBLIC",
"PRIVATE"
]
},
"location": {
"description": "The location of the Channel: Space, Folder, or List",
"allOf": [
{
"$ref": "#/components/schemas/ChatChannelLocation"
}
]
}
},
"required": [
"location"
]
},
"ChatPublicApiChatChannelsControllerCreateLocationChatChannel200Response": {
"type": "object",
"description": "The existing location Channel that is matching the creation request.",
"properties": {
"data": {
"$ref": "#/components/schemas/ChatChannel"
}
},
"required": [
"data"
]
},
"ChatPublicApiChatChannelsControllerCreateLocationChatChannel201Response": {
"type": "object",
"description": "The new location Channel.",
"properties": {
"data": {
"$ref": "#/components/schemas/ChatChannel"
}
},
"required": [
"data"
]
},
"CommentPublicApiChatMessagesControllerGetChatMessagesWorkspaceIdPath": {
"type": "integer"
},
"CommentPublicApiChatMessagesControllerGetChatMessagesLimitQuery": {
"minimum": 1,
"maximum": 100,
"default": 50,
"type": "integer"
},
"CommentPublicApiChatMessagesControllerGetChatMessagesContentFormatQuery": {
"default": "text/md",
"enum": [
"text/md",
"text/plain"
],
"type": "string"
},
"CommentPublicApiChatMessagesControllerGetChatMessages200Response": {
"allOf": [
{
"$ref": "#/components/schemas/CommentPaginatedResponse"
},
{
"type": "object",
"description": "The list of top level messages in the Channel, most recent first.",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatMessage"
}
}
}
}
]
},
"CommentPaginatedResponse": {
"type": "object",
"properties": {
"next_cursor": {
"type": "string",
"description": "The next cursor to use for pagination."
}
},
"required": [
"next_cursor"
]
},
"ChatMessage": {
"type": "object",
"properties": {
"assignee": {
"type": "string",
"description": "The possible assignee of the message."
},
"assigned_by": {
"type": "string",
"description": "The user who assigned the message."
},
"content": {
"type": "string",
"description": "The full content of the message.",
"format": "RichText"
},
"date": {
"type": "number",
"description": "The date & time the message was created (Unix epoch milliseconds timestamp)."
},
"date_assigned": {
"type": "number",
"description": "The date & time the message was assigned (Unix epoch milliseconds timestamp)."
},
"date_resolved": {
"type": "number",
"description": "The date & time the message was resolved (Unix epoch milliseconds timestamp)."
},
"date_updated": {
"type": "number",
"description": "The date & time the message was updated (Unix epoch milliseconds timestamp)."
},
"group_assignee": {
"type": "string",
"description": "The possible group assignee of the message."
},
"id": {
"type": "string",
"description": "The ID of the message."
},
"parent_channel": {
"type": "string",
"description": "The ID of the Channel this message belongs to."
},
"parent_message": {
"type": "string",
"description": "The ID of the message this message is a reply to."
},
"post_data": {
"description": "The data of the post message.",
"allOf": [
{
"$ref": "#/components/schemas/ChatPostData"
}
]
},
"resolved": {
"type": "boolean",
"description": "The resolved status of the message."
},
"resolved_by": {
"type": "string",
"description": "The user who resolved the message."
},
"triaged_action": {
"type": "number",
"description": "The triaged action applied to the message.",
"enum": [1, 2]
},
"triaged_object_id": {
"type": "string",
"description": "The message triaged action object id."
},
"triaged_object_type": {
"type": "number",
"description": "The message triaged action object type."
},
"type": {
"type": "string",
"description": "The type of message.",
"enum": [
"message",
"post"
]
},
"user_id": {
"type": "string",
"description": "The ID of the user who created the message."
},
"links": {
"description": "The links to elements of the message.",
"allOf": [
{
"$ref": "#/components/schemas/CommentChatMessageLinks2"
}
]
},
"replies_count": {
"type": "number",
"description": "The number of replies to the message."
}
},
"required": [
"content",
"date",
"id",
"parent_channel",
"resolved",
"type",
"user_id",
"links",
"replies_count"
]
},
"ChatPostData": {
"type": "object",
"properties": {
"subtype": {
"description": "The subtype of the Chat Post.",
"allOf": [
{
"$ref": "#/components/schemas/ChatPostSubtype"
}
]
},
"title": {
"type": "string",
"description": "The title of the Chat Post.",
"maxLength": 255
}
},
"required": [
"subtype",
"title"
]
},
"ChatPostSubtype": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The subtype ID of the Chat Post."
},
"name": {
"type": "string",
"description": "The subtype name of the Chat Post."
}
},
"required": [
"id",
"name"
]
},
"CommentChatMessageLinks2": {
"type": "object",
"properties": {
"reactions": {
"type": "string",
"description": "The link to the reactions of this message."
},
"replies": {
"type": "string",
"description": "The link to the replies of this message."
},
"tagged_users": {
"type": "string",
"description": "The link to the tagged users of this message."
}
},
"required": [
"reactions",
"replies",
"tagged_users"
]
},
"CommentPublicApiErrorResponse": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "The HTTP Status code for the error"
},
"message": {
"type": "string",
"description": "The message describing the error",
"example": "Generic error message"
},
"trace_id": {
"type": "integer",
"description": "Unique trace ID for tracking the request. Used for troubleshooting errors",
"example": 123456789,
"nullable": true
},
"timestamp": {
"type": "integer",
"description": "The time of the error (Unix epoch milliseconds timestamp).",
"example": 1671534256138
}
},
"required": [
"status",
"message",
"trace_id",
"timestamp"
]
},
"CommentPublicApiChatMessagesControllerCreateChatMessageWorkspaceIdPath": {
"type": "integer"
},
"CommentCreateChatMessage": {
"type": "object",
"properties": {
"assignee": {
"type": "string",
"description": "The possible assignee of the message."
},
"group_assignee": {
"type": "string",
"description": "The possible group assignee of the message."
},
"triaged_action": {
"type": "number",
"description": "The triaged action applied to the message.",
"enum": [1, 2]
},
"triaged_object_id": {
"type": "string",
"description": "The message triaged action object id."
},
"triaged_object_type": {
"type": "number",
"description": "The message triaged action object type."
},
"type": {
"type": "string",
"description": "The type of message.",
"enum": [
"message",
"post"
]
},
"content": {
"type": "string",
"description": "The full content of the message to be created",
"format": "RichText",
"maxLength": 40000
},
"reactions": {
"type": "array",
"description": "The reactions to the message that exist at creation time",
"items": {
"$ref": "#/components/schemas/ChatReaction"
},
"maxItems": 10
},
"followers": {
"type": "array",
"description": "The ids of the followers of the message",
"items": {
"type": "string"
},
"maxItems": 10
},
"content_format": {
"type": "string",
"description": "The format of the message content (Default: text/md)",
"default": "text/md",
"enum": [
"text/md",
"text/plain"
]
},
"post_data": {
"description": "The data of the post message.",
"allOf": [
{
"$ref": "#/components/schemas/CommentChatPostDataCreate"
}
]
}
},
"required": [
"type",
"content"
]
},
"ChatReaction": {
"type": "object",
"properties": {
"date": {
"type": "number",
"description": "The date & time the reaction was created (Unix epoch milliseconds timestamp)."
},
"reaction": {
"type": "string",
"description": "The reaction to the message."
},
"user_id": {
"type": "string",
"description": "The ID of the user who created the reaction."
}
},
"required": [
"date",
"reaction",
"user_id"
]
},
"CommentChatPostDataCreate": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the Chat Post.",
"maxLength": 255
},
"subtype": {
"description": "The subtype of the Chat Post.",
"allOf": [
{
"$ref": "#/components/schemas/CommentChatPostSubtypeCreate"
}
]
}
},
"required": [
"title",
"subtype"
]
},
"CommentChatPostSubtypeCreate": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The subtype ID of the Chat Post."
}
},
"required": [
"id"
]
},
"CommentCreateChatMessageResponse": {
"type": "object",
"properties": {
"post_data": {
"description": "The data of the post message.",
"allOf": [
{
"$ref": "#/components/schemas/CommentChatPostDataCreate"
}
]
},
"assignee": {
"type": "string",
"description": "The possible assignee of the message."
},
"assigned_by": {
"type": "string",
"description": "The user who assigned the message."
},
"content": {
"type": "string",
"description": "The full content of the message.",
"format": "RichText"
},
"date": {
"type": "number",
"description": "The date & time the message was created (Unix epoch milliseconds timestamp)."
},
"date_assigned": {
"type": "number",
"description": "The date & time the message was assigned (Unix epoch milliseconds timestamp)."
},
"date_resolved": {
"type": "number",
"description": "The date & time the message was resolved (Unix epoch milliseconds timestamp)."
},
"date_updated": {
"type": "number",
"description": "The date & time the message was updated (Unix epoch milliseconds timestamp)."
},
"group_assignee": {
"type": "string",
"description": "The possible group assignee of the message."
},
"id": {
"type": "string",
"description": "The ID of the message."
},
"parent_channel": {
"type": "string",
"description": "The ID of the chat this message belongs to."
},
"parent_message": {
"type": "string",
"description": "The ID of the message this message is a reply to."
},
"resolved": {
"type": "boolean",
"description": "The resolved status of the message."
},
"resolved_by": {
"type": "string",
"description": "The user who resolved the message."
},
"triaged_action": {
"type": "number",
"description": "The triaged action applied to the message.",
"enum": [1, 2]
},
"triaged_object_id": {
"type": "string",
"description": "The message triaged action object id."
},
"triaged_object_type": {
"type": "number",
"description": "The message triaged action object type."
},
"type": {
"type": "string",
"description": "The type of message.",
"enum": [
"message",
"post"
]
},
"user_id": {
"type": "string",
"description": "The ID of the user who created the message."
},
"links": {
"description": "The links to elements of the message.",
"allOf": [
{
"$ref": "#/components/schemas/CommentChatMessageLinks2"
}
]
},
"replies_count": {
"type": "number",
"description": "The number of replies to the message."
}
},
"required": [
"content",
"date",
"id",
"parent_channel",
"resolved",
"type",
"user_id",
"links",
"replies_count"
]
},
"CommentPublicApiChatMessagesControllerPatchChatMessageWorkspaceIdPath": {
"type": "integer"
},
"CommentPatchChatMessage": {
"type": "object",
"properties": {
"assignee": {
"type": "string",
"description": "The possible assignee of the message."
},
"group_assignee": {
"type": "string",
"description": "The possible group assignee of the message."
},
"content": {
"type": "string",
"description": "The full content of the message to be created",
"format": "RichText",
"maxLength": 40000
},
"content_format": {
"type": "string",
"description": "The format of the message content (Default: text/md)",
"default": "text/md",
"enum": [
"text/md",
"text/plain"
]
},
"post_data": {
"description": "The data of the post message.",
"allOf": [
{
"$ref": "#/components/schemas/CommentChatPostDataPatch"
}
]
},
"resolved": {
"type": "boolean",
"description": "The resolved status of the message."
}
}
},
"CommentChatPostDataPatch": {
"type": "object",
"properties": {
"subtype": {
"description": "The subtype of the Chat Post.",
"allOf": [
{
"$ref": "#/components/schemas/CommentChatPostSubtypePatch"
}
]
},
"title": {
"type": "string",
"description": "The title of the Chat Post.",
"maxLength": 255
}
}
},
"CommentChatPostSubtypePatch": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The subtype ID of the Chat Post."
}
},
"required": [
"id"
]
},
"CommentPatchChatMessageResponse": {
"type": "object",
"properties": {
"post_data": {
"description": "The data of the post message.",
"allOf": [
{
"$ref": "#/components/schemas/CommentChatPostDataCreate"
}
]
},
"assignee": {
"type": "string",
"description": "The possible assignee of the message."
},
"assigned_by": {
"type": "string",
"description": "The user who assigned the message."
},
"content": {
"type": "string",
"description": "The full content of the message.",
"format": "RichText"
},
"date": {
"type": "number",
"description": "The date & time the message was created (Unix epoch milliseconds timestamp)."
},
"date_assigned": {
"type": "number",
"description": "The date & time the message was assigned (Unix epoch milliseconds timestamp)."
},
"date_resolved": {
"type": "number",
"description": "The date & time the message was resolved (Unix epoch milliseconds timestamp)."
},
"date_updated": {
"type": "number",
"description": "The date & time the message was updated (Unix epoch milliseconds timestamp)."
},
"group_assignee": {
"type": "string",
"description": "The possible group assignee of the message."
},
"id": {
"type": "string",
"description": "The ID of the message."
},
"parent_channel": {
"type": "string",
"description": "The ID of the chat this message belongs to."
},
"parent_message": {
"type": "string",
"description": "The ID of the message this message is a reply to."
},
"resolved": {
"type": "boolean",
"description": "The resolved status of the message."
},
"resolved_by": {
"type": "string",
"description": "The user who resolved the message."
},
"triaged_action": {
"type": "number",
"description": "The triaged action applied to the message.",
"enum": [1, 2]
},
"triaged_object_id": {
"type": "string",
"description": "The message triaged action object id."
},
"triaged_object_type": {
"type": "number",
"description": "The message triaged action object type."
},
"type": {
"type": "string",
"description": "The type of message.",
"enum": [
"message",
"post"
]
},
"user_id": {
"type": "string",
"description": "The ID of the user who created the message."
},
"replies_count": {
"type": "number",
"description": "The number of replies to the message."
},
"links": {
"description": "The links to elements of the message.",
"oneOf": [
{
"type": "object",
"required": [
"replies",
"tagged_users",
"reactions"
],
"properties": {
"reactions": {
"type": "string",
"description": "The link to the reactions of this message."
},
"replies": {
"type": "string",
"description": "The link to the replies of this message."
},
"tagged_users": {
"type": "string",
"description": "The link to the tagged users of this message."
}
}
},
{
"type": "object",
"required": [
"tagged_users",
"reactions"
],
"properties": {
"reactions": {
"type": "string",
"description": "The link to the reactions of this message."
},
"tagged_users": {
"type": "string",
"description": "The link to the tagged users of this message."
}
}
}
]
}
},
"required": [
"content",
"date",
"id",
"parent_channel",
"resolved",
"type",
"user_id",
"replies_count",
"links"
]
},
"CommentPublicApiChatMessagesControllerDeleteChatMessageWorkspaceIdPath": {
"type": "integer"
},
"CommentPublicApiChatMessagesControllerGetChatMessageReactionsWorkspaceIdPath": {
"type": "integer"
},
"CommentPublicApiChatMessagesControllerGetChatMessageReactionsLimitQuery": {
"minimum": 1,
"maximum": 100,
"default": 50,
"type": "integer"
},
"CommentPublicApiChatMessagesControllerGetChatMessageReactions200Response": {
"allOf": [
{
"$ref": "#/components/schemas/CommentPaginatedResponse"
},
{
"type": "object",
"description": "The list of message reactions.",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChatReaction"
}
}
}
}
]
},
"CommentPublicApiChatMessagesControllerCreateChatReactionWorkspaceIdPath": {
"type": "integer"
},
"CommentCreateChatReaction": {
"type": "object",
"properties": {
"reaction": {
"type": "string",
"description": "The name of the emoji to use for the reaction."
}
},
"required": [
"reaction"
]
},
"CommentPublicApiChatMessagesControllerDeleteChatReactionWorkspaceIdPath": {
"type": "integer"
},
"CommentPublicApiChatMessagesControllerGetChatMessageRepliesWorkspaceIdPath": {
"type": "integer"
},
"CommentPublicApiChatMessagesControllerGetChatMessageRepliesLimitQuery": {
"minimum": 1,
"maximum": 100,
"default": 50,
"type": "integer"
},
"CommentPublicApiChatMessagesControllerGetChatMessageRepliesContentFormatQuery": {
"default": "text/md",
"enum": [
"text/md",
"text/plain"
],
"type": "string"
},
"CommentPublicApiChatMessagesControllerGetChatMessageReplies200Response": {
"allOf": [
{
"$ref": "#/components/schemas/CommentPaginatedResponse"
},
{
"type": "object",
"description": "The list of replies to a message, most recent first.",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReplyMessage"
}
}
}
}
]
},
"ReplyMessage": {
"type": "object",
"properties": {
"assignee": {
"type": "string",
"description": "The possible assignee of the message."
},
"assigned_by": {
"type": "string",
"description": "The user who assigned the message."
},
"content": {
"type": "string",
"description": "The full content of the message.",
"format": "RichText"
},
"date": {
"type": "number",
"description": "The date & time the message was created (Unix epoch milliseconds timestamp)."
},
"date_assigned": {
"type": "number",
"description": "The date & time the message was assigned (Unix epoch milliseconds timestamp)."
},
"date_resolved": {
"type": "number",
"description": "The date & time the message was resolved (Unix epoch milliseconds timestamp)."
},
"date_updated": {
"type": "number",
"description": "The date & time the message was updated (Unix epoch milliseconds timestamp)."
},
"group_assignee": {
"type": "string",
"description": "The possible group assignee of the message."
},
"id": {
"type": "string",
"description": "The ID of the message."
},
"parent_channel": {
"type": "string",
"description": "The ID of the chat this message belongs to."
},
"parent_message": {
"type": "string",
"description": "The ID of the message this message is a reply to."
},
"post_data": {
"description": "The data of the post message.",
"allOf": [
{
"$ref": "#/components/schemas/ChatPostData"
}
]
},
"resolved": {
"type": "boolean",
"description": "The resolved status of the message."
},
"resolved_by": {
"type": "string",
"description": "The user who resolved the message."
},
"triaged_action": {
"type": "number",
"description": "The triaged action applied to the message.",
"enum": [1, 2]
},
"triaged_object_id": {
"type": "string",
"description": "The message triaged action object id."
},
"triaged_object_type": {
"type": "number",
"description": "The message triaged action object type."
},
"type": {
"type": "string",
"description": "The type of message.",
"enum": [
"message",
"post"
]
},
"user_id": {
"type": "string",
"description": "The ID of the user who created the message."
},
"links": {
"description": "The links to elements of the message.",
"allOf": [
{
"$ref": "#/components/schemas/CommentReplyMessageLinks2"
}
]
}
},
"required": [
"content",
"date",
"id",
"parent_channel",
"parent_message",
"resolved",
"type",
"user_id",
"links"
]
},
"CommentReplyMessageLinks2": {
"type": "object",
"properties": {
"reactions": {
"type": "string",
"description": "The link to the reactions of this message."
},
"tagged_users": {
"type": "string",
"description": "The link to the tagged users of this message."
}
},
"required": [
"reactions",
"tagged_users"
]
},
"CommentPublicApiChatMessagesControllerCreateReplyMessageWorkspaceIdPath": {
"type": "integer"
},
"CommentCreateReplyMessageResponse": {
"type": "object",
"properties": {
"post_data": {
"description": "The data of the post message.",
"allOf": [
{
"$ref": "#/components/schemas/CommentChatPostDataCreate"
}
]
},
"assignee": {
"type": "string",
"description": "The possible assignee of the message."
},
"assigned_by": {
"type": "string",
"description": "The user who assigned the message."
},
"content": {
"type": "string",
"description": "The full content of the message.",
"format": "RichText"
},
"date": {
"type": "number",
"description": "The date & time the message was created (Unix epoch milliseconds timestamp)."
},
"date_assigned": {
"type": "number",
"description": "The date & time the message was assigned (Unix epoch milliseconds timestamp)."
},
"date_resolved": {
"type": "number",
"description": "The date & time the message was resolved (Unix epoch milliseconds timestamp)."
},
"date_updated": {
"type": "number",
"description": "The date & time the message was updated (Unix epoch milliseconds timestamp)."
},
"group_assignee": {
"type": "string",
"description": "The possible group assignee of the message."
},
"id": {
"type": "string",
"description": "The ID of the message."
},
"parent_channel": {
"type": "string",
"description": "The ID of the chat this message belongs to."
},
"parent_message": {
"type": "string",
"description": "The ID of the message this message is a reply to."
},
"resolved": {
"type": "boolean",
"description": "The resolved status of the message."
},
"resolved_by": {
"type": "string",
"description": "The user who resolved the message."
},
"triaged_action": {
"type": "number",
"description": "The triaged action applied to the message.",
"enum": [1, 2]
},
"triaged_object_id": {
"type": "string",
"description": "The message triaged action object id."
},
"triaged_object_type": {
"type": "number",
"description": "The message triaged action object type."
},
"type": {
"type": "string",
"description": "The type of message.",
"enum": [
"message",
"post"
]
},
"user_id": {
"type": "string",
"description": "The ID of the user who created the message."
},
"links": {
"description": "The links to elements of the message.",
"allOf": [
{
"$ref": "#/components/schemas/CommentReplyMessageLinks2"
}
]
}
},
"required": [
"content",
"date",
"id",
"parent_channel",
"parent_message",
"resolved",
"type",
"user_id",
"links"
]
},
"CommentPublicApiChatMessagesControllerGetChatMessageTaggedUsersWorkspaceIdPath": {
"type": "integer"
},
"CommentPublicApiChatMessagesControllerGetChatMessageTaggedUsersLimitQuery": {
"minimum": 1,
"maximum": 100,
"default": 50,
"type": "integer"
},
"CommentPublicApiChatMessagesControllerGetChatMessageTaggedUsers200Response": {
"allOf": [
{
"$ref": "#/components/schemas/CommentPaginatedResponse"
},
{
"type": "object",
"description": "The list of message tagged users.",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommentSimpleUser"
}
}
}
}
]
},
"CommentSimpleUser": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email of the user."
},
"id": {
"type": "string",
"description": "ID of the user."
},
"initials": {
"type": "string",
"description": "Initials of the user."
},
"name": {
"type": "string",
"description": "Name of the user."
},
"username": {
"type": "string",
"description": "Userame of the user."
}
},
"required": [
"email",
"id"
]
}
},
"securitySchemes": {
"Authorization_Token": {
"name": "Authorization",
"type": "apiKey",
"in": "header",
"description": "API token required for authentication. Two types of tokens are supported:\n**Personal API Key** Obtain from ClickUp's settings page under 'Apps' and add it to the header as `Authorization: pk_...`\n**OAuth2 Access Token** Generated through the OAuth2 flow and add it to the header as `Authorization: Bearer {access_token}`"
}
}
},
"security": [
{
"Authorization_Token": []
}
],
"tags": [
{
"name": "Audit Logs"
},
{
"name": "Authorization"
},
{
"name": "Attachments"
},
{
"name": "Comments"
},
{
"name": "Custom Task Types"
},
{
"name": "Custom Fields"
},
{
"name": "Docs"
},
{
"name": "Folders"
},
{
"name": "Goals"
},
{
"name": "Guests"
},
{
"name": "Lists"
},
{
"name": "Members"
},
{
"name": "Privacy and access"
},
{
"name": "Roles"
},
{
"name": "Shared Hierarchy"
},
{
"name": "Spaces"
},
{
"name": "Tags"
},
{
"name": "Tasks"
},
{
"name": "Task Checklists"
},
{
"name": "Task Relationships"
},
{
"name": "Templates"
},
{
"name": "Workspaces"
},
{
"name": "User Groups"
},
{
"name": "Time Tracking"
},
{
"name": "Time Tracking (Legacy)"
},
{
"name": "Users"
},
{
"name": "Views"
},
{
"name": "Webhooks"
}
]
}
Reference in a new issue View git blame Copy permalink