BigCommerce Docs

query ExampleQuery($companyId: Int, $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $search: String) {
  companyRoles(companyId: $companyId, offset: $offset, before: $before, after: $after, first: $first, last: $last, search: $search) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node
      cursor
    }
    totalCount
  }
}

{
  "companyId": 0,
  "offset": 0,
  "before": "example",
  "after": "example",
  "first": 0,
  "last": 0,
  "search": "example"
}

{
  "data": {
    "companyRoles": {
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example",
        "endCursor": "example"
      },
      "edges": [
        {
          "node": {
            "id": null,
            "name": null,
            "roleType": null,
            "roleLevel": null
          },
          "cursor": "example"
        }
      ],
      "totalCount": 0
    }
  }
}

Get company roles, which can be searched by name, code. Requires a B2B Token.

Arguments

companyIdIntegerOptional

ID of the company, optional

offsetIntegerOptional

beforeStringOptional

afterStringOptional

firstIntegerOptional

lastIntegerOptional

searchStringOptional

Returns

an optional CompanyRolesTypeCountableConnection

pageInfoPageInfo

Pagination data for this connection.

edgeslist of CompanyRolesTypeCountableEdges

totalCountInteger

A total count of items in the collection.

1	query ExampleQuery($companyId: Int, $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $search: String) {
2	companyRoles(companyId: $companyId, offset: $offset, before: $before, after: $after, first: $first, last: $last, search: $search) {
3	pageInfo {
4	hasNextPage
5	hasPreviousPage
6	startCursor
7	endCursor
8	}
9	edges {
10	node
11	cursor
12	}
13	totalCount
14	}
15	}

1	{
2	"companyId": 0,
3	"offset": 0,
4	"before": "example",
5	"after": "example",
6	"first": 0,
7	"last": 0,
8	"search": "example"
9	}

1	{
2	"data": {
3	"companyRoles": {
4	"pageInfo": {
5	"hasNextPage": true,
6	"hasPreviousPage": true,
7	"startCursor": "example",
8	"endCursor": "example"
9	},
10	"edges": [
11	{
12	"node": {
13	"id": null,
14	"name": null,
15	"roleType": null,
16	"roleLevel": null
17	},
18	"cursor": "example"
19	}
20	],
21	"totalCount": 0
22	}
23	}
24	}