List Super Admins with Assigned Companies

GET

https://api-b2b.bigcommerce.com/api/v3/io/companies/super-admins

GET

/api/v3/io/companies/super-admins

curl -G https://api-b2b.bigcommerce.com/api/v3/io/companies/super-admins \
     -H "X-Auth-Token: <apiKey>" \
     -d maxCreated=1745868780 \
     -d maxModified=1745868780 \
     -d minCreated=1745868780 \
     -d minModified=1745868780 \
     -d q=alice \
     -d uuid=b2b-uuid-1

200Retrieved

{
  "code": 200,
  "data": [
    {
      "channelList": [
        {
          "channelId": 1,
          "channelName": "Great Buys Wholesale",
          "iconUrl": "https://s3.amazonaws.com/bc-channel-platform/channel-icons/bigcommerce.svg"
        }
      ],
      "createdAt": 1745868780,
      "email": "marie.curie@example.com",
      "extraFields": [
        {
          "fieldName": "customField1",
          "fieldValue": "foo"
        }
      ],
      "firstName": "Marie",
      "id": 123456,
      "lastName": "Curie",
      "phone": "string",
      "updatedAt": 1750962754,
      "uuid": "string"
    }
  ],
  "meta": {
    "message": "Success",
    "pagination": {
      "totalCount": 789,
      "limit": 10,
      "offset": 0
    }
  }
}

Returns a list of Super Admins with basic account data and a count of Companies associated with them. The id returned with Super Admin data may be used with other Super Admin API endpoints as the superAdminId.

Authentication

X-Auth-Tokenstring

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Query parameters

limitintegerOptional1-200Defaults to 10

Maximum number of entries to return per page of results.

offsetintegerOptional>=0Defaults to 0

The number of entries to skip before returning the current page of results.

orderByenumOptionalDefaults to DESC

Determines whether results will be sorted in acending (ASC) or descending (DESC) order.

Allowed values:

qstringOptional

Search string for the request. Response data will be limited to accounts matching this string in firstName, lastName, or email.

uuidstringOptional

Filter results by uuid. An empty uuid parameter will return all results.

maxCreatedstringOptional

Filter results by createdAt, returning only those with a Unix timestamp value less than maxCreated.

minCreatedstringOptional

Filter results by createdAt, returning only those with a Unix timestamp value greater than minCreated.

maxModifiedstringOptional

Filter results by updatedAt, returning only those with a Unix timestamp value less than maxModified.

minModifiedstringOptional

Filter results by updatedAt, returning only those with a Unix timestamp value greater than minModified.

isIncludeExtraFieldsenumOptionalDefaults to 0

Indicates whether to include extra fields in the response. A value of 0 will exclude extra fields, while a value of 1 will include them.

Allowed values:

Response

SUCCESS

codeintegerOptionalDefaults to 200

datalist of objectsOptional

metaobjectOptional