Loki Docs
Tools › Profile › Get habits profile

Get habits profile

get_profileReads
What it does
Reads only. Changes nothing.
Permission
Profile, read profile:read

What your assistant is told

Read the calling user's Habits profile - primary goal, tracker experience, focus area, reminder posture, week start, IANA time zone, day-start offset (see below), plus any optional context they shared (preferred daily-check-in time, birth year, notes). Optional fields may be null; dayStartOffsetMinutes is always present and defaults to 0. dayStartOffsetMinutes is when their logical day rolls over, in minutes past local midnight (0 = plain midnight; 120 = a 2am rollover, so a 1am check-in counts for the day that just ended). If the user hasn't onboarded yet the call still succeeds with optional fields null so the coach can offer to fill them in.

Parameters

Takes no parameters.