v1

latestOpenAPI 3.0.32026-08-067332206.6 KB

attachments

Fetch an attachment

Gets the matching attachment.

get/attachments/{attachment_id}

Query parameters

fieldsstring

Set it to a comma-separated list (no spaces) of any of the following attributes of the attachment to return as part of the attachment's attributes in the response.

Allowed values:

metadata
thumbnail_url
view_thumbnail_retina
extension
version_count
tag_names
label_names

WARNING: This parameter can slow response times.

includestring

Set it to a comma-separated list (no spaces) of any of the following record names to return those records related to the attachment you're fetching. Related records are returned in an included array in the response.

Allowed values:

asset
section
brandfolder
collections
tags
labels

WARNING: This parameter can slow response times.

Headers

Accept'application/json' required

Response

The matching attachment.

Example response

{
  "data": {
    "id": "oqgkkd-fr3j84-33j7db",
    "attributes": {
      "mimetype": "image/png",
      "extension": "png",
      "filename": "brandfolder_logo.png",
      "size": 123456,
      "width": 1920,
      "height": 1080,
      "url": "https://some_domain.com/brandfolder_logo.png?expiry=1625260667",
      "thumbnail_url": "https://some_domain.com/some_thumbnail.png"
    }
  }
}