Brandfolder API - Version 2

Overview

The Brandfolder API provides access to resources available on Brandfolder.com to provide programmatic access in order to provide additional feature and more complex workflow that may not be available as part of the core web application.

Authorization

All requests must be authorized to the API. Failure to authorizer a request will result in a 401 Not Authorized response. Authorization must be provided via an obtained User Token and passed via HTTP header or query parameter.

User Tokens

Each request identifies a single user and each request will take an action based on the user of the request. User tokens are static and will only change if the user changes their password.

Obtaining a token

User tokens can be obtained by visiting User Settings on Brandfolder.com.

Token Header Request

Token header requests must be specified using the Authorization header using JWT as the type.

GET https://api.brandfolder.com/v2/organizations HTTP/1.1
Accept: application/vnd.api+json
Authorization: JWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2tleSI6IjMyeHp0MnBmIn0.6P3XJLDt1lqKIdor0bxCy2q3KQL_2RAv998iMIo0vfw

Token Param

Token param requests must be specified using the api-token query parameter.

GET https://api.brandfolder.com/v2/organizations?api-token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2tleSI6IjMyeHp0MnBmIn0.6P3XJLDt1lqKIdor0bxCy2q3KQL_2RAv998iMIo0vfw HTTP/1.1
Accept: application/vnd.api+json

Rate Limiting

Defaults

By default, all users are rate limited to 50 calls per hour. Organization can purchase an API enabled enterprise plan to acquire more calls. For more information Get A Quote.

Rate Limit Headers

  • X-RateLimit-Limit: The total allowed calls per hour.
  • X-RateLimit-Remaining: The remaining API calls, each call will expire in an hour and be reallocated to your remaining count.

Example Workflows

Uploading Assets

The following examples show you all the steps to add an asset programatically to an existing Brandfolder.

To an existing Brandfolder (with attachments)

  1. List your Brandfolders.
  2. Locate the desired brandfolders's url in data[#].links.self.
  3. GET the Brandfolder by it's id.
  4. Locate the brandfolder's sections related link in data.relationships.assets.links.related. (A section with the default_asset_type of GenericFile will support attachments.
  5. List a Brandfolder's Sections using the link acquired above.
  6. Locate the section's url in data[#].links.self.
  7. GET the Section by it's id.
  8. Locate the sections's assets related link in data.relationships.assets.links.related.
  9. POST a new asset to the related url.
  10. Locate the related link for the newly created asset's attachments in data.relationships.attachments.links.related.
  11. POST a new attachment to the related url.

To an existing Brandfolder (with asset_data)

Refer to Assets for supported asset_data.

  1. List your Brandfolders.
  2. Locate the desired brandfolders's url in data[#].links.self.
  3. GET the Brandfolder by it's id.
  4. Locate the brandfolder's sections related link in data.relationships.assets.links.related. (A section with the default_asset_type of Person will suppor asset data.
  5. List a Brandfolder's Sections using the link acquired above.
  6. Locate the section's url in data[#].links.self.
  7. GET the Section by it's id.
  8. Locate the sections's assets related link in data.relationships.assets.links.related.
  9. POST a new asset to the related url. Refer to to determine which asset data fields the type supports.

Resources

Organizations

Organizations are the primary account on Brandfolder.com. Each Organization can be assigned different access rights that give users the ability to administer, collaborate, and view settings and/or assets on the Organization. Users with permissions on Organizations will have access to all Brandfolders and Collections within the account

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: name

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • branded_login_image String

    optional

    The image for the organizations branded login.

    Allowed: read

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • download_zip_url String

    optional

    The url to download a zip of all the assets

    Allowed: read

  • name String

    optional

    The name of the Organization.

    Allowed: read and write

  • number_of_brandfolders Integer

    optional

    The number of brandfolders.

    Allowed: read

  • number_of_users Integer

    optional

    The number of users.

    Allowed: read

  • plan_name String

    optional

    The plan name for the organization

    Allowed: read

  • slug String

    required: true

    The url of the organization on Brandfolder.com.

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Organizations

Request
GET /v2/organizations HTTP/1.1
Accept: application/vnd.api+json

List User’s Organizations

Request
GET /v2/users/:id/organizations HTTP/1.1
Accept: application/vnd.api+json

Read Organizations

Request
GET /v2/organizations/:id HTTP/1.1
Accept: application/vnd.api+json

Read Brandfolder’s Organization

Request
GET /v2/brandfolders/:id/organization HTTP/1.1
Accept: application/vnd.api+json

Read Adobe Integration’s Organization

Request
GET /v2/adobe_integrations/:id/organization HTTP/1.1
Accept: application/vnd.api+json

Read Asset’s Organization

Request
GET /v2/assets/:id/organization HTTP/1.1
Accept: application/vnd.api+json

Read Collection’s Organization

Request
GET /v2/collections/:id/organization HTTP/1.1
Accept: application/vnd.api+json

Read Plan’s Organization

Request
GET /v2/plans/:id/organization HTTP/1.1
Accept: application/vnd.api+json

Update Organizations

Request
PATCH /v2/organizations/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Show Brandfolder’s Organization

Request
GET /v2/brandfolders/:id/relationships/organization HTTP/1.1
Accept: application/vnd.api+json

Show User’s Organizations

Request
GET /v2/users/:id/relationships/organizations HTTP/1.1
Accept: application/vnd.api+json

Show Adobe Integration’s Organization

Request
GET /v2/adobe_integrations/:id/relationships/organization HTTP/1.1
Accept: application/vnd.api+json

Show Asset’s Organization

Request
GET /v2/assets/:id/relationships/organization HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Organization

Request
GET /v2/collections/:id/relationships/organization HTTP/1.1
Accept: application/vnd.api+json

Show Plan’s Organization

Request
GET /v2/plans/:id/relationships/organization HTTP/1.1
Accept: application/vnd.api+json

Brandfolders

Brandfolder's are containers that house all your companies digital assets. Each Brandfolder can be assigned different access rights that give users the ability to administer, collaborate, and view settings and/or assets on the Brandfolder.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: name

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

  • search[query]

    optional

Attributes

  • card_image String

    optional

    The image of the Brandfolder that shows up on the organization page

    Allowed: read

  • controlled_custom_fields_enabled Boolean

    optional

    A boolean to determine whether custom fields are controlled or not.

    Allowed: read and write

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • download_zip_url String

    optional

    The url to download a zip of all the assets

    Allowed: read

  • enable_simple_password Boolean

    optional

    Enable a password for the Brandfolder to allow guests to access it without logging in.

    Allowed: read and write

  • google_analytics_id String

    optional

    The Google Analytics Id tied to the Brandfolder.

    Allowed: write

  • header_image String

    optional

    The header image of the Brandfolder

    Allowed: read

  • key String

    optional

    The api key of the Brandfolder

    Allowed: read and write

  • name String

    required: true

    The name of the Brandfolder.

    Allowed: read and write

  • number_of_assets Integer

    optional

    The number of assets.

    Allowed: read

  • number_of_attachments Integer

    optional

    The number of attachments.

    Allowed: read

  • number_of_collections Integer

    optional

    The number of collections.

    Allowed: read

  • number_of_users Integer

    optional

    The number of users.

    Allowed: read

  • password String

    optional

    The value of the Brandfolder's password.

    Allowed: write

  • private Boolean

    optional

    The boolean signifying if a Brandfolder is private.

    Allowed: read and write

  • public Boolean

    optional

    The boolean signifying if a Brandfolder is public.

    Allowed: read and write

  • request_access_enabled Boolean

    optional

    A boolean set to notify admins of the Brandfolder.

    Allowed: read and write

  • request_access_prompt String

    optional

    Prompts the user for information when requesting access.

    Allowed: read and write

  • slug String

    optional

    The url of the Brandfolder on Brandfolder.com

    Allowed: read and write

  • stealth Boolean

    optional

    The integer signifying if a Brandfolder is stealth.

    Allowed: read and write

  • tagline String

    optional

    The tagline of the Brandfolder.

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

  • whitelisted_domains Array

    optional

    The whitelisted domains tied to a Brandfolder.

    Allowed: read and write

Relationships

List Brandfolders

Request
GET /v2/brandfolders HTTP/1.1
Accept: application/vnd.api+json

List User’s Brandfolders

Request
GET /v2/users/:id/brandfolders HTTP/1.1
Accept: application/vnd.api+json

List Organization’s Brandfolders

Request
GET /v2/organizations/:id/brandfolders HTTP/1.1
Accept: application/vnd.api+json

Create Organization’s Brandfolders

Request
POST /v2/organizations/:id/brandfolders HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read Brandfolders

Request
GET /v2/brandfolders/:id HTTP/1.1
Accept: application/vnd.api+json

Read Search Filter’s Brandfolder

Request
GET /v2/search_filters/:id/brandfolder HTTP/1.1
Accept: application/vnd.api+json
Request
GET /v2/social_links/:id/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Read Section’s Brandfolder

Request
GET /v2/sections/:id/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Read Access Request’s Brandfolder

Request
GET /v2/access_requests/:id/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Read Asset’s Brandfolder

Request
GET /v2/assets/:id/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Read Collection Section’s Brandfolder

Request
GET /v2/collection_sections/:id/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Read Collection’s Brandfolder

Request
GET /v2/collections/:id/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Read Custom Field Key’s Brandfolder

Request
GET /v2/custom_field_keys/:id/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Read Search Filter Section’s Brandfolder

Request
GET /v2/search_filter_sections/:id/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Update Brandfolders

Request
PATCH /v2/brandfolders/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Delete Brandfolders

Request
DELETE /v2/brandfolders/:id HTTP/1.1
Accept: application/vnd.api+json

Show Search Filter’s Brandfolder

Request
GET /v2/search_filters/:id/relationships/brandfolder HTTP/1.1
Accept: application/vnd.api+json
Request
GET /v2/social_links/:id/relationships/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Show User’s Brandfolders

Request
GET /v2/users/:id/relationships/brandfolders HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Brandfolders

Request
GET /v2/organizations/:id/relationships/brandfolders HTTP/1.1
Accept: application/vnd.api+json

Show Section’s Brandfolder

Request
GET /v2/sections/:id/relationships/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Show Access Request’s Brandfolder

Request
GET /v2/access_requests/:id/relationships/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Show Asset’s Brandfolder

Request
GET /v2/assets/:id/relationships/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Show Collection Section’s Brandfolder

Request
GET /v2/collection_sections/:id/relationships/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Brandfolder

Request
GET /v2/collections/:id/relationships/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Show Custom Field Key’s Brandfolder

Request
GET /v2/custom_field_keys/:id/relationships/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Show Search Filter Section’s Brandfolder

Request
GET /v2/search_filter_sections/:id/relationships/brandfolder HTTP/1.1
Accept: application/vnd.api+json

Collections

Collections are slices of assets in a specific Brandfolder. Every user of the Collection's Brandfolder will have access to the collection. In addition each Brandfolder can be assigned different access rights that give users the ability to administer, collaborate, and view settings and/or assets on the Collection.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: name

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • download_zip_url String

    optional

    The url to download a zip of all the assets

    Allowed: read

  • name String

    required: true

    The name of the Collection.

    Allowed: read and write

  • number_of_assets Integer

    optional

    The number of assets.

    Allowed: read

  • number_of_users Integer

    optional

    The number of users.

    Allowed: read

  • options Object

    optional

    The options for the Collection include data about the header image.

    Allowed: read and write

  • private Boolean

    optional

    The boolean signifying if a Collection is private.

    Allowed: read and write

  • public Boolean

    optional

    The boolean signifying if a Collection is public.

    Allowed: read and write

  • slug String

    optional

    The url of the Collection on Brandfolder.com.

    Allowed: read and write

  • stealth Boolean

    optional

    The integer signifying if a Collection is stealth.

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List User’s Collections

Request
GET /v2/users/:id/collections HTTP/1.1
Accept: application/vnd.api+json

List Asset’s Collections

Request
GET /v2/assets/:id/collections HTTP/1.1
Accept: application/vnd.api+json

List Brandfolder’s Collections

Request
GET /v2/brandfolders/:id/collections HTTP/1.1
Accept: application/vnd.api+json

Create Brandfolder’s Collections

Request
POST /v2/brandfolders/:id/collections HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read Collections

Request
GET /v2/collections/:id HTTP/1.1
Accept: application/vnd.api+json

Read Collection Section’s Collection

Request
GET /v2/collection_sections/:id/collection HTTP/1.1
Accept: application/vnd.api+json

Update Collections

Request
PATCH /v2/collections/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Delete Collections

Request
DELETE /v2/collections/:id HTTP/1.1
Accept: application/vnd.api+json

Add Asset’s Collections

Request
POST /v2/assets/:id/relationships/collections HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Asset’s Collections

Request
DELETE /v2/assets/:id/relationships/collections HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Show User’s Collections

Request
GET /v2/users/:id/relationships/collections HTTP/1.1
Accept: application/vnd.api+json

Show Collection Section’s Collection

Request
GET /v2/collection_sections/:id/relationships/collection HTTP/1.1
Accept: application/vnd.api+json

Show Asset’s Collections

Request
GET /v2/assets/:id/relationships/collections HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Collections

Request
GET /v2/brandfolders/:id/relationships/collections HTTP/1.1
Accept: application/vnd.api+json

Sections

Sections are visual asset containers that provide a static grouping of assets within the Brandfolder.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: position

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • default_asset_type String

    required: true

    The type of the assets that populate the section: GenericFile, ExternalMedium, Person, Press, Font, Color, Text.

    Allowed: read and write

  • download_zip_url String

    optional

    The url to download a zip of all the assets

    Allowed: read

  • name String

    required: true

    The name of the Section.

    Allowed: read and write

  • number_of_assets Integer

    optional

    The number of assets.

    Allowed: read

  • position Integer

    optional

    The position of the section in the Brandfolder.

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Brandfolder’s Sections

Request
GET /v2/brandfolders/:id/sections HTTP/1.1
Accept: application/vnd.api+json

Create Brandfolder’s Sections

Request
POST /v2/brandfolders/:id/sections HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read Sections

Request
GET /v2/sections/:id HTTP/1.1
Accept: application/vnd.api+json

Read Asset’s Section

Request
GET /v2/assets/:id/section HTTP/1.1
Accept: application/vnd.api+json

Update Sections

Request
PATCH /v2/sections/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Delete Sections

Request
DELETE /v2/sections/:id HTTP/1.1
Accept: application/vnd.api+json

Show Asset’s Section

Request
GET /v2/assets/:id/relationships/section HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Sections

Request
GET /v2/brandfolders/:id/relationships/sections HTTP/1.1
Accept: application/vnd.api+json

Assets

Assets are the containers that hold your companies digital assets and the metadata that surrounds them. Depending on the asset type, you may either provide an attachment (for GenericFiles) or correlating asset data (for Person, Color, Press, and ExternalMedia).

Asset Data Fields

Each type supports different asset data. Refer to the table below to see what asset_data fields each type supports. asset_type | supported fields ---|--- GenericFile | NONE Color | hex, c, m, y, k, r, g, b, pantone, pantone_u Font | family, family_html_safe, web_font_id, other_font_id, web_font_type, variant, weight ExternalMedium | url, embed_code, thumbnail, embedlyed Person | bio, title, phone_number, email, linkedin, twitter Press | url, published_date, element_thumb_key, view_thumb_key Text | NONE Template | NONE

Searching

Brandfolder's API supports both simple and advanced search capabilities. Assets can be searched using the search[query] url parameter on the index action. Refer to the fields and methods below to learn how to build various queries.

Search Fields

The following fields are searchable for an asset. By default all fields will use {field_name}:"{value}" in the query to search on a specific field. * The following aliases will also resolve to the above fields. * section (alias for section_name) * category (alias for section_name) * ext (alias for extensions) * extension (alias for extensions) * filetype (alias for extensions) * filename (alias for filenames) * tag (alias for tag_names) * tags (alias for tag_names) * comments (alias for has_comments) * collection (alias for collection_names) * asset_data (alias for data)

Deep Object Fields

Some fields may be objects, to search within them use dot notation. ex: asset_type:Color AND asset_data.hex:ff9900.

Composite/Complex Searches

Searches can be combined by using OR and AND and by wrapping subqueries in parenthesis. (Note: Advanced Search Queries SHOULD be prefixed with ::) Example: text ::(asset_type:Color AND asset_data.hex:ff9900) OR (asset_type:GenericFile AND metadata.background_color:ff9900)

Example Search Request:
GET /v2/collections/:id/assets?search[query]=name:"Foo"%20description:"Bar%20Bar" HTTP/1.1
Accept: application/vnd.api+json

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

  • search[query]

    optional

Attributes

  • approved Boolean

    optional

    The approval status of the Asset

    Allowed: read and write

  • asset_data Object

    optional

    The additional data needed to describe to Asset.

    Allowed: read and write

  • asset_type String

    optional

    Type of asset: GenericFile, ExternalMedium, Person, Press, Font, Color, Text.

    Allowed: read

  • collection_names Array

    optional

    Collections that the Asset belongs to.

    Allowed: read

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • custom_fields Object

    optional

    The custom fields associated with an asset

    Allowed: read and write

  • description String

    optional

    The Asset description.

    Allowed: read and write

  • download_zip_url String

    optional

    The url to download a zip of all the assets

    Allowed: read

  • name String

    required: true

    The name of the Asset.

    Allowed: read and write

  • number_of_approvals Integer

    optional

    The number of approvals on the asset

    Allowed: read

  • number_of_collections Integer

    optional

    The number of collections the asset belongs to

    Allowed: read

  • number_of_comments Integer

    optional

    The number of comments on the asset

    Allowed: read

  • position Integer

    optional

    The position of the asset in the section.

    Allowed: read and write

  • preview_url String

    optional

    The url of the preview image for the asset.

    Allowed: read

  • section_name String

    optional

    The section name formatted for search.

    Allowed: read

  • tag_names Array

    optional

    The tag names of the Asset.

    Allowed: read and write

  • thumbnail_url String

    optional

    The url of the thumbnail image for the asset.

    Allowed: read

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Bulk Selection’s Selected Assets

Request
GET /v2/bulk_selections/:id/selected_assets HTTP/1.1
Accept: application/vnd.api+json

List Search Filter Section’s Assets

Request
GET /v2/search_filter_sections/:id/assets HTTP/1.1
Accept: application/vnd.api+json

List Section’s Assets

Request
GET /v2/sections/:id/assets HTTP/1.1
Accept: application/vnd.api+json

List Organization’s Assets

Request
GET /v2/organizations/:id/assets HTTP/1.1
Accept: application/vnd.api+json

List Collection’s Assets

Request
GET /v2/collections/:id/assets HTTP/1.1
Accept: application/vnd.api+json

List Collection Section’s Assets

Request
GET /v2/collection_sections/:id/assets HTTP/1.1
Accept: application/vnd.api+json

List Search Filter Section’s Assets

Request
GET /v2/search_filter_sections/:id/assets HTTP/1.1
Accept: application/vnd.api+json

List Brandfolder’s Assets

Request
GET /v2/brandfolders/:id/assets HTTP/1.1
Accept: application/vnd.api+json

Create Section’s Assets

Request
POST /v2/sections/:id/assets HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Collection Section’s Assets

Request
POST /v2/collection_sections/:id/assets HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Search Filter Section’s Assets

Request
POST /v2/search_filter_sections/:id/assets HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read Assets

Request
GET /v2/assets/:id HTTP/1.1
Accept: application/vnd.api+json

Read File’s Asset

Request
GET /v2/files/:id/asset HTTP/1.1
Accept: application/vnd.api+json

Read Attachment’s Asset

Request
GET /v2/attachments/:id/asset HTTP/1.1
Accept: application/vnd.api+json

Read Asset Approval’s Asset

Request
GET /v2/asset_approvals/:id/asset HTTP/1.1
Accept: application/vnd.api+json

Read Asset Participant’s Asset

Request
GET /v2/asset_participants/:id/asset HTTP/1.1
Accept: application/vnd.api+json

Read Custom Field Value’s Asset

Request
GET /v2/custom_field_values/:id/asset HTTP/1.1
Accept: application/vnd.api+json

Read Asset Comment’s Asset

Request
GET /v2/asset_comments/:id/asset HTTP/1.1
Accept: application/vnd.api+json

Update Assets

Request
PATCH /v2/assets/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Delete Assets

Request
DELETE /v2/assets/:id HTTP/1.1
Accept: application/vnd.api+json

Add Section’s Assets

Request
POST /v2/sections/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Collection Section’s Assets

Request
POST /v2/collection_sections/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Search Filter Section’s Assets

Request
POST /v2/search_filter_sections/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Section’s Assets

Request
DELETE /v2/sections/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Collection’s Assets

Request
DELETE /v2/collections/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Collection Section’s Assets

Request
DELETE /v2/collection_sections/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Search Filter Section’s Assets

Request
DELETE /v2/search_filter_sections/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Brandfolder’s Assets

Request
DELETE /v2/brandfolders/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Show Bulk Selection’s Selected Assets

Request
GET /v2/bulk_selections/:id/relationships/selected_assets HTTP/1.1
Accept: application/vnd.api+json

Show Search Filter Section’s Assets

Request
GET /v2/search_filter_sections/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json

Show File’s Asset

Request
GET /v2/files/:id/relationships/asset HTTP/1.1
Accept: application/vnd.api+json

Show Section’s Assets

Request
GET /v2/sections/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json

Show Attachment’s Asset

Request
GET /v2/attachments/:id/relationships/asset HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Assets

Request
GET /v2/organizations/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Assets

Request
GET /v2/collections/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json

Show Collection Section’s Assets

Request
GET /v2/collection_sections/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json

Show Asset Approval’s Asset

Request
GET /v2/asset_approvals/:id/relationships/asset HTTP/1.1
Accept: application/vnd.api+json

Show Search Filter Section’s Assets

Request
GET /v2/search_filter_sections/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json

Show Asset Participant’s Asset

Request
GET /v2/asset_participants/:id/relationships/asset HTTP/1.1
Accept: application/vnd.api+json

Show Custom Field Value’s Asset

Request
GET /v2/custom_field_values/:id/relationships/asset HTTP/1.1
Accept: application/vnd.api+json

Show Asset Comment’s Asset

Request
GET /v2/asset_comments/:id/relationships/asset HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Assets

Request
GET /v2/brandfolders/:id/relationships/assets HTTP/1.1
Accept: application/vnd.api+json

Attachments

Attachments are the raw binary files that are uploaded to assets. When uploaded they are automatically processed for easy resizing and searching of embedded metadata.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: position

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

  • search[query]

    optional

  • filter[mimetype]

    optional

  • exp[token]

    optional

  • convert[width]

    optional

  • convert[height]

    optional

Attributes

  • attachment_key String

    optional

    The attachment key for an Attachment

    Allowed: read and write

  • best_metadata Object

    optional

    The best metadata of the Attachment

    Allowed: read

  • conversion_options Array

    optional

    The conversion options of Attachment

    Allowed: read

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • dimensions_restricted Boolean

    optional

    Whether the Attachment has been set to restrict resizing to certain dimensions or not

    Allowed: read and write

  • extension String

    optional

    The format of the Attachment.

    Allowed: read

  • file_url String

    optional

    The url of the Attachment's original file

    Allowed: read

  • filename String

    optional

    The file name of the Attachment.

    Allowed: read

  • height Integer

    optional

    The height of the Attachment.

    Allowed: read

  • mimetype String

    optional

    The format of the Attachment.

    Allowed: read

  • other_metadata Object

    optional

    The metadata of the Attachment

    Allowed: read

  • path String

    optional

    The full path of the File.

    Allowed: read

  • position Integer

    optional

    The position of the Attachment on the Asset.

    Allowed: read and write

  • preview_url String

    optional

    The url of the Attachment's preview image

    Allowed: read

  • restricted_max_height Integer

    optional

    The maximum height that can be set when downloading/converting the attachment

    Allowed: read and write

  • restricted_max_width Integer

    optional

    The maximum width that can be set when downloading/converting the attachment

    Allowed: read and write

  • restricted_min_height Integer

    optional

    The minimum height that can be set when downloading/converting the attachment

    Allowed: read and write

  • restricted_min_width Integer

    optional

    The minimum width that can be set when downloading/converting the attachment

    Allowed: read and write

  • size Integer

    optional

    The size of the file Attachment.

    Allowed: read

  • thumbnail_url String

    optional

    The url of the Attachment's thumbnail

    Allowed: read

  • thumbnailed Boolean

    optional

    The boolean indicating if an Attachment has a thumbnail.

    Allowed: read

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

  • url String

    required: create

    The remote file url for an Attachment on upload.

    Allowed: write

  • width Integer

    optional

    The width of the Attachment.

    Allowed: read

Relationships

List Asset’s Attachments

Request
GET /v2/assets/:id/attachments HTTP/1.1
Accept: application/vnd.api+json

List Brandfolder’s Attachments

Request
GET /v2/brandfolders/:id/attachments HTTP/1.1
Accept: application/vnd.api+json

Create Asset’s Attachments

Request
POST /v2/assets/:id/attachments HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read Attachments

Request
GET /v2/attachments/:id HTTP/1.1
Accept: application/vnd.api+json
Request
GET /v2/attachments/:id.png HTTP/1.1
Accept: image/png

Update Attachments

Request
PATCH /v2/attachments/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Delete Attachments

Request
DELETE /v2/attachments/:id HTTP/1.1
Accept: application/vnd.api+json

Show Asset’s Attachments

Request
GET /v2/assets/:id/relationships/attachments HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Attachments

Request
GET /v2/brandfolders/:id/relationships/attachments HTTP/1.1
Accept: application/vnd.api+json

Access Requests

Access requests is a feature that allows users to request guest access to your Brandfolder(s).

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • accepted Boolean

    optional

    Whether to approve or deny the request

    Allowed: write

  • created_at TimeString

    optional

    The date the access request was created.

    Allowed: read

  • email String

    required: create

    The email of the person requesting access

    Allowed: read and write

  • prompt_response String

    optional

    An optional message explaining why the requestor wants access

    Allowed: read and write

  • updated_at TimeString

    optional

    The date the access request was updated.

    Allowed: read

Relationships

List Brandfolder’s Access Requests

Request
GET /v2/brandfolders/:id/access_requests HTTP/1.1
Accept: application/vnd.api+json

Create Brandfolder’s Access Requests

Request
POST /v2/brandfolders/:id/access_requests HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read Access Requests

Request
GET /v2/access_requests/:id HTTP/1.1
Accept: application/vnd.api+json

Update Access Requests

Request
PATCH /v2/access_requests/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Delete Access Requests

Request
DELETE /v2/access_requests/:id HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Access Requests

Request
GET /v2/brandfolders/:id/relationships/access_requests HTTP/1.1
Accept: application/vnd.api+json

Adobe Integrations

The adobe integrations on an organiztaion.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Organization’s Adobe Integrations

Request
GET /v2/organizations/:id/adobe_integrations HTTP/1.1
Accept: application/vnd.api+json

List User’s Adobe Integrations

Request
GET /v2/users/:id/adobe_integrations HTTP/1.1
Accept: application/vnd.api+json

Create Adobe Integrations

Request
POST /v2/adobe_integrations HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Organization’s Adobe Integrations

Request
POST /v2/organizations/:id/adobe_integrations HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create User’s Adobe Integrations

Request
POST /v2/users/:id/adobe_integrations HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read Adobe Integrations

Request
GET /v2/adobe_integrations/:id HTTP/1.1
Accept: application/vnd.api+json

Delete Adobe Integrations

Request
DELETE /v2/adobe_integrations/:id HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Adobe Integrations

Request
GET /v2/organizations/:id/relationships/adobe_integrations HTTP/1.1
Accept: application/vnd.api+json

Show User’s Adobe Integrations

Request
GET /v2/users/:id/relationships/adobe_integrations HTTP/1.1
Accept: application/vnd.api+json

Asset Approvals

Asset approvals track the user specific approvals of an asset.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Asset’s Approvals

Request
GET /v2/assets/:id/approvals HTTP/1.1
Accept: application/vnd.api+json

Create Asset’s Approvals

Request
POST /v2/assets/:id/approvals HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read Asset Approvals

Request
GET /v2/asset_approvals/:id HTTP/1.1
Accept: application/vnd.api+json

Delete Asset Approvals

Request
DELETE /v2/asset_approvals/:id HTTP/1.1
Accept: application/vnd.api+json

Show Asset’s Approvals

Request
GET /v2/assets/:id/relationships/approvals HTTP/1.1
Accept: application/vnd.api+json

Asset Comments

Asset comments are a discussion tool enabled on assets.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • body String

    required: true

    The body of the asset comment.

    Allowed: read and write

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • mention_meta Object

    optional

    The metadata for the mentions in the body

    Allowed: read

  • notified Boolean

    optional

    Whether or not the participants have been notified of this comment.

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Asset’s Comments

Request
GET /v2/assets/:id/comments HTTP/1.1
Accept: application/vnd.api+json

List Asset Comment’s Replies

Request
GET /v2/asset_comments/:id/replies HTTP/1.1
Accept: application/vnd.api+json

Create Asset’s Comments

Request
POST /v2/assets/:id/comments HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Asset Comment’s Replies

Request
POST /v2/asset_comments/:id/replies HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read Asset Comments

Request
GET /v2/asset_comments/:id HTTP/1.1
Accept: application/vnd.api+json

Read Asset Comment’s Parent

Request
GET /v2/asset_comments/:id/parent HTTP/1.1
Accept: application/vnd.api+json

Update Asset Comments

Request
PATCH /v2/asset_comments/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Delete Asset Comments

Request
DELETE /v2/asset_comments/:id HTTP/1.1
Accept: application/vnd.api+json

Show Asset Comment’s Parent

Request
GET /v2/asset_comments/:id/relationships/parent HTTP/1.1
Accept: application/vnd.api+json

Show Asset’s Comments

Request
GET /v2/assets/:id/relationships/comments HTTP/1.1
Accept: application/vnd.api+json

Show Asset Comment’s Replies

Request
GET /v2/asset_comments/:id/relationships/replies HTTP/1.1
Accept: application/vnd.api+json

Asset Participants

Asset comments are a discussion tool enabled on assets.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • subscribed Boolean

    required: true

    Whether or not to notify the user of comments on the asset.

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

Read Asset Participants

Request
GET /v2/asset_participants/:id HTTP/1.1
Accept: application/vnd.api+json

Read Asset’s Participation

Request
GET /v2/assets/:id/participation HTTP/1.1
Accept: application/vnd.api+json

Update Asset Participants

Request
PATCH /v2/asset_participants/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Show Asset’s Participation

Request
GET /v2/assets/:id/relationships/participation HTTP/1.1
Accept: application/vnd.api+json

Bulk Selections

Bulk selections are a cached record of what assets a user has bulk selected for a given Brandfolder at any point in time. They expire in 30 days.

A bulk selection manifest can belong to a Brandfolder, Collection, or external share manifest. It must belong to at least one of those 3 resources.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • approve Object

    optional

    Parameters pertaining to the user bulk approving selected assets

    Allowed: write

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • delete Object

    optional

    Parameters pertaining to the user bulk deleting selected assets

    Allowed: write

  • download_zip_url String

    optional

    The url to download a zip of all the assets

    Allowed: read

  • merge Object

    optional

    Parameters pertaining to the user bulk merging selected assets

    Allowed: write

  • select Object

    optional

    Parameters pertaining to the user selecting and deselecting assets

    Allowed: write

  • selected_asset_keys Array

    optional

    Used to create a BulkSelection record with assets pre-selected

    Allowed: write

  • tag Object

    optional

    Parameters pertaining to the user bulk tagging selected assets

    Allowed: write

  • unapprove Object

    optional

    Parameters pertaining to the user bulk unapproving selected assets

    Allowed: write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Organization’s Bulk Selections

Request
GET /v2/organizations/:id/bulk_selections HTTP/1.1
Accept: application/vnd.api+json

List Collection’s Bulk Selections

Request
GET /v2/collections/:id/bulk_selections HTTP/1.1
Accept: application/vnd.api+json

List Brandfolder’s Bulk Selections

Request
GET /v2/brandfolders/:id/bulk_selections HTTP/1.1
Accept: application/vnd.api+json

Create Organization’s Bulk Selections

Request
POST /v2/organizations/:id/bulk_selections HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Collection’s Bulk Selections

Request
POST /v2/collections/:id/bulk_selections HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Brandfolder’s Bulk Selections

Request
POST /v2/brandfolders/:id/bulk_selections HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read Bulk Selections

Request
GET /v2/bulk_selections/:id HTTP/1.1
Accept: application/vnd.api+json

Read Brandfolder’s Bulk Selection

Request
GET /v2/brandfolders/:id/bulk_selection HTTP/1.1
Accept: application/vnd.api+json

Read Collection’s Bulk Selection

Request
GET /v2/collections/:id/bulk_selection HTTP/1.1
Accept: application/vnd.api+json

Read Search Filter’s Bulk Selection

Request
GET /v2/search_filters/:id/bulk_selection HTTP/1.1
Accept: application/vnd.api+json

Update Bulk Selections

Request
PATCH /v2/bulk_selections/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Show Brandfolder’s Bulk Selection

Request
GET /v2/brandfolders/:id/relationships/bulk_selection HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Bulk Selection

Request
GET /v2/collections/:id/relationships/bulk_selection HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Bulk Selections

Request
GET /v2/organizations/:id/relationships/bulk_selections HTTP/1.1
Accept: application/vnd.api+json

Show Search Filter’s Bulk Selection

Request
GET /v2/search_filters/:id/relationships/bulk_selection HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Bulk Selections

Request
GET /v2/collections/:id/relationships/bulk_selections HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Bulk Selections

Request
GET /v2/brandfolders/:id/relationships/bulk_selections HTTP/1.1
Accept: application/vnd.api+json

Collection Sections

Collection sections are visual asset containers that provide a static grouping of assets within the Collection.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: position

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • default_asset_type String

    required: true

    The type of the assets that populate the section: GenericFile, ExternalMedium, Person, Press, Font, Color, Text.

    Allowed: read and write

  • download_zip_url String

    optional

    The url to download a zip of all the assets

    Allowed: read

  • name String

    required: true

    The name of the Section.

    Allowed: read and write

  • number_of_assets Integer

    optional

    The number of assets.

    Allowed: read

  • position Integer

    optional

    The position of the section in the Brandfolder.

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Collection’s Sections

Request
GET /v2/collections/:id/sections HTTP/1.1
Accept: application/vnd.api+json

Read Collection Sections

Request
GET /v2/collection_sections/:id HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Sections

Request
GET /v2/collections/:id/relationships/sections HTTP/1.1
Accept: application/vnd.api+json

Custom Field Keys

Custom Field Keys are one piece of Brandfolder's version of Custom Metadata feature. The Custom Metadata feature allows users to set key/value pairs on assets that describe custom data such as SKUs, Product IDs, or whatever domain specific data a client would want to attach to an asset. Custom Field Keys belong to a Brandfolder and relate to many Custom Field Values. Custom Field Keys can also be specified to have allowed values, which are used to validate data that users supply when created a related Custom Field Value.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: name

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • allowed_values Array

    optional

    The allowed values that related Custom Field Values can have.

    Allowed: read and write

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • name String

    required: true

    The value of the Custom Field Key.

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Brandfolder’s Custom Field Keys

Request
GET /v2/brandfolders/:id/custom_field_keys HTTP/1.1
Accept: application/vnd.api+json

Create Brandfolder’s Custom Field Keys

Request
POST /v2/brandfolders/:id/custom_field_keys HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read Custom Field Keys

Request
GET /v2/custom_field_keys/:id HTTP/1.1
Accept: application/vnd.api+json

Read Custom Field Value’s Custom Field Key

Request
GET /v2/custom_field_values/:id/custom_field_key HTTP/1.1
Accept: application/vnd.api+json

Update Custom Field Keys

Request
PATCH /v2/custom_field_keys/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Show Custom Field Value’s Custom Field Key

Request
GET /v2/custom_field_values/:id/relationships/custom_field_key HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Custom Field Keys

Request
GET /v2/brandfolders/:id/relationships/custom_field_keys HTTP/1.1
Accept: application/vnd.api+json

Custom Field Values

Custom Field Values are one piece of Brandfolder's version of Custom Metadata feature. The Custom Metadata feature allows users to set key/value pairs on assets that describe custom data such as SKUs, Product IDs, or whatever domain specific data a client would want to attach to an asset. Custom Field Values belong to a Custom Field Key and relate to one Asset. Optionally, allowed values can be specifed on the related Custom Field Key that limit what values are permitted for the Custom Field Value itself.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

  • value String

    required: true

    The value of the Custom Field Key.

    Allowed: read and write

Relationships

List Custom Field Key’s Custom Field Values

Request
GET /v2/custom_field_keys/:id/custom_field_values HTTP/1.1
Accept: application/vnd.api+json

Read Custom Field Values

Request
GET /v2/custom_field_values/:id HTTP/1.1
Accept: application/vnd.api+json

Update Custom Field Values

Request
PATCH /v2/custom_field_values/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Show Custom Field Key’s Custom Field Values

Request
GET /v2/custom_field_keys/:id/relationships/custom_field_values HTTP/1.1
Accept: application/vnd.api+json

Files

Files that belong to attachments.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

  • search[query]

    optional

  • filter[mimetype]

    optional

  • exp[token]

    optional

  • convert[width]

    optional

  • convert[height]

    optional

Attributes

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • path String

    optional

    The full path of the File.

    Allowed: read

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

  • url String

    optional

    The url of the Attachment's original file

    Allowed: read

Relationships

List Brandfolder’s Files

Request
GET /v2/brandfolders/:id/files HTTP/1.1
Accept: application/vnd.api+json

List Share Manifest’s Files

Request
GET /v2/share_manifests/:id/files HTTP/1.1
Accept: application/vnd.api+json

List Bulk Selection’s Files

Request
GET /v2/bulk_selections/:id/files HTTP/1.1
Accept: application/vnd.api+json

List Organization’s Files

Request
GET /v2/organizations/:id/files HTTP/1.1
Accept: application/vnd.api+json

List Organization’s Files

Request
GET /v2/organizations/:id/files HTTP/1.1
Accept: application/vnd.api+json

List Search Filter’s Files

Request
GET /v2/search_filters/:id/files HTTP/1.1
Accept: application/vnd.api+json

List Collection’s Files

Request
GET /v2/collections/:id/files HTTP/1.1
Accept: application/vnd.api+json

List Search Filter Section’s Files

Request
GET /v2/search_filter_sections/:id/files HTTP/1.1
Accept: application/vnd.api+json

List Collection Section’s Files

Request
GET /v2/collection_sections/:id/files HTTP/1.1
Accept: application/vnd.api+json

List Section’s Files

Request
GET /v2/sections/:id/files HTTP/1.1
Accept: application/vnd.api+json

List Asset’s Files

Request
GET /v2/assets/:id/files HTTP/1.1
Accept: application/vnd.api+json

List Asset’s Files

Request
GET /v2/assets/:id/files HTTP/1.1
Accept: application/vnd.api+json

Read Files

Request
GET /v2/files/:id HTTP/1.1
Accept: application/vnd.api+json
Request
GET /v2/files/:id.png HTTP/1.1
Accept: image/png

Read Attachment’s File

Request
GET /v2/attachments/:id/file HTTP/1.1
Accept: application/vnd.api+json
Request
GET /v2/attachments/:id/file.png HTTP/1.1
Accept: image/png

Show Brandfolder’s Files

Request
GET /v2/brandfolders/:id/relationships/files HTTP/1.1
Accept: application/vnd.api+json

Show Share Manifest’s Files

Request
GET /v2/share_manifests/:id/relationships/files HTTP/1.1
Accept: application/vnd.api+json

Show Bulk Selection’s Files

Request
GET /v2/bulk_selections/:id/relationships/files HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Files

Request
GET /v2/organizations/:id/relationships/files HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Files

Request
GET /v2/organizations/:id/relationships/files HTTP/1.1
Accept: application/vnd.api+json

Show Search Filter’s Files

Request
GET /v2/search_filters/:id/relationships/files HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Files

Request
GET /v2/collections/:id/relationships/files HTTP/1.1
Accept: application/vnd.api+json

Show Attachment’s File

Request
GET /v2/attachments/:id/relationships/file HTTP/1.1
Accept: application/vnd.api+json

Show Search Filter Section’s Files

Request
GET /v2/search_filter_sections/:id/relationships/files HTTP/1.1
Accept: application/vnd.api+json

Show Collection Section’s Files

Request
GET /v2/collection_sections/:id/relationships/files HTTP/1.1
Accept: application/vnd.api+json

Show Section’s Files

Request
GET /v2/sections/:id/relationships/files HTTP/1.1
Accept: application/vnd.api+json

Show Asset’s Files

Request
GET /v2/assets/:id/relationships/files HTTP/1.1
Accept: application/vnd.api+json

Show Asset’s Files

Request
GET /v2/assets/:id/relationships/files HTTP/1.1
Accept: application/vnd.api+json

Followers

Follows bridges followers that have subscribed to an actual asset

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • email String

    optional

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Brandfolder’s Followers

Request
GET /v2/brandfolders/:id/followers HTTP/1.1
Accept: application/vnd.api+json

List Organization’s Followers

Request
GET /v2/organizations/:id/followers HTTP/1.1
Accept: application/vnd.api+json

List Collection’s Followers

Request
GET /v2/collections/:id/followers HTTP/1.1
Accept: application/vnd.api+json

List Asset’s Followers

Request
GET /v2/assets/:id/followers HTTP/1.1
Accept: application/vnd.api+json

Create Brandfolder’s Followers

Request
POST /v2/brandfolders/:id/followers HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Organization’s Followers

Request
POST /v2/organizations/:id/followers HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Collection’s Followers

Request
POST /v2/collections/:id/followers HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Asset’s Followers

Request
POST /v2/assets/:id/followers HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read Followers

Request
GET /v2/followers/:id HTTP/1.1
Accept: application/vnd.api+json

Read User’s Follower

Request
GET /v2/users/:id/follower HTTP/1.1
Accept: application/vnd.api+json

Read Follow’s Follower

Request
GET /v2/follows/:id/follower HTTP/1.1
Accept: application/vnd.api+json

Update Followers

Request
PATCH /v2/followers/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Delete Followers

Request
DELETE /v2/followers/:id HTTP/1.1
Accept: application/vnd.api+json

Add Brandfolder’s Followers

Request
POST /v2/brandfolders/:id/relationships/followers HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Organization’s Followers

Request
POST /v2/organizations/:id/relationships/followers HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Collection’s Followers

Request
POST /v2/collections/:id/relationships/followers HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Asset’s Followers

Request
POST /v2/assets/:id/relationships/followers HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Brandfolder’s Followers

Request
DELETE /v2/brandfolders/:id/relationships/followers HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Organization’s Followers

Request
DELETE /v2/organizations/:id/relationships/followers HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Collection’s Followers

Request
DELETE /v2/collections/:id/relationships/followers HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Asset’s Followers

Request
DELETE /v2/assets/:id/relationships/followers HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Show Brandfolder’s Followers

Request
GET /v2/brandfolders/:id/relationships/followers HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Followers

Request
GET /v2/organizations/:id/relationships/followers HTTP/1.1
Accept: application/vnd.api+json

Show User’s Follower

Request
GET /v2/users/:id/relationships/follower HTTP/1.1
Accept: application/vnd.api+json

Show Follow’s Follower

Request
GET /v2/follows/:id/relationships/follower HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Followers

Request
GET /v2/collections/:id/relationships/followers HTTP/1.1
Accept: application/vnd.api+json

Show Asset’s Followers

Request
GET /v2/assets/:id/relationships/followers HTTP/1.1
Accept: application/vnd.api+json

Follows

Follows bridges followers that have subscribed to an actual asset, brandfolder, or collection

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • followable_asset_key String

    optional

    Allowed: read

  • followable_name String

    optional

    Allowed: read

  • followable_type String

    optional

    Allowed: read

  • followable_updated_at TimeString

    optional

    Allowed: read

  • frequency Integer

    optional

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Brandfolder’s Follows

Request
GET /v2/brandfolders/:id/follows HTTP/1.1
Accept: application/vnd.api+json

List Organization’s Follows

Request
GET /v2/organizations/:id/follows HTTP/1.1
Accept: application/vnd.api+json

List Collection’s Follows

Request
GET /v2/collections/:id/follows HTTP/1.1
Accept: application/vnd.api+json

List Follower’s Follows

Request
GET /v2/followers/:id/follows HTTP/1.1
Accept: application/vnd.api+json

List Asset’s Follows

Request
GET /v2/assets/:id/follows HTTP/1.1
Accept: application/vnd.api+json

Read Follows

Request
GET /v2/follows/:id HTTP/1.1
Accept: application/vnd.api+json

Update Follows

Request
PATCH /v2/follows/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Delete Follows

Request
DELETE /v2/follows/:id HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Follows

Request
GET /v2/brandfolders/:id/relationships/follows HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Follows

Request
GET /v2/organizations/:id/relationships/follows HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Follows

Request
GET /v2/collections/:id/relationships/follows HTTP/1.1
Accept: application/vnd.api+json

Show Follower’s Follows

Request
GET /v2/followers/:id/relationships/follows HTTP/1.1
Accept: application/vnd.api+json

Show Asset’s Follows

Request
GET /v2/assets/:id/relationships/follows HTTP/1.1
Accept: application/vnd.api+json

Invitation Tokens

Invitation Tokens are really just Invitations, but with the token as the ID of the resource. This allows for looking up invitations through GraphQL by using the token as the apiId.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • active Boolean

    optional

    The boolean that indicated if the Invitation is active

    Allowed: read and write

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • email String

    required: true

    The email tied to the Invitation.

    Allowed: read and write

  • token String

    optional

    The Invitation token

    Allowed: read

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Read Invitation Tokens

Request
GET /v2/invitation_tokens/:id HTTP/1.1
Accept: application/vnd.api+json

Invitations

Invitations give the ability for users to grant access to external users that may or may not not have a pre-existing user account by providing an email address.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • active Boolean

    optional

    The boolean that indicated if the Invitation is active

    Allowed: read and write

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • email String

    required: true

    The email tied to the Invitation.

    Allowed: read and write

  • permission_level String

    required: true

    The permission level of the Invitation

    Allowed: read and write

  • personal_message String

    optional

    The personal message on the Invitation

    Allowed: read and write

  • token String

    optional

    The Invitation token

    Allowed: read

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Brandfolder’s Invitations

Request
GET /v2/brandfolders/:id/invitations HTTP/1.1
Accept: application/vnd.api+json

List Search Filter’s Invitations

Request
GET /v2/search_filters/:id/invitations HTTP/1.1
Accept: application/vnd.api+json

List Collection’s Invitations

Request
GET /v2/collections/:id/invitations HTTP/1.1
Accept: application/vnd.api+json

List Organization’s Invitations

Request
GET /v2/organizations/:id/invitations HTTP/1.1
Accept: application/vnd.api+json

Create Brandfolder’s Invitations

Request
POST /v2/brandfolders/:id/invitations HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Search Filter’s Invitations

Request
POST /v2/search_filters/:id/invitations HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Collection’s Invitations

Request
POST /v2/collections/:id/invitations HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Organization’s Invitations

Request
POST /v2/organizations/:id/invitations HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read Invitations

Request
GET /v2/invitations/:id HTTP/1.1
Accept: application/vnd.api+json

Delete Invitations

Request
DELETE /v2/invitations/:id HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Invitations

Request
GET /v2/brandfolders/:id/relationships/invitations HTTP/1.1
Accept: application/vnd.api+json

Show Search Filter’s Invitations

Request
GET /v2/search_filters/:id/relationships/invitations HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Invitations

Request
GET /v2/collections/:id/relationships/invitations HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Invitations

Request
GET /v2/organizations/:id/relationships/invitations HTTP/1.1
Accept: application/vnd.api+json

Plans

Describes the plan for a given account in addition to all of its usage and configured limits.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • adobe_integration_count Integer

    optional

    The plan's count for Adobe Integrations.

    Allowed: read

  • adobe_integration_limit Integer

    optional

    The plan's limit for Adobe Integrations.

    Allowed: read

  • api_call_count Integer

    optional

    The plan's limit for API Calls.

    Allowed: read

  • api_call_limit Integer

    optional

    The plan's limit for API Calls.

    Allowed: read

  • asset_count Integer

    optional

    The plan's limit for Assets.

    Allowed: read

  • asset_limit Integer

    optional

    The plan's limit for Assets.

    Allowed: read

  • brandfolder_count Integer

    optional

    The plan's count for Brandfolders.

    Allowed: read

  • brandfolder_limit Integer

    optional

    The plan's limit for Brandfolders.

    Allowed: read

  • collaborator_count Integer

    optional

    The plan's limit for Collaborators.

    Allowed: read

  • collaborator_invite_count Integer

    optional

    The plan's limit for Collaborator invites.

    Allowed: read

  • collaborator_limit Integer

    optional

    The plan's limit for Collaborators.

    Allowed: read

  • collection_count Integer

    optional

    The plan's limit for Collections.

    Allowed: read

  • collection_limit Integer

    optional

    The plan's limit for Collections.

    Allowed: read

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • feature_names Array

    optional

    The available feature names

    Allowed: read

  • name String

    optional

    Allowed: read and write

  • storage_gb_count Integer

    optional

    The plan's gigabyte count for Storage.

    Allowed: read

  • storage_gb_limit Integer

    optional

    The plan's gigabyte limit for Storage.

    Allowed: read

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

Read Plans

Request
GET /v2/plans/:id HTTP/1.1
Accept: application/vnd.api+json

Read Organization’s Plan

Request
GET /v2/organizations/:id/plan HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Plan

Request
GET /v2/organizations/:id/relationships/plan HTTP/1.1
Accept: application/vnd.api+json

Search Filter Sections

Collection sections are visual asset containers that provide a static grouping of assets within the Collection.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: position

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • default_asset_type String

    required: true

    The type of the assets that populate the section: GenericFile, ExternalMedium, Person, Press, Font, Color, Text.

    Allowed: read and write

  • download_zip_url String

    optional

    The url to download a zip of all the assets

    Allowed: read

  • name String

    required: true

    The name of the Section.

    Allowed: read and write

  • number_of_assets Integer

    optional

    The number of assets.

    Allowed: read

  • position Integer

    optional

    The position of the section in the Brandfolder.

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Search Filter’s Sections

Request
GET /v2/search_filters/:id/sections HTTP/1.1
Accept: application/vnd.api+json

Read Search Filter Sections

Request
GET /v2/search_filter_sections/:id HTTP/1.1
Accept: application/vnd.api+json

Show Search Filter’s Sections

Request
GET /v2/search_filters/:id/relationships/sections HTTP/1.1
Accept: application/vnd.api+json

Search Filters

Describes the plan for a given account in addition to all of its usage and configured limits.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: position

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • download_zip_url String

    optional

    The url to download a zip of all the assets

    Allowed: read

  • label String

    required: true

    The plan's count for Brandfolders.

    Allowed: read and write

  • number_of_sections Integer

    optional

    The number of sections.

    Allowed: read

  • number_of_users Integer

    optional

    The number of users.

    Allowed: read

  • position Integer

    required: true

    The plan's limit for Brandfolders.

    Allowed: read and write

  • query String

    required: true

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Brandfolder’s Search Filters

Request
GET /v2/brandfolders/:id/search_filters HTTP/1.1
Accept: application/vnd.api+json

Read Search Filters

Request
GET /v2/search_filters/:id HTTP/1.1
Accept: application/vnd.api+json

Read Search Filter Section’s Search Filter

Request
GET /v2/search_filter_sections/:id/search_filter HTTP/1.1
Accept: application/vnd.api+json

Update Search Filters

Request
PATCH /v2/search_filters/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Delete Search Filters

Request
DELETE /v2/search_filters/:id HTTP/1.1
Accept: application/vnd.api+json

Show Search Filter Section’s Search Filter

Request
GET /v2/search_filter_sections/:id/relationships/search_filter HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Search Filters

Request
GET /v2/brandfolders/:id/relationships/search_filters HTTP/1.1
Accept: application/vnd.api+json

Share Manifests

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • availability_start DateString

    optional

    The time (without time zone) that the share manifest will be viewable after.

    Allowed: read and write

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • download_zip_url String

    optional

    The url to download a zip of all the assets

    Allowed: read

  • time_zone String

    optional

    The time zone related to the availability.

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

Read Share Manifests

Request
GET /v2/share_manifests/:id HTTP/1.1
Accept: application/vnd.api+json

Read Bulk Selection’s Share Manifest

Request
GET /v2/bulk_selections/:id/share_manifest HTTP/1.1
Accept: application/vnd.api+json

Show Bulk Selection’s Share Manifest

Request
GET /v2/bulk_selections/:id/relationships/share_manifest HTTP/1.1
Accept: application/vnd.api+json

Social links are links on the Brandfolder that provide quick access to external sites.

  • Authorization

    optional

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • name String

    required: true

    The name of the link.

    Allowed: read and write

  • position Integer

    optional

    The position of the link.

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

  • url String

    required: true

    The url of the link pointing to the external site.

    Allowed: read and write

Request
GET /v2/brandfolders/:id/social_links HTTP/1.1
Accept: application/vnd.api+json

Create Brandfolder’s Social Links

Request
POST /v2/brandfolders/:id/social_links HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }
Request
GET /v2/social_links/:id HTTP/1.1
Accept: application/vnd.api+json
Request
PATCH /v2/social_links/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }
Request
DELETE /v2/social_links/:id HTTP/1.1
Accept: application/vnd.api+json
Request
GET /v2/brandfolders/:id/relationships/social_links HTTP/1.1
Accept: application/vnd.api+json

User Permissions

User permissions contain the rights to various objects on Brandfolder.com.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • email String

    optional

    The email of the user for the permission.

    Allowed: write

  • permission_level String

    required: true

    The permission level for the User: owner, admin, collaborator, guest

    Allowed: read and write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Search Filter’s User Permissions

Request
GET /v2/search_filters/:id/user_permissions HTTP/1.1
Accept: application/vnd.api+json

List Brandfolder’s User Permissions

Request
GET /v2/brandfolders/:id/user_permissions HTTP/1.1
Accept: application/vnd.api+json

List Organization’s User Permissions

Request
GET /v2/organizations/:id/user_permissions HTTP/1.1
Accept: application/vnd.api+json

List Collection’s User Permissions

Request
GET /v2/collections/:id/user_permissions HTTP/1.1
Accept: application/vnd.api+json

Create Search Filter’s User Permissions

Request
POST /v2/search_filters/:id/user_permissions HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Brandfolder’s User Permissions

Request
POST /v2/brandfolders/:id/user_permissions HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Organization’s User Permissions

Request
POST /v2/organizations/:id/user_permissions HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Collection’s User Permissions

Request
POST /v2/collections/:id/user_permissions HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read User Permissions

Request
GET /v2/user_permissions/:id HTTP/1.1
Accept: application/vnd.api+json

Read Invitation’s User Permission

Request
GET /v2/invitations/:id/user_permission HTTP/1.1
Accept: application/vnd.api+json

Update User Permissions

Request
PATCH /v2/user_permissions/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Delete User Permissions

Request
DELETE /v2/user_permissions/:id HTTP/1.1
Accept: application/vnd.api+json

Show Search Filter’s User Permissions

Request
GET /v2/search_filters/:id/relationships/user_permissions HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s User Permissions

Request
GET /v2/brandfolders/:id/relationships/user_permissions HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s User Permissions

Request
GET /v2/organizations/:id/relationships/user_permissions HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s User Permissions

Request
GET /v2/collections/:id/relationships/user_permissions HTTP/1.1
Accept: application/vnd.api+json

Show Invitation’s User Permission

Request
GET /v2/invitations/:id/relationships/user_permission HTTP/1.1
Accept: application/vnd.api+json

Users

Users are authenticated accounts that may have permissions to various objects on Brandfolder.com.

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: id

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

  • search[query]

    optional

  • filter[access_level]

    optional

Attributes

  • created_at TimeString

    optional

    The time the resource was created.

    Allowed: read

  • email String

    required: create

    The email of the User.

    Allowed: read and write

  • first_name String

    optional

    The first name of the User.

    Allowed: read and write

  • gravatar_url String

    optional

    The Gravatar URL based on email address

    Allowed: read

  • initials String

    optional

    The initials based on First Name and Last Name

    Allowed: read

  • initials_colors Array

    optional

    The colors to use for styling initials

    Allowed: read

  • last_name String

    optional

    The last name of the User.

    Allowed: read and write

  • password String

    required: create

    The password for the User

    Allowed: write

  • token String

    required: create

    The invite token used to create the user record.

    Allowed: write

  • updated_at TimeString

    optional

    The time the resource was updated.

    Allowed: read

Relationships

List Users

Request
GET /v2/users HTTP/1.1
Accept: application/vnd.api+json

List Search Filter’s Users

Request
GET /v2/search_filters/:id/users HTTP/1.1
Accept: application/vnd.api+json

List Search Filter’s Guests

Request
GET /v2/search_filters/:id/guests HTTP/1.1
Accept: application/vnd.api+json

List Brandfolder’s Following Users

Request
GET /v2/brandfolders/:id/following_users HTTP/1.1
Accept: application/vnd.api+json

List Asset’s Following Users

Request
GET /v2/assets/:id/following_users HTTP/1.1
Accept: application/vnd.api+json

List Organization’s Owners

Request
GET /v2/organizations/:id/owners HTTP/1.1
Accept: application/vnd.api+json

List Collection’s Admins

Request
GET /v2/collections/:id/admins HTTP/1.1
Accept: application/vnd.api+json

List Collection’s Following Users

Request
GET /v2/collections/:id/following_users HTTP/1.1
Accept: application/vnd.api+json

List Organization’s Guests

Request
GET /v2/organizations/:id/guests HTTP/1.1
Accept: application/vnd.api+json

List Organization’s Licensed Users

Request
GET /v2/organizations/:id/licensed_users HTTP/1.1
Accept: application/vnd.api+json

List Organization’s Following Users

Request
GET /v2/organizations/:id/following_users HTTP/1.1
Accept: application/vnd.api+json

List Collection’s Collaborators

Request
GET /v2/collections/:id/collaborators HTTP/1.1
Accept: application/vnd.api+json

List Organization’s Admins

Request
GET /v2/organizations/:id/admins HTTP/1.1
Accept: application/vnd.api+json

List Organization’s All Users

Request
GET /v2/organizations/:id/all_users HTTP/1.1
Accept: application/vnd.api+json

List Organization’s Collaborators

Request
GET /v2/organizations/:id/collaborators HTTP/1.1
Accept: application/vnd.api+json

List Organization’s Users

Request
GET /v2/organizations/:id/users HTTP/1.1
Accept: application/vnd.api+json

List Collection’s Users

Request
GET /v2/collections/:id/users HTTP/1.1
Accept: application/vnd.api+json

List Collection’s Guests

Request
GET /v2/collections/:id/guests HTTP/1.1
Accept: application/vnd.api+json

List Search Filter’s Collaborators

Request
GET /v2/search_filters/:id/collaborators HTTP/1.1
Accept: application/vnd.api+json

List Brandfolder’s Users

Request
GET /v2/brandfolders/:id/users HTTP/1.1
Accept: application/vnd.api+json

List Brandfolder’s Admins

Request
GET /v2/brandfolders/:id/admins HTTP/1.1
Accept: application/vnd.api+json

List Search Filter’s Admins

Request
GET /v2/search_filters/:id/admins HTTP/1.1
Accept: application/vnd.api+json

List Brandfolder’s Collaborators

Request
GET /v2/brandfolders/:id/collaborators HTTP/1.1
Accept: application/vnd.api+json

List Brandfolder’s Guests

Request
GET /v2/brandfolders/:id/guests HTTP/1.1
Accept: application/vnd.api+json

Create Users

Request
POST /v2/users HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Brandfolder’s Following Users

Request
POST /v2/brandfolders/:id/following_users HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Asset’s Following Users

Request
POST /v2/assets/:id/following_users HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Collection’s Following Users

Request
POST /v2/collections/:id/following_users HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Organization’s Licensed Users

Request
POST /v2/organizations/:id/licensed_users HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Organization’s Following Users

Request
POST /v2/organizations/:id/following_users HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Create Organization’s All Users

Request
POST /v2/organizations/:id/all_users HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Read Users

Request
GET /v2/users/:id HTTP/1.1
Accept: application/vnd.api+json

Read Adobe Integration’s User

Request
GET /v2/adobe_integrations/:id/user HTTP/1.1
Accept: application/vnd.api+json

Read Asset Comment’s Author

Request
GET /v2/asset_comments/:id/author HTTP/1.1
Accept: application/vnd.api+json

Read User Permission’s User

Request
GET /v2/user_permissions/:id/user HTTP/1.1
Accept: application/vnd.api+json

Read Follow’s User

Request
GET /v2/follows/:id/user HTTP/1.1
Accept: application/vnd.api+json

Read Invitation’s Inviter

Request
GET /v2/invitations/:id/inviter HTTP/1.1
Accept: application/vnd.api+json

Read Asset Approval’s User

Request
GET /v2/asset_approvals/:id/user HTTP/1.1
Accept: application/vnd.api+json

Read Follower’s User

Request
GET /v2/followers/:id/user HTTP/1.1
Accept: application/vnd.api+json

Update Users

Request
PATCH /v2/users/:id HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Delete Users

Request
DELETE /v2/users/:id HTTP/1.1
Accept: application/vnd.api+json

Add Search Filter’s Guests

Request
POST /v2/search_filters/:id/relationships/guests HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Organization’s Owners

Request
POST /v2/organizations/:id/relationships/owners HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Collection’s Admins

Request
POST /v2/collections/:id/relationships/admins HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Organization’s Guests

Request
POST /v2/organizations/:id/relationships/guests HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Collection’s Collaborators

Request
POST /v2/collections/:id/relationships/collaborators HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Organization’s Admins

Request
POST /v2/organizations/:id/relationships/admins HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Organization’s Collaborators

Request
POST /v2/organizations/:id/relationships/collaborators HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Collection’s Guests

Request
POST /v2/collections/:id/relationships/guests HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Search Filter’s Collaborators

Request
POST /v2/search_filters/:id/relationships/collaborators HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Brandfolder’s Admins

Request
POST /v2/brandfolders/:id/relationships/admins HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Search Filter’s Admins

Request
POST /v2/search_filters/:id/relationships/admins HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Brandfolder’s Collaborators

Request
POST /v2/brandfolders/:id/relationships/collaborators HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Add Brandfolder’s Guests

Request
POST /v2/brandfolders/:id/relationships/guests HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Search Filter’s Users

Request
DELETE /v2/search_filters/:id/relationships/users HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Search Filter’s Guests

Request
DELETE /v2/search_filters/:id/relationships/guests HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Organization’s Owners

Request
DELETE /v2/organizations/:id/relationships/owners HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Collection’s Admins

Request
DELETE /v2/collections/:id/relationships/admins HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Organization’s Guests

Request
DELETE /v2/organizations/:id/relationships/guests HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Collection’s Collaborators

Request
DELETE /v2/collections/:id/relationships/collaborators HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Organization’s Admins

Request
DELETE /v2/organizations/:id/relationships/admins HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Organization’s Collaborators

Request
DELETE /v2/organizations/:id/relationships/collaborators HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Organization’s Users

Request
DELETE /v2/organizations/:id/relationships/users HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Collection’s Users

Request
DELETE /v2/collections/:id/relationships/users HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Collection’s Guests

Request
DELETE /v2/collections/:id/relationships/guests HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Search Filter’s Collaborators

Request
DELETE /v2/search_filters/:id/relationships/collaborators HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Brandfolder’s Users

Request
DELETE /v2/brandfolders/:id/relationships/users HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Brandfolder’s Admins

Request
DELETE /v2/brandfolders/:id/relationships/admins HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Search Filter’s Admins

Request
DELETE /v2/search_filters/:id/relationships/admins HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Brandfolder’s Collaborators

Request
DELETE /v2/brandfolders/:id/relationships/collaborators HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Remove Brandfolder’s Guests

Request
DELETE /v2/brandfolders/:id/relationships/guests HTTP/1.1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

{ ...request body... }

Show Search Filter’s Users

Request
GET /v2/search_filters/:id/relationships/users HTTP/1.1
Accept: application/vnd.api+json

Show Search Filter’s Guests

Request
GET /v2/search_filters/:id/relationships/guests HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Following Users

Request
GET /v2/brandfolders/:id/relationships/following_users HTTP/1.1
Accept: application/vnd.api+json

Show Adobe Integration’s User

Request
GET /v2/adobe_integrations/:id/relationships/user HTTP/1.1
Accept: application/vnd.api+json

Show Asset’s Following Users

Request
GET /v2/assets/:id/relationships/following_users HTTP/1.1
Accept: application/vnd.api+json

Show Asset Comment’s Author

Request
GET /v2/asset_comments/:id/relationships/author HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Owners

Request
GET /v2/organizations/:id/relationships/owners HTTP/1.1
Accept: application/vnd.api+json

Show User Permission’s User

Request
GET /v2/user_permissions/:id/relationships/user HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Admins

Request
GET /v2/collections/:id/relationships/admins HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Following Users

Request
GET /v2/collections/:id/relationships/following_users HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Guests

Request
GET /v2/organizations/:id/relationships/guests HTTP/1.1
Accept: application/vnd.api+json

Show Follow’s User

Request
GET /v2/follows/:id/relationships/user HTTP/1.1
Accept: application/vnd.api+json

Show Invitation’s Inviter

Request
GET /v2/invitations/:id/relationships/inviter HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Licensed Users

Request
GET /v2/organizations/:id/relationships/licensed_users HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Following Users

Request
GET /v2/organizations/:id/relationships/following_users HTTP/1.1
Accept: application/vnd.api+json

Show Asset Approval’s User

Request
GET /v2/asset_approvals/:id/relationships/user HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Collaborators

Request
GET /v2/collections/:id/relationships/collaborators HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Admins

Request
GET /v2/organizations/:id/relationships/admins HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s All Users

Request
GET /v2/organizations/:id/relationships/all_users HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Collaborators

Request
GET /v2/organizations/:id/relationships/collaborators HTTP/1.1
Accept: application/vnd.api+json

Show Organization’s Users

Request
GET /v2/organizations/:id/relationships/users HTTP/1.1
Accept: application/vnd.api+json

Show Follower’s User

Request
GET /v2/followers/:id/relationships/user HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Users

Request
GET /v2/collections/:id/relationships/users HTTP/1.1
Accept: application/vnd.api+json

Show Collection’s Guests

Request
GET /v2/collections/:id/relationships/guests HTTP/1.1
Accept: application/vnd.api+json

Show Search Filter’s Collaborators

Request
GET /v2/search_filters/:id/relationships/collaborators HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Users

Request
GET /v2/brandfolders/:id/relationships/users HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Admins

Request
GET /v2/brandfolders/:id/relationships/admins HTTP/1.1
Accept: application/vnd.api+json

Show Search Filter’s Admins

Request
GET /v2/search_filters/:id/relationships/admins HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Collaborators

Request
GET /v2/brandfolders/:id/relationships/collaborators HTTP/1.1
Accept: application/vnd.api+json

Show Brandfolder’s Guests

Request
GET /v2/brandfolders/:id/relationships/guests HTTP/1.1
Accept: application/vnd.api+json

Web Fonts

Request Headers

  • Authorization

    optional

Query Params

  • sort — default: name

    optional

  • filter[id]

    optional

  • api-token

    optional

  • page[after]

    optional

  • page[before]

    optional

  • page[first]

    optional

  • page[last]

    optional

Attributes

  • name String

    optional

    The name of the webfont

    Allowed: read

  • option String

    optional

    The option to be used when creating an asset

    Allowed: read

Read Web Fonts

Request
GET /v2/web_fonts/:id HTTP/1.1
Accept: application/vnd.api+json