Introduction

This stage loads what a rooftop has contracted, which Vini agents it bought, and its onboarding checklist. It then marks checklist tasks done as setup work finishes.

Endpoint	Method and path	What it does
Get contracting data	`GET /credit/v6/get-team-contracting-data`	Returns the rooftop's active contracts and the product lines and products on each.
Get contract product lines	`GET /user-management/v1/team-onboarding/get-contract-product-lines`	Returns the product lines in onboarding and whether the user is the reseller owner.
List active Vini products	`GET /user-management/v1/vini/active-products`	Lists the Vini agents the rooftop bought, by category.
Get the onboarding checklist	`GET /console/v1/onboarding/task/get-onboarding-task-v2`	Returns the checklist by agent segment and section, with each task's status.
Get contracted agent details	`GET /console/v1/product-onboarding/vini/agents/teams/{teamId}/enterpriseId/{enterpriseId}`	Returns each contracted agent type and the created agent's summary.
Mark a task done	`POST /console/v1/product-onboarding/onboarding-tracker/bulk-complete-shared-task`	Marks a task completed, or sets it back to in progress, by name.

Order of calls

Get contracting data
Get contract product lines
List active Vini products
Get the onboarding checklist
Get contracted agent details
Mark a task done as each setup task finishes, then get the checklist again to refresh status.

Base URL and headers

Every path starts with https://api.spyne.ai. Send the signed-in console user's session token on every call:

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Content-Type is needed only on the POST call.

Agents, segmentName and entity

Each Vini agent has its own checklist segment. segmentName is the agent's product name. It is the key under product_group.segment_name in the checklist response, and the value you send as segmentName when you mark an Agent Setup or Go Live Readiness task done. entity is the agent key used by the per-agent Go Live readiness configuration.

Agent	`segmentName`	`entity`
Service inbound	`inboundService`	`service_inbound`
Service outbound	`outboundService`	`service_outbound`

When to send segmentName: leave it out for Rooftop Setup and Integrations tasks. Send it for Agent Setup and Go Live Readiness tasks.

segmentName is matched case-sensitively when you mark a task done. Send it exactly as shown.
A segment exists only for a rooftop that bought that agent. Checklist rows for a segment are created only for the product names the rooftop has.

Checklist task names

Pass these as taskName when you mark a task done. Matching is exact but ignores case, so spacing and punctuation must match. Task rows come from the product line's task template, and a row appears only if the template created it for the rooftop's segment. Check the strings against task_name in the checklist response before you hard-code them.

Section (`task_group_name`)	Task name	Send `segmentName`
Rooftop Setup	`Rooftop Setup`	No
Rooftop Setup	`Department Details & Holidays`	No
Rooftop Setup	`User Setup`	No
Rooftop Setup	`CNAM Registration`	No
Rooftop Setup	`Employee Directory`	No
Integrations	`CRM Integration`	No
Integrations	`IMS Integration`	No
Integrations	`Vehicle History Integration`	No
Integrations	`DMS Integration`	No
Integrations	`Service Scheduler`	No
Agent Setup	`Agent Customization`	Yes
Agent Setup	`Assign Number`	Yes
Agent Setup	`Service Policies`	Yes
Agent Setup	`Upload Call Transcripts / Recordings`	Yes
Agent Setup	`Chatbot Script` (receptionist only)	Not written by the API
Go Live Readiness	`After Hours`	Yes
Go Live Readiness	`Office Hours - Overflow`	Yes
Go Live Readiness	`Office Hours - All Leads`	Yes
Go Live Readiness	`Office Hours Overflow calls`	Yes
Go Live Readiness	`All Office Hours`	Yes
Go Live Readiness	`Run First Campaign`	Yes
Go Live Readiness	`CRM Credentials`	Yes
Go Live Readiness	`DMS Credentials`	Yes
Go Live Readiness	`Upload Reports and Show Campaigns`	Yes
Go Live Readiness	`Smart View` (currently hidden in the checklist)	Yes

Rooftop Setup and Integrations tasks are shared across the rooftop. Without segmentName, one call updates the matching task in every segment and every product line the rooftop has.
Rooftop Setup is also accepted as RoofTop Setup, because matching ignores case.
DMS Integration is sent without segmentName, so it updates every segment that has a task with that name.
Chatbot Script is never marked done through this API. The checklist treats it as done when a website chat script exists for the rooftop.
Which Go Live Readiness tasks a segment has depends on the template for that agent. The receptionist checklist does not show the Go Live Readiness section.