v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-224341,4072.0 MB

Onboarding Settings

Get

Get retrieves the current onboarding progress for the tenant.

get/api/v1/settings/onboarding

Response

Successful response

conversationIdstring

The identifier of the onboarding conversation thread, if one is in progress.

intentsstring[] nullable

The intents field.

status'ONBOARDING_STATUS_UNSPECIFIED' | 'ONBOARDING_STATUS_NOT_STARTED' | 'ONBOARDING_STATUS_IN_PROGRESS' | 'ONBOARDING_STATUS_COMPLETE' | 'ONBOARDING_STATUS_DISMISSED'

The current status of the tenant onboarding process.