users

Example Query

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
  }
}

Variables

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

Example response

{
  "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

roleDoubleOptional

searchStringOptional

companyRoleIdDoubleOptional

Returns

an optional UserTypeCountableConnection

pageInfoPageInfo

Pagination data for this connection.

edgeslist of UserTypeCountableEdges

totalCountIntegerOptional

A total count of items in the collection.