clickup_get_entity_attachments
Retrieve attachments from a task or File-type Custom Field in ClickUp. Paginated with cursor support.
Instructions
List the attachments of a task or File-type Custom Field (v3).
Calls GET /v3/workspaces/{workspace_id}/{entity_type}/{entity_id}/attachments
and returns the page of attachments plus the cursor for the next page.
When to Use:
To enumerate the files attached to a task (entity_type='attachments') or a File Custom Field (entity_type='custom_fields').
When NOT to Use:
To upload a file — use
clickup_create_entity_attachmentorclickup_create_task_attachment.
Returns:
Each attachment's title, id, size, and URL. When more results exist, the
response includes the cursor to pass back as cursor for the next page.
Pagination:
Cursor-based and asymmetric — the request takes cursor, the response
returns next_cursor. Loop: pass the returned next_cursor back as cursor
until it is absent.
Examples:
task:
params = {"workspace_id": "123", "entity_type": "attachments", "entity_id": "abc"}custom field:
params = {"workspace_id": "123", "entity_type": "custom_fields", "entity_id": "fld-1", "limit": 20}
Error Handling:
A 404 means the entity_id was not found — or the v3 attachments surface is
not available on this Workspace at all (verified live on a Business-plan
workspace: even reads 404). If both tools here 404 on ids that definitely
exist, fall back to clickup_create_task_attachment (v2) for task files.
A 400 usually means entity_type and entity_id do not match (e.g. a Custom
Field ID with entity_type='attachments').
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |