# MCP tool reference

1 callable tools.

Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.

Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.

[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)

## report_onboarding

Read or advance a workspace's onboarding and getting-started activation state.

Use to read activation progress or merge a single onboarding step's answers.

Step saves merge per-step; they are not a full-state overwrite.

Scopes: workspace:read, workspace:update

Risk: write; confirmation: none; idempotency: supported.

### Input schema (personal API key)

```json
{
  "type": "object",
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "getState"
              ]
            }
          ]
        },
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        }
      },
      "required": [
        "action",
        "workspaceId"
      ],
      "patternProperties": {
        "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "action",
          "workspaceId"
        ]
      }
    },
    {
      "type": "object",
      "properties": {
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "gettingStarted"
              ]
            }
          ]
        },
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        }
      },
      "required": [
        "action",
        "workspaceId"
      ],
      "patternProperties": {
        "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "action",
          "workspaceId"
        ]
      }
    },
    {
      "type": "object",
      "properties": {
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "saveStep"
              ]
            }
          ]
        },
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        },
        "step": {
          "type": "string",
          "enum": [
            "website",
            "company",
            "tools",
            "heardFrom",
            "role",
            "mailboxes"
          ]
        },
        "answers": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/Union_"
          }
        },
        "syncFavicon": {
          "type": "boolean"
        }
      },
      "required": [
        "action",
        "workspaceId",
        "step",
        "answers"
      ],
      "patternProperties": {
        "^(?!(?:action|workspaceId|step|answers|syncFavicon)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "action",
          "workspaceId",
          "step",
          "answers",
          "syncFavicon"
        ]
      }
    },
    {
      "type": "object",
      "properties": {
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "skip"
              ]
            }
          ]
        },
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        }
      },
      "required": [
        "action",
        "workspaceId"
      ],
      "patternProperties": {
        "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "action",
          "workspaceId"
        ]
      }
    },
    {
      "type": "object",
      "properties": {
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "complete"
              ]
            }
          ]
        },
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        }
      },
      "required": [
        "action",
        "workspaceId"
      ],
      "patternProperties": {
        "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "action",
          "workspaceId"
        ]
      }
    }
  ],
  "$defs": {
    "Union_": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "boolean"
        },
        {
          "type": "number"
        },
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Union_"
          }
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/Union_"
          }
        }
      ]
    },
    "ReportOnboardingInput": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "action": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "getState"
                  ]
                }
              ]
            },
            "workspaceId": {
              "type": "string",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
              "format": "uuid"
            }
          },
          "required": [
            "action",
            "workspaceId"
          ],
          "patternProperties": {
            "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "action",
              "workspaceId"
            ]
          }
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "gettingStarted"
                  ]
                }
              ]
            },
            "workspaceId": {
              "type": "string",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
              "format": "uuid"
            }
          },
          "required": [
            "action",
            "workspaceId"
          ],
          "patternProperties": {
            "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "action",
              "workspaceId"
            ]
          }
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "saveStep"
                  ]
                }
              ]
            },
            "workspaceId": {
              "type": "string",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
              "format": "uuid"
            },
            "step": {
              "type": "string",
              "enum": [
                "website",
                "company",
                "tools",
                "heardFrom",
                "role",
                "mailboxes"
              ]
            },
            "answers": {
              "type": "object",
              "additionalProperties": {
                "$ref": "#/$defs/Union_"
              }
            },
            "syncFavicon": {
              "type": "boolean"
            }
          },
          "required": [
            "action",
            "workspaceId",
            "step",
            "answers"
          ],
          "patternProperties": {
            "^(?!(?:action|workspaceId|step|answers|syncFavicon)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "action",
              "workspaceId",
              "step",
              "answers",
              "syncFavicon"
            ]
          }
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "skip"
                  ]
                }
              ]
            },
            "workspaceId": {
              "type": "string",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
              "format": "uuid"
            }
          },
          "required": [
            "action",
            "workspaceId"
          ],
          "patternProperties": {
            "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "action",
              "workspaceId"
            ]
          }
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "complete"
                  ]
                }
              ]
            },
            "workspaceId": {
              "type": "string",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
              "format": "uuid"
            }
          },
          "required": [
            "action",
            "workspaceId"
          ],
          "patternProperties": {
            "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "action",
              "workspaceId"
            ]
          }
        }
      ]
    }
  }
}
```

### Input schema (OAuth / delegated agent)

```json
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "format": "uuid",
      "description": "Target Workspace UUID. Call list_workspaces to enumerate the Workspaces this credential may access, then pass the chosen id here."
    }
  },
  "required": [
    "workspaceId"
  ],
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        },
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "getState"
              ]
            }
          ]
        }
      },
      "required": [
        "action",
        "workspaceId"
      ],
      "patternProperties": {
        "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId)$)[\\s\\S]*$)": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "action",
              "workspaceId"
            ]
          },
          {
            "enum": [
              "workspaceId"
            ]
          }
        ]
      }
    },
    {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        },
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "gettingStarted"
              ]
            }
          ]
        }
      },
      "required": [
        "action",
        "workspaceId"
      ],
      "patternProperties": {
        "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId)$)[\\s\\S]*$)": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "action",
              "workspaceId"
            ]
          },
          {
            "enum": [
              "workspaceId"
            ]
          }
        ]
      }
    },
    {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        },
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "saveStep"
              ]
            }
          ]
        },
        "step": {
          "type": "string",
          "enum": [
            "website",
            "company",
            "tools",
            "heardFrom",
            "role",
            "mailboxes"
          ]
        },
        "answers": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/Union_"
          }
        },
        "syncFavicon": {
          "type": "boolean"
        }
      },
      "required": [
        "action",
        "workspaceId",
        "step",
        "answers"
      ],
      "patternProperties": {
        "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|step|answers|syncFavicon)$)[\\s\\S]*$)": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "action",
              "workspaceId",
              "step",
              "answers",
              "syncFavicon"
            ]
          },
          {
            "enum": [
              "workspaceId"
            ]
          }
        ]
      }
    },
    {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        },
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "skip"
              ]
            }
          ]
        }
      },
      "required": [
        "action",
        "workspaceId"
      ],
      "patternProperties": {
        "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId)$)[\\s\\S]*$)": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "action",
              "workspaceId"
            ]
          },
          {
            "enum": [
              "workspaceId"
            ]
          }
        ]
      }
    },
    {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
          "format": "uuid"
        },
        "action": {
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "complete"
              ]
            }
          ]
        }
      },
      "required": [
        "action",
        "workspaceId"
      ],
      "patternProperties": {
        "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId)$)[\\s\\S]*$)": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "action",
              "workspaceId"
            ]
          },
          {
            "enum": [
              "workspaceId"
            ]
          }
        ]
      }
    }
  ],
  "$defs": {
    "Union_": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "boolean"
        },
        {
          "type": "number"
        },
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Union_"
          }
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/Union_"
          }
        }
      ]
    },
    "ReportOnboardingInput": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "action": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "getState"
                  ]
                }
              ]
            },
            "workspaceId": {
              "type": "string",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
              "format": "uuid"
            }
          },
          "required": [
            "action",
            "workspaceId"
          ],
          "patternProperties": {
            "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "action",
              "workspaceId"
            ]
          }
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "gettingStarted"
                  ]
                }
              ]
            },
            "workspaceId": {
              "type": "string",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
              "format": "uuid"
            }
          },
          "required": [
            "action",
            "workspaceId"
          ],
          "patternProperties": {
            "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "action",
              "workspaceId"
            ]
          }
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "saveStep"
                  ]
                }
              ]
            },
            "workspaceId": {
              "type": "string",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
              "format": "uuid"
            },
            "step": {
              "type": "string",
              "enum": [
                "website",
                "company",
                "tools",
                "heardFrom",
                "role",
                "mailboxes"
              ]
            },
            "answers": {
              "type": "object",
              "additionalProperties": {
                "$ref": "#/$defs/Union_"
              }
            },
            "syncFavicon": {
              "type": "boolean"
            }
          },
          "required": [
            "action",
            "workspaceId",
            "step",
            "answers"
          ],
          "patternProperties": {
            "^(?!(?:action|workspaceId|step|answers|syncFavicon)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "action",
              "workspaceId",
              "step",
              "answers",
              "syncFavicon"
            ]
          }
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "skip"
                  ]
                }
              ]
            },
            "workspaceId": {
              "type": "string",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
              "format": "uuid"
            }
          },
          "required": [
            "action",
            "workspaceId"
          ],
          "patternProperties": {
            "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "action",
              "workspaceId"
            ]
          }
        },
        {
          "type": "object",
          "properties": {
            "action": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "complete"
                  ]
                }
              ]
            },
            "workspaceId": {
              "type": "string",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
              "format": "uuid"
            }
          },
          "required": [
            "action",
            "workspaceId"
          ],
          "patternProperties": {
            "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "action",
              "workspaceId"
            ]
          }
        }
      ]
    }
  }
}
```

### Output schema (structuredContent)

```json
{
  "$defs": {
    "Union_": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "boolean"
        },
        {
          "type": "number"
        },
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Union_"
          }
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/Union_"
          }
        }
      ]
    },
    "UtcDateTimeEncoded": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
    },
    "ReportOnboardingOutput": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "connectInbox": {
              "type": "boolean"
            },
            "importLeads": {
              "type": "boolean"
            },
            "createCampaign": {
              "type": "boolean"
            },
            "launchCampaign": {
              "type": "boolean"
            },
            "verifyLeads": {
              "type": "boolean"
            },
            "inviteTeam": {
              "type": "boolean"
            }
          },
          "required": [
            "connectInbox",
            "importLeads",
            "createCampaign",
            "launchCampaign",
            "verifyLeads",
            "inviteTeam"
          ],
          "patternProperties": {
            "^(?!(?:connectInbox|importLeads|createCampaign|launchCampaign|verifyLeads|inviteTeam)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "connectInbox",
              "importLeads",
              "createCampaign",
              "launchCampaign",
              "verifyLeads",
              "inviteTeam"
            ]
          }
        },
        {
          "type": "object",
          "properties": {
            "organizationId": {
              "type": "string",
              "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
              "format": "uuid"
            },
            "companySize": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "solo",
                    "2_5",
                    "6_10",
                    "11_25",
                    "26_50",
                    "51_200",
                    "200_plus"
                  ]
                },
                {
                  "type": "null"
                }
              ]
            },
            "answers": {
              "type": "object",
              "additionalProperties": {
                "$ref": "#/$defs/Union_"
              }
            },
            "completedSteps": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "website",
                  "company",
                  "tools",
                  "heardFrom",
                  "role",
                  "mailboxes"
                ]
              }
            },
            "completedAt": {
              "anyOf": [
                {
                  "$ref": "#/$defs/UtcDateTimeEncoded"
                },
                {
                  "type": "null"
                }
              ]
            },
            "skippedAt": {
              "anyOf": [
                {
                  "$ref": "#/$defs/UtcDateTimeEncoded"
                },
                {
                  "type": "null"
                }
              ]
            },
            "createdAt": {
              "anyOf": [
                {
                  "$ref": "#/$defs/UtcDateTimeEncoded"
                },
                {
                  "type": "null"
                }
              ]
            },
            "updatedAt": {
              "anyOf": [
                {
                  "$ref": "#/$defs/UtcDateTimeEncoded"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          "required": [
            "organizationId",
            "companySize",
            "answers",
            "completedSteps",
            "completedAt",
            "skippedAt",
            "createdAt",
            "updatedAt"
          ],
          "patternProperties": {
            "^(?!(?:organizationId|companySize|answers|completedSteps|completedAt|skippedAt|createdAt|updatedAt)$)[\\s\\S]*$": false
          },
          "additionalProperties": true,
          "propertyNames": {
            "type": "string",
            "enum": [
              "organizationId",
              "companySize",
              "answers",
              "completedSteps",
              "completedAt",
              "skippedAt",
              "createdAt",
              "updatedAt"
            ]
          }
        }
      ]
    }
  },
  "type": "object",
  "anyOf": [
    {
      "allOf": [
        {
          "$ref": "#/$defs/ReportOnboardingOutput"
        },
        {
          "type": "object"
        }
      ]
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "allOf": [
            {
              "$ref": "#/$defs/ReportOnboardingOutput"
            },
            {
              "not": {
                "type": "object"
              }
            }
          ]
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false
    }
  ]
}
```

### Underlying API operations

- `workspaces.gettingStarted`: `GET /v1/workspaces/:workspaceId/getting-started`
- `workspaces.onboarding.get`: `GET /v1/workspaces/:workspaceId/onboarding`
- `workspaces.onboarding.saveStep`: `POST /v1/workspaces/:workspaceId/onboarding/steps`
- `workspaces.onboarding.skip`: `POST /v1/workspaces/:workspaceId/onboarding/skip`
- `workspaces.onboarding.complete`: `POST /v1/workspaces/:workspaceId/onboarding/complete`