users

Example Query

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 }

Variables

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": 0,
12   "search": "example",
13   "companyRoleId": 0
14 }

Example response

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 }

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

roleDoubleOptional

searchStringOptional

companyRoleIdDoubleOptional

Returns

an optional UserTypeCountableConnection

pageInfoPageInfo

Pagination data for this connection.

edgeslist of UserTypeCountableEdges

totalCountInteger

A total count of items in the collection.