User
The user object is based on the portable contacts specification. It is extended with some custom fields. userId
is an integer and represents the unique user ID, while id
is a legacy uuid and should be ignored in new integrations. The uuid
is also a user identifier, which is is globally unique and should therefore be the preferred identifier for a user. The email
and phoneNumber
fields will always contain the primary used for both if available. The corresponding *Verified fields are the date of the last time those were verified.
When requesting a user that is not connected to the authorized client, only public profile data will be available:
id
userId
uuid
status
displayName
name
gender
preferredUsername
utcOffset
published
updated
lastLoggedIn
locale
tracking
id ✓ | stringLegacy |
---|---|
userId ✓ | integer (as string)Unique user ID. Custom extension. |
uuid ✓ | stringUnique user UUID. Custom extension. Should be preferred as the user identifier. |
name ✓ | NameJSON object containing |
displayName ✓ | stringName suitable for displaying to end-users. |
published ✓ | date-timeThe date this user was first added. Can return false if the user account was deleted. |
updated ✓ | date-timeThe most recent date the details of this user were updated |
status ✓ | User status |
email ✓ | stringPrimary email |
emailVerified | stringDate when the email was last verified. |
emails ✓ | list of Email addressesAll user's registered email addresses. |
phoneNumber | stringPrimary phone number |
phoneNumberVerified | stringDate when the phone number was last verified. |
phoneNumbers | list of Phone numbersAll user's registered phone numbers. |
verified | stringDate when user last verified data (email, phone number). Returns false if user wasn't verified. |
url | string |
photo | stringURL to a photo of the user (GIF/JPG/PNG) |
preferredUsername | string |
gender ✓ | stringOne of undisclosed, female, male, other, withheld. Default is undisclosed. Portable contacts |
birthday ✓ | dateDate of birth in YYYY-MM-DD format. Year will be 0000 if not provided. Defaults to 0000-00-00. Portable contacts |
locale ✓ | stringThe user's preferred locale. Locales follow ISO Language and country codes respectively, joined by an underscore. |
utcOffset ✓ | stringThe user's timezone, given as offset from UTC. |
lastLoggedIn ✓ | datetimeReturns false if the user has not been logged in before. |
lastAuthenticated ✓ | datetimeThe last time the user authenticated with their password. Returns false if the user has not been authenticated before. |
imported | datetime |
migrated | datetime |
addresses | collection of Addresses, as an object with |
accounts | list of Third-party accountsThird-party accounts and other client services |
merchants | arrayList of Schibsted account merchants the user is connected to |
currentLocation | list of AddressesIf user has no current location returns empty array. |
tracking | booleanIf |
The check mark ✓ indicates that the field always contains a valid non-empty value.
Comments/feedback
Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. Our team reads and responds to every question. Additionally, your experience can help others using Schibsted account, and it can help us continuously improve our documentation.