Skip to main content

SyncUser

type SyncUser = {
[key: string]: unknown;
activatedUser: boolean;
autoReminder: number;
avatarBig?: string;
avatarMedium?: string;
avatarS640?: string;
avatarSmall?: string;
businessAccountId: string | null;
dailyGoal: number;
dateFormat: "DD/MM/YYYY" | "MM/DD/YYYY";
dateistLang: string | null;
daysOff: number[];
email: string;
featureIdentifier: string;
features: {
[key: string]: unknown;
autoInviteDisabled?: boolean;
beta: boolean;
dateistInlineDisabled: boolean;
dateistLang: any;
goldTheme?: boolean;
hasPushReminders: boolean;
karmaDisabled: boolean;
karmaVacation: boolean;
migratedFromTdb?: boolean;
restriction: number;
};
freeTrailExpires?: string;
fullName: string;
gettingStartedGuideProjects: | {
[key: string]: unknown;
closed: boolean;
completed: boolean;
onboardingUseCase: string;
projectId: string;
}[]
| null;
hasMagicNumber: boolean;
hasPassword: boolean;
hasStartedATrial?: boolean;
id: string;
imageId: string | null;
inboxProjectId: string;
isCelebrationsEnabled: boolean;
isPremium: boolean;
joinableWorkspace: | {
[key: string]: unknown;
memberCount: number;
workspaceId: string;
workspaceName: string;
}
| null;
joinedAt: string;
karma: number;
karmaTrend: string;
lang: string;
mfaEnabled?: boolean;
mobileHost: string | null;
mobileNumber: string | null;
nextWeek: | "Monday"
| "Tuesday"
| "Wednesday"
| "Thursday"
| "Friday"
| "Saturday"
| "Sunday";
onboardingCompleted?: boolean | null;
onboardingInitiated?: boolean | null;
onboardingLevel?: string | null;
onboardingPersona?: string | null;
onboardingRole?: string | null;
onboardingSkipped?: boolean;
onboardingTeamMode?: boolean | null;
onboardingUseCases?: string[] | null;
premiumStatus: | "not_premium"
| "current_personal_plan"
| "legacy_personal_plan"
| "teams_business_member";
premiumUntil: string | null;
rambleSessionsUsage?: | {
currentCount: number;
limit: number;
remaining: number;
resetDate: string;
}
| null;
shareLimit: number;
sortOrder: number;
startDay: | "Monday"
| "Tuesday"
| "Wednesday"
| "Thursday"
| "Friday"
| "Saturday"
| "Sunday";
startPage: string;
themeId: string;
timeFormat: "24h" | "12h";
token: string;
tzInfo: {
[key: string]: unknown;
gmtString: string;
hours: number;
isDst: boolean;
minutes: number;
timezone: string;
};
uniquePrefix: number;
verificationStatus: string;
websocketUrl: string;
weekendStartDay: number;
weeklyGoal: number;
};

Sync API user resource.

This is a superset of the REST CurrentUserSchema — the Sync API returns many additional fields for features, onboarding state, and account details.

Type Declaration

Index Signature

[key: string]: unknown
NameTypeDefault value
activatedUserboolean-
autoRemindernumber-
avatarBig?string-
avatarMedium?string-
avatarS640?string-
avatarSmall?string-
businessAccountIdstring | null-
dailyGoalnumber-
dateFormat"DD/MM/YYYY" | "MM/DD/YYYY"DateFormatSchema
dateistLangstring | null-
daysOffnumber[]-
emailstring-
featureIdentifierstring-
features{ [key: string]: unknown; autoInviteDisabled?: boolean; beta: boolean; dateistInlineDisabled: boolean; dateistLang: any; goldTheme?: boolean; hasPushReminders: boolean; karmaDisabled: boolean; karmaVacation: boolean; migratedFromTdb?: boolean; restriction: number; }FeaturesSchema
features.autoInviteDisabled?boolean-
features.betabooleanBooleanFromZeroOneSchema
features.dateistInlineDisabledboolean-
features.dateistLangany-
features.goldTheme?boolean-
features.hasPushRemindersboolean-
features.karmaDisabledboolean-
features.karmaVacationboolean-
features.migratedFromTdb?boolean-
features.restrictionnumber-
freeTrailExpires?string-
fullNamestring-
gettingStartedGuideProjects| { [key: string]: unknown; closed: boolean; completed: boolean; onboardingUseCase: string; projectId: string; }[] | null-
hasMagicNumberboolean-
hasPasswordboolean-
hasStartedATrial?boolean-
idstring-
imageIdstring | null-
inboxProjectIdstring-
isCelebrationsEnabledboolean-
isPremiumboolean-
joinableWorkspace| { [key: string]: unknown; memberCount: number; workspaceId: string; workspaceName: string; } | null-
joinedAtstring-
karmanumber-
karmaTrendstring-
langstring-
mfaEnabled?boolean-
mobileHoststring | null-
mobileNumberstring | null-
nextWeek| "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday"DayOfWeekSchema
onboardingCompleted?boolean | null-
onboardingInitiated?boolean | null-
onboardingLevel?string | null-
onboardingPersona?string | null-
onboardingRole?string | null-
onboardingSkipped?boolean-
onboardingTeamMode?boolean | null-
onboardingUseCases?string[] | null-
premiumStatus| "not_premium" | "current_personal_plan" | "legacy_personal_plan" | "teams_business_member"-
premiumUntilstring | null-
rambleSessionsUsage?| { currentCount: number; limit: number; remaining: number; resetDate: string; } | null-
shareLimitnumber-
sortOrdernumber-
startDay| "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday"DayOfWeekSchema
startPagestring-
themeIdstring-
timeFormat"24h" | "12h"TimeFormatSchema
tokenstring-
tzInfo{ [key: string]: unknown; gmtString: string; hours: number; isDst: boolean; minutes: number; timezone: string; }TzInfoSchema
tzInfo.gmtStringstring-
tzInfo.hoursnumber-
tzInfo.isDstbooleanBooleanFromZeroOneSchema
tzInfo.minutesnumber-
tzInfo.timezonestring-
uniquePrefixnumber-
verificationStatusstring-
websocketUrlstring-
weekendStartDaynumber-
weeklyGoalnumber-