Get Success Plan Profile
GET/api/success-plan/profile
Returns the profile, every field labeled with where it came from.
success_plan:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Each field is {value, auto, source, label, evidence, detail, original, entered_by, at}. Fields SKU.io fills in from your account (region from the store address, orders_per_month_band, sku_count_band, channels, fulfillment, accounting) are auto: true, labeled M, with a detail such as "3,412 orders in Sep 2026". Once you change one, it is labeled C and original keeps SKU.io's value. Answered fields (industry, team_size, previous_tools, trigger, alternatives) are labeled C; in retrospective mode the look-back answers carry evidence: recall. pain_quote is kept as a quote in the story log (story_entry_id).
Also returned with no question asked: kickoff_at, go_live_on, days_to_go_live, migrated.skus, migrated.open_pos (labeled values), features_used, and complete (industry, region, team size and the previous tools for inventory and orders are answered). mode is the plan mode.
Authentication: Requires Bearer token with the success_plan:read scope. The user must hold the success_plan.view permission.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.