Introduction
Last updated

Introduction

The Brandfolder API enables you to programatically access and manage your organization's Brandfolder resources.

By activating or using the Brandfolder API, you acknowledge and agree to the API License Agreement found here.

V4 is a RESTful JSON API giving you programmatic access to the same resources you can access as a user of our website.

You're probably wondering, "Which resources are those?" Well, each one has its own section in this documentation where you can learn in more detail exactly what operations you can perform in relation to that particular resource, but a bit of an overview here might be helpful.

As a Brandfolder user, you are part of one or more Organizations.

Organizations can have multiple Brandfolders.

Brandfolders have Sections which hold Assets.

Assets can also belong to multiple Collections within a Brandfolder.

Assets have Attachments and can also have Tags and Custom Fields.

You can also send Invitations to grant users access to Organizations, Brandfolders, and Collections.

Authentication

Authentication is performed with every API call by sending a header with your unique Brandfolder API key.

The required header in each request is:

Authorization: Bearer {BF_API_KEY}

Each response to your API calls will only include the resources that you (or the User whose API key your application is using) can access based on your permissions.

Making Requests

All V4 requests are made via the following URL:

https://brandfolder.com/api/v4 + resource endpoint

When using our examples in your code, you'll need to make sure to replace {organization_id} (or any other resource ID like {asset_id}) with the actual ID for the desired resource.

For example, Fetch an Organization shows the endpoint as GET /organizations/{organization_id}. If you wish to fetch information about an Organization with an ID of plqlkk-22rw6g-3dqgx0, then this means you need to make an HTTP request with a method of GET to https://brandfolder.com/api/v4/organizations/plqlkk-22rw6g-3dqgx0

We list parameters for each API endpoint. Query parameters describes some common query parameters.

If our API responds to your request with an error, please see Error codes to understand what may have gone wrong.

 
Next page