List Company Hierarchy | BigCommerce Developer Center

curl https://api-b2b.bigcommerce.com/api/v3/io/companies/companyId/hierarchy \
     -H "authToken: <apiKey>"

{
  "data": [
    {
      "companyId": 1,
      "companyName": "Company A",
      "companyStatus": 1,
      "subsidiaries": [
        {
          "companyId": 2,
          "companyName": "Company B",
          "companyStatus": 1,
          "subsidiaries": [
            {
              "companyId": 4,
              "companyName": "Company D",
              "companyStatus": 1,
              "subsidiaries": [
                {
                  "companyId": 5,
                  "companyName": "Company E",
                  "companyStatus": 1,
                  "subsidiaries": [
                    {
                      "companyId": 6,
                      "companyName": "Company F",
                      "companyStatus": 1
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "companyId": 3,
          "companyName": "Company C",
          "companyStatus": 1
        }
      ]
    }
  ],
  "meta": {
    "message": "SUCCESS",
    "pagination": {
      "totalCount": 2,
      "limit": 10,
      "offset": 0
    }
  }
}

Get the complete hierarchy of current company, including its parent companies and subsidiaries. The API rate limit is 15 times/min per store.

Authentication

authTokenstring

Required to authenticate requests. Include the token in a header parameter called authToken.

Path parameters

companyIdstringRequired

Query parameters

offsetintegerOptionalDefaults to 0

Pagination offset.

limitintegerOptionalDefaults to 10

Pagination limit for subsidiaries of current company.

Response

datalist of objects

metaobject

Errors

404

Not Found Error

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	}