Skip to main content
GET
/
v0
/
user
/
me
/
cta
Get personalized calls-to-action
curl --request GET \
  --url https://api.sumvin.com/v0/user/me/cta \
  --header 'x-sumvin-pat: <api-key>'
{
  "_links": {
    "self": {
      "href": "/v0/user/me/cta"
    }
  },
  "ctas": [
    {
      "category": "trust-ladder",
      "cta": "Review your portfolio allocation",
      "meta": {
        "color": "teal",
        "icon": "chart"
      },
      "trust_stage_target": "connected",
      "type": "home",
      "urgency_score": 0.75
    }
  ],
  "generating": false,
  "refreshing": false
}

Authorizations

x-sumvin-pat
string
header
required

Personal access token issued to the Sumvin CLI. Send it in the x-sumvin-pat header to authenticate as the owning user.

Headers

x-sumvin-token
string | null
x-sumvin-pat
string | null
x-juno-jwt
string | null
x-juno-orgid
string | null

Tenant org ID for multi-tenant auth

X-Timestamp-Format
string

Controls how timestamp fields are serialized in JSON response bodies.

Default (header omitted or any other value): epoch milliseconds as integers. iso8601: UTC ISO 8601 strings of the form YYYY-MM-DDTHH:MM:SSZ.

Example: with X-Timestamp-Format: iso8601, the field value 1704067200000 becomes "2024-01-01T00:00:00Z".

Affected fields (recursively, in dicts and arrays): any field whose name ends in _at, plus the literal field names timestamp, period_start, and period_end. All other fields are passed through unchanged.

Only iso8601 is recognized. Any other value (or omitting the header) yields the default epoch-ms representation; the server does not reject unknown values, so this is documented as an example rather than an enum to keep generated clients permissive.

Example:

"iso8601"

Query Parameters

type
enum<string> | null

Filter by CTA type (home or chat). Omit for both.

Available options:
home,
chat

Response

CTAs returned (may be partial if generating)

Response containing personalized calls-to-action.

HAL-style hypermedia links for navigation and available actions.

ctas
CTAData · object[]
required

List of CTAs for the requested type(s).

generating
boolean
default:false

True if CTAs are being generated in the background. Client should poll again shortly.

refreshing
boolean
default:false

True if stale CTAs are being refreshed in the background. Current CTAs are still valid.