The User model

The User object

AttributeTypeDescription
idstringUnique identifier of the User.
user_namestringPerk'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.
nameobjectThe name of the user. Check table below for more information.
preferred_languagestringIndicates the user's preferred written or spoken language.
localestringIndicates the User's default location for purposes of localizing such items as currency, date time format, or numerical representations.
activebooleanWill have a value of true if the user is able to log into Perk, false otherwise.
job_titlestringThe user's job title.
phone_numbersarray[string]The User's phone numbers.
emergency_contactobjectWho to contact in case the user is in an emergency. Check table below for more information.
emailstringEmail address associated with the user. This will often, but not always, be the same as the user_name.

User name object

AttributeTypeDescription
last_namestringThe family name of the user.
first_namestringThe given name of the user.
middle_namestringThe middle name(s) of the user.
titlestringThe honorific prefix(es) of the user.

User emergency contact object

AttributeTypeDescription
namestringName of the emergency contact.
phonestringPhone number of the emergency contact.
{
  "id":"7",
  "user_name":"[email protected]",
  "name":{
    "last_name":"Morrison",
    "first_name":"Boss",
    "middle_name":"",
    "title":"MR"
  },
  "preferred_language":"en",
  "locale":"en-gb",
  "active":true,
  "job_title":"Boss",
  "phone_numbers":[
    "+34 123456789"
  ],
  "emergency_contact":{
    "name":"Mrs. Morrison",
    "phone":"+34 987654321"
  },
  "email": "[email protected]"
}