ListsAddTaskToListResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
ListsRemoveListResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
ListsRemoveTaskFromListResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
Member
{
"type": "object",
"title": "Member",
"example": {
"user": {
"id": 123,
"color": "#000000",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
},
"required": [
"user"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User"
}
},
"x-examples": [
{
"user": {
"id": 123,
"color": "#000000",
"username": "John Doe",
"profilePicture": "https://clickup.com/avatar.jpg"
}
}
]
}
Member1
{
"type": "object",
"title": "Member1",
"example": {
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"isCreator": true,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "edit"
},
"required": [
"id",
"username",
"email",
"color",
"permission_level",
"profilePicture",
"initials",
"isCreator"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"isCreator": {
"type": "boolean"
},
"profilePicture": {
"type": "string"
},
"permission_level": {
"type": "string"
}
},
"x-examples": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"initials": "JD",
"username": "Jane Doe",
"isCreator": true,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "edit"
}
]
}
Member2
{
"type": "object",
"title": "Member2",
"example": {
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"added_by": 183,
"initials": "JD",
"username": "Jane Doe",
"date_added": 1631599941928,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "read"
},
"required": [
"id",
"email",
"username",
"color",
"permission_level",
"date_added",
"added_by",
"initials",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"added_by": {
"type": "integer",
"contentEncoding": "int32"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"date_added": {
"type": "integer",
"contentEncoding": "int64"
},
"profilePicture": {
"type": "string"
},
"permission_level": {
"type": "string"
}
},
"x-examples": [
{
"id": 182,
"color": "#827718",
"email": "janedoe@gmail.com",
"added_by": 183,
"initials": "JD",
"username": "Jane Doe",
"date_added": 1631599941928,
"profilePicture": "https://attachments-public.clickup.com/profilePictures/profile.jpg",
"permission_level": "read"
}
]
}
Member4
{
"type": "object",
"title": "Member4",
"example": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"custom_role": {
"id": 12345,
"name": "guest custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_create_views": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
},
"required": [
"user",
"invited_by",
"can_see_time_spent",
"can_see_time_estimated",
"can_edit_tags",
"can_create_views"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User5"
},
"invited_by": {
"$ref": "#/components/schemas/InvitedBy"
},
"can_edit_tags": {
"type": "boolean"
},
"can_create_views": {
"type": "boolean"
},
"can_see_time_spent": {
"type": "boolean"
},
"can_see_time_estimated": {
"type": "boolean"
}
},
"x-examples": [
{
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"custom_role": {
"id": 12345,
"name": "guest custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_create_views": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
]
}
Member5
{
"type": "object",
"title": "Member5",
"example": {
"id": 812,
"color": "#FFFFFF",
"email": "john@example.com",
"initials": "JD",
"username": "John Doe",
"profileInfo": {
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
},
"profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg"
},
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture",
"profileInfo"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": [
"string",
"null"
]
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profileInfo": {
"$ref": "#/components/schemas/ProfileInfo"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 812,
"color": "#FFFFFF",
"email": "john@example.com",
"initials": "JD",
"username": "John Doe",
"profileInfo": {
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
},
"profilePicture": "https://attachments-public.clickup.com/profilePictures/812_nx1.jpg"
}
]
}
Member7
{
"type": "object",
"title": "Member7",
"example": {
"user": {
"id": 184,
"role": 3,
"color": null,
"email": "user@example.com",
"initials": "UN",
"username": "User Name",
"custom_role": {
"id": 998877,
"name": "member custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
},
"properties": {
"user": {
"$ref": "#/components/schemas/User21"
},
"shared": {
"$ref": "#/components/schemas/Shared"
},
"invited_by": {
"$ref": "#/components/schemas/InvitedBy"
}
},
"x-examples": [
{
"user": {
"id": 184,
"role": 3,
"color": null,
"email": "user@example.com",
"initials": "UN",
"username": "User Name",
"custom_role": {
"id": 998877,
"name": "member custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
}
]
}
Members
{
"type": "object",
"title": "Members",
"example": {
"empty_member_seats": 0,
"total_member_seats": 9,
"filled_members_seats": 9
},
"required": [
"filled_members_seats",
"total_member_seats",
"empty_member_seats"
],
"properties": {
"empty_member_seats": {
"type": "integer",
"contentEncoding": "int32"
},
"total_member_seats": {
"type": "integer",
"contentEncoding": "int32"
},
"filled_members_seats": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"empty_member_seats": 0,
"total_member_seats": 9,
"filled_members_seats": 9
}
]
}
Members1
{
"type": "object",
"title": "Members1",
"example": {
"id": 185,
"color": "#4169E1",
"email": "sam@example.com",
"initials": "S",
"username": "Sam",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 185,
"color": "#4169E1",
"email": "sam@example.com",
"initials": "S",
"username": "Sam",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
]
}
Members2
{
"type": "object",
"title": "Members2",
"example": {
"add": [
123456,
987654
],
"rem": [
159753
]
},
"required": [
"add",
"rem"
],
"properties": {
"add": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
},
"rem": {
"type": "array",
"items": {
"type": "integer",
"contentEncoding": "int32"
},
"description": ""
}
},
"x-examples": [
{
"add": [
123456,
987654
],
"rem": [
159753
]
}
]
}
Members3
{
"type": "object",
"title": "Members3",
"example": {
"id": 201,
"color": "#40BC86",
"email": "jim@example.com",
"initials": "JH",
"username": "Jim Halpert",
"profilePicture": null
},
"required": [
"id",
"username",
"email",
"color",
"initials",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"id": 201,
"color": "#40BC86",
"email": "jim@example.com",
"initials": "JH",
"username": "Jim Halpert",
"profilePicture": null
}
]
}
Members5
{
"type": "object",
"title": "Members5",
"example": {
"user": {
"id": 184,
"role": 2,
"color": null,
"email": "user@example.com",
"initials": "G",
"username": null,
"custom_role": {
"id": 112233,
"name": "admin custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
},
"required": [
"user",
"invited_by"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User5"
},
"invited_by": {
"$ref": "#/components/schemas/InvitedBy"
}
},
"x-examples": [
{
"user": {
"id": 184,
"role": 2,
"color": null,
"email": "user@example.com",
"initials": "G",
"username": null,
"custom_role": {
"id": 112233,
"name": "admin custom"
},
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
}
]
}
Milestones
{
"type": "object",
"title": "Milestones",
"example": {
"enabled": false
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": false
}
]
}
MultipleAssignees
{
"type": "object",
"title": "MultipleAssignees",
"example": {
"enabled": true
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": true
}
]
}
Option
{
"type": "object",
"title": "Option",
"example": {
"id": "fb332c98-d7bc-4ee8-a3bd-b5ffaff98c3c",
"color": null,
"label": "one"
},
"required": [
"id",
"color"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"color": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"value": {
"type": "integer",
"contentEncoding": "int32"
},
"orderindex": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"id": "fb332c98-d7bc-4ee8-a3bd-b5ffaff98c3c",
"color": null,
"label": "one"
}
]
}
Owner
{
"type": "object",
"title": "Owner",
"example": {
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
},
"required": [
"id",
"username",
"initials",
"email",
"color",
"profilePicture"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"color": {
"type": "string"
},
"email": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"x-examples": [
{
"id": 183,
"color": "#827718",
"email": "johndoe@gmail.com",
"initials": "JD",
"username": "John Doe",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/183_abc.jpg"
}
]
}
Parent
{
"type": "object",
"title": "Parent",
"example": {
"id": "512X",
"type": 7
},
"required": [
"id",
"type"
],
"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"
}
},
"x-examples": [
{
"id": "512X",
"type": 7
}
],
"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."
}
Points
{
"type": "object",
"title": "Points",
"example": {
"enabled": false
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": false
}
]
}
Portfolios
{
"type": "object",
"title": "Portfolios",
"example": {
"enabled": true
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": true
}
]
}
Priority
{
"type": "object",
"title": "Priority",
"example": {
"id": "1X",
"color": "#f50000",
"priority": "urgent",
"orderindex": "1"
},
"required": [
"id",
"priority",
"color",
"orderindex"
],
"properties": {
"id": {
"type": "string"
},
"color": {
"type": "string"
},
"priority": {
"type": "string"
},
"orderindex": {
"type": "string"
}
},
"x-examples": [
{
"id": "1X",
"color": "#f50000",
"priority": "urgent",
"orderindex": "1"
}
]
}
Priority1
{
"type": "object",
"title": "Priority1",
"example": {
"color": "#f50000",
"priority": "urgent"
},
"required": [
"priority",
"color"
],
"properties": {
"color": {
"type": "string"
},
"priority": {
"type": "string"
}
},
"x-examples": [
{
"color": "#f50000",
"priority": "urgent"
}
]
}
Priority4
{
"type": "object",
"title": "Priority4",
"example": {
"color": "#f50000",
"priority": "high"
},
"properties": {
"color": {
"type": "string"
},
"priority": {
"type": "string"
}
},
"x-examples": [
{
"color": "#f50000",
"priority": "high"
}
]
}
ProfileInfo
{
"type": "object",
"title": "ProfileInfo",
"example": {
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
},
"required": [
"display_profile",
"verified_ambassador",
"verified_consultant",
"top_tier_user",
"viewed_verified_ambassador",
"viewed_verified_consultant",
"viewed_top_tier_user"
],
"properties": {
"top_tier_user": {
"type": [
"string",
"null"
]
},
"display_profile": {
"type": [
"string",
"null"
]
},
"verified_ambassador": {
"type": [
"string",
"null"
]
},
"verified_consultant": {
"type": [
"string",
"null"
]
},
"viewed_top_tier_user": {
"type": [
"string",
"null"
]
},
"viewed_verified_ambassador": {
"type": [
"string",
"null"
]
},
"viewed_verified_consultant": {
"type": [
"string",
"null"
]
}
},
"x-examples": [
{
"top_tier_user": null,
"display_profile": null,
"verified_ambassador": null,
"verified_consultant": null,
"viewed_top_tier_user": null,
"viewed_verified_ambassador": null,
"viewed_verified_consultant": null
}
]
}
Project
{
"type": "object",
"title": "Project",
"example": {
"id": "1X",
"name": "Folder",
"access": true,
"hidden": false
},
"required": [
"id",
"name",
"hidden",
"access"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"access": {
"type": "boolean"
},
"hidden": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "1X",
"name": "Folder",
"access": true,
"hidden": false
}
]
}
RemapDependencies
{
"type": "object",
"title": "RemapDependencies",
"example": {
"enabled": true
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": true
}
]
}
RemoveGuestFromFolderresponse
{
"type": "object",
"title": "RemoveGuestFromFolderresponse",
"example": {
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
},
"required": [
"guest"
],
"properties": {
"guest": {
"$ref": "#/components/schemas/Guest2"
}
},
"x-examples": [
{
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
}
]
}
RemoveGuestFromListresponse
{
"type": "object",
"title": "RemoveGuestFromListresponse",
"example": {
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
},
"required": [
"guest"
],
"properties": {
"guest": {
"$ref": "#/components/schemas/Guest2"
}
},
"x-examples": [
{
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
}
]
}
RemoveGuestFromTaskresponse
{
"type": "object",
"title": "RemoveGuestFromTaskresponse",
"example": {
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
},
"required": [
"guest"
],
"properties": {
"guest": {
"$ref": "#/components/schemas/Guest2"
}
},
"x-examples": [
{
"guest": {
"user": {
"id": 184,
"role": 4,
"color": null,
"email": "guest@example.com",
"initials": "G",
"username": null,
"date_joined": null,
"last_active": null,
"date_invited": "1583358383412",
"profilePicture": null
},
"shared": {
"lists": [],
"tasks": [],
"folders": []
},
"invited_by": {
"id": 183,
"color": "#827718",
"email": "jerry@example.com",
"initials": "J",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"can_edit_tags": true,
"can_see_time_spent": true,
"can_see_time_estimated": true
}
}
]
}
RemoveGuestFromWorkspaceresponse
{
"type": "object",
"title": "RemoveGuestFromWorkspaceresponse",
"example": {
"team": {
"id": "333X",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
}
},
"required": [
"team"
],
"properties": {
"team": {
"$ref": "#/components/schemas/Team2"
}
},
"x-examples": [
{
"team": {
"id": "333X",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
}
}
]
}
RemoveUserFromWorkspaceresponse
{
"type": "object",
"title": "RemoveUserFromWorkspaceresponse",
"example": {
"team": {
"id": "333X",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
}
},
"required": [
"team"
],
"properties": {
"team": {
"$ref": "#/components/schemas/Team2"
}
},
"x-examples": [
{
"team": {
"id": "333X",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": []
}
}
]
}
Removetagsfromtimeentriesrequest
{
"type": "object",
"title": "Removetagsfromtimeentriesrequest",
"example": {
"tags": [
{
"name": "name of tag"
}
],
"time_entry_ids": [
"timer_id"
]
},
"required": [
"time_entry_ids",
"tags"
],
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tags10"
},
"description": ""
},
"time_entry_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"x-examples": [
{
"tags": [
{
"name": "name of tag"
}
],
"time_entry_ids": [
"timer_id"
]
}
]
}
Role
{
"type": "object",
"title": "Role",
"example": {
"id": 1,
"name": "owner",
"custom": false
},
"required": [
"id",
"name",
"custom"
],
"properties": {
"id": {
"type": "integer",
"contentEncoding": "int32"
},
"name": {
"type": "string"
},
"custom": {
"type": "boolean"
},
"inherited_role": {
"type": "integer",
"contentEncoding": "int32"
}
},
"x-examples": [
{
"id": 1,
"name": "owner",
"custom": false
}
]
}
SetCustomFieldValuerequest
{
"anyOf": [
{
"type": "object",
"title": "URL Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "https://clickup.com/api"
}
},
"description": "The `value` must be a string with a valid URL."
},
{
"type": "object",
"title": "Dropdown Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "uuid1234"
}
},
"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.](https://clickup.com/api)"
},
{
"type": "object",
"title": "Email Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "user@company.com"
}
},
"description": "The `value` must be a string with a valid email address."
},
{
"type": "object",
"title": "Phone Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "+1 123 456 7890"
}
},
"description": "The `value` must be a string with a valid country code."
},
{
"type": "object",
"title": "Date Custom Field",
"properties": {
"value": {
"type": "integer",
"format": "int32",
"example": 1667367645000
},
"value_options": {
"type": "object",
"required": [
"time"
],
"properties": {
"time": {
"type": "boolean",
"example": true
}
}
}
},
"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."
},
{
"type": "object",
"title": "Short or Long Text Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"example": "This is short or long text in a Custom Field."
}
},
"description": "Enter a string of text."
},
{
"type": "object",
"title": "Number Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "number",
"example": -28
}
},
"description": "Enter a number."
},
{
"type": "object",
"title": "Money Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "number",
"example": 8000
}
},
"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.](https://clickup.com/api)"
},
{
"type": "object",
"title": "Task Relationship Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "string"
}
},
"rem": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"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."
},
{
"type": "object",
"title": "People Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "object",
"properties": {
"add": {
"type": "array",
"items": {
"type": "number"
}
},
"rem": {
"type": "array",
"items": {
"type": "number"
}
}
}
}
},
"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).](https://clickup.com/api)"
},
{
"type": "object",
"title": "Emoji (Rating) Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "integer",
"format": "int32",
"example": 4
}
},
"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.](https://clickup.com/api)"
},
{
"type": "object",
"title": "Manual Progress Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "object",
"required": [
"current"
],
"properties": {
"current": {
"type": "number",
"example": 20
}
}
}
},
"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.](https://clickup.com/api)"
},
{
"type": "object",
"title": "Label Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "array",
"items": {
"type": "string",
"example": [
"uuid1234",
"uuid9876"
]
}
}
},
"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.](https://clickup.com/api)"
},
{
"type": "object",
"title": "Location Custom Field",
"required": [
"value"
],
"properties": {
"value": {
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"lat": {
"type": "number"
},
"lng": {
"type": "number"
}
}
},
"formatted_address": {
"type": "string"
}
}
}
},
"description": "Include the latitude, longitude, and formatted address as defined in the [Google Maps Geocoding API.](https://developers.google.com/maps/documentation/geocoding/overview)"
}
],
"title": "SetCustomFieldValuerequest"
}
Settings
{
"type": "object",
"title": "Settings",
"example": {
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
},
"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"
],
"properties": {
"me_comments": {
"type": "boolean"
},
"me_subtasks": {
"type": "boolean"
},
"show_images": {
"type": "boolean"
},
"me_checklists": {
"type": "boolean"
},
"show_subtasks": {
"type": "integer",
"description": "Acceptable values are `1`, `2`, or `3`, which show subtasks separate, expanded, or collapsed.",
"contentEncoding": "int32"
},
"show_assignees": {
"type": "boolean"
},
"show_task_locations": {
"type": "boolean"
},
"show_closed_subtasks": {
"type": "boolean"
},
"collapse_empty_columns": {
"type": [
"string",
"null"
]
},
"show_subtask_parent_names": {
"type": "boolean"
}
},
"x-examples": [
{
"me_comments": true,
"me_subtasks": true,
"show_images": true,
"me_checklists": true,
"show_subtasks": 3,
"show_assignees": true,
"show_task_locations": false,
"show_closed_subtasks": false,
"collapse_empty_columns": null,
"show_subtask_parent_names": false
}
]
}
Shared
{
"type": "object",
"title": "Shared",
"example": {
"lists": [],
"tasks": [],
"folders": []
},
"properties": {
"lists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"x-examples": [
{
"lists": [],
"tasks": [],
"folders": []
}
]
}
Shared1
{
"type": "object",
"title": "Shared1",
"example": {
"lists": [],
"tasks": [
{
"id": "c04X",
"url": "https://app.clickup.com/t/c04",
"list": {
"id": "1752X",
"name": "Shared with me",
"access": false
},
"name": "Task Name",
"tags": [],
"space": {
"id": "380X"
},
"folder": {
"id": "1217X",
"name": "Shared with me",
"access": false,
"hidden": false
},
"parent": null,
"points": null,
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
"creator": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"team_id": "108",
"archived": false,
"due_date": "1508369194377",
"priority": {
"id": "1X",
"color": "#f50000",
"priority": "urgent",
"orderindex": "1"
},
"assignees": [],
"checklists": [],
"orderindex": "0",
"start_date": null,
"date_closed": null,
"date_created": "1574718405408",
"date_updated": "1574722145869",
"dependencies": [],
"custom_fields": [],
"time_estimate": null,
"permission_level": "read"
}
],
"folders": []
},
"required": [
"tasks",
"lists",
"folders"
],
"properties": {
"lists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tasks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Task2"
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"x-examples": [
{
"lists": [],
"tasks": [
{
"id": "c04X",
"url": "https://app.clickup.com/t/c04",
"list": {
"id": "1752X",
"name": "Shared with me",
"access": false
},
"name": "Task Name",
"tags": [],
"space": {
"id": "380X"
},
"folder": {
"id": "1217X",
"name": "Shared with me",
"access": false,
"hidden": false
},
"parent": null,
"points": null,
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
"creator": {
"id": 183,
"color": "#827718",
"username": "Jerry",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
},
"team_id": "108",
"archived": false,
"due_date": "1508369194377",
"priority": {
"id": "1X",
"color": "#f50000",
"priority": "urgent",
"orderindex": "1"
},
"assignees": [],
"checklists": [],
"orderindex": "0",
"start_date": null,
"date_closed": null,
"date_created": "1574718405408",
"date_updated": "1574722145869",
"dependencies": [],
"custom_fields": [],
"time_estimate": null,
"permission_level": "read"
}
],
"folders": []
}
]
}
Shared3
{
"type": "object",
"title": "Shared3",
"example": {
"lists": [
{
"id": "1427X",
"name": "List Name",
"status": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 1,
"start_date": null,
"task_count": "5",
"permission_level": "read",
"override_statuses": true
}
],
"tasks": [],
"folders": []
},
"required": [
"tasks",
"lists",
"folders"
],
"properties": {
"lists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/List3"
},
"description": ""
},
"tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
}
},
"x-examples": [
{
"lists": [
{
"id": "1427X",
"name": "List Name",
"status": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 1,
"start_date": null,
"task_count": "5",
"permission_level": "read",
"override_statuses": true
}
],
"tasks": [],
"folders": []
}
]
}
Shared5
{
"type": "object",
"title": "Shared5",
"example": {
"lists": [],
"tasks": [],
"folders": [
{
"id": "1057X",
"name": "Folder Name",
"lists": [],
"hidden": false,
"archived": false,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 5,
"task_count": "20",
"permission_level": "read",
"override_statuses": true
}
]
},
"required": [
"tasks",
"lists",
"folders"
],
"properties": {
"lists": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Folder4"
},
"description": ""
}
},
"x-examples": [
{
"lists": [],
"tasks": [],
"folders": [
{
"id": "1057X",
"name": "Folder Name",
"lists": [],
"hidden": false,
"archived": false,
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "Open",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "Closed",
"orderindex": 5
}
],
"orderindex": 5,
"task_count": "20",
"permission_level": "read",
"override_statuses": true
}
]
}
]
}
Shared7
{
"type": "object",
"title": "Shared7",
"example": {
"lists": [
{
"id": "1421X",
"name": "Shared List",
"status": null,
"content": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"orderindex": 0,
"start_date": null,
"task_count": "0"
}
],
"tasks": [],
"folders": [
{
"id": "1058X",
"name": "Shared Folder",
"content": null,
"archived": false,
"due_date": null,
"orderindex": 0,
"task_count": "0"
}
]
},
"required": [
"tasks",
"lists",
"folders"
],
"properties": {
"lists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/List6"
},
"description": ""
},
"tasks": {
"type": "array",
"items": {
"type": "string"
},
"description": ""
},
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Folder11"
},
"description": ""
}
},
"x-examples": [
{
"lists": [
{
"id": "1421X",
"name": "Shared List",
"status": null,
"content": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"orderindex": 0,
"start_date": null,
"task_count": "0"
}
],
"tasks": [],
"folders": [
{
"id": "1058X",
"name": "Shared Folder",
"content": null,
"archived": false,
"due_date": null,
"orderindex": 0,
"task_count": "0"
}
]
}
]
}
SharedHierarchyresponse
{
"type": "object",
"title": "SharedHierarchyresponse",
"example": {
"shared": {
"lists": [
{
"id": "1421X",
"name": "Shared List",
"status": null,
"content": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"orderindex": 0,
"start_date": null,
"task_count": "0"
}
],
"tasks": [],
"folders": [
{
"id": "1058X",
"name": "Shared Folder",
"content": null,
"archived": false,
"due_date": null,
"orderindex": 0,
"task_count": "0"
}
]
}
},
"required": [
"shared"
],
"properties": {
"shared": {
"$ref": "#/components/schemas/Shared7"
}
},
"x-examples": [
{
"shared": {
"lists": [
{
"id": "1421X",
"name": "Shared List",
"status": null,
"content": null,
"archived": false,
"assignee": null,
"due_date": null,
"priority": null,
"orderindex": 0,
"start_date": null,
"task_count": "0"
}
],
"tasks": [],
"folders": [
{
"id": "1058X",
"name": "Shared Folder",
"content": null,
"archived": false,
"due_date": null,
"orderindex": 0,
"task_count": "0"
}
]
}
}
]
}
Sorting
{
"type": "object",
"title": "Sorting",
"example": {
"fields": [
{
"dir": -1,
"idx": 0,
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2"
}
]
},
"required": [
"fields"
],
"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](https://clickup.com/api)."
}
},
"x-examples": [
{
"fields": [
{
"dir": -1,
"idx": 0,
"field": "cf_624a423a-c1d1-4467-99e2-63e225658cb2"
}
]
}
]
}
Space
{
"type": "object",
"title": "Space",
"example": {
"id": "789X"
},
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
}
},
"x-examples": [
{
"id": "789X"
}
]
}
Space13
{
"type": "object",
"title": "Space13",
"example": {
"id": "790X",
"name": "Updated Space Name",
"color": null,
"avatar": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg",
"members": [
{
"user": {
"id": 12312312,
"color": null,
"initials": "JJ",
"username": "John Jones",
"profilePicture": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg"
}
}
],
"private": false,
"archived": false,
"features": {
"tags": {
"enabled": false
},
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"remap_dependencies": {
"enabled": false
}
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"admin_can_manage": true,
"multiple_assignees": false
},
"required": [
"id",
"name",
"private",
"statuses",
"multiple_assignees",
"features"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"avatar": {
"type": "string"
},
"members": {
"type": "array",
"user": {
"id": {
"type": "string"
},
"color": {
"type": "string"
},
"initials": {
"type": "string"
},
"username": {
"type": "string"
},
"profilePicture": {
"type": "string"
}
},
"items": {
"$ref": "#/components/schemas/Member"
},
"description": ""
},
"private": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"features": {
"$ref": "#/components/schemas/Features4"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Status"
},
"description": ""
},
"admin_can_manage": {
"type": "boolean"
},
"multiple_assignees": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "790X",
"name": "Updated Space Name",
"color": null,
"avatar": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg",
"members": [
{
"user": {
"id": 12312312,
"color": null,
"initials": "JJ",
"username": "John Jones",
"profilePicture": "https://attachments.clickup.com/profilePictures/12312312_HoB.jpg"
}
}
],
"private": false,
"archived": false,
"features": {
"tags": {
"enabled": false
},
"due_dates": {
"enabled": false,
"start_date": false,
"remap_due_dates": false,
"remap_closed_due_date": false
},
"checklists": {
"enabled": true
},
"portfolios": {
"enabled": false
},
"custom_fields": {
"enabled": true
},
"time_tracking": {
"enabled": false
},
"time_estimates": {
"enabled": false
},
"dependency_warning": {
"enabled": false
},
"remap_dependencies": {
"enabled": false
}
},
"statuses": [
{
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
{
"type": "closed",
"color": "#6bc950",
"status": "complete",
"orderindex": 1
}
],
"admin_can_manage": true,
"multiple_assignees": false
}
]
}
Space2
{
"type": "object",
"title": "Space2",
"example": {
"id": "789X",
"name": "Space Name",
"access": true
},
"required": [
"id",
"name",
"access"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"access": {
"type": "boolean"
}
},
"x-examples": [
{
"id": "789X",
"name": "Space Name",
"access": true
}
]
}
SpacesRemoveSpaceResponse
{
"type": "object",
"example": {},
"x-examples": [
{}
],
"contentMediaType": "application/json"
}
Sprints
{
"type": "object",
"title": "Sprints",
"example": {
"enabled": false
},
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"x-examples": [
{
"enabled": false
}
]
}
StartatimeEntryrequest
{
"type": "object",
"title": "StartatimeEntryrequest",
"example": {
"tid": "task_id",
"tags": [
{
"name": "tag1"
}
],
"billable": false,
"description": "from api"
},
"properties": {
"tid": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tags10"
},
"description": "Users on the Business Plan and above can include a time tracking label."
},
"billable": {
"type": "boolean"
},
"description": {
"type": "string"
}
},
"x-examples": [
{
"tid": "task_id",
"tags": [
{
"name": "tag1"
}
],
"billable": false,
"description": "from api"
}
]
}
StartatimeEntryresponse
{
"type": "object",
"title": "StartatimeEntryresponse",
"example": {
"data": {
"at": 1595289452790,
"id": "timer_idX",
"wid": "workspace_id",
"tags": [],
"task": {
"id": "task_idX",
"name": "test task",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
"custom_type": null
},
"user": {
"id": 1,
"color": "#08c7e0",
"email": "test@gmail.com",
"initials": "JK",
"username": "first_name last_name",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"start": "1595289395842",
"billable": false,
"duration": -53,
"description": ""
}
},
"required": [
"data"
],
"properties": {
"data": {
"$ref": "#/components/schemas/Data2"
}
},
"x-examples": [
{
"data": {
"at": 1595289452790,
"id": "timer_idX",
"wid": "workspace_id",
"tags": [],
"task": {
"id": "task_idX",
"name": "test task",
"status": {
"type": "open",
"color": "#d3d3d3",
"status": "to do",
"orderindex": 0
},
"custom_type": null
},
"user": {
"id": 1,
"color": "#08c7e0",
"email": "test@gmail.com",
"initials": "JK",
"username": "first_name last_name",
"profilePicture": "https://attachments-public.clickup.com/profilePictures/1_HHk.jpg"
},
"start": "1595289395842",
"billable": false,
"duration": -53,
"description": ""
}
}
]
}