Brandfolder

App · 20 actions

Add, update and organize brand assets in Brandfolder: assets, collections, tags and custom fields.

Actions

ActionWhat it does
Add custom field to assetGive an asset a value for one of the Brandfolder's custom fields.
Add tags to assetAdd one or more tags to an asset.
Create assetAdd an asset to a Brandfolder from a file at a public link.
Create collectionCreate a collection in a Brandfolder, to group and share a set of its assets.
Delete assetDelete an asset and all of its files.
Delete collectionDelete a collection.
Get assetGet an asset's name, description and approval, and optionally its files, tags and custom fields.
Get attachmentGet one of an asset's files: its name, type, size, dimensions and download link.
Get collectionGet a collection's name, tagline and sharing settings.
List asset custom fieldsList an asset's custom fields and their values.
List assetsList the assets in a Brandfolder, or only those in one of its collections, sections or labels.
List BrandfoldersList the Brandfolders your account can open.
List collectionsList the collections in a Brandfolder.
List custom fieldsList the custom fields set up for a Brandfolder, with the values each one allows.
List sectionsList the sections of a Brandfolder.
Remove custom field from assetRemove one of an asset's custom field values.
Remove tags from assetRemove tags from an asset.
Update assetChange an asset's name, description, approval or dates, or add a file to it.
Update asset custom fieldChange the value of one of an asset's custom fields.
Update collectionRename a collection or change its tagline.

Add custom field to asset

Give an asset a value for one of the Brandfolder's custom fields.

Inputs

Brandfolderbrandfolder_idtext
The Brandfolder the asset is in. Choosing it lists its assets to pick from.
Custom fieldcustom_field_key_idtextRequired
The custom field to fill in.
Assetasset_idtextRequired
The asset to use.
ValuevaluetextRequired
The value to give the asset.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": [
      {
        "attributes": {
          "key": "example",
          "value": "example"
        },
        "id": "example",
        "type": "example"
      }
    ]
  }
}

Add tags to asset

Add one or more tags to an asset. Its existing tags stay.

Inputs

Brandfolderbrandfolder_idtext
The Brandfolder the asset is in. Choosing it lists its assets to pick from.
Assetasset_idtextRequired
The asset to use.
TagstagslistRequired
The tags to add, one per entry.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": [
      {
        "attributes": {
          "auto_generated": true,
          "name": "example"
        },
        "id": "example",
        "type": "example"
      }
    ],
    "meta": {
      "current_page": 1,
      "next_page": 1,
      "prev_page": 1,
      "total_count": 1,
      "total_pages": 1
    }
  }
}

Create asset

Add an asset to a Brandfolder from a file at a public link. Brandfolder finishes processing the file shortly after the step.

Inputs

Brandfolderbrandfolder_idtextRequired
The Brandfolder to use.
Sectionsection_idtextRequired
The section of the Brandfolder new assets go in. Assets are created in a section, and each section holds one kind of asset, such as files or fonts.
Collectioncollection_idtext
Also add the asset to this collection.
NamenametextRequired
The asset's name.
Descriptiondescriptiontext
A description of the asset.
Approvedapprovedtrue/false
Whether the asset is approved for use.
Available fromavailable_fromdate and time
When the asset is published. Until then Brandfolder shows it as a draft.
Available untilavailable_untildate and time
When the asset expires. After this Brandfolder shows it as expired.
File linkfile_urltext
A public link to the file. Brandfolder downloads it from there, so the link must work without signing in.
File namefilenametext
The file's name, with its extension (for example `logo.png`). Leave empty to use the name in the link.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": [
      {
        "attributes": {
          "approved": true,
          "created_at": "example",
          "description": "example",
          "name": "example",
          "thumbnail_url": "example",
          "updated_at": "example"
        },
        "id": "example",
        "type": "example"
      }
    ]
  }
}

Create collection

Create a collection in a Brandfolder, to group and share a set of its assets.

Inputs

Brandfolderbrandfolder_idtextRequired
The Brandfolder to use.
NamenametextRequired
The collection's name. Brandfolder makes its link from it.
Taglinetaglinetext
A short line describing the collection.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "is_workspace": true,
        "name": "example",
        "public": true,
        "slug": "example",
        "stealth": true,
        "tagline": "example"
      },
      "id": "example",
      "type": "example"
    }
  }
}

Delete asset

Delete an asset and all of its files.

Inputs

Brandfolderbrandfolder_idtext
The Brandfolder the asset is in. Choosing it lists its assets to pick from.
Assetasset_idtextRequired
The asset to use.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {}
}

Delete collection

Delete a collection. Its assets stay in the Brandfolder.

Inputs

Collectioncollection_idtextRequired
The collection to use.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {}
}

Get asset

Get an asset's name, description and approval, and optionally its files, tags and custom fields.

Inputs

Brandfolderbrandfolder_idtext
The Brandfolder the asset is in. Choosing it lists its assets to pick from.
Assetasset_idtextRequired
The asset to use.
Extra detailsextra_detailslist
Extra details to return with each asset, such as when it was created or its public link. Each one can slow the answer down.One or more of: created_at (Created at), updated_at (Updated at), cdn_url (Cdn url), availability.
Also returnrelatedlist
Related records to return with the asset, listed under `included`.One or more of: attachments, tags, custom_fields (Custom fields), section, collections, brandfolder.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "approved": true,
        "created_at": "example",
        "description": "example",
        "name": "example",
        "thumbnail_url": "example",
        "updated_at": "example"
      },
      "id": "example",
      "type": "example"
    },
    "included": [
      {}
    ]
  }
}

Get attachment

Get one of an asset's files: its name, type, size, dimensions and download link.

Inputs

Brandfolderbrandfolder_idtext
The Brandfolder the asset is in. Choosing it lists its assets to pick from.
Assetasset_idtext
The asset the record belongs to. Choosing it lists its records to pick from.
Fileattachment_idtextRequired
The file to get.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "extension": "example",
        "filename": "example",
        "height": 1,
        "mimetype": "example",
        "size": 1,
        "thumbnail_url": "example",
        "url": "example",
        "width": 1
      },
      "id": "example",
      "type": "example"
    }
  }
}

Get collection

Get a collection's name, tagline and sharing settings.

Inputs

Collectioncollection_idtextRequired
The collection to use.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "is_workspace": true,
        "name": "example",
        "public": true,
        "slug": "example",
        "stealth": true,
        "tagline": "example"
      },
      "id": "example",
      "type": "example"
    }
  }
}

List asset custom fields

List an asset's custom fields and their values.

Inputs

Brandfolderbrandfolder_idtext
The Brandfolder the asset is in. Choosing it lists its assets to pick from.
Assetasset_idtextRequired
The asset to use.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": [
      {
        "attributes": {
          "key": "example",
          "value": "example"
        },
        "id": "example",
        "type": "example"
      }
    ],
    "meta": {
      "current_page": 1,
      "next_page": 1,
      "prev_page": 1,
      "total_count": 1,
      "total_pages": 1
    }
  }
}

List assets

List the assets in a Brandfolder, or only those in one of its collections, sections or labels. Use Page to read past the first page.

Inputs

Brandfolderbrandfolder_idtextRequired
The Brandfolder to use.
Collectioncollection_idtext
Only list assets in this collection.
Sectionsection_idtext
Only list assets in this section.
Labellabel_idtext
Only list assets with this label. Labels aren't turned on for every Brandfolder account.
Searchsearchtext
Only list assets that match this search, written as you would in Brandfolder's search bar (for example `extension:png`).
Extra detailsextra_detailslist
Extra details to return with each asset, such as when it was created or its public link. Each one can slow the answer down.One or more of: created_at (Created at), updated_at (Updated at), cdn_url (Cdn url), availability.
Pagepagenumber
Which page of results to return, starting at 1.At least 1.
Assets per pageper_pagenumber
How many assets to return on each page, up to 3000. Brandfolder returns 100 if left empty.From 1 to 3000.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": [
      {
        "attributes": {
          "approved": true,
          "created_at": "example",
          "description": "example",
          "name": "example",
          "thumbnail_url": "example",
          "updated_at": "example"
        },
        "id": "example",
        "type": "example"
      }
    ],
    "meta": {
      "current_page": 1,
      "next_page": 1,
      "prev_page": 1,
      "total_count": 1,
      "total_pages": 1
    }
  }
}

List Brandfolders

List the Brandfolders your account can open.

Inputs

Searchsearchtext
Only list Brandfolders that match these search words.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": [
      {
        "attributes": {
          "name": "example",
          "privacy": "example",
          "slug": "example",
          "tagline": "example"
        },
        "id": "example",
        "type": "example"
      }
    ],
    "meta": {
      "current_page": 1,
      "next_page": 1,
      "prev_page": 1,
      "total_count": 1,
      "total_pages": 1
    }
  }
}

List collections

List the collections in a Brandfolder.

Inputs

Brandfolderbrandfolder_idtextRequired
The Brandfolder to use.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": [
      {
        "attributes": {
          "is_workspace": true,
          "name": "example",
          "public": true,
          "slug": "example",
          "stealth": true,
          "tagline": "example"
        },
        "id": "example",
        "type": "example"
      }
    ],
    "meta": {
      "current_page": 1,
      "next_page": 1,
      "prev_page": 1,
      "total_count": 1,
      "total_pages": 1
    }
  }
}

List custom fields

List the custom fields set up for a Brandfolder, with the values each one allows.

Inputs

Brandfolderbrandfolder_idtextRequired
The Brandfolder to use.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": [
      {
        "attributes": {
          "allowed_values": [
            "example"
          ],
          "name": "example",
          "position": 1,
          "prioritized": true,
          "required": true,
          "restricted": true
        },
        "id": "example",
        "type": "example"
      }
    ],
    "meta": {
      "current_page": 1,
      "next_page": 1,
      "prev_page": 1,
      "total_count": 1,
      "total_pages": 1
    }
  }
}

List sections

List the sections of a Brandfolder. Every asset belongs to one section.

Inputs

Brandfolderbrandfolder_idtextRequired
The Brandfolder to use.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": [
      {
        "attributes": {
          "default_asset_type": "example",
          "name": "example",
          "position": 1
        },
        "id": "example",
        "type": "example"
      }
    ],
    "meta": {
      "current_page": 1,
      "next_page": 1,
      "prev_page": 1,
      "total_count": 1,
      "total_pages": 1
    }
  }
}

Remove custom field from asset

Remove one of an asset's custom field values.

Inputs

Brandfolderbrandfolder_idtext
The Brandfolder the asset is in. Choosing it lists its assets to pick from.
Assetasset_idtext
The asset the record belongs to. Choosing it lists its records to pick from.
Custom fieldcustom_field_value_idtextRequired
The custom field value to remove.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {}
}

Remove tags from asset

Remove tags from an asset. Brandfolder removes them in the background, so they can take a moment to disappear.

Inputs

Brandfolderbrandfolder_idtext
The Brandfolder the asset is in. Choosing it lists its assets to pick from.
Assetasset_idtextRequired
The asset to remove tags from.
TagstagslistRequired
The tags to remove.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {}
}

Update asset

Change an asset's name, description, approval or dates, or add a file to it. Fields left empty keep their current values.

Inputs

Brandfolderbrandfolder_idtext
The Brandfolder the asset is in. Choosing it lists its assets to pick from.
Assetasset_idtextRequired
The asset to use.
Namenametext
The asset's name.
Descriptiondescriptiontext
A description of the asset.
Approvedapprovedtrue/false
Whether the asset is approved for use.
Available fromavailable_fromdate and time
When the asset is published. Until then Brandfolder shows it as a draft.
Available untilavailable_untildate and time
When the asset expires. After this Brandfolder shows it as expired.
File linkfile_urltext
A public link to the file. Brandfolder downloads it from there, so the link must work without signing in.
File namefilenametext
The file's name, with its extension (for example `logo.png`). Leave empty to use the name in the link.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "approved": true,
        "created_at": "example",
        "description": "example",
        "name": "example",
        "thumbnail_url": "example",
        "updated_at": "example"
      },
      "id": "example",
      "type": "example"
    }
  }
}

Update asset custom field

Change the value of one of an asset's custom fields.

Inputs

Brandfolderbrandfolder_idtext
The Brandfolder the asset is in. Choosing it lists its assets to pick from.
Assetasset_idtext
The asset the record belongs to. Choosing it lists its records to pick from.
Custom fieldcustom_field_value_idtextRequired
The custom field value to change.
ValuevaluetextRequired
The new value.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": [
      {
        "attributes": {
          "key": "example",
          "value": "example"
        },
        "id": "example",
        "type": "example"
      }
    ],
    "meta": {
      "current_page": 1,
      "next_page": 1,
      "prev_page": 1,
      "total_count": 1,
      "total_pages": 1
    }
  }
}

Update collection

Rename a collection or change its tagline. Fields left empty keep their current values.

Inputs

Collectioncollection_idtextRequired
The collection to use.
Namenametext
The collection's new name.
Taglinetaglinetext
The collection's new tagline.

Outputs

dataobject
The response from Brandfolder.
Example output
{
  "data": {
    "data": {
      "attributes": {
        "is_workspace": true,
        "name": "example",
        "public": true,
        "slug": "example",
        "stealth": true,
        "tagline": "example"
      },
      "id": "example",
      "type": "example"
    }
  }
}

On this page