Get Goal Templates
GET/api/success-plan/templates
Lists the goal templates in display order. Each template has its key, name, metric_key (what SKU.io measures, or null), allowed units (the first is the default), direction, measurement (measured, customer or hybrid), the check_in_question asked later, help, options (option key to allowed values), directions (only custom offers a choice) and by_role (hours are entered per role).
success_plan:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
In kickoff mode a measured template carries measured_suggestion: SKU.io's labeled figure for last month, with method_version and counts, that you can use as the baseline (baseline.use_measured). In retrospective mode the response carries before_period and each template a before_question about the month before go-live instead, never an early SKU.io figure; growth_without_hires may also carry imported_offer, the orders imported from before go-live (from, to, covers_period, value).
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.