profile

Fetch the authenticated user profile.

Returns the singleton profile for the caller. Read-only fields (is_premium, subscription_*, firestore_id, gamification counters) are included but cannot be PATCHed back.

get/profile

Request

  • Base URL: https://restivity.ai/api/v1
  • URL: https://restivity.ai/api/v1/profile
  • Auth: OAuth 2 (authorization code, authorization URL https://restivity.ai/oauth/authorize, token URL https://restivity.ai/api/oauth/token, scopes: profile:read)

Response

The profile.

idstring uuid required
display_namestring required
photo_urlstring nullable required
biostring required
occupationstring required
themestring required
languagestring required
timezonestring required
first_day_of_weekinteger required
show_weekendsboolean required
weekend_daysinteger[] required
notifications_enabledboolean required
preferred_work_methodstring required
pomodoro_work_durationinteger required
pomodoro_short_breakinteger required
pomodoro_long_breakinteger required
pomodoro_long_break_intervalinteger required
pomodoro_preferred_breakstring required
pomodoro_auto_start_breaksboolean required
pomodoro_auto_start_workboolean required
pomodoro_sound_enabledboolean required
pomodoro_notifications_enabledboolean required
pomodoro_volumenumber required
timer_soundstring required
focus_musicstring required
total_focus_timeinteger required
tasks_completedinteger required

Tasks this user has completed: the tasks they moved to completed (still completed, not in the Trash) plus the reminder occurrences they completed. Counted on every read.

current_streakinteger required
longest_streakinteger required
levelinteger required
pointsinteger required
is_premiumboolean required
created_atstring
localestring required
default_view'today' | 'inbox' | 'project' required

Changes

No recorded changes to this operation across all 1 revision of this API.