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. Use the next value from the response instead of computing offsets yourself.

paginate:optionalstring

Set to cursor to switch to the keyset envelope, which skips the COUNT query and returns next_cursor and has_more instead of next and total_count. Leave it out to get 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. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.

Pass all to get every requestable field. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.

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

Status	Code	Cause
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan, or is switched off.
403	forbidden	Your role or token scope can't read this page.
404	not_found	No such wiki page in this workspace, or you can't see it.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

List workspace page attachments

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"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/pages/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/attachments/",
    headers={"X-Api-Key": "your-api-key"},
    params={"per_page": 50},
)
print(response.json())

const params = new URLSearchParams({ per_page: "50" });
const response = await fetch(
  `https://api.plane.so/api/v2/workspaces/my-team/pages/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/attachments/?${params}`,
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "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"
  }
}