v1

latestOpenAPI 3.0.32026-08-067332206.6 KB
assets
collections

List assets in a collection

Lists assets in a collection.

get/collections/{collection_id}/assets

Query parameters

pageinteger

Set this to a positive, non-zero integer representing the page number of the results you want.

perinteger

Set this pagination parameter to the maximum number of results you want to receive back from your request. More records may exist (as denoted by the meta.total_count value).

searchstring

Set it to any URL-encoded query to fetch only assets that match your criteria.

WARNING: This parameter can slow response times.

fieldsstring

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

Allowed values:

  • created_at
  • updated_at
  • cdn_url
  • availability

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 asset you're fetching. Related records are returned in an included array in the response.

Allowed values:

  • attachments
  • brandfolder
  • collections
  • custom_fields
  • section
  • tags

WARNING: This parameter can slow response times.

Response

The matching collection assets.

Example response

{
  "data": [
    {
      "id": "oqgkkd-fr5iv4-443db",
      "attributes": {
        "name": "Brandfolder Logo",
        "description": "Brandfolder's logo in print ready format",
        "thumbnail_url": "https://example.com/example.jpg?Expires=1624742369",
        "approved": true
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1
  }
}