Skip to main content

User

The User type represents a user in the system.

type User {
id: UUID!
contracts(
statuses: [ContractPhase!]
ids: [UUID!]
first: Int! = 10
after: String
last: Int! = 0
before: String
): ContractConnection!
customerNumber: String!
email: String!
firstName: String!
surname: String!
middleName: String
phoneNumber: String!
birthDate: Time!
vendor: Vendor!
}

Fields

User.id ● UUID! non-null scalar

The unique identifier of the user.

User.contracts ● ContractConnection! non-null object

Returns the contracts for the user. For simplicity all contracts not in ContractPhase DELIVERY_STOPPED, NEVER_DELIVERED or DELIVERY_FAILED are considered active. These contracts are ordered by the start date.

User.contracts.statuses ● [ContractPhase!] list enum

A list of contract statuses to filter by.

User.contracts.ids ● [UUID!] list scalar

A list of specific contract IDs to retrieve.

User.contracts.first ● Int! non-null scalar

The number of contracts to return from the beginning.

User.contracts.after ● String scalar

The cursor for pagination, denoting contracts to return after this cursor.

User.contracts.last ● Int! non-null scalar

The number of contracts to return from the end.

User.contracts.before ● String scalar

The cursor for pagination, denoting contracts to return before this cursor.

User.customerNumber ● String! non-null scalar

The customer number of the user.

User.email ● String! non-null scalar

The user's login and contact email.

User.firstName ● String! non-null scalar

The user's first name.

User.surname ● String! non-null scalar

The user's surname.

User.middleName ● String scalar

The user's middle name. This is optional.

User.phoneNumber ● String! non-null scalar

The user's phone number.

User.birthDate ● Time! non-null scalar

The user's birth date.

User.vendor ● Vendor! non-null object

The vendor of the user is the company that sells energy to the user through the platform. A user can only have one vendor.

Returned By

me query

Implemented By

UpdateMyProfileResponse union