For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Search docs
/
Ask AI
Dev Portal
Docs
API Reference
Learn
Community
Changelog
GraphQL
B2B
Queries
userCompany
Copy page
Get a company details by user id. Requires a B2B Token.
Developer
Developer
Developer
Developer
Arguments
userId
Integer
Required
B2BEdition user id. This field is required.
Returns
an optional CompanyType
id
String
Unique ID of this company
companyName
String
Company name
bcGroupName
String
The group name in BigCommerce's group. which must be unique
description
String
A brief introduction to the company
catalogId
String
Prices list ID of this company
companyStatus
Integer
Company status
addressLine1
String
Company address line 1
addressLine2
String
Company address line 2
city
String
Company city
state
String
Company state
zipCode
String
Zip code of company city
country
String
Company country
extraFields
list of optional ExtraFieldsValueType
extra fields of this company
customerGroupId
Integer
Company customer group id
