latestOpenAPI 3.0.42026-08-2211752834.3 KB

fa74265a328d

UserAccount

Get entity from UserAccount by key

get/UserAccount({Id})

Idnumber nullable required

Id of the UserAccount

$selectstring[]

Select properties to be returned

$expandstring[]

Expand related entities

Retrieved entity

Idnumber

Internal identifier for ChurnZero.

AvatarUrlstring

The URL to this User's avatar image.

CanLogInboolean

True if this UserAccount is allowed to log into ChurnZero. UserAccounts that cannot log in can still own Accounts.

CrmIdstring

The Id of this UserAccount's linked user record in an external source, such as the tenant's CRM.

Emailstring

The User's email address.

FirstNamestring

The User's first name.

HasAccountsboolean

True if this UserAccount owns at least one Account in ChurnZero (see Account.UserAccountId).

IsActiveboolean

True if the UserAccount is active in ChurnZero.

LastNamestring

The User's last name.

MobilePhonestring

The User's mobile phone number.

Namestring

The User's full name.

ObjectCreatedDatestring date-time

The date/time the UserAccount record was created. ISO 8601 formatted string.

ObjectLastModifiedDatestring date-time

The date/time the UserAccount record was last modified. ISO 8601 formatted string.

OfficePhonestring

The User's office phone number.

Titlestring

The User's job title.

UserNamestring

The UserName this User uses to log into ChurnZero.