Users
NOTICE
As of September 30, 2025, the B2B Edition API
authToken
will be deprecated and replaced by the standard BigCommerce APIX-Auth-Token
. For information concerning this change, see B2B Authentication.While
authToken
authentication is not expected to be fully sunset in the near future, it is advised to migrate to the new system as soon as possible to prevent disruption of functionality.
NOTE:
While Super Admins are B2B Edition user accounts, they are not included in the response data for this API. To manage Super Admin accounts, refer to the B2B Edition Super Admin API.
The Users API provides programmatic access to B2B Edition user management within BigCommerce. It enables storefront operations such as creating Company users, assigning roles, associating users with channels, and managing extra fields. This ensures that B2B customers can be onboarded, managed, and maintained according to your business logic and storefront requirements.
Each B2B Edition user account is associated with a BigCommerce customer account. To manage BigCommerce specific account information, refer to the Customers API.
Limitations & Considerations
- Role Management: Only built-in roles (admin, senior buyer, junior buyer) are supported in filters, but custom roles are still accessible for reading and updating.
- Bulk Operations: Bulk user creation is limited to 10 users per request.
- Deletion Safeguards: Deleting the last user in a Company is not allowed; deleting all admin users is permitted but may render Companies unable to transact.
- Channel Assignments: Users must be assigned to at least one storefront channel in order to perform business operations in a store with multiple storefront channels.