/userpreferences/me

Returns your user preferences document. Without fields it returns every stored key, which can be large; the schema lists the common ones.

Some settings can be managed by your workspace role: addUnsubscribeLinkToSequences, defaultUnsubscribeText, shareOptions, defaultAutoSyncToTeamFeed, logNonMixmaxMessagesInsightsLiveFeed, autoBccExcludedEmails and autoBccExcludedDomains. Unless the role lets you manage them yourself, the role's value is returned instead of yours. For the two exclusion lists, the role's and your values are combined.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Comma-separated keys to return. Dotted paths such as calendarAppointmentSlots.linkEnabled work. _id and userId are always included. Leave it out to get every key.

boolean

Pass any value to add finalDefaultCalendarUrl, your scheduling page URL for your default meeting template. Any value, even false, turns this on.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
Psst... like working with APIs? Come join us!