Skip to main content

User

Represents information about a user.

type User {
id: ID!
firstName: String
lastName: String
displayName: String
email: String
account: Account!
roles: [Role!]
isAccountOwner: Boolean
status: UserStatus
language: String
abilities: JSON
permissions: [Permission]
modules: [Module!]
setting(name: String!): Setting
globalSetting(name: String!): Setting
position: String
createdAt: DateTimeTz!
updatedAt: DateTimeTz!
deletedAt: DateTimeTz
phones(
where: UserPhonesWhereWhereConditions
orderBy: [UserPhonesOrderByOrderByClause!]
first: Int! = 10
after: String
): PhoneConnection!
contacts(
where: UserContactsWhereWhereConditions
orderBy: [UserContactsOrderByOrderByClause!]
first: Int! = 10
after: String
): ContactConnection!
companies(
where: UserCompaniesWhereWhereConditions
orderBy: [UserCompaniesOrderByOrderByClause!]
first: Int! = 10
after: String
): CompanyConnection!
people(
where: UserPeopleWhereWhereConditions
orderBy: [UserPeopleOrderByOrderByClause!]
first: Int! = 10
after: String
): PersonConnection!
projects(
where: UserProjectsWhereWhereConditions
orderBy: [UserProjectsOrderByOrderByClause!]
first: Int! = 10
after: String
): ProjectConnection!
}

Fields

User.id ● ID! non-null scalar

User's unique identifier.

User.firstName ● String scalar

The user's first name.

User.lastName ● String scalar

The user's last name.

User.displayName ● String scalar

The user's full name.

User.email ● String scalar

The user's email address.

User.account ● Account! non-null object

The user's account relationship.

User.roles ● [Role!] list object

The user's role.

User.isAccountOwner ● Boolean scalar

Determine whether the user is the account owner.

User.status ● UserStatus enum

Determine the user's status.

User.language ● String scalar

Determine the user's language.

User.abilities ● JSON scalar

The user's abilities.

User.permissions ● [Permission] list object

The user's permissions.

User.modules ● [Module!] list object

The user's modules.

User.setting ● Setting object

The user's setting.

User.setting.name ● String! non-null scalar

User.globalSetting ● Setting object

The user's global setting, that looks for a value from both the user and as a fallback from the account.

User.globalSetting.name ● String! non-null scalar

User.position ● String scalar

The user's position.

User.createdAt ● DateTimeTz! non-null scalar

The date and time when the user was created.

User.updatedAt ● DateTimeTz! non-null scalar

The date and time when the user was last updated.

User.deletedAt ● DateTimeTz scalar

The date and time when the user was deleted.

User.phones ● PhoneConnection! non-null object

The user's phone numbers.

User.phones.where ● UserPhonesWhereWhereConditions input
User.phones.orderBy ● [UserPhonesOrderByOrderByClause!] list input
User.phones.first ● Int! non-null scalar

Limits number of fetched items. Maximum allowed value: 50.

User.phones.after ● String scalar

A cursor after which elements are returned.

User.contacts ● ContactConnection! non-null object

A list of contacts associated with the user.

User.contacts.where ● UserContactsWhereWhereConditions input
User.contacts.orderBy ● [UserContactsOrderByOrderByClause!] list input
User.contacts.first ● Int! non-null scalar

Limits number of fetched items. Maximum allowed value: 50.

User.contacts.after ● String scalar

A cursor after which elements are returned.

User.companies ● CompanyConnection! non-null object

A list of companies associated with the user.

User.companies.where ● UserCompaniesWhereWhereConditions input
User.companies.orderBy ● [UserCompaniesOrderByOrderByClause!] list input
User.companies.first ● Int! non-null scalar

Limits number of fetched items. Maximum allowed value: 50.

User.companies.after ● String scalar

A cursor after which elements are returned.

User.people ● PersonConnection! non-null object

A list of people associated with the user.

User.people.where ● UserPeopleWhereWhereConditions input
User.people.orderBy ● [UserPeopleOrderByOrderByClause!] list input
User.people.first ● Int! non-null scalar

Limits number of fetched items. Maximum allowed value: 50.

User.people.after ● String scalar

A cursor after which elements are returned.

User.projects ● ProjectConnection! non-null object

A list of projects associated with the user.

User.projects.where ● UserProjectsWhereWhereConditions input
User.projects.orderBy ● [UserProjectsOrderByOrderByClause!] list input
User.projects.first ● Int! non-null scalar

Limits number of fetched items. Maximum allowed value: 50.

User.projects.after ● String scalar

A cursor after which elements are returned.

Returned By

addUserPhone mutation ● assignRole mutation ● deleteUser mutation ● me query ● restoreUser mutation ● updateUser mutation ● updateUserPhones mutation ● updateUserRoles mutation ● user query

Member Of

Activity object ● AuthPayload object ● Comment object ● Company object ● Contact object ● Contract object ● ContractMembersEdge object ● Coordination object ● CoordinationMembersEdge object ● Easement object ● Expense object ● File object ● Invite object ● Invoice object ● Letter object ● LetterMembersEdge object ● Meter object ● Notification object ● Ordinance object ● OrdinanceMembersEdge object ● Person object ● Project object ● ProjectMembersEdge object ● Property object ● Quote object ● Reading object ● Role object ● Specification object ● SpecificationMembersEdge object ● Submission object ● SubmissionMembersEdge object ● Task object ● TaskMembersEdge object ● UserEdge object