Perk's identifier. Used to authenticate to Perk. Usually an email address, but might be any string. There is a separate email field below if a guaranteed valid email address is required.
name
object
The name of the user. Check table below for more information.
preferred_language
string
Indicates the user's preferred written or spoken language.
locale
string
Indicates the User's default location for purposes of localizing such items as currency, date time format, or numerical representations.
active
boolean
Will have a value of true if the user is able to log into Perk, false otherwise.
job_title
string
The user's job title.
phone_numbers
array[string]
The User's phone numbers.
emergency_contact
object
Who to contact in case the user is in an emergency. Check table below for more information.
email
string
Email address associated with the user. This will often, but not always, be the same as the user_name.