BigCommerce Docs

query ExampleQuery($companyId: Int, $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $email: String, $firstName: String, $lastName: String, $role: Decimal, $search: String, $companyRoleId: Decimal) {
  users(companyId: $companyId, offset: $offset, before: $before, after: $after, first: $first, last: $last, email: $email, firstName: $firstName, lastName: $lastName, role: $role, search: $search, companyRoleId: $companyRoleId) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node
      cursor
    }
    totalCount
  }
}

{
  "companyId": 0,
  "offset": 0,
  "before": "example",
  "after": "example",
  "first": 0,
  "last": 0,
  "email": "example",
  "firstName": "example",
  "lastName": "example",
  "role": "Decimal",
  "search": "example",
  "companyRoleId": "Decimal"
}

{
  "data": {
    "users": {
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example",
        "endCursor": "example"
      },
      "edges": [
        {
          "node": {
            "id": null,
            "createdAt": null,
            "updatedAt": null,
            "firstName": null,
            "lastName": null,
            "email": null,
            "phone": null,
            "bcId": null,
            "role": null,
            "masqueradingCompanyId": null
          },
          "cursor": "example"
        }
      ],
      "totalCount": 0
    }
  }
}

query ExampleQuery($companyId: Int, $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $email: String, $firstName: String, $lastName: String, $role: Decimal, $search: String, $companyRoleId: Decimal) {
  users(companyId: $companyId, offset: $offset, before: $before, after: $after, first: $first, last: $last, email: $email, firstName: $firstName, lastName: $lastName, role: $role, search: $search, companyRoleId: $companyRoleId) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node
      cursor
    }
    totalCount
  }
}

{
  "companyId": 0,
  "offset": 0,
  "before": "example",
  "after": "example",
  "first": 0,
  "last": 0,
  "email": "example",
  "firstName": "example",
  "lastName": "example",
  "role": "Decimal",
  "search": "example",
  "companyRoleId": "Decimal"
}

{
  "data": {
    "users": {
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example",
        "endCursor": "example"
      },
      "edges": [
        {
          "node": {
            "id": null,
            "createdAt": null,
            "updatedAt": null,
            "firstName": null,
            "lastName": null,
            "email": null,
            "phone": null,
            "bcId": null,
            "role": null,
            "masqueradingCompanyId": null
          },
          "cursor": "example"
        }
      ],
      "totalCount": 0
    }
  }
}

List of company users. Requires a B2B Token.

Arguments

companyIdIntegerRequired

The id of the company. This field is required.

offsetIntegerOptional

beforeStringOptional

afterStringOptional

firstIntegerOptional

lastIntegerOptional

emailStringOptional

firstNameStringOptional

lastNameStringOptional

roleDecimalOptional

searchStringOptional

companyRoleIdDecimalOptional

Returns

an optional UserTypeCountableConnection

pageInfoPageInfo

Pagination data for this connection.

edgeslist of UserTypeCountableEdges

totalCountInteger

A total count of items in the collection.

1	query ExampleQuery($companyId: Int, $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $email: String, $firstName: String, $lastName: String, $role: Decimal, $search: String, $companyRoleId: Decimal) {
2	users(companyId: $companyId, offset: $offset, before: $before, after: $after, first: $first, last: $last, email: $email, firstName: $firstName, lastName: $lastName, role: $role, search: $search, companyRoleId: $companyRoleId) {
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	"email": "example",
9	"firstName": "example",
10	"lastName": "example",
11	"role": "Decimal",
12	"search": "example",
13	"companyRoleId": "Decimal"
14	}

1	{
2	"data": {
3	"users": {
4	"pageInfo": {
5	"hasNextPage": true,
6	"hasPreviousPage": true,
7	"startCursor": "example",
8	"endCursor": "example"
9	},
10	"edges": [
11	{
12	"node": {
13	"id": null,
14	"createdAt": null,
15	"updatedAt": null,
16	"firstName": null,
17	"lastName": null,
18	"email": null,
19	"phone": null,
20	"bcId": null,
21	"role": null,
22	"masqueradingCompanyId": null
23	},
24	"cursor": "example"
25	}
26	],
27	"totalCount": 0
28	}
29	}
30	}