Get Onboarding Progress

GET

/api/v1/onboarding/progress

const url = 'https://api.ultimateteam.ai/api/v1/onboarding/progress';
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/onboarding/progress \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

ApiKeyAuth

Responses

200

Successful Response

application/json

OnboardingProgressResponse

object

charter

required

TenantConstitutionResponse

The tenant-wide Standing Operating Charter (one row per tenant).

object

acknowledgement

Any of:

object
null

object

key

additional properties

any

brand_voice_strictness

required

Brand Voice Strictness

string

communication_autonomy

required

Communication Autonomy

string

competitor_sensitivity

required

Competitor Sensitivity

string

configured

required

Configured

boolean

dispatch_pending

Dispatch Pending

boolean

financial_auth_limit

required

Financial Auth Limit

number

risk_tolerance

required

Risk Tolerance

string

updated_at

required

Any of:

string
null

string format: date-time

profile

required

Any of:

SavedOnboardingProfile
null

SavedOnboardingProfile

object

description

required

Description

string

industry

required

Industry

string

involvement_level

required

Involvement Level

string

name

required

Name

string

services

Any of:

string
null

string

stage

required

Stage

string

website_url

Any of:

string
null

string

scan_id

Any of:

string
null

string

team_status

required

Team Status

string

Example

{
  "charter": {
    "dispatch_pending": false
  }
}