Get Super Admin Details

GET

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

GET

/api/v3/io/super-admins/info/:superAdminId

$ curl https://api-b2b.bigcommerce.com/api/v3/io/super-admins/info/11 \
>      -H "X-Auth-Token: <apiKey>"

1 {
2   "code": 200,
3   "data": {
4     "channelList": [
5       {
6         "channelId": 1,
7         "channelName": "Great Buys Wholesale",
8         "iconUrl": "https://s3.amazonaws.com/bc-channel-platform/channel-icons/bigcommerce.svg"
9       }
10     ],
11     "createdAt": 1745868780,
12     "customerId": 343,
13     "email": "marie.curie@example.com",
14     "extraFields": [
15       {
16         "fieldName": "customField1",
17         "fieldValue": "foo"
18       }
19     ],
20     "firstName": "Marie",
21     "id": 123456,
22     "lastName": "Curie",
23     "phone": "string",
24     "updatedAt": 1750962754,
25     "uuid": "string"
26   },
27   "meta": {
28     "message": "Success"
29   }
30 }

Returns detailed information about the Super Admin account associated with 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.

| 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-fundamentals/api-accounts). | For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/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

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

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

Path parameters

superAdminIdintegerRequired

The unique ID of the Super Admin account. Does not match the BigCommerce customer account ID.

Response

SUCCESS

codeintegerDefaults to 200

dataobject

metaobject

Errors

404

Not Found Error