Get Sharing Consent
GET/api/success-plan/consent
Returns the current sharing consent and its full history, newest first.
success_plan:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Fields: status (unset, open, ask_later, no) with status_label, permissions (name_company, use_figures, name_person; set only while open), set_by, set_at, and history (id, status, status_label, permissions, via (settings, goal_met_prompt, staff_recorded), set_by, set_at, note).
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.