Skip to content

List workspace page attachments ​

GET/api/v2/workspaces/{slug}/pages/{page_id}/attachments/

Return the attachments on one wiki page as a paginated list, newest first.

By default, the list holds only confirmed uploads and leaves out any attachment whose upload you requested but never confirmed. Pass is_uploaded to choose. ?is_uploaded=false returns only the unconfirmed ones. Use it to find uploads a client started and didn't finish.

Path Parameters ​

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

page_id:requiredstring (uuid)

The wiki page whose attachments you want. A project page, a page you can't see, and a page in another workspace all return 404.

Query Parameters ​

is_uploaded:optionalboolean

true returns confirmed uploads, false returns unconfirmed ones. When you omit it, the list returns only confirmed uploads.

Ordering ​

order_by:optionalstring

Field to sort by. Prefix with - for descending. Defaults to -created_at.

  • created_at, -created_at
  • id, -id

Pagination ​

per_page:optionalinteger

Page size. Defaults to 50, maximum 200.

offset:optionalinteger

Number of rows to skip from the start of the result set. Maximum 10000. Read the next value from the response rather than computing offsets yourself.

paginate:optionalstring

Set to cursor to opt into the COUNT-free keyset envelope, which returns next_cursor and has_more instead of next and total_count. Omit it for the default offset envelope.

count:optionalboolean

Defaults to true. Set to false to skip the COUNT(*) behind total_count. The field is then omitted from the response.

Response shaping ​

fields:optionalstring

Comma-separated list of fields to return on each row. Unrequested keys are omitted from the response, not returned as null, so absent means "not requested" and null means "actually null". id always comes back whether or not you name it.

Pass all for every requestable field. An unknown name is a 400 that lists the valid set and suggests the closest match, so a typo can't silently cost you the saving.

Requestable here: asset_url, attributes, content_type, created_at, created_by_id, id, is_uploaded, name, page_id, size, updated_at, updated_by_id.

See Sparse fields.

Scopes ​

wiki.pages:read

Errors ​

StatusCodeCause
401unauthorizedMissing or invalid credentials.
402payment_requiredThe feature this endpoint belongs to isn't enabled on your plan, or is switched off.
403forbiddenYour role or token scope can't read this page.
404not_foundNo such wiki page in this workspace, or you can't see it.
406not_acceptableThe Accept header asks for a representation the API can't produce.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
List workspace page attachments
bash
curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/pages/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/attachments/?per_page=50" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "data": [
    {
      "id": "8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13",
      "page_id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
      "name": "architecture-diagram.png",
      "content_type": "image/png",
      "size": 482133.0,
      "attributes": {
        "name": "architecture-diagram.png",
        "type": "image/png",
        "size": 482133
      },
      "asset_url": "/api/assets/v2/workspaces/my-team/projects/None/8f4c2b1e-0d3a-4f7b-9c21-6e5a8b7d4f13/",
      "is_uploaded": true,
      "created_at": "2026-01-14T09:22:41.478363Z",
      "updated_at": "2026-01-14T09:23:05.112907Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    },
    {
      "id": "3b7d9e21-5a4c-4f08-8e63-1c2a9f7b0d54",
      "page_id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
      "name": "q1-roadmap.pdf",
      "content_type": "application/pdf",
      "size": 1048576.0,
      "attributes": {
        "name": "q1-roadmap.pdf",
        "type": "application/pdf",
        "size": 1048576
      },
      "asset_url": "/api/assets/v2/workspaces/my-team/projects/None/3b7d9e21-5a4c-4f08-8e63-1c2a9f7b0d54/",
      "is_uploaded": true,
      "created_at": "2026-01-13T16:04:02.911204Z",
      "updated_at": "2026-01-13T16:04:19.537720Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}