address |
object |
Hash of address parts |
address. city |
string |
City |
address. country |
object |
Two digit ISO 3166-1 country code |
address. lines |
array |
List of (max 3) free format address lines |
address. postalCode |
string |
Postal code (free format) |
adminConditionsAccepted |
boolean |
Read-only Whether or not the user accepted Terms & Conditions for
network administrators |
avatarThumbnailUrl |
URI |
Network profile only File URL to profile picture thumbnail |
birthday |
string |
Date of birth (ISO 8601 YYYY-MM-DD) |
deleted |
boolean |
Since 1.0.4 Read-only Whether this user has been deleted or not |
EID |
EID |
Unique entity identifier |
emailAddresses |
array |
List of alternative email addresses |
external |
boolean |
Since 1.0.22 Read-only Whether this is an external user with
limited privileges |
fullName |
string |
Read-only Concatenated name parts |
gender |
string |
'female' , 'male' or 'complicated' |
headerBackgroundUrl |
URI |
File URL to header background image. In API versions up to 1.3.6
this is the URL of a pre-scaled thumbnail. In versions 1.3.7 and
higher this is the URL of the original file, which can be scaled by
adding w and h query parameters as described here:
Custom Thumbnails |
jobTitle |
string |
Network profile only Current job title |
languages |
array |
List of languages (ISO 639-1) |
lastModified |
datetime |
Since 1.0.4 Read-only Last time the user was modified |
name |
object |
Full name parts |
name. firstName |
string |
First name |
name. infix |
string |
Optional infices ('de' , 'van der ‘, 'von' , etc.) |
name. familyName |
string |
Family or last name |
preferredLanguage |
string |
Global user only Preferred language in RFC 5646/4647 format (e.g.
'en-US' or 'nl-NL' ) |
primaryEmail |
string |
Read-only Primary email address |
privacyStatementAccepted |
boolean |
Read-only Whether or not the user accepted Speakap’s general Terms &
Conditions |
relationshipStatus |
string |
Until 1.1.3 Relationship status |
telephoneNumbers |
array |
List of telephone numbers |
tourCompleted |
boolean |
Since 1.0.10 global user only Whether or not this user has
completed the tour at least once |
type |
string |
“user” |
XID |
string |
Since 1.1.3 Unique external identifier |