For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Dev Portal

Docs API Reference Learn Community Changelog

Overview
Docs
- Archive
- Closed Beta Programs

Dev Portal

Closed Beta Programs B2B Edition Updates API Reference Company

List Company Attachments

Beta

GET

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

GET

/api/v3/io/companies/:companyId/attachments

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

200Example 1

1 {
2   "code": 200,
3   "data": [
4     {
5       "id": "f593d7c8-078e-4bb6-af6b-688ef8df1a12",
6       "attachmentUrl": "https://xxx.com/xxx.csv"
7     }
8   ],
9   "meta": {
10     "message": "SUCCESS"
11   }
12 }

Get company attachments

Was this page helpful?

List Company Extra Field Configs

Add Company Attachment

Built with

Closed Beta Programs B2B Edition Updates API Reference Company

List Company Attachments

Beta

GET

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

GET

/api/v3/io/companies/:companyId/attachments

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

200Example 1

1 {
2   "code": 200,
3   "data": [
4     {
5       "id": "f593d7c8-078e-4bb6-af6b-688ef8df1a12",
6       "attachmentUrl": "https://xxx.com/xxx.csv"
7     }
8   ],
9   "meta": {
10     "message": "SUCCESS"
11   }
12 }

Get company attachments

Authentication

authTokenstring

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

Path parameters

companyIdintegerRequired

ID of company.

Response

codedouble

datalist of objects

metaobject

Was this page helpful?

List Company Extra Field Configs

Add Company Attachment

Built with

Authentication

authTokenstring

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

Path parameters

companyIdintegerRequired

ID of company.

Response

codedouble

datalist of objects

metaobject

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

1	{
2	"code": 200,
3	"data": [
4	{
5	"id": "f593d7c8-078e-4bb6-af6b-688ef8df1a12",
6	"attachmentUrl": "https://xxx.com/xxx.csv"
7	}
8	],
9	"meta": {
10	"message": "SUCCESS"
11	}
12	}