BigCommerce Docs

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

{
  "code": 200,
  "data": {
    "companyId": "147340",
    "companyName": "Glam Squad Hair and Makeup Artistry",
    "bcGroupName": "salons",
    "companyStatus": "1",
    "companyEmail": "support@bundleb2b.net",
    "companyPhone": "123456789",
    "uuid": "",
    "catalogId": "",
    "catalogName": "",
    "updatedAt": "1618794615",
    "createdAt": "1618787774",
    "extraFields": [
      {
        "dataType": "2",
        "fieldName": "extraStr1",
        "fieldValue": "extra_text",
        "isRequired": "0",
        "labelName": "Enter your license"
      }
    ],
    "bcGroupId": "1",
    "parentCompany": {
      "id": 1,
      "name": "Parent Company"
    }
  },
  "meta": {
    "message": "SUCCESS"
  }
}

Get details about a specific company.

Authentication

authTokenstring

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

Path parameters

companyIdintegerRequired

ID of company.

Response

codedouble

dataobject

metaobject

Errors

404

Not Found Error

Get Company Detail

Get Company Detail

Authentication

Path parameters

Response

Errors

Authentication

Path parameters

Response

Errors

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

1	{
2	"code": 200,
3	"data": {
4	"companyId": "147340",
5	"companyName": "Glam Squad Hair and Makeup Artistry",
6	"bcGroupName": "salons",
7	"companyStatus": "1",
8	"companyEmail": "support@bundleb2b.net",
9	"companyPhone": "123456789",
10	"uuid": "",
11	"catalogId": "",
12	"catalogName": "",
13	"updatedAt": "1618794615",
14	"createdAt": "1618787774",
15	"extraFields": [
16	{
17	"dataType": "2",
18	"fieldName": "extraStr1",
19	"fieldValue": "extra_text",
20	"isRequired": "0",
21	"labelName": "Enter your license"
22	}
23	],
24	"bcGroupId": "1",
25	"parentCompany": {
26	"id": 1,
27	"name": "Parent Company"
28	}
29	},
30	"meta": {
31	"message": "SUCCESS"
32	}
33	}