Skip to main content
GET
/
v1
/
onboarding
/
config
Get Onboarding Config
curl --request GET \
  --url https://api.example.com/v1/onboarding/config \
  --header 'Authorization: Bearer <token>'
{
  "welcome": {
    "title": "<string>",
    "subtitle": "<string>"
  },
  "connector_catalog": [
    {
      "id": "<string>",
      "label": "<string>",
      "icon": "<string>"
    }
  ],
  "alert_defaults": {
    "threshold": 123,
    "window": "<string>"
  },
  "invite_defaults": {
    "role": "<string>",
    "seats_available": 123
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

Spec shape for GET /onboarding/config (C-022).

welcome
OnboardingWelcome · object
required
connector_catalog
ConnectorCatalogEntry · object[]
required
alert_defaults
OnboardingAlertDefaults · object
required
invite_defaults
OnboardingInviteDefaults · object
required