How to get a Brandfolder API key, add it to Medialake as an access key, and understand exactly what access it grants.
What to expect
Brandfolder is connected with an API key, not an OAuth sign-in. There is no Brandfolder sign-in or consent screen when you connect: a Medialake administrator saves the API key once as an access key, and Medialake authenticates to Brandfolder in the background from then on.
A Brandfolder API key belongs to a Brandfolder user and carries that user's permissions. Brandfolder only returns the Brandfolders and assets that user can access, so the user you take the key from decides what Medialake can see. We follow the principle of least privilege: the recommended setup uses a dedicated user with access to only the Brandfolders you want to sync.
The Brandfolder connector only reads content. It lists your Brandfolders, reads asset and attachment details, retrieves thumbnails, and downloads the files in the Brandfolders you select. It does not upload, edit, tag, share, or delete anything in Brandfolder.
You do not need a portal URL or region: Medialake always connects to Brandfolder's API at https://brandfolder.com/api/v4.
Administrators Medialake Brandfolder
│ copy the API key of a │ │
│ dedicated Brandfolder │ │
│ user │ │
│◀───────────────────────────────────────────────────────│
│ save it as an │ │
│ access key │ │
│───────────────────────────▶│ │
│ │ │
Team member │ │
│ connect with the key │ identify the key's user │
│───────────────────────────▶│──────────────────────────▶│
│ choose Brandfolders │ read-only requests │
│───────────────────────────▶│──────────────────────────▶│
Before you begin
You will need:
A Brandfolder user whose API key Medialake will use, ideally a dedicated one (see Step 1), and the ability to sign in as that user
Help from a Brandfolder administrator if you are creating a new user or changing its access
Administrator privileges in Medialake, to save the access key
>Keep the API key private. Anyone who has the key can use the Brandfolder API with that user's permissions. Store it in an approved password manager or secret-management system. Do not email it, paste it into a support ticket, or commit it to source control. Medialake stores the key encrypted and never shows it again after you save it.
Step 1: Choose or create a dedicated Brandfolder user
Because the API key inherits its user's permissions, that user, not the key, defines what Medialake can access.
Ask a Brandfolder administrator to invite a dedicated user for the integration, for example
[email protected].Give that user access only to the Brandfolders Medialake should sync, with the lowest permission level that still lets it view and download their assets. In Brandfolder that is the Guest role, which Brandfolder describes as view and download only. Do not make it a Collaborator, Admin, or Owner.
Using a dedicated user rather than a personal account keeps the connection independent of any one person, and makes its access easy to review and remove. If you use an existing account instead, Medialake will be able to see everything that account can see.
Step 2: Copy the user's API key
Sign in to Brandfolder as the user from Step 1.
Open the Integrations section of your profile at
https://brandfolder.com/profile#integrations.Click the copy icon next to your API key.
Keep the copied value exactly as it is, with no spaces before, after, or inside it.
Step 3: Add the API key to Medialake
You need administrator privileges in Medialake for this step.
Open Administration → Integrations from the sidebar.
Open the Brandfolder integration.
In the Access Keys section, click Create New Setting.
In the New access key panel, enter a Name that tells people which Brandfolder user the key belongs to, for example
Brandfolder integration user. The name is shown in the access key list and next to every account that connects with it.Under Credentials, paste the key into Brandfolder API key (no spaces).
Under Who can use it?, choose the teams whose members can connect Brandfolder with this key, or make it available to all teams.
Click Save access key.
An access key cannot be edited after it is saved. To change the API key later, save a new access key and connect with it, as described under Staying connected below.
Step 4: Connect Brandfolder and choose what to sync
Any team member who is allowed to connect sources can do this, as long as the access key is available to their team.
Open Connections → Catalogue from the side menu.
Find Brandfolder and click Connect.
Under Access key, select the key you saved in Step 3.
Optionally, click Test to check the key with Brandfolder before connecting.
Click Connect.
There is no Brandfolder login screen. Medialake asks Brandfolder which user the API key belongs to and adds the account under that user's name.
Next, choose what to sync. Every Brandfolder the key's user can access is listed as a folder, and you select the Brandfolders Medialake should sync. Selecting a Brandfolder syncs all of its assets; its sections and collections are not offered as separate choices. Each attachment on an asset is synced as its own file in Medialake, and files whose type Medialake does not support are skipped. Nothing outside your selection is imported.
Limiting what Medialake can access
Brandfolder enforces one boundary: the permissions of the user the API key belongs to. The key can reach whatever that user can reach, so restricting the user is the strongest control you have.
Selecting Brandfolders in Medialake controls what is synced, but it does not narrow the key itself. Medialake only ever sends read requests, but the key would allow anything its user is permitted to do through the Brandfolder API. That is why the dedicated user should have access to as few Brandfolders as possible and no administrative rights. Review its access periodically.
What Medialake can and cannot do
With the setup above, Medialake can:
Identify the user the API key belongs to (name and email address)
List the Brandfolders that user can access
Read asset and attachment details such as names, descriptions, file names, file types, sizes, dimensions, dates, tags, and custom fields
Retrieve thumbnails
Download the attachments in the Brandfolders you select
Medialake cannot:
See any Brandfolder user's password
Access Brandfolders or assets that the key's user cannot access
The Brandfolder connector never:
Uploads, replaces, edits, tags, shares, or deletes assets
Changes Brandfolders, sections, collections, or custom fields
Manages Brandfolder users or organization settings
Staying connected
Medialake sends the saved API key with every request. There is no token to refresh and nothing for anyone to re-approve.
If Brandfolder stops accepting the key, the account stops syncing and shows a Service Disconnected warning in Medialake. To restore it:
If the problem was on the Brandfolder side and has been fixed, for example the user's access was restored, click Check connection on the warning to test the saved key again.
If you need to use a different key, save it as a new access key (Step 3), then connect again with it (Step 4). Connecting the same Brandfolder user again in the same team updates the existing account instead of adding a second one.
Revoking access
To stop Medialake from reaching Brandfolder:
In Brandfolder: remove the dedicated user's access to the Brandfolders, or remove the user from your organization. The API key can never reach more than its user can.
In Medialake: remove the Brandfolder account if it should no longer sync. Once no account uses the access key, delete it from the integration's Access Keys section. Medialake will not delete an access key that a connected account still uses.
Troubleshooting
Symptom | What to check |
"The Brandfolder API key (no spaces) field is required." when saving | The key field was left empty. Paste the key from your Brandfolder profile. |
"A setting with this title already exists in the group. Choose a different title." when saving | Another Brandfolder access key already uses that Name. Choose a different name. |
Test reports "The provider rejected these credentials." | The key is wrong or incomplete. Copy it again from |
Test reports "These credentials look right, but the provider couldn't confirm them just now." | Brandfolder could not be reached or returned a temporary error. Try again in a few minutes. |
An Incorrect Credentials. page appears after clicking Connect | Medialake could not identify the key's user with Brandfolder. Run Test on the access key and, if it is rejected, save a corrected key. |
A Brandfolder you expected is not listed | The key's user does not have access to it. Grant access in Brandfolder, then open the sync selection again. |
Some files from a Brandfolder do not appear | Medialake skips file types it does not support. Assets outside the selected Brandfolders are not synced. |
The account shows Service Disconnected | Brandfolder stopped accepting the key. See Staying connected above. |
If the issue continues, contact [email protected] with the name of the access key and the error message. Do not include the API key.
Further reading
Brandfolder API authentication — where to find your API key and how it is used
Brandfolder API introduction — overview of the API the connector uses
Questions about connecting Brandfolder? Contact [email protected].
