Fields

accounts : [AccountInterface]

List of accounts that the user is linked to either via portfolio role or account role.
Arguments
allowedBrandCodes : [BrandChoices]

Optionally filter the user's accounts to only return those linked to portfolios on the specified brands.
excludeAccountsWithoutAgreements : Boolean

Optionally exclude accounts that have never had an agreement.
excludeAccountTypes : [AccountTypeChoices]

Optionally exclude accounts with any of the given account types.
restrictToAccountNumbers : [String]

Optionally restrict user accounts to only return those with the specified account numbers.
restrictToPublicFacingBrands : Boolean

Optionally restrict user accounts to only return those linked to portfolios on public facing brands.
accountUserRoles : [AccountUserRoleType]

List of roles a user has for each account they're linked to.
Arguments
accountNumber : String

Optionally filter the user's account roles to only return those linked to specific accounts.
address : RichAddressType

This user's address.
alternativePhoneNumbers : [String]

List of alternative phone numbers for the account user.
businesses : BusinessConnectionTypeConnection

List of businesses that the user has access to through their granted roles.
Arguments
after : String
before : String
first : Int
last : Int
consents : [ConsentType!]! required

Consents linked to this user.
createdAt : DateTime! required
dateOfBirth : Date

AccountUser's date of birth.
details : [AccountUserDetailType]

List of details linked to this user.
displayName : String

We recommend you use fullName instead of this field.
Deprecation
The 'displayName' field is deprecated.

Please use fullName instead of this field.

- Marked as deprecated on 2019-12-11.
- Scheduled for removal on or after 2024-01-01.
email : String! required
externalId : String

The value set in the configured external ID details namespace.
familyName : String! required
firstName : String

We recommend you use preferredName or fullName instead of this field.
Deprecation
The 'firstName' field is deprecated.

Use 'givenName' instead.

- Marked as deprecated on 2020-09-23.
- Scheduled for removal on or after 2023-06-05.
fullName : String

The user's full name.
givenName : String! required
hasFamilyIssues : Boolean

Whether there are family issues.
holdMusicChoices : [TrackOptionType]

List of hold music options.
id : ID! required
isActive : Boolean

Whether this user is active.
isDeceased : Boolean! required

Designates whether this user is deceased.
isInHardship : Boolean

True if user is linked to an account with an active hardship agreement.
isOptedInToWof : Boolean
label : String

A free text field to help identifying the customer (e.g. for a job title).
landline : String! required
landlinePhoneNumber : String

The user's landline phone number.
Deprecation
The 'landlinePhoneNumber' field is deprecated.

Use 'landline' instead.

- Marked as deprecated on 2021-03-22.
- Scheduled for removal on or after 2024-01-01.
lastName : String

We recommend you use preferredName or fullName instead of this field.
Deprecation
The 'lastName' field is deprecated.

Use 'familyName' instead.

- Marked as deprecated on 2020-09-23.
- Scheduled for removal on or after 2023-06-05.
liveSecretKey : String

The user's secret key to access the Developer API.
mobile : String! required
number : String

A code that uniquely identifies the account user.
paymentMethods : PaymentInstructionConnectionTypeConnection

List payment instructions linked to this user.
Arguments
after : String
before : String
first : Int
last : Int
statuses : [PaymentInstructionStatus]

Optionally filter the payment instructions by status.
validAt : DateTime

Optionally return only payment instructions valid at the given datetime.
permissions : [AccountUserPermission]

Holds information about the permissions of the current viewer.
portfolioId : ID

We recommend you use portfolioIds instead of this field.
Deprecation
The 'portfolioId' field is deprecated.

Please use 'portfolioIds' instead.

- Marked as deprecated on 2022-08-04.
- Scheduled for removal on or after 2024-01-01.
portfolioIds : [ID]

List of portfolio ids that the user is linked to via their portfolio roles.
Arguments
allowedBrandCodes : [BrandChoices]

Optionally filter the user's portfolios to only return those linked to specified brands.
restrictToPublicFacingBrands : Boolean

Optionally restrict the user portfolios to only return those linked to public facing brands.
portfolios : PortfolioConnectionTypeConnection

List of portfolios that the user is linked to via their portfolio roles.
Arguments
after : String
allowedBrandCodes : [BrandChoices]

Optionally filter the user's portfolios to only return those linked to specified brands.
before : String
first : Int
last : Int
restrictToPublicFacingBrands : Boolean

Optionally restrict the user portfolios to only return those linked to public facing brands.
portfolioUserRoles : [PortfolioUserRoleType]

List of roles a user has for each portfolio they're linked to.
Arguments
accountNumber : String

Return the user portfolio roles for this account's portfolio.
portfolioNumber : String

Optionally filter the portfolio's user roles to only return those linked to a specific portfolio.
preferredName : String

The user's preferred name.
pronouns : String

The user's pronouns e.g. 'she/her', 'he/him', 'they/them'.
specialCircumstances : SpecialCircumstancesType
title : String
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "accounts": AccountInterface, "accountUserRoles": [AccountUserRoleType], "address": RichAddressType, "alternativePhoneNumbers": "specific-tough-agency-notice-actually", "businesses": BusinessConnectionTypeConnection, "consents": [ConsentType], "createdAt": "1986-10-09T18:57:22.467394+00:00", "dateOfBirth": "2008-02-18", "details": [AccountUserDetailType], "email": "right-power-away-health-south", "externalId": "68675854", "familyName": "Shaw", "fullName": "ground-more-a-kind-last", "givenName": "Kevin", "hasFamilyIssues": true, "holdMusicChoices": [TrackOptionType], "id": "63606929", "isActive": true, "isDeceased": true, "isInHardship": true, "isOptedInToWof": true, "label": "fund-room-number-both-truth", "landline": "him-news-yes-player-reveal", "liveSecretKey": "school-rock-current-type-over", "mobile": "might-visit-Republican-would-reflect", "number": "last-protect-culture-moment-question", "paymentMethods": PaymentInstructionConnectionTypeConnection, "permissions": [AccountUserPermission], "portfolioIds": "87758530", "portfolios": PortfolioConnectionTypeConnection, "portfolioUserRoles": [PortfolioUserRoleType], "preferences": AccountUserCommsPreferences, "preferredName": "international-if-technology-once-safe", "pronouns": "today-see-manage-second-policy", "specialCircumstances": SpecialCircumstancesType, "title": "possible-picture-imagine-picture-plant" }