List Super Admins with Assigned Companies | BigCommerce Developer Center

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

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:

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.

Filter results by `createdAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value less than `maxCreated`.

minCreatedstringOptional

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

Filter results by `createdAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value greater than `minCreated`.

maxModifiedstringOptional

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

Filter results by `updatedAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) value less than `maxModified`.

minModifiedstringOptional

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

Filter results by `updatedAt`, returning only those with a [Unix timestamp](https://www.unixtimestamp.com/) 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

codeintegerDefaults to 200

datalist of objects

metaobject

1	import requests
2
3	url = "https://api-b2b.bigcommerce.com/api/v3/io/companies/super-admins"
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	"channelList": [
6	{
7	"channelId": 2,
8	"channelName": "Global Wholesale",
9	"iconUrl": "https://s3.amazonaws.com/bc-channel-platform/channel-icons/global-wholesale.svg"
10	},
11	{
12	"channelId": 5,
13	"channelName": "Retail Partners",
14	"iconUrl": "https://s3.amazonaws.com/bc-channel-platform/channel-icons/retail-partners.svg"
15	}
16	],
17	"createdAt": 1700000000,
18	"email": "alice.johnson@bigcommerce.com",
19	"extraFields": [
20	{
21	"fieldName": "region",
22	"fieldValue": "North America"
23	},
24	{
25	"fieldName": "department",
26	"fieldValue": "Sales"
27	}
28	],
29	"firstName": "Alice",
30	"id": 987654,
31	"lastName": "Johnson",
32	"phone": "+1-555-123-4567",
33	"updatedAt": 1705000000,
34	"uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
35	},
36	{
37	"channelList": [
38	{
39	"channelId": 1,
40	"channelName": "Great Buys Wholesale",
41	"iconUrl": "https://s3.amazonaws.com/bc-channel-platform/channel-icons/bigcommerce.svg"
42	}
43	],
44	"createdAt": 1695000000,
45	"email": "marie.curie@example.com",
46	"extraFields": [
47	{
48	"fieldName": "customField1",
49	"fieldValue": "foo"
50	}
51	],
52	"firstName": "Marie",
53	"id": 123456,
54	"lastName": "Curie",
55	"phone": "+1-555-987-6543",
56	"updatedAt": 1701000000,
57	"uuid": "b2b-uuid-1"
58	}
59	],
60	"meta": {
61	"message": "Success",
62	"pagination": {
63	"totalCount": 789,
64	"limit": 10,
65	"offset": 0
66	}
67	}
68	}