v1

latestOpenAPI 3.0.32026-08-067332206.6 KB
brandfolders

List Brandfolders

Lists all Brandfolders for a User. Unauthorized requests will return an empty list.

You can use the returned slug attribute to form a link to the desired Brandfolder like so:

https://brandfolder.com/{slug}
get/brandfolders

Query parameters

fieldsstring

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

Allowed values:

  • asset_count
  • attachment_count
  • storage

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

Allowed values:

  • organization
  • collections
  • assets

WARNING: This parameter can slow response times.

searchstring

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

WARNING: This parameter can slow response times.

Response

References to all the user's Brandfolders.

Example response

{
  "data": [
    {
      "id": "oqgiju-21olts-ce9egi",
      "attributes": {
        "name": "Brandfolder",
        "privacy": "private",
        "slug": "brandfolder",
        "tagline": "You expected this - Brandfolder's Brandfolder!"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1
  }
}
All 73 operations