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 Company Permissions
              • POSTCreate Company Permission
              • PUTUpdate Company Permission
              • DELDelete Company Permission
              • GETList Company Roles
              • POSTCreate Company Role
              • GETGet Company Role Detail
              • PUTUpdate Company Role
              • DELDelete Company Role
Dev Portal
LogoLogo
Closed Beta ProgramsB2B Edition UpdatesAPI ReferenceCompany Roles and Permissions

Get Company Role Detail

Beta
GET
https://api-b2b.bigcommerce.com/api/v3/io/companies/roles/:roleId
GET
/api/v3/io/companies/roles/:roleId
$curl https://api-b2b.bigcommerce.com/api/v3/io/companies/roles/1 \
>     -H "authToken: <apiKey>" \
>     -H "Content-Type: application/json"
200Example 1
1{
2  "code": 200,
3  "data": {
4    "id": 1,
5    "name": "Sales Manager",
6    "roleType": 2,
7    "roleLevel": 1,
8    "permissions": [
9      {
10        "id": 101,
11        "code": "view_orders",
12        "permissionLevel": 2
13      },
14      {
15        "id": 102,
16        "code": "edit_customers",
17        "permissionLevel": 1
18      }
19    ]
20  },
21  "meta": {
22    "message": "SUCCESS"
23  }
24}
Get company role detail
Was this page helpful?
Previous

Create Company Role

Next

Update Company Role

Built with

Authentication

authTokenstring

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

Path parameters

roleIdintegerRequired

Response

OK
codeinteger
dataobject
metaobject