Skip to main content

Get Success Plan

GET 
/api/success-plan

Returns the whole success plan in one payload: the plan (mode is kickoff when the plan started near go-live, retrospective when it started more than 30 days after), the active goals with their baselines, latest readings, change, target and trend, this week's focus (the first off-track goal and its next step, or null), the check-in schedule, current sharing consent, the latest 20 story entries, drafts awaiting your review, and whether the profile is complete.

Required scope: success_plan:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

plan.go_live_on follows your inventory start date. plan.can_manage says whether the caller may make changes. health is always null for API tokens.

Authentication: Requires Bearer token with the success_plan:read scope. The user must hold the success_plan.view permission.

Goal objects carry id, template_key, template_name, metric_key (null for goals only the customer measures), title (the customer's own words), unit, direction, status (no_data, on_track, off_track, met, archived) with status_label, options, baseline, latest (the newest reading other than the current month) and current (this month's provisional measured figure), change (absolute, percent, mixed_sources, compared_with, baseline_compared_value), target (value, by_date), expected_now (a straight line from baseline to target), first_measurement_after, before_answered, before_period, first_30_days, trend (measured months, oldest first), next_steps (key, title, why, route, cta, done), hero_eligible and hero_ineligible_reasons (e.g. baseline_estimate, latest_not_settled, latest_missing), met_at, archived_at and created_at.

Labeled values. Every number in a success-plan response is an object, never a bare figure: value (or value_bool for yes/no goals), unit, source (measured, customer_entered, staff_entered), label (M, C or S), source_description, evidence (system, document, system_export, estimate, recall), as_of, period (Y-m for a measured month), state (provisional, settled, partial; measured months only), hero_eligible, range_low / range_high and confidence (estimates and recalled values), and a note. Stored readings also carry reading_id, breakdown (e.g. hours by role), method_version, counts (records included and excluded per rule), entered_by, is_baseline, supersedes_reading_id / superseded / restatement_reason for corrections, check_in_id, display (how the figure may be quoted: estimates read "about N (customer estimate)") and attachments.

Request​

Responses​

OK

Response Headers
    Content-Type