Skip to content

Retrieve workspace page attachment metadata

GET/api/v1/workspaces/{workspace_slug}/pages/{page_id}/attachments/{attachment_id}/

Retrieve metadata and links for an existing workspace page attachment. The caller must be able to view the page.

Path Parameters

workspace_slug:requiredstring

The workspace's unique slug.

page_id:requiredstring

The workspace page UUID.

attachment_id:requiredstring

The attachment asset UUID.

Scopes

read or wiki.pages:read

Retrieve attachment metadata
bash
curl -X GET "https://api.plane.so/api/v1/workspaces/my-workspace/pages/page-uuid/attachments/attachment-uuid/" -H "X-API-Key: $PLANE_API_KEY"
Response200
json
{
  "id": "attachment-uuid",
  "page_id": "page-uuid",
  "name": "diagram.png",
  "type": "image/png",
  "size": 24576,
  "is_uploaded": true,
  "asset_url": "https://api.plane.so/api/v1/workspaces/my-workspace/pages/page-uuid/attachments/attachment-uuid/",
  "_links": {
    "download": "https://api.plane.so/api/v1/workspaces/my-workspace/pages/page-uuid/attachments/attachment-uuid/download/"
  }
}