List Company Hierarchy

GET

https://api-b2b.bigcommerce.com/api/v3/io/companies/:companyId/hierarchy

GET

/api/v3/io/companies/:companyId/hierarchy

$ curl -G https://api-b2b.bigcommerce.com/api/v3/io/companies/123456/hierarchy \
>      -H "X-Auth-Token: <apiKey>" \
>      -d limit=10 \
>      -d offset=3

1 {
2   "data": [
3     {
4       "companyId": 1,
5       "companyName": "Company A",
6       "companyStatus": 1,
7       "subsidiaries": [
8         {
9           "companyId": 2,
10           "companyName": "Company B",
11           "companyStatus": 1,
12           "subsidiaries": [
13             {
14               "companyId": 4,
15               "companyName": "Company D",
16               "companyStatus": 1,
17               "subsidiaries": [
18                 {
19                   "companyId": 5,
20                   "companyName": "Company E",
21                   "companyStatus": 1,
22                   "subsidiaries": [
23                     {
24                       "companyId": 6,
25                       "companyName": "Company F",
26                       "companyStatus": 1
27                     }
28                   ]
29                 }
30               ]
31             }
32           ]
33         },
34         {
35           "companyId": 3,
36           "companyName": "Company C",
37           "companyStatus": 1
38         }
39       ]
40     }
41   ],
42   "meta": {
43     "message": "SUCCESS",
44     "pagination": {
45       "totalCount": 2,
46       "limit": 10,
47       "offset": 0
48     }
49   }
50 }

Returns all parent and child accounts in the hierarchy of a particular Company.

The default rate limit for this endpoint is 500 calls/min per store.

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

companyIdintegerRequired

Unique numeric ID of the Company account.

Query parameters

offsetintegerOptionalDefaults to 0

The number of results to skip before returning the first result. If left blank, this defaults to 0.

limitintegerOptionalDefaults to 10

Determines the number of records to return per page. If left blank, this defaults to 10.

Response

datalist of objectsOptional

metaobjectOptional

Errors

404

Not Found Error