List Company Roles

Beta

GET

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

GET

/api/v3/io/companies/roles

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

200Retrieved

1 {
2   "code": 200,
3   "data": [
4     {
5       "id": 101,
6       "uuid": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f6a9d12",
7       "fieldName": "Company Registration Number",
8       "fieldType": 0,
9       "isRequired": true,
10       "isUnique": true,
11       "visibleToEnduser": true,
12       "configType": 1,
13       "defaultValue": "N/A",
14       "maximumLength": "20",
15       "numberOfRows": "",
16       "maximumValue": "",
17       "listOfValue": []
18     },
19     {
20       "id": 102,
21       "uuid": "b7d2e3f4-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
22       "fieldName": "Company Description",
23       "fieldType": 1,
24       "isRequired": false,
25       "isUnique": false,
26       "visibleToEnduser": true,
27       "configType": 2,
28       "defaultValue": "",
29       "maximumLength": "",
30       "numberOfRows": "5",
31       "maximumValue": "",
32       "listOfValue": []
33     },
34     {
35       "id": 103,
36       "uuid": "c8e9f0a1-b2c3-4d5e-6f7a-8b9c0d1e2f3a",
37       "fieldName": "Number of Employees",
38       "fieldType": 2,
39       "isRequired": false,
40       "isUnique": false,
41       "visibleToEnduser": false,
42       "configType": 2,
43       "defaultValue": "10",
44       "maximumLength": "",
45       "numberOfRows": "",
46       "maximumValue": "10000",
47       "listOfValue": []
48     }
49   ],
50   "meta": {
51     "pagination": {
52       "totalCount": 3,
53       "limit": 10,
54       "offset": 0
55     }
56   }
57 }

Get company roles

Authentication

authTokenstring

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

Query parameters

qstringOptional

Search by company role name

offsetintegerOptionalDefaults to 0

Pagination offset

limitintegerOptionalDefaults to 10

Pagination limit

Response

codeinteger

datalist of objects

metaobject