admin toolset
get_setup_checklist
Get the setup checklist. What's left to set up in this workspace: branding, boards, team, the widget, an AI client and a custom domain. Each step says whether it's done (detected from the workspace, or marked by hand) and links to where to do it. Use it to guide a new owner. Team only. No side effects.
- Toolset
- admin
- Who can call it
- OwnersManagersContributorsAPI keys
- REST
GET /api/v1/w/{workspace}/setup- Behavior
- read-onlyidempotent
Input
No input.
Output
| Field | Type | Description |
|---|---|---|
stepsrequired | array of object | |
donerequired | integer | |
totalrequired | integer | |
completerequired | boolean | |
dismissedrequired | boolean | Hidden from Home; it can still be read here. |
Calling it
// MCP: tools/call
{ "name": "get_setup_checklist", "arguments": {} }
// Typed client
await carechannel.get_setup_checklist({});