ClickUp Public API v3

{"openapi":"3.0.0","info":{"title":"ClickUp Public API v3","version":"version","description":"This API is exposed to the public internet and is meant to be accessed by third-party integrations."},"servers":[{"url":"https://api.clickup.com/","description":"ClickUp"}],"paths":{"/api/v3/workspaces/{workspace_id}/chat/channels":{"get":{"operationId":"getChatChannels","summary":"Retrieve Channels","description":"This endpoint retrieves the Channels in a Workspace.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelsWorkspaceIdPath"}},{"name":"description_format","in":"query","description":"Format of the Channel description (Default: text/md).","required":false,"schema":{"$ref":"#/components/schemas/ChatTextFormat"}},{"name":"cursor","in":"query","description":"Used to request the next page of results.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of results to fetch for this page.","required":false,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelsLimitQuery"}},{"name":"is_follower","in":"query","description":"Only return Channels the user is following.","required":false,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelsIsFollowerQuery"}},{"name":"include_closed","in":"query","description":"Include DMs/Group DMs that have been explicitly closed.","required":false,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelsIncludeClosedQuery"}},{"name":"with_message_since","in":"query","description":"Only return Channels with at least one message since the given timestamp.","required":false,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelsWithMessageSinceQuery"}},{"name":"channel_types","in":"query","description":"Specify the types of Channels to return from the request.","required":false,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelsChannelTypesQuery"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannels200Response"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true},"post":{"operationId":"createChatChannel","summary":"Create a Channel","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.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerCreateChatChannelWorkspaceIdPath"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCreateChatChannel"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerCreateChatChannel200Response"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerCreateChatChannel201Response"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/chat/channels/location":{"post":{"operationId":"createLocationChatChannel","summary":"Create a Channel on a Space, Folder, or List","description":"This endpoint creates a Channel on a Space, Folder, or List. When a Channel already exists on the requested location, it returns it.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerCreateLocationChatChannelWorkspaceIdPath"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCreateLocationChatChannel"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerCreateLocationChatChannel200Response"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerCreateLocationChatChannel201Response"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/chat/channels/direct_message":{"post":{"operationId":"createDirectMessageChatChannel","summary":"Create a Direct Message","description":"This endpoint creates a new Direct Message between up to 15 users. If a Direct Message between those users already exists it returns it.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerCreateDirectMessageChatChannelWorkspaceIdPath"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCreateDirectMessageChatChannel"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerCreateDirectMessageChatChannel200Response"}}}},"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerCreateDirectMessageChatChannel201Response"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}":{"get":{"operationId":"getChatChannel","summary":"Retrieve a Channel","description":"This endpoint retrieves a specific Channel given its ID.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelWorkspaceIdPath"}},{"name":"channel_id","in":"path","description":"The ID of the specified Channel.","required":true,"schema":{"type":"string"}},{"name":"description_format","in":"query","description":"Format of the Channel description (Default: text/md).","required":false,"schema":{"$ref":"#/components/schemas/ChatTextFormat"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannel200Response"}}}},"404":{"description":"Returns when the requested {channelId} was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiErrorResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true},"patch":{"operationId":"updateChatChannel","summary":"Update a Channel","description":"This endpoint updates a single Channel.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerUpdateChatChannelWorkspaceIdPath"}},{"name":"channel_id","in":"path","description":"The ID of the specified Channel.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatUpdateChatChannel"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerUpdateChatChannel200Response"}}}},"400":{"description":"Invalid update request for {channelId}.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiErrorResponse"}}}},"404":{"description":"Returns when the requested {channelId} was not found when updating a Channel.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiErrorResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true},"delete":{"operationId":"deleteChatChannel","summary":"Delete a Channel","description":"This endpoint deletes a Channel. Applies to Channels tied to a Space, Folder, or List or not tied to locations.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerDeleteChatChannelWorkspaceIdPath"}},{"name":"channel_id","in":"path","description":"The ID of the specified Channel.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The Channel was deleted.","content":{"application/json":{}}},"404":{"description":"Returns when the requested {channelId} was not found when deleting a Channel.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiErrorResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/followers":{"get":{"operationId":"getChatChannelFollowers","summary":"Retrieve Channel followers","description":"This endpoint retrieves followers of a specific Channel given its ID.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelFollowersWorkspaceIdPath"}},{"name":"channel_id","in":"path","description":"The ID of the specified Channel.","required":true,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"The cursor to use to fetch the next page of results.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of results to fetch for this page.","required":false,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelFollowersLimitQuery"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelFollowers200Response"}}}},"404":{"description":"Returns when the specified {channelId} was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiErrorResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/members":{"get":{"operationId":"getChatChannelMembers","summary":"Retrieve Channel members","description":"This endpoint retrieves members of a specific Channel given its ID.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelMembersWorkspaceIdPath"}},{"name":"channel_id","in":"path","description":"The ID of the specified Channel.","required":true,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"The cursor to use to fetch the next page of results.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of results to fetch for this page.","required":false,"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelMembersLimitQuery"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiChatChannelsControllerGetChatChannelMembers200Response"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/chat/channels/{channel_id}/messages":{"get":{"operationId":"getChatMessages","summary":"Retrieve Channel messages","description":"This endpoint retrieves messages for a specified Channel.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessagesWorkspaceIdPath"}},{"name":"channel_id","in":"path","description":"The ID of the Channel where the messages live.","required":true,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"The cursor to use to fetch the next page of results.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of results to fetch for this page.","required":false,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessagesLimitQuery"}},{"name":"content_format","in":"query","description":"Format of the message content (Default: text/md).","required":false,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessagesContentFormatQuery"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessages200Response"}}}},"404":{"description":"Returns when the specified {channelId} was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true},"post":{"operationId":"createChatMessage","summary":"Send a message","description":"This endpoint creates a top level message.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerCreateChatMessageWorkspaceIdPath"}},{"name":"channel_id","in":"path","description":"The ID of the Channel where the messages live.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentCreateChatMessage"}}}},"responses":{"201":{"description":"The message is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentCreateChatMessageResponse"}}}},"404":{"description":"Returns when {channelId} was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}":{"patch":{"operationId":"patchChatMessage","summary":"Update a message","description":"This endpoint updates a message.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerPatchChatMessageWorkspaceIdPath"}},{"name":"message_id","in":"path","description":"The ID of the specified message.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPatchChatMessage"}}}},"responses":{"200":{"description":"The message that was updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPatchChatMessageResponse"}}}},"400":{"description":"Returns when the request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}},"404":{"description":"Returns when {messageId} was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true},"delete":{"operationId":"deleteChatMessage","summary":"Delete a message","description":"This endpoint deletes a message.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerDeleteChatMessageWorkspaceIdPath"}},{"name":"message_id","in":"path","description":"The ID of the specified message.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The message was deleted.","content":{"application/json":{}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions":{"get":{"operationId":"getChatMessageReactions","summary":"Retrieve message reactions","description":"This endpoint retrieves the reactions to a message.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageReactionsWorkspaceIdPath"}},{"name":"message_id","in":"path","description":"The ID of the specified message.","required":true,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"The cursor to use to fetch the next page of results.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of results to fetch for this page.","required":false,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageReactionsLimitQuery"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageReactions200Response"}}}},"404":{"description":"Returns when the specified {messageId} was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true},"post":{"operationId":"createChatReaction","summary":"Create a message reaction","description":"This endpoint creates a message reaction using lower case emoji names.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerCreateChatReactionWorkspaceIdPath"}},{"name":"message_id","in":"path","description":"The ID of the specified message.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentCreateChatReaction"}}}},"responses":{"201":{"description":"The message reaction is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatReaction"}}}},"400":{"description":"Returns when the reaction {reaction} is not supported or already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}},"404":{"description":"Returns when the message {messageId} is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/reactions/{reaction}":{"delete":{"operationId":"deleteChatReaction","summary":"Delete a message reaction","description":"This endpoint deletes a message reaction.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerDeleteChatReactionWorkspaceIdPath"}},{"name":"message_id","in":"path","description":"The ID of the specified message.","required":true,"schema":{"type":"string"}},{"name":"reaction","in":"path","description":"The name of the reaction to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The message reaction was deleted.","content":{"application/json":{}}},"400":{"description":"Returns when the reaction {reaction} is not supported.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}},"404":{"description":"Returns when the message {messageId} or the reaction {reaction} is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/replies":{"get":{"operationId":"getChatMessageReplies","summary":"Retrieve message replies","description":"This endpoint retrieves the replies to a message.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageRepliesWorkspaceIdPath"}},{"name":"message_id","in":"path","description":"The ID of the specified message.","required":true,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"The cursor to use to fetch the next page of results.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of results to fetch for this page.","required":false,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageRepliesLimitQuery"}},{"name":"content_format","in":"query","description":"Format of the message content (Default: text/md).","required":false,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageRepliesContentFormatQuery"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageReplies200Response"}}}},"404":{"description":"Returns when the specified {messageId} was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true},"post":{"operationId":"createReplyMessage","summary":"Create a reply message","description":"This endpoint creates a reply message.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerCreateReplyMessageWorkspaceIdPath"}},{"name":"message_id","in":"path","description":"The ID of the specified message.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentCreateChatMessage"}}}},"responses":{"201":{"description":"The reply message is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentCreateReplyMessageResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/chat/messages/{message_id}/tagged_users":{"get":{"operationId":"getChatMessageTaggedUsers","summary":"Retrieve message tagged users","description":"This endpoint retrieves tagged users for a message.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageTaggedUsersWorkspaceIdPath"}},{"name":"message_id","in":"path","description":"The ID of the specified message.","required":true,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"The cursor to use to fetch the next page of results.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of results to fetch for this page.","required":false,"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageTaggedUsersLimitQuery"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiChatMessagesControllerGetChatMessageTaggedUsers200Response"}}}},"404":{"description":"Returns when the specified {messageId} was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPublicApiErrorResponse"}}}}},"tags":["Chat"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/{entity_type}/{entity_id}/attachments":{"get":{"operationId":"getParentEntityAttachments","summary":"Get Attachments","description":"Return a list of attachments for the specified entity, including a task or File type Custom Field.","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/AttachmentsPublicApiAttachmentsControllerGetParentEntityAttachmentsWorkspaceIdPath"}},{"name":"entity_type","in":"path","description":"The entity type. Options include `attachments` for tasks and `custom_fields` for a File type Custom Field.","required":true,"schema":{"$ref":"#/components/schemas/AttachmentsPublicApiAttachmentsControllerGetParentEntityAttachmentsEntityTypePath"}},{"name":"entity_id","in":"path","description":"The ID of the task or Custom Field.","required":true,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"The cursor to use to fetch the next page of results.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The maximum number of results to fetch for this page.","required":false,"schema":{"$ref":"#/components/schemas/AttachmentsPublicApiAttachmentsControllerGetParentEntityAttachmentsLimitQuery"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentsPublicApiAttachmentsControllerGetParentEntityAttachments200Response"}}}},"400":{"description":"Returns when request was invalid when fetching attachments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentsPublicApiErrorResponse"}}}},"404":{"description":"Returns when {entityId} not found when fetching attachments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentsPublicApiErrorResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentsPublicApiErrorResponse"}}}}},"tags":["Attachments"],"x-is-workspace-endpoint":true},"post":{"operationId":"postEntityAttachment","summary":"Create an Attachment","description":"Upload an attachment to a task or to a file type Custom Field. \\\n \\\nOnce a file has been uploaded to a `custom_fields` entity, use [Set Custom Field Value](ref:SetCustomFieldValue) to associate the uploaded file with a task. \\\n \\\nTo retrieve the ID of a Custom Field, you can use [Get List Custom Fields](red:GetAccessibleCustomFields) or [Get task](ref:GetTask).","parameters":[{"name":"workspace_id","in":"path","description":"The ID of the Workspace.","required":true,"schema":{"$ref":"#/components/schemas/AttachmentsPublicApiAttachmentsControllerPostEntityAttachmentWorkspaceIdPath"}},{"name":"entity_type","in":"path","description":"The entity type. Options include `attachments` for tasks or `custom_fields` for a Files Custom Field.","required":true,"schema":{"$ref":"#/components/schemas/AttachmentsPublicApiAttachmentsControllerPostEntityAttachmentEntityTypePath"}},{"name":"entity_id","in":"path","description":"The ID of the task or Custom Field.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AttachmentsPublicPostAttachmentBodyParamsDto"}}}},"responses":{"200":{"description":"The created attachment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentsAttachment"}}}},"400":{"description":"Returns when {entityType} is not 'custom_fields'","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentsPublicApiErrorResponse"}}}},"404":{"description":"Returns when {entityId} not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentsPublicApiErrorResponse"}}}},"default":{"description":"Generic Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentsPublicApiErrorResponse"}}}}},"tags":["Attachments"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/{object_type}/{object_id}/acls":{"patch":{"operationId":"publicPatchAcl","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.","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserAclPublicControllerPublicPatchAclWorkspaceIdPath"}},{"name":"object_type","in":"path","description":"ObjectType","required":true,"schema":{"$ref":"#/components/schemas/ObjectType"}},{"name":"object_id","in":"path","description":"The ID of the object to share.","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserPatchAclApiRequest"}}}},"responses":{"200":{"description":"","content":{"application/json":{}}}},"tags":["Acls","Privacy and access"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/auditlogs":{"post":{"operationId":"queryAuditLog","summary":"Create Workspace-level audit logs","description":"Create Workspace-level audit logs. Only the Workspace owner can create audit logs. \\\n \\\n***Note:** This endpoint is only available to Workspaces on our [Enterprise Plan](https://clickup.com/pricing).*","parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AutoAuditlogWorkspaceAuditLogPublicControllerQueryAuditLogWorkspaceIdPath"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoAuditlogAuditLogQueryRequest"},"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"}}}}}}},"responses":{"200":{"description":"","content":{"application/json":{}}}},"tags":["Auditlogs","Audit Logs"],"x-is-workspace-endpoint":true}},"/api/v3/workspaces/{workspace_id}/comments/types/{comment_type}/subtypes":{"get":{"operationId":"getSubtypes","summary":"Get Post Subtype IDs","des

# --- truncated at 32 KB (128 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clickup/refs/heads/main/openapi/clickup-public-api-v3-openapi.json