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

Company id of the company to obtain information from

companyUsers.query ● String scalar

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

companyUsers.offset ● Int scalar

The index of the page to fetch, defaults to 0

companyUsers.limit ● Int scalar

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

companyUsers.sortBy ● CompanyUsersSortField enum

Sorting key in the response

companyUsers.sortDirection ● SortOrder enum

Sorting order of the response

Type

CompanyUsers object

Loading...