List Companies with Assigned Super Admins | BigCommerce Developer Center

Returns a list of Companies with basic Company data and a count of Super Admins associated with them. The companyId returned with Company data may be used with B2B Edition Companies API endpoints (see Company Management or Companies and Users for more information).

Returns a list of Companies with basic Company data and a count of Super Admins associated with them. The `companyId` returned with Company data may be used with B2B Edition Companies API endpoints (see [Company Management](/developer/api-reference/rest/b2b/management/companies) or [Companies and Users](/developer/api-reference/rest/b2b/storefront/companies) for more information).

Authentication

X-Auth-Tokenstring

Authentication header

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

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

X-Store-Hashstring

Authentication header

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

### Authentication header | 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:

Response

SUCCESS

codeintegerDefaults to 200

datalist of objects

metaobject

1	import requests
2
3	url = "https://api-b2b.bigcommerce.com/api/v3/io/super-admins/companies"
4
5	payload = {}
6	headers = {
7	"X-Auth-Token": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.get(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"code": 200,
3	"data": [
4	{
5	"addressLine1": "456 Commerce Blvd",
6	"addressLine2": "Suite 300",
7	"city": "Dallas",
8	"companyEmail": "contact@acmeindustrial.com",
9	"companyId": 98765,
10	"companyName": "Acme Industrial Supplies",
11	"country": "United States",
12	"description": "Acme Industrial Supplies",
13	"state": "Texas",
14	"superAdminCount": 3,
15	"zipCode": "75201"
16	},
17	{
18	"addressLine1": "789 Innovation Drive",
19	"addressLine2": "Floor 5",
20	"catalogId": "pl-456789",
21	"city": "San Francisco",
22	"companyEmail": "admin@greentech.com",
23	"companyId": 12346,
24	"companyName": "GreenTech Solutions",
25	"country": "US",
26	"description": "GreenTech Solutions",
27	"state": "California",
28	"superAdminCount": 2,
29	"zipCode": "94107"
30	}
31	],
32	"meta": {
33	"message": "Success",
34	"pagination": {
35	"totalCount": 789,
36	"limit": 10,
37	"offset": 0
38	}
39	}
40	}