API Key OAuth 2.0

data

49 actions

Action

Description

Required scopes

List Activity Stream

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

List Contact Roles

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

List Custom Fields

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

List Tags

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

List Category Members

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

List Comments

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

List Contacts

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

Create Contact

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

Get Contact

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

Update Contact

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

Delete Contact

Permanently delete a contact from the Wealthbox workspace by ID

List Events

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

Create Event

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

Get Event

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

Update Event

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

Delete Event

Remove a calendar event from the workspace by ID

Add Household Member

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

Delete Household Member

Remove a contact from a household without deleting the contact

List Notes

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

Create Note

Create a note with content linked to contacts, opportunities or projects

Get Note

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

Update Note

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

List Opportunities

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

Create Opportunity

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

Get Opportunity

Retrieve an opportunity by ID including stage, probability and amounts

Update Opportunity

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

Delete Opportunity

Remove a sales opportunity from the workspace by ID

List Projects

List projects in the workspace, optionally filtered by update window

Create Project

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

Get Project

Retrieve a project by ID including its organizer and custom fields

Update Project

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

Delete Project

Remove a project from the workspace by ID

List Tasks

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

Create Task

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

Get Task

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

Update Task

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

Delete Task

Remove a task and its subtasks from the workspace by ID

Get Login Profile

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

List User Groups

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

List Teams

List teams in the workspace and their members

List Users

List users in the workspace account, optionally filtered by status

List Workflows

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

Create Workflow

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

Get Workflow

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

Delete Workflow

Remove a workflow from the workspace by ID

List Workflow Templates

List the workflow templates available in the workspace

Get Workflow Template

Retrieve a workflow template by ID including its steps and milestones

Complete Workflow Step

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

Revert Workflow Step

Revert a previously completed step of a workflow back to incomplete