---
title: "Get attachments"
method: GET
path: "/attachments"
tags: ["Attachment"]
---

# Get attachments

`GET /attachments`

Returns all attachments. The number of results is limited by the `limit` parameter and additional results (if available)
will be available through the `next` URL present in the `Link` response header.

**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the container of the attachment.

## Query parameters

- `sort` 'created-date' | '-created-date' | 'modified-date' | '-modified-date' — The sort fields for attachments. The default sort direction is ascending. To sort in descending order, append a `-` character before the sort field. For example, `fieldName` or `-fieldName`.
- `cursor` string
- `status` string[]
- `mediaType` string
- `filename` string
- `limit` integer

## Response `200`

Returned if the requested attachments are returned.

- object
  - `results` AttachmentBulk[]
    - `id` string — ID of the attachment.
    - `status` 'current' | 'draft' | 'archived' | 'historical' | 'trashed' | 'deleted' | 'any' — The status of the content.
    - `title` string — Title of the comment.
    - `createdAt` string, date-time — Date and time when the attachment was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".
    - `pageId` string — ID of the containing page. Note: This is only returned if the attachment has a container that is a page.
    - `blogPostId` string — ID of the containing blog post. Note: This is only returned if the attachment has a container that is a blog post.
    - `customContentId` string — ID of the containing custom content. Note: This is only returned if the attachment has a container that is custom content.
    - `mediaType` string — Media Type for the attachment.
    - `mediaTypeDescription` string — Media Type description for the attachment.
    - `comment` string — Comment for the attachment.
    - `fileId` string — File ID of the attachment. This is the ID referenced in `atlas_doc_format` bodies and is distinct from the attachment ID.
    - `fileSize` integer — File size of the attachment.
    - `webuiLink` string — WebUI link of the attachment.
    - `downloadLink` string — Download link of the attachment.
    - `version` Version
      - `createdAt` string, date-time — Date and time when the version was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".
      - `message` string — Message associated with the current version.
      - `number` integer — The version number.
      - `minorEdit` boolean — Describes if this version is a minor version. Email notifications and activity stream updates are not created for minor versions.
      - `authorId` string — The account ID of the user who created this version.
    - `_links` AttachmentLinks
      - `webui` string — Web UI link of the content.
      - `download` string — Download link of the content.
  - `_links` MultiEntityLinks
    - `next` string — Used for pagination. Contains the relative URL for the next set of results, using a cursor query parameter. This property will not be present if there is no additional data available.
    - `base` string — Base url of the Confluence site.

## Other responses

- `400` — Returned if an invalid request is provided.
- `401` — Returned if the authentication credentials are incorrect or missing from the request.

---

[API](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api-v2.md) · [All operations](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-confluence-cloud-rest-api-v2/revisions/c4bd1ed570f2/schema)