Skip to main content
Version: Beta

companyUsers

Enterprise
description

Fetches basic data for users in a company given the company's ID. Client admins can only fetch users from their own company.

companyUsers(
  companyId: Int
  query: String = ""
  offset: Int = 0
  limit: Int = 100
  sortBy: CompanyUsersSortField = LAST_NAME
  sortDirection: SortOrder = ASC
): CompanyUsers!

Arguments​

companyUsers.companyId ● Int scalar graph-ql-types​

Company id of the company to obtain information from

companyUsers.query ● String scalar graph-ql-types​

The criterion to filter users, supports searching by prefix in username, first name, last name, and email

companyUsers.offset ● Int scalar graph-ql-types​

The index of the page to fetch, defaults to 0

companyUsers.limit ● Int scalar graph-ql-types​

The number of users to fetch per page, 100 as maximum

companyUsers.sortBy ● CompanyUsersSortField enum graph-ql-types​

Sorting key in the response

companyUsers.sortDirection ● SortOrder enum graph-ql-types​

Sorting order of the response

Type​

CompanyUsers object graph-ql-types​

Loading...