> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Wealthbox

> How to set up the Wealthbox connector, plus the actions that are available.

![Wealthbox](https://stackone-logos.com/api/wealthbox/filled/svg)

v1.0.0[See changelog](https://docs.stackone.com/connectors/wealthbox/changelog.md)

[49 actions](#actions) · 2 auth methods

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Personal Access Token · Connector Profile](https://docs.stackone.com/connectors/wealthbox/guides/connector-profile/personal-access-token.md)
>
> Personal API access token sent in the ACCESS\_TOKEN header. No app registration required; requests run with the permissio...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/wealthbox/guides/connector-profile/oauth-2-0.md)
>
> Requires an OAuth client issued by Wealthbox support. Access is scoped to the authorizing user; access tokens last two h...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Personal Access Token · Link Account](https://docs.stackone.com/connectors/wealthbox/guides/link-account/personal-access-token.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/wealthbox/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

OAuth 2.0

Personal Access Token

No auth methods found

Scopes

Select all
|
Clear

data

No scopes found

49 actions

ActionDescriptionRequired scopes

List Activity Stream`wealthbox_list_activity`

List activity stream items for the authenticated user, optionally filtered by contact or document type

`data`

List Contact Roles`wealthbox_list_contact_roles`

List the contact roles defined in the workspace, such as Planning Advisor

`data`

List Custom Fields`wealthbox_list_custom_fields`

List custom field definitions in the workspace, optionally for one document type

`data`

List Tags`wealthbox_list_tags`

List the tags defined in the workspace, optionally for contacts or notes

`data`

List Category Members`wealthbox_list_category_members`

List the values of a customizable category such as task categories, opportunity stages or contact sources

`data`

List Comments`wealthbox_list_comments`

List comments on a record, filtered by resource and update window

`data`

List Contacts`wealthbox_list_contacts`

List contacts in the workspace, filtered by name, email, phone, type, tags or update window

`data`

Create Contact`wealthbox_create_contact`

Create a person, household, organization or trust contact with addresses, emails and custom fields

`data`

Get Contact`wealthbox_get_contact`

Retrieve a contact by ID including addresses, emails, phone numbers and financial profile

`data`

Update Contact`wealthbox_update_contact`

Update fields on an existing contact, including addresses, tags, roles and custom fields

`data`

Delete Contact`wealthbox_delete_contact`

Permanently delete a contact from the Wealthbox workspace by ID

`data`

List Events`wealthbox_list_events`

List calendar events, filtered by linked record, start date range or update window

`data`

Create Event`wealthbox_create_event`

Create a calendar event with start and end times, invitees and linked records

`data`

Get Event`wealthbox_get_event`

Retrieve a calendar event by ID including invitees, linked records and custom fields

`data`

Update Event`wealthbox_update_event`

Update the title, times, location, invitees or linked records of an existing event

`data`

Delete Event`wealthbox_delete_event`

Remove a calendar event from the workspace by ID

`data`

Add Household Member`wealthbox_add_household_member`

Add a contact to a household with a household title such as Head or Spouse

`data`

Delete Household Member`wealthbox_delete_household_member`

Remove a contact from a household without deleting the contact

`data`

List Notes`wealthbox_list_notes`

List notes, filtered by linked record or update window, in a chosen order

`data`

Create Note`wealthbox_create_note`

Create a note with content, optionally linked to one or more contacts

`data`

Get Note`wealthbox_get_note`

Retrieve a note by ID including its content, linked records and tags

`data`

Update Note`wealthbox_update_note`

Change the content, linked records, visibility or tags of an existing note

`data`

List Opportunities`wealthbox_list_opportunities`

List sales opportunities, filtered by linked record, closed state or update window

`data`

Create Opportunity`wealthbox_create_opportunity`

Create a sales opportunity with target close date, stage, probability and amounts

`data`

Get Opportunity`wealthbox_get_opportunity`

Retrieve an opportunity by ID including stage, probability and amounts

`data`

Update Opportunity`wealthbox_update_opportunity`

Update the stage, probability, amounts or other fields of an existing opportunity

`data`

Delete Opportunity`wealthbox_delete_opportunity`

Remove a sales opportunity from the workspace by ID

`data`

List Projects`wealthbox_list_projects`

List projects in the workspace, optionally filtered by update window

`data`

Create Project`wealthbox_create_project`

Create a project with a name, description, organizer and visibility

`data`

Get Project`wealthbox_get_project`

Retrieve a project by ID including its organizer and custom fields

`data`

Update Project`wealthbox_update_project`

Update the name, description, organizer or visibility of an existing project

`data`

Delete Project`wealthbox_delete_project`

Remove a project from the workspace by ID

`data`

List Tasks`wealthbox_list_tasks`

List tasks, filtered by linked record, assignee, team, completion state or type

`data`

Create Task`wealthbox_create_task`

Create a task with a due date and priority, assigned to a user or a team

`data`

Get Task`wealthbox_get_task`

Retrieve a task by ID including subtasks, due date, priority and linked records

`data`

Update Task`wealthbox_update_task`

Update the name, due date, completion, priority or assignee of an existing task

`data`

Delete Task`wealthbox_delete_task`

Remove a task and its subtasks from the workspace by ID

`data`

Get Login Profile`wealthbox_get_me`

Retrieve the login profile of the authenticated user, including the current user and accessible workspaces

`data`

List User Groups`wealthbox_list_user_groups`

List the user groups in the workspace, used to restrict record visibility

`data`

List Teams`wealthbox_list_teams`

List teams in the workspace and their members

`data`

List Users`wealthbox_list_users`

List users in the workspace account, optionally filtered by status

`data`

List Workflows`wealthbox_list_workflows`

List workflows, filtered by linked record, status or update window

`data`

Create Workflow`wealthbox_create_workflow`

Start a workflow from a workflow template, optionally linked to a contact, project or opportunity

`data`

Get Workflow`wealthbox_get_workflow`

Retrieve a workflow by ID including its steps, milestones and linked record

`data`

Delete Workflow`wealthbox_delete_workflow`

Remove a workflow from the workspace by ID

`data`

List Workflow Templates`wealthbox_list_workflow_templates`

List the workflow templates available in the workspace

`data`

Get Workflow Template`wealthbox_get_workflow_template`

Retrieve a workflow template by ID including its steps and milestones

`data`

Complete Workflow Step`wealthbox_complete_workflow_step`

Mark a step of a workflow complete, optionally applying a workflow outcome and the due date of a restarted step

`data`

Revert Workflow Step`wealthbox_revert_workflow_step`

Revert a previously completed step of a workflow back to incomplete

`data`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.