Get onboarding conversation state

GET

/api/v1/enterprise/onboarding

const url = 'https://api.ultimateteam.ai/api/v1/enterprise/onboarding';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/enterprise/onboarding \
  --header 'X-API-Key: <X-API-Key>'

Returns the current enterprise onboarding progress for the authenticated tenant, including which steps are completed, the current step, and results for completed steps.

Authorizations

ApiKeyAuth

Responses

200

Successful Response

application/json

OnboardingStateResponse

Response for GET /api/v1/enterprise/onboarding.

Attributes: tenant_id: The tenant identifier. current_step: The next step to complete (1-6, or 7 if all done). total_steps: Total number of onboarding steps (always 6). completed_steps: List of completed step numbers. steps: Full state for all 6 steps. is_complete: Whether all steps have been completed.

object

completed_steps

required

Completed Steps

Array<integer>

current_step

required

Current Step

integer

is_complete

required

Is Complete

boolean

steps

required

Steps

Array<object>

OnboardingStepState

State for a single onboarding step.

Attributes: step_number: The step number (1-6). name: Step name (e.g. ‘map_organization’). status: ‘pending’, ‘completed’, or ‘skipped’. result: Step result if completed, None otherwise.

object

name

required

Name

string

result

Any of:

Result
null

Result

status

required

Status

string

step_number

required

Step Number

integer

tenant_id

required

Tenant Id

string

total_steps

Total Steps

integer

default: 6

Example

{
  "total_steps": 6
}