Groups and permissions

Each API credential has roles that specify its groups, permissions, and capabilities.

The API credential for your company, for example abc@Company.[YourCompanyAccount], is assigned default groups and permissions when the company account is created. These are listed in the tables on this page. The groups and permissions linked to your abc credential can also be assigned to other API credentials in your company.

Having the correct group and permission allows you to access specific features in BFG and use the relevant API endpoints. You can manage groups and permissions on the Manage API page (Settings > API Keys) in BFG.

If your API credential lacks the required groups and permissions, contact [email protected].

Groups

The following table shows the groups your API credential can have access to:

Group	Description
Companies	Organizational accounts of a brand or a store that group users, stores, API credentials, and other resources under a single entity.
Companies History	History and download list of imported CSV files containing brand and store information.
Companies Inventories	Exported CSV file containing a list of products or products missing MAP pricing.
Company Relationships
Company Tags	Custom labels that help categorize and organize stores for filtering and reporting.
FFL Dealers	Licensed firearms sellers registered in BFG to support compliant order fulfillment and firearm transfers, can be used to specify FFL information in a store.
Import Prompts	Interactive messages and options that appear during a CSV import process to guide users for handling missing data and formatting.
Manufacturer Categories	Classifications assigned to products by the store to organize and filter products.
Manufacturer Dealers	Refer to stores, store tags, and store types.
Manufacturer Tags	Custom labels that help categorize and organize products for filtering and reporting.
MAP Policies	Define the minimum price at which a product can be advertised, as set by the brand.
MAP Policies History	History of imported CSV files containing MAP policy and price information.
MAP Promotions	Brand-authorized exception that allows a product to be advertised below its standard Minimum Advertised Price (MAP) for a specified period.
Product Inventories	Available quantity of a specific product tracked in BFG.
Products	Individual items or SKUs managed in your store.
Products History	History and download list of imported CSV files containing product information.
Store Locators	Public-facing interface that allows customers to find nearby physical store locations. It displays store details such as address, contact info, and business hours, and can be customized or embedded into a brand or store's website.
User Invites	Grant access to new users by sending email invitations that includes a group and associated permissions.
Users	Individual accounts with assigned roles and permissions that define access to features and data in BFG.
Webhooks	Allow external systems to receive real-time notifications about specific events, such as order updates or inventory changes. When triggered, BFG sends an HTTP POST request to a configured URL, enabling integration with third-party applications and services.

Permissions

The following table shows the permissions your API credential can have access to:

Permission	BFG description	API description
Manage	Displays the items under a group on the sidebar and its related pages.	Gets the items that the API credential has access to.
View	Displays an item's page or a list of items in a table.	Gets the items that the API credential has access to.
Create	Creates an item.	Creates the items that the API credential has access to.
Delete	Deletes an item.	Deletes the items that the API credential has access to.
Update	Edits information of an item.	Edits the items that the API credential has access to.
Export	Downloads information of an item or a group of items	Gets the items that the API credential has access to.
Import	Uploads and imports data of an item or a group of items	Posts the items that the API credential has access to.