Get checklist progress
const url = 'https://api.ultimateteam.ai/api/v1/onboarding/checklist';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/checklist \ --header 'X-API-Key: <X-API-Key>'Returns the onboarding checklist progress for the authenticated tenant. Creates a new row with all-false defaults if none exists.
Authorizations
Section titled “Authorizations”Responses
Section titled “ Responses ”Successful Response
Response for GET/PUT /api/v1/onboarding/checklist.
Contains the completion status for all 9 checklist items plus computed aggregate fields.
Attributes: setup_profile: Whether user completed their profile. setup_business_info: Whether user added business info. setup_first_integration: Whether user connected first integration. activate_read_brief: Whether user read first morning brief. activate_chat_agent: Whether user chatted with an agent. activate_review_decision: Whether user reviewed a decision. optimize_custom_kpi: Whether user created a custom KPI. optimize_second_integration: Whether user connected second integration. optimize_invite_team: Whether user invited a team member. all_complete: True when all 9 items are completed. completed_count: Number of completed items (0-9). total_count: Total number of items (always 9).
object
Example
{ "activate_chat_agent": false, "activate_read_brief": false, "activate_review_decision": false, "all_complete": false, "completed_count": 0, "optimize_custom_kpi": false, "optimize_invite_team": false, "optimize_second_integration": false, "setup_business_info": false, "setup_first_integration": false, "setup_profile": false, "total_count": 9}