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
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
  • Overview
    • Quick Start
    • Sandboxes
    • Tools & SDKs
    • Support
  • Docs
    • Archive
    • Closed Beta Programs
        • Overview
        • API Reference
              • GETList Companies
              • POSTCreate Company
              • GETGet Company Detail
              • PUTUpdate Company
              • DELDelete Company
              • POSTConvert from BigCommerce CustomerGroup into Company
              • POSTBulk Create Companies
              • PUTUpdate Companies (batch)
              • PUTUpdate Company's Catalog
              • PUTUpdate Company's Status
              • GETList Company Extra Field Configs
              • GETList Company Attachments
              • POSTAdd Company Attachment
              • DELDelete Company Attachment
              • GETList Company Subsidiaries
              • DELDelete Company Subsidiary
              • POSTAttach Company as Parent to Current Company
              • GETList Company Hierarchy
Dev Portal
LogoLogo
Closed Beta ProgramsB2B Edition UpdatesAPI ReferenceCompany

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?
Previous

List Company Extra Field Configs

Next

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

OK
codedouble
datalist of objects
metaobject