List Companies | BigCommerce Developer Center

curl -G https://api-b2b.bigcommerce.com/api/v3/io/companies \
     -H "authToken: <apiKey>" \
     --data-urlencode extraFields=externalID:a

{
  "code": 200,
  "data": [
    {
      "companyId": "147340",
      "companyName": "Glam Squad Hair and Makeup Artistry",
      "bcGroupName": "Glam Squad Hair and Makeup Artistry",
      "companyStatus": "1",
      "companyEmail": "support@glamsquad.com",
      "companyPhone": "+1-555-123-4567",
      "uuid": "a3f47b9e-8c2d-4f3a-9b7e-2d5f6a1c9e4b",
      "catalogId": "cat-2024-001",
      "catalogName": "Spring 2024 Collection",
      "updatedAt": "1682505600",
      "createdAt": "1677628800",
      "bcGroupId": 102,
      "priceListAssign": [
        {
          "channelId": 5,
          "priceListId": 12,
          "priceListName": "Wholesale Pricing",
          "channelName": "Online Store"
        }
      ],
      "parentCompany": {
        "id": 1,
        "name": "Parent Company"
      }
    }
  ],
  "meta": {
    "message": "SUCCESS",
    "pagination": {
      "limit": 10,
      "offset": 1,
      "totalCount": 989
    }
  }
}

Get a list of all companies.

Authentication

authTokenstring

Required to authenticate requests. Include the token in a header parameter called authToken.

Query parameters

limitintegerOptionalDefaults to 10

Pagination limit

offsetintegerOptionalDefaults to 0

Pagination offset

minModifieddoubleOptional

Minimum modified timestamp

maxModifieddoubleOptional

Maximum modified timestamp

minCreateddoubleOptional

Minimum created timestamp

maxCreateddoubleOptional

Maximum created timestamp

sortByenumOptionalDefaults to updatedAt

Sort the result by a specific company field.

Allowed values:

orderByenumOptionalDefaults to DESC

Allow: ‘DESC’, ‘ASC’

Allowed values:

isIncludeExtraFieldsenumOptionalDefaults to 0

Whether the response will include extra fields.

Allowed values:

companyStatusenumOptional

0: PENDING 1: APPROVED 2: REJECTED 3: INACTIVE

Allowed values:

qstringOptional

Company query string

extraFieldslist of stringsOptional

Filter by extra fields.

bcOrderIdintegerOptional

A company purchases a BigCommerce order ID, which allows you to find the company by BigCommerce order ID.

orderIdstringOptional

Company purchase order ID

bcGroupIdstringOptional

BigCommerce customer group ID

customerIdintegerOptional

BigCommerce customer ID. This customer should be a B2B company user.

extraFieldFilterTypeenumOptionalDefaults to search

Extra field filter type. The search filter type allows for partial matches, while the exact-match filter type only returns results that exactly match the specified criteria.

Allowed values:

Response

codedouble

datalist of objects

metaobject

Used to response pagination information