Back to top

Introduction

The Wealthbox API consists of resource URLs which provide a predictable way to interact with Wealthbox over or .

We support , allowing you to interact securely with our API from a client-side web application.

The Wealthbox API gives you powerful read/write access to your CRM account data, allowing you to build integrations with your other preferred tools.

API Endpoint
https://api.crmworkspace.com

Authentication

Every request to the Wealthbox CRM needs to be indentified and authorized. In order to do this, you must provide API credentials, which can take the form of an API access token, provided inside your personal settings, or by leveraging our OAuth 2.0 authentication flow.

Authenticating with an API access token

Authenticate your account when using the API by including an API access token in the request header. In order to obtain a new access token or to manage your existing tokens, please visit the . From there, simply click 'Create Access Token' and give the token a name. That token should then be passed as an HTTP Header, with the name ACCESS_TOKEN, in all requests to the API.

Authenticating with OAuth

Once you have obtained API credentials, you can identify your application by including an OAuth access token in your request. This method is more complicated, but allows for much deeper integration. Once you have followed the steps below to generate a token, you can include in it your API requests by passing the token as an HTTP header, with the following format:Authorization: Bearer OAUTH_ACCESS_TOKEN

SSO with Wealthbox CRM

Wealthbox CRM supports Single Sign On (SSO) via OAuth, which will grant a user access to his/her Wealthbox instance using the OAuth access token that is provided in the request header. The access token should be included in the same header as OAuth requests to the API, with the following format:Authorization: Bearer OAUTH_ACCESS_TOKEN

As long as the access token that is provided in the header is valid, the requests will authenticated and a session maintained for the user who is related to the OAuth token.

The basic flow of OAuth is as follows:
  1. The user should be redirected to https://app.crmworkspace.com/oauth/authorize
  2. The user will be shown a login screen.
  3. After entering their credentials, the user will be shown an authorization page to authorize the linking of their Wealthbox CRM account to the partner’s account.
  4. After the customer has authorized the connecting of their accounts, we’ll redirect to the redirect URI. This will include the access token and a refresh token.
  5. You can now use the access token to request data from the Wealthbox CRM API.
  6. If your access token expires, you’ll need to use the refresh token. This is similar to step 5. You’ll need to post to https://app.crmworkspace.com/oauth/token
  7. If your refresh token has expired, you will need to start the process over from step 1. We recommend that apps autonomously connect to Wealthbox CRM using the refresh token within the 90 day window, if they want to avoid forcing the user to reauthenticate.
Example Request with API access token
$ curl https://api.crmworkspace.com/v1/contacts -i \
-H "ACCESS_TOKEN:12345678901234567890123456789012"
Example Request with OAuth access token
$ curl https://api.crmworkspace.com/v1/contacts -i \
-H "AUTHORIZATION: Bearer 12345678901234567890123456789012"

Errors

Wealthbox uses standard HTTP response codes to indicate the status of an API request. Generally, 2xx response codes indicate success, 4xx represents a problem that occurred (e.x., authentication token was not included in request, or required fields were not present to create a "contact"). 5xx codes indicate there was an error on the server, even though your request appears valid.

HTTP Status Code Summary
200 - OKEverything worked as expected.
201 - Authorization token createdAfter a successful authorization via the API, an access token was created.
202 - Two-Factor Authentication requiredAfter a successful authorization via the API, Two-Factor authentication is required.
401 - UnauthorizedNo valid API key provided.
402 - Trial expiredYour Wealthbox trial account has expired.
403 - InaccessibleThe requesting user does not have permission to view the resource.
404 - Not FoundThe requested item doesn't exist.
422 - Invalid request parametersYour request was invalid and rejected by the server.
422 - Unprocessable EntityThe content-type in the header may be invalid or the object sent doesn't match the content-type that was set.
429 - Too Many RequestsToo many requests hit the API too quickly.
5xx - Server ErrorsWealthbox error (Rare occurrence.)

Pagination

All resources in the API have support for fetching in bulk via the list methods. For example, you could list all contacts, or all notes in your workspace.

We utilize a page-based system for listing items in bulk. This requires both per_page and a page parameter to be passed when fetching paginated data (see below).

Pagination Parameters
per_page
number
25 (default)
page
number
1 (default)
Example Request
$ curl https://api.crmworkspace.com/v1/contacts?per_page=50&page=2 -i \
-H "ACCESS_TOKEN:12345678901234567890123456789012"

Responses from the API

Each request made to the API will generate a or response. The responses can be classified into 3 distinct types.

Successful response returning a single resource

When returning a single resource, the object is represented as a JSON object of its properties.

Successful response returning a collection of resources

When returning a collection of resources, the collection is returned as a JSON object, whose key is the plural version of the resource, for example /v1/contacts returns a JSON object whose key is contacts. The object contains an array of the resources stored at that key. It is important to remember that these collections are not ordered, so their order can not be counted on.

Unsuccessful response

When a request is unsuccessful the API will return a JSON object with 2 keys, success,which will be set to false and an errors key which describes the error.

Versioning

When we make backwards-incompatible changes to the API we will release a new version. Examples of a backwards-compatible change that would not result in a new version would be adding a new endpoint, changing the order of properties in an API response, or adding a new optional property to an existing endpoint.

The current API version is v1, so any requests should include this in the URL.

Example Request
$ curl https://api.crmworkspace.com/v1/contacts -i \
-H "ACCESS_TOKEN:12345678901234567890123456789012"

Throttling

All requests made to the Wealthbox API are subject to throttling based on the API access token being used to make the request. The throttling rate is one request/second over a five minute sampling period, although, the Wealthbox API will permit short bursts of activity above that threshold. If you have made more requests to the Wealthbox API than permitted a 429 status code is returned to indicate that you have exceeded our rate limit for that period.

Create a new authentication

POST
Create a new authentication
/v1/authentication

Create a new authentication for the provided email/password combination.

Request Attributes
email
string

The email address associated with the user

password
string

The password associated with the account referenced by the email

Response Attributes
token
string

A string that can be used to authenticate the user with the API

user
User

The user object related to the email passed into the request

Hide child attributesShow child attributes
id
number

The ID of the user returned by the authentication

name
string

The name of the user being returned

workspace_name
string

The name of the workspace to which the user belongs

email
string

The email address associated with the user

dropbox_email_address
string

The email address used to attach emails to your account

Request  Valid request with returns an existing token
Body
{
  "email": "bill@example.com",
  "password": "password"
}
Response  200
Body
{
  "token": "access_token",
  "user": {
    "id": 1,
    "name": "Bill Jones",
    "workspace_name": "Patriot Financial",
    "email": "bill@example.com",
    "dropbox_email_address": "test@example.com"
  }
}
Request  Valid request which requires a new token be created
Body
{
  "email": "bill@example.com",
  "password": "password"
}
Response  201
Body
{
  "token": "access_token",
  "user": {
    "id": 1,
    "name": "Bill Jones",
    "workspace_name": "Patriot Financial",
    "email": "bill@example.com",
    "dropbox_email_address": "test@example.com"
  }
}
Request  Valid request which requires TFA
Body
{
  "email": "bill@example.com",
  "password": "password"
}
Response  202
Body
{
  "token": "access_token",
  "user": {
    "id": 1,
    "name": "Bill Jones",
    "workspace_name": "Patriot Financial",
    "email": "bill@example.com",
    "dropbox_email_address": "test@example.com"
  }
}
Request  Valid request with TFA code
Body
{
  "email": "bill@example.com",
  "password": "password",
  "tfa_code": "123456"
}
Response  200
Body
{
  "token": "access_token",
  "user": {
    "id": 1,
    "name": "Bill Jones",
    "workspace_name": "Patriot Financial",
    "email": "bill@example.com",
    "dropbox_email_address": "test@example.com"
  }
}
Request  Valid request with for account whose subscription has expired
Body
{
  "email": "bill@example.com",
  "password": "password"
}
Response  402
Body
{
  "token": "access_token",
  "user": {
    "id": 1,
    "name": "Bill Jones",
    "workspace_name": "Patriot Financial",
    "email": "bill@example.com",
    "dropbox_email_address": "test@example.com"
  }
}

Retrieve activity stream

GET
Retrieve activity stream
/v1/activity{?contact}

This endpoint will return all of the activity stream items for the user who has authenticated with their access token.

Parameters
contact
number

The id of the Contact whose stream items you are requesting

Response Attributes
stream_items
Array (StreamItem)
Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

body
string, required

The main body of the StreamItem returned as HTML

linked_to
Document

The document this SteamItem is related to

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

icon
string

A URL linking to the closet icon for the feed

Response  200
Body
{
  "stream_items": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "body": "Spoke with Kevin Anderson on the phone...",
      "linked_to": {
        "id": 1,
        "type": "Contact",
        "name": "Kevin Anderson"
      },
      "icon": "https://example.com/icon.png"
    }
  ]
}

Retrieve all contacts

GET
Retrieve all contacts
/v1/contacts{?id}{?contactType}{?email}{?phone}{?type}{?name}{?active}{?householdTitle}{?order}

When fetching contacts, results can optionally be filtered by the following parameters. The parameters that can be used are listed below and can be used individually or in any combination.

Parameters
id
number

The ID of the contact that you are searching for

contactType
string

The contact_type of the Contact that should be returned from the endpoint

name
string

The name that you wish to search for. This field with take any name, first and last or either and supports partial matches

email
string

The email address you wish to filter the contacts by

phone
string

The phone number you wish to filter the contacts by, you may include any delimiters you would like ( -, (), they will be stripped on the server before matching

active
boolean

Only returns contacts whose active flag match the specified value

householdTitle
string

The household title you wish to filter the household title

Choices: HeadSpouseParentOther DependentChildSiblingPartnerGrandchildGrandparent

type
string

The type of the Contact that should be returned from the endpoint

Choices: personhouseholdorganizationtrust

order
string

The order that the contacts should be returned in

Choices: ascdescrecentcreated

Response Attributes
contacts
Array (Contact)
Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

prefix
string

The preferred prefix for the Contact

first_name
string, required

The first name of the Contact

middle_name
string

The middle name of the Contact

last_name
string, required

The last name of the Contact

suffix
string

The suffix associated with the Contact

nickname
string

A preferred shortname for the Contact

job_title
string

The title the contact holds at his/her present company

twitter_name
string

The twitter handle of the contact

linkedin_url
string

The LinkedIn url for the contact

background_information
string

A brief description of the contact in a longer format

birth_date
Date

The birthdate of the contact

anniversary
Date

The wedding anniversary of the contact

client_since
Date

The date when the contact became a client

date_of_death
Date

The date of death of the contact

assigned_to
number

The id of the User who is assigned to this contact

referred_by
number

The id of the Contact who referred this Contact to the firm

type
string

The type of the Contact being created

Choices: Person Household Organization Trust

gender
string

The gender of the Contact

Choices: Male Female Unknown

contact_source
string

The method in which this contact was taken on as new business

Choices: Referral Conference Direct Mail Cold Call Other

contact_type
string

A string further classifying the Contact

Choices: Client Past Client Prospect Vendor Organization

status
string

A flag indicating whether or not the contact is currently active

Choices: Active Inactive

marital_status
string

The marital status of the contact

Choices: Married Single Divorced Widowed Life Partner Seperated Unknown

attorney
number

The id of the Contact acting as this Contact’s attorney

cpa
number

The id of the Contact acting as this Contact’s accountant

doctor
number

The id of the Contact acting as this Contact’s doctor

insurance
number

The id of the Contact acting as this Contact’s insurance agent

business_manager
number

The id of the Contact acting as this Contact’s business manager

family_officer
number

The id of the Contact acting as this Contact’s family officer

assistant
number

The id of the Contact acting as this Contact’s assistant

other
number

The id of the Contact acting as this Contact’s other

important_information
string

A block of text containing any other important info for the Contact

personal_interests
string

A block of text containing personal interests for the Contact

investment_objective
string

A basic classification of the Contact’s investment objectives

Choices: Aggressive Growth Growth Income Safety of Principal

time_horizon
string

A basic classification of the time horizon for the Contact’s investment goals

Choices: Short Term Intermediate Long Term

risk_tolerance
string

A basic classification of the Contact’s risk tolerance

Choices: Low Moderate High Risk

mutual_fund_experience
number

Years of experience the contact has in the mutual fund market

stocks_and_bonds_experience
number

Years of experience the contact has in the stocks and bonds fund market

partnerships_experience
number

Years of experience the contact has in partnerships

other_investing_experience
number

Years of experience the contact has in other aspects of the investement world

gross_annual_income
number

The Contact’s estimated gross annual income

assets
number

The value of all of the Contact’s holdings

non_liquid_assets
number

The total value of all of the assets holdings that are liquid

liabilities
number

The total value of the Contact’s liabilities

adjusted_gross_income
number

The Contact’s annual income adjusted for tax withholdings

estimated_taxes
number

The total amount of taxes paid by the Contact during a tax year

confirmed_by_tax_return
boolean

Flag to indicate if the Contact’s adjusted gross income and estimated taxes have been confirmed by their tax return

tax_year
number

The year of the tax return that was used to confirim the Contact’s income and tax liability

tax_bracket
number

Tax bracket that the Contact sits in according to his last recorded tax return

birth_place
string

The city/state where the Contact was born

maiden_name
string

The maiden name of the Contact is she has one

passport_number
string

The passport number of the Contact

green_card_number
string

The green card number of the Contact

occupation
Occupation

An object representing critical information about the contact’s occupation

Hide child attributesShow child attributes
name
string

The current occupation of the contact

start_date
Date

The date when the Contact started his current job

drivers_license
DriversLicense

An object representing the contact’s driver’s license

Hide child attributesShow child attributes
number
string

The ID number for this Contact’s drivers license

state
string

The state in which this Contact’s drivers license was issued

issued_date
Date

The date when the Contact’s driver’s license was last issued

expires_date
Date

The date when the Contact’s driver’s license is set to expire

retirement_date
Date

The date when the Contact hope to retire

signed_fee_agreement_date
Date

The date when the Contact’s fee agreement was signed

signed_ips_agreement_date
Date

The date when the Contact’s IPS agreement was signed

last_adv_offering_date
Date

The date when the Contact’s was last offered ADV

last_privacy_offering_date
Date

The date when the Contact last signed their privacy agreement

company_name
string

The name of the company the person is employed with

household
Household

An object representing the contact’s household

Hide child attributesShow child attributes
name
string

The name of the household of which the Contact belongs to

title
string

The title the contact holds within his/her own household

Choices: Head Spouse Partner Child Grandchild Parent Grandparent Sibling Other Dependent

id
number

The id of the household

members
Array (HouseholdMember)

A list of all contacts assoicated with this record

Hide child attributesShow child attributes
id
number

The id of the household member

first_name
string

The full name of the household member

last_name
string

The full name of the household member

title
string

The title of the household member

type
string

The type of the household member

image
string

A URL that links to the headshot for the contact

tags
Array (Tag)

An array of tags that are associated with the contact

Hide child attributesShow child attributes
id
number

The id of the object being returned

name
string

The name of the tag in question

street_addresses
Array (MailingAddress)

An arrary of the street addresses associated with the contact

Hide child attributesShow child attributes
street_line_1
string

The top line of the address

street_line_2
string

The second line of the address

city
string

The city the address is located in

state
string

The state the address is located in

zip_code
string

The zip code of the address

country
string
Default: United States

The country the address is located in

principal
boolean

A flag to indicate if the address is the primary address for the contact

kind
string

The type of the mailing address being created

Choices: Work Home Mobile Vacation Fax Other

id
number

The id of the mailing address

address
string

The top line of the address

email_addresses
Array (EmailAddress)

An arrary of the email addresses associated with the contact

Hide child attributesShow child attributes
id
number

The id of the email address

address
string, required

The address assoicated with the email address

principal
boolean

Flag to indicate if the email address is the principal address of the contact

kind
string

The type of the phone number being created

Choices: Work Home Mobile Vacation Fax Other

phone_numbers
Array (PhoneNumber)

An arrary of the phone numbers associated with the contact

Hide child attributesShow child attributes
id
number

The id of the phone number

address
string, required

The number assoicated with the phone number

principal
boolean

A flag indicating whether this number is the primary phone number for the contact

extension
string

The number extension

kind
string

The type of the phone number being created

Choices: Work Home Mobile Vacation Fax Other

websites
Array (Website)

An arrary of the websites associated with the contact

Hide child attributesShow child attributes
id
number

The id of the website

address
string, required

The address assoicated with the email address

principal
boolean

Flag to indicate if the website is principal site of the contact

kind
string

The type of the website being created

Choices: Website Facebook Blog

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

Response  200
Body
{
  "contacts": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "prefix": "Mr.",
      "first_name": "Kevin",
      "middle_name": "James",
      "last_name": "Anderson",
      "suffix": "M.D.",
      "nickname": "Kev",
      "job_title": "CEO",
      "twitter_name": "kev.anderson",
      "linkedin_url": "linkedin.com/in/kanderson",
      "background_information": "Met Kevin at a conference.",
      "birth_date": "1975-10-27",
      "anniversary": "1998-11-29",
      "client_since": "2002-05-21",
      "date_of_death": "2018-01-21",
      "assigned_to": 1,
      "referred_by": 1,
      "type": "Person",
      "gender": "Male",
      "contact_source": "Referral",
      "contact_type": "Client",
      "status": "Active",
      "marital_status": "Married",
      "attorney": 1,
      "cpa": 1,
      "doctor": 1,
      "insurance": 1,
      "business_manager": 1,
      "family_officer": 1,
      "assistant": 1,
      "other": 1,
      "important_information": "Has 3 kids in college",
      "personal_interests": "Skiing: Downhill, Traveling",
      "investment_objective": "Aggressive Growth",
      "time_horizon": "Short Term",
      "risk_tolerance": "Low",
      "mutual_fund_experience": 3,
      "stocks_and_bonds_experience": 2,
      "partnerships_experience": 1,
      "other_investing_experience": 5,
      "gross_annual_income": 100000,
      "assets": 250000,
      "non_liquid_assets": 50000,
      "liabilities": 50000,
      "adjusted_gross_income": 75000,
      "estimated_taxes": 18000,
      "confirmed_by_tax_return": true,
      "tax_year": 2015,
      "tax_bracket": 10,
      "birth_place": "New York, NY",
      "maiden_name": "Anderson",
      "passport_number": "AB1234CD5689",
      "green_card_number": "ZX567HG134",
      "occupation": {
        "name": "CEO",
        "start_date": "2015-11-25"
      },
      "drivers_license": {
        "number": "1111111",
        "state": "New York",
        "issued_date": "2001-10-27",
        "expires_date": "2011-10-27"
      },
      "retirement_date": "2025-09-30",
      "signed_fee_agreement_date": "2013-05-15",
      "signed_ips_agreement_date": "2014-03-12",
      "last_adv_offering_date": "2013-09-21",
      "last_privacy_offering_date": "2011-10-23",
      "company_name": "Acme Co.",
      "household": {
        "name": "The Anderson's",
        "title": "Head",
        "id": 1,
        "members": [
          {
            "id": 1,
            "first_name": "Kevin",
            "last_name": "Anderson",
            "title": "Head",
            "type": "Person"
          }
        ]
      },
      "image": "https://app.crmworkspace.com/avatar.png",
      "tags": [
        {
          "id": 1,
          "name": "Clients"
        }
      ],
      "street_addresses": [
        {
          "street_line_1": "155 12th Ave.",
          "street_line_2": "Apt 3B",
          "city": "New York",
          "state": "New York",
          "zip_code": "10001",
          "country": "United States",
          "principal": true,
          "kind": "Work",
          "id": 1,
          "address": "Hello, world!"
        }
      ],
      "email_addresses": [
        {
          "id": 1,
          "address": "kevin.anderson@example.com",
          "principal": true,
          "kind": "Work"
        }
      ],
      "phone_numbers": [
        {
          "id": 1,
          "address": "(555) 555-5555",
          "principal": true,
          "extension": "77",
          "kind": "Work"
        }
      ],
      "websites": [
        {
          "id": 1,
          "address": "https://www.example.com",
          "principal": true,
          "kind": "Website"
        }
      ],
      "custom_fields": [
        {
          "id": 1,
          "name": "My Field",
          "value": "123456789"
        }
      ]
    }
  ]
}

Create a new contact

POST
Create a new contact
/v1/contacts

Create a new Contact.

Request Attributes
prefix
string

The preferred prefix for the Contact

first_name
string, required

The first name of the Contact

middle_name
string

The middle name of the Contact

last_name
string, required

The last name of the Contact

suffix
string

The suffix associated with the Contact

nickname
string

A preferred shortname for the Contact

job_title
string

The title the contact holds at his/her present company

twitter_name
string

The twitter handle of the contact

linkedin_url
string

The LinkedIn url for the contact

background_information
string

A brief description of the contact in a longer format

birth_date
Date

The birthdate of the contact

anniversary
Date

The wedding anniversary of the contact

client_since
Date

The date when the contact became a client

date_of_death
Date

The date of death of the contact

assigned_to
number

The id of the User who is assigned to this contact

referred_by
number

The id of the Contact who referred this Contact to the firm

type
string

The type of the Contact being created

Choices: Person Household Organization Trust

gender
string

The gender of the Contact

Choices: Male Female Unknown

contact_source
string

The method in which this contact was taken on as new business

Choices: Referral Conference Direct Mail Cold Call Other

contact_type
string

A string further classifying the Contact

Choices: Client Past Client Prospect Vendor Organization

status
string

A flag indicating whether or not the contact is currently active

Choices: Active Inactive

marital_status
string

The marital status of the contact

Choices: Married Single Divorced Widowed Life Partner Seperated Unknown

attorney
number

The id of the Contact acting as this Contact’s attorney

cpa
number

The id of the Contact acting as this Contact’s accountant

doctor
number

The id of the Contact acting as this Contact’s doctor

insurance
number

The id of the Contact acting as this Contact’s insurance agent

business_manager
number

The id of the Contact acting as this Contact’s business manager

family_officer
number

The id of the Contact acting as this Contact’s family officer

assistant
number

The id of the Contact acting as this Contact’s assistant

other
number

The id of the Contact acting as this Contact’s other

important_information
string

A block of text containing any other important info for the Contact

personal_interests
string

A block of text containing personal interests for the Contact

investment_objective
string

A basic classification of the Contact’s investment objectives

Choices: Aggressive Growth Growth Income Safety of Principal

time_horizon
string

A basic classification of the time horizon for the Contact’s investment goals

Choices: Short Term Intermediate Long Term

risk_tolerance
string

A basic classification of the Contact’s risk tolerance

Choices: Low Moderate High Risk

mutual_fund_experience
number

Years of experience the contact has in the mutual fund market

stocks_and_bonds_experience
number

Years of experience the contact has in the stocks and bonds fund market

partnerships_experience
number

Years of experience the contact has in partnerships

other_investing_experience
number

Years of experience the contact has in other aspects of the investement world

gross_annual_income
number

The Contact’s estimated gross annual income

assets
number

The value of all of the Contact’s holdings

non_liquid_assets
number

The total value of all of the assets holdings that are liquid

liabilities
number

The total value of the Contact’s liabilities

adjusted_gross_income
number

The Contact’s annual income adjusted for tax withholdings

estimated_taxes
number

The total amount of taxes paid by the Contact during a tax year

confirmed_by_tax_return
boolean

Flag to indicate if the Contact’s adjusted gross income and estimated taxes have been confirmed by their tax return

tax_year
number

The year of the tax return that was used to confirim the Contact’s income and tax liability

tax_bracket
number

Tax bracket that the Contact sits in according to his last recorded tax return

birth_place
string

The city/state where the Contact was born

maiden_name
string

The maiden name of the Contact is she has one

passport_number
string

The passport number of the Contact

green_card_number
string

The green card number of the Contact

occupation
Occupation

An object representing critical information about the contact’s occupation

Hide child attributesShow child attributes
name
string

The current occupation of the contact

start_date
Date

The date when the Contact started his current job

drivers_license
DriversLicense

An object representing the contact’s driver’s license

Hide child attributesShow child attributes
number
string

The ID number for this Contact’s drivers license

state
string

The state in which this Contact’s drivers license was issued

issued_date
Date

The date when the Contact’s driver’s license was last issued

expires_date
Date

The date when the Contact’s driver’s license is set to expire

retirement_date
Date

The date when the Contact hope to retire

signed_fee_agreement_date
Date

The date when the Contact’s fee agreement was signed

signed_ips_agreement_date
Date

The date when the Contact’s IPS agreement was signed

last_adv_offering_date
Date

The date when the Contact’s was last offered ADV

last_privacy_offering_date
Date

The date when the Contact last signed their privacy agreement

company
string

The name of the company the person is employed with

household
HouseholdRequest

An object representing the contact’s household

Hide child attributesShow child attributes
name
string

The name of the household of which the Contact belongs to

title
string

The title the contact holds within his/her own household

Choices: Head Spouse Partner Child Grandchild Parent Grandparent Sibling Other Dependent

tags
Array (string)

An array of tags that are associated with the contact

street_addresses
Array (MailingAddressRequest)

An arrary of the street addresses associated with the contact

Hide child attributesShow child attributes
street_line_1
string

The top line of the address

street_line_2
string

The second line of the address

city
string

The city the address is located in

state
string

The state the address is located in

zip_code
string

The zip code of the address

country
string
Default: United States

The country the address is located in

principal
boolean

A flag to indicate if the address is the primary address for the contact

kind
string

The type of the mailing address being created

Choices: Work Home Mobile Vacation Fax Other

destroy `false`
boolean

Flag to indicate whether or not to destroy the mailing address being updated

email_addresses
Array (EmailAddressRequest)

An arrary of the email addresses associated with the contact

Hide child attributesShow child attributes
address
string, required

The address assoicated with the email address

principal
boolean

Flag to indicate if the email address is the principal address of the contact

kind
string

The type of the phone number being created

Choices: Work Home Mobile Vacation Fax Other

destroy `false`
boolean

Flag to indicate whether or not to destroy the email address being updated

phone_numbers
Array (PhoneNumberRequest)

An arrary of the phone numbers associated with the contact

Hide child attributesShow child attributes
address
string, required

The number assoicated with the phone number

principal
boolean

A flag indicating whether this number is the primary phone number for the contact

extension
string

The number extension

kind
string

The type of the phone number being created

Choices: Work Home Mobile Vacation Fax Other

destroy `false`
boolean

Flag to indicate whether or not to destroy the phone number being updated

websites
Array (WebsiteRequest)

An arrary of the websites associated with the contact

Hide child attributesShow child attributes
address
string, required

The address assoicated with the email address

principal
boolean

Flag to indicate if the website is principal site of the contact

kind
string

The type of the website being created

Choices: Website Facebook Blog

destroy `false`
boolean

Flag to indicate whether or not to destroy the website being updated

custom_fields
Array (CustomFieldRequest)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

value
string

The value that the custom field should take on

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

prefix
string

The preferred prefix for the Contact

first_name
string, required

The first name of the Contact

middle_name
string

The middle name of the Contact

last_name
string, required

The last name of the Contact

suffix
string

The suffix associated with the Contact

nickname
string

A preferred shortname for the Contact

job_title
string

The title the contact holds at his/her present company

twitter_name
string

The twitter handle of the contact

linkedin_url
string

The LinkedIn url for the contact

background_information
string

A brief description of the contact in a longer format

birth_date
Date

The birthdate of the contact

anniversary
Date

The wedding anniversary of the contact

client_since
Date

The date when the contact became a client

date_of_death
Date

The date of death of the contact

assigned_to
number

The id of the User who is assigned to this contact

referred_by
number

The id of the Contact who referred this Contact to the firm

type
string

The type of the Contact being created

Choices: Person Household Organization Trust

gender
string

The gender of the Contact

Choices: Male Female Unknown

contact_source
string

The method in which this contact was taken on as new business

Choices: Referral Conference Direct Mail Cold Call Other

contact_type
string

A string further classifying the Contact

Choices: Client Past Client Prospect Vendor Organization

status
string

A flag indicating whether or not the contact is currently active

Choices: Active Inactive

marital_status
string

The marital status of the contact

Choices: Married Single Divorced Widowed Life Partner Seperated Unknown

attorney
number

The id of the Contact acting as this Contact’s attorney

cpa
number

The id of the Contact acting as this Contact’s accountant

doctor
number

The id of the Contact acting as this Contact’s doctor

insurance
number

The id of the Contact acting as this Contact’s insurance agent

business_manager
number

The id of the Contact acting as this Contact’s business manager

family_officer
number

The id of the Contact acting as this Contact’s family officer

assistant
number

The id of the Contact acting as this Contact’s assistant

other
number

The id of the Contact acting as this Contact’s other

important_information
string

A block of text containing any other important info for the Contact

personal_interests
string

A block of text containing personal interests for the Contact

investment_objective
string

A basic classification of the Contact’s investment objectives

Choices: Aggressive Growth Growth Income Safety of Principal

time_horizon
string

A basic classification of the time horizon for the Contact’s investment goals

Choices: Short Term Intermediate Long Term

risk_tolerance
string

A basic classification of the Contact’s risk tolerance

Choices: Low Moderate High Risk

mutual_fund_experience
number

Years of experience the contact has in the mutual fund market

stocks_and_bonds_experience
number

Years of experience the contact has in the stocks and bonds fund market

partnerships_experience
number

Years of experience the contact has in partnerships

other_investing_experience
number

Years of experience the contact has in other aspects of the investement world

gross_annual_income
number

The Contact’s estimated gross annual income

assets
number

The value of all of the Contact’s holdings

non_liquid_assets
number

The total value of all of the assets holdings that are liquid

liabilities
number

The total value of the Contact’s liabilities

adjusted_gross_income
number

The Contact’s annual income adjusted for tax withholdings

estimated_taxes
number

The total amount of taxes paid by the Contact during a tax year

confirmed_by_tax_return
boolean

Flag to indicate if the Contact’s adjusted gross income and estimated taxes have been confirmed by their tax return

tax_year
number

The year of the tax return that was used to confirim the Contact’s income and tax liability

tax_bracket
number

Tax bracket that the Contact sits in according to his last recorded tax return

birth_place
string

The city/state where the Contact was born

maiden_name
string

The maiden name of the Contact is she has one

passport_number
string

The passport number of the Contact

green_card_number
string

The green card number of the Contact

occupation
Occupation

An object representing critical information about the contact’s occupation

Hide child attributesShow child attributes
name
string

The current occupation of the contact

start_date
Date

The date when the Contact started his current job

drivers_license
DriversLicense

An object representing the contact’s driver’s license

Hide child attributesShow child attributes
number
string

The ID number for this Contact’s drivers license

state
string

The state in which this Contact’s drivers license was issued

issued_date
Date

The date when the Contact’s driver’s license was last issued

expires_date
Date

The date when the Contact’s driver’s license is set to expire

retirement_date
Date

The date when the Contact hope to retire

signed_fee_agreement_date
Date

The date when the Contact’s fee agreement was signed

signed_ips_agreement_date
Date

The date when the Contact’s IPS agreement was signed

last_adv_offering_date
Date

The date when the Contact’s was last offered ADV

last_privacy_offering_date
Date

The date when the Contact last signed their privacy agreement

company_name
string

The name of the company the person is employed with

household
Household

An object representing the contact’s household

Hide child attributesShow child attributes
name
string

The name of the household of which the Contact belongs to

title
string

The title the contact holds within his/her own household

Choices: Head Spouse Partner Child Grandchild Parent Grandparent Sibling Other Dependent

id
number

The id of the household

members
Array (HouseholdMember)

A list of all contacts assoicated with this record

Hide child attributesShow child attributes
id
number

The id of the household member

first_name
string

The full name of the household member

last_name
string

The full name of the household member

title
string

The title of the household member

type
string

The type of the household member

image
string

A URL that links to the headshot for the contact

tags
Array (Tag)

An array of tags that are associated with the contact

Hide child attributesShow child attributes
id
number

The id of the object being returned

name
string

The name of the tag in question

street_addresses
Array (MailingAddress)

An arrary of the street addresses associated with the contact

Hide child attributesShow child attributes
street_line_1
string

The top line of the address

street_line_2
string

The second line of the address

city
string

The city the address is located in

state
string

The state the address is located in

zip_code
string

The zip code of the address

country
string
Default: United States

The country the address is located in

principal
boolean

A flag to indicate if the address is the primary address for the contact

kind
string

The type of the mailing address being created

Choices: Work Home Mobile Vacation Fax Other

id
number

The id of the mailing address

address
string

The top line of the address

email_addresses
Array (EmailAddress)

An arrary of the email addresses associated with the contact

Hide child attributesShow child attributes
id
number

The id of the email address

address
string, required

The address assoicated with the email address

principal
boolean

Flag to indicate if the email address is the principal address of the contact

kind
string

The type of the phone number being created

Choices: Work Home Mobile Vacation Fax Other

phone_numbers
Array (PhoneNumber)

An arrary of the phone numbers associated with the contact

Hide child attributesShow child attributes
id
number

The id of the phone number

address
string, required

The number assoicated with the phone number

principal
boolean

A flag indicating whether this number is the primary phone number for the contact

extension
string

The number extension

kind
string

The type of the phone number being created

Choices: Work Home Mobile Vacation Fax Other

websites
Array (Website)

An arrary of the websites associated with the contact

Hide child attributesShow child attributes
id
number

The id of the website

address
string, required

The address assoicated with the email address

principal
boolean

Flag to indicate if the website is principal site of the contact

kind
string

The type of the website being created

Choices: Website Facebook Blog

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

Request
Body
{
  "prefix": "Mr.",
  "first_name": "Kevin",
  "middle_name": "James",
  "last_name": "Anderson",
  "suffix": "M.D.",
  "nickname": "Kev",
  "job_title": "CEO",
  "twitter_name": "kev.anderson",
  "linkedin_url": "linkedin.com/in/kanderson",
  "background_information": "Met Kevin at a conference.",
  "birth_date": "1975-10-27",
  "anniversary": "1998-11-29",
  "client_since": "2002-05-21",
  "date_of_death": "2018-01-21",
  "assigned_to": 1,
  "referred_by": 1,
  "type": "Person",
  "gender": "Male",
  "contact_source": "Referral",
  "contact_type": "Client",
  "status": "Active",
  "marital_status": "Married",
  "attorney": 1,
  "cpa": 1,
  "doctor": 1,
  "insurance": 1,
  "business_manager": 1,
  "family_officer": 1,
  "assistant": 1,
  "other": 1,
  "important_information": "Has 3 kids in college",
  "personal_interests": "Skiing: Downhill, Traveling",
  "investment_objective": "Aggressive Growth",
  "time_horizon": "Short Term",
  "risk_tolerance": "Low",
  "mutual_fund_experience": 3,
  "stocks_and_bonds_experience": 2,
  "partnerships_experience": 1,
  "other_investing_experience": 5,
  "gross_annual_income": 100000,
  "assets": 250000,
  "non_liquid_assets": 50000,
  "liabilities": 50000,
  "adjusted_gross_income": 75000,
  "estimated_taxes": 18000,
  "confirmed_by_tax_return": true,
  "tax_year": 2015,
  "tax_bracket": 10,
  "birth_place": "New York, NY",
  "maiden_name": "Anderson",
  "passport_number": "AB1234CD5689",
  "green_card_number": "ZX567HG134",
  "occupation": {
    "name": "CEO",
    "start_date": "2015-11-25"
  },
  "drivers_license": {
    "number": "1111111",
    "state": "New York",
    "issued_date": "2001-10-27",
    "expires_date": "2011-10-27"
  },
  "retirement_date": "2025-09-30",
  "signed_fee_agreement_date": "2013-05-15",
  "signed_ips_agreement_date": "2014-03-12",
  "last_adv_offering_date": "2013-09-21",
  "last_privacy_offering_date": "2011-10-23",
  "company": "Acme Co.",
  "household": {
    "name": "The Anderson's",
    "title": "Head"
  },
  "tags": [
    "Hello, world!"
  ],
  "street_addresses": [
    {
      "street_line_1": "155 12th Ave.",
      "street_line_2": "Apt 3B",
      "city": "New York",
      "state": "New York",
      "zip_code": "10001",
      "country": "United States",
      "principal": true,
      "kind": "Work",
      "destroy         `false`": true
    }
  ],
  "email_addresses": [
    {
      "address": "kevin.anderson@example.com",
      "principal": true,
      "kind": "Work",
      "destroy     `false`": true
    }
  ],
  "phone_numbers": [
    {
      "address": "(555) 555-5555",
      "principal": true,
      "extension": "77",
      "kind": "Work",
      "destroy         `false`": true
    }
  ],
  "websites": [
    {
      "address": "https://www.example.com",
      "principal": true,
      "kind": "Website",
      "destroy         `false`": true
    }
  ],
  "custom_fields": [
    {
      "id": 1,
      "value": "123456789"
    }
  ],
  "visible_to": "Everyone"
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "prefix": "Mr.",
  "first_name": "Kevin",
  "middle_name": "James",
  "last_name": "Anderson",
  "suffix": "M.D.",
  "nickname": "Kev",
  "job_title": "CEO",
  "twitter_name": "kev.anderson",
  "linkedin_url": "linkedin.com/in/kanderson",
  "background_information": "Met Kevin at a conference.",
  "birth_date": "1975-10-27",
  "anniversary": "1998-11-29",
  "client_since": "2002-05-21",
  "date_of_death": "2018-01-21",
  "assigned_to": 1,
  "referred_by": 1,
  "type": "Person",
  "gender": "Male",
  "contact_source": "Referral",
  "contact_type": "Client",
  "status": "Active",
  "marital_status": "Married",
  "attorney": 1,
  "cpa": 1,
  "doctor": 1,
  "insurance": 1,
  "business_manager": 1,
  "family_officer": 1,
  "assistant": 1,
  "other": 1,
  "important_information": "Has 3 kids in college",
  "personal_interests": "Skiing: Downhill, Traveling",
  "investment_objective": "Aggressive Growth",
  "time_horizon": "Short Term",
  "risk_tolerance": "Low",
  "mutual_fund_experience": 3,
  "stocks_and_bonds_experience": 2,
  "partnerships_experience": 1,
  "other_investing_experience": 5,
  "gross_annual_income": 100000,
  "assets": 250000,
  "non_liquid_assets": 50000,
  "liabilities": 50000,
  "adjusted_gross_income": 75000,
  "estimated_taxes": 18000,
  "confirmed_by_tax_return": true,
  "tax_year": 2015,
  "tax_bracket": 10,
  "birth_place": "New York, NY",
  "maiden_name": "Anderson",
  "passport_number": "AB1234CD5689",
  "green_card_number": "ZX567HG134",
  "occupation": {
    "name": "CEO",
    "start_date": "2015-11-25"
  },
  "drivers_license": {
    "number": "1111111",
    "state": "New York",
    "issued_date": "2001-10-27",
    "expires_date": "2011-10-27"
  },
  "retirement_date": "2025-09-30",
  "signed_fee_agreement_date": "2013-05-15",
  "signed_ips_agreement_date": "2014-03-12",
  "last_adv_offering_date": "2013-09-21",
  "last_privacy_offering_date": "2011-10-23",
  "company_name": "Acme Co.",
  "household": {
    "name": "The Anderson's",
    "title": "Head",
    "id": 1,
    "members": [
      {
        "id": 1,
        "first_name": "Kevin",
        "last_name": "Anderson",
        "title": "Head",
        "type": "Person"
      }
    ]
  },
  "image": "https://app.crmworkspace.com/avatar.png",
  "tags": [
    {
      "id": 1,
      "name": "Clients"
    }
  ],
  "street_addresses": [
    {
      "street_line_1": "155 12th Ave.",
      "street_line_2": "Apt 3B",
      "city": "New York",
      "state": "New York",
      "zip_code": "10001",
      "country": "United States",
      "principal": true,
      "kind": "Work",
      "id": 1,
      "address": "Hello, world!"
    }
  ],
  "email_addresses": [
    {
      "id": 1,
      "address": "kevin.anderson@example.com",
      "principal": true,
      "kind": "Work"
    }
  ],
  "phone_numbers": [
    {
      "id": 1,
      "address": "(555) 555-5555",
      "principal": true,
      "extension": "77",
      "kind": "Work"
    }
  ],
  "websites": [
    {
      "id": 1,
      "address": "https://www.example.com",
      "principal": true,
      "kind": "Website"
    }
  ],
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ]
}

Contact

GET
Fetch an existing contact
/v1/contacts/{id}

Retrieve a specific contact using it unique identifier. The contact returned will include the attributes listed below.

Parameters
id
number, required

The id of the contact to be updated

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

prefix
string

The preferred prefix for the Contact

first_name
string, required

The first name of the Contact

middle_name
string

The middle name of the Contact

last_name
string, required

The last name of the Contact

suffix
string

The suffix associated with the Contact

nickname
string

A preferred shortname for the Contact

job_title
string

The title the contact holds at his/her present company

twitter_name
string

The twitter handle of the contact

linkedin_url
string

The LinkedIn url for the contact

background_information
string

A brief description of the contact in a longer format

birth_date
Date

The birthdate of the contact

anniversary
Date

The wedding anniversary of the contact

client_since
Date

The date when the contact became a client

date_of_death
Date

The date of death of the contact

assigned_to
number

The id of the User who is assigned to this contact

referred_by
number

The id of the Contact who referred this Contact to the firm

type
string

The type of the Contact being created

Choices: Person Household Organization Trust

gender
string

The gender of the Contact

Choices: Male Female Unknown

contact_source
string

The method in which this contact was taken on as new business

Choices: Referral Conference Direct Mail Cold Call Other

contact_type
string

A string further classifying the Contact

Choices: Client Past Client Prospect Vendor Organization

status
string

A flag indicating whether or not the contact is currently active

Choices: Active Inactive

marital_status
string

The marital status of the contact

Choices: Married Single Divorced Widowed Life Partner Seperated Unknown

attorney
number

The id of the Contact acting as this Contact’s attorney

cpa
number

The id of the Contact acting as this Contact’s accountant

doctor
number

The id of the Contact acting as this Contact’s doctor

insurance
number

The id of the Contact acting as this Contact’s insurance agent

business_manager
number

The id of the Contact acting as this Contact’s business manager

family_officer
number

The id of the Contact acting as this Contact’s family officer

assistant
number

The id of the Contact acting as this Contact’s assistant

other
number

The id of the Contact acting as this Contact’s other

important_information
string

A block of text containing any other important info for the Contact

personal_interests
string

A block of text containing personal interests for the Contact

investment_objective
string

A basic classification of the Contact’s investment objectives

Choices: Aggressive Growth Growth Income Safety of Principal

time_horizon
string

A basic classification of the time horizon for the Contact’s investment goals

Choices: Short Term Intermediate Long Term

risk_tolerance
string

A basic classification of the Contact’s risk tolerance

Choices: Low Moderate High Risk

mutual_fund_experience
number

Years of experience the contact has in the mutual fund market

stocks_and_bonds_experience
number

Years of experience the contact has in the stocks and bonds fund market

partnerships_experience
number

Years of experience the contact has in partnerships

other_investing_experience
number

Years of experience the contact has in other aspects of the investement world

gross_annual_income
number

The Contact’s estimated gross annual income

assets
number

The value of all of the Contact’s holdings

non_liquid_assets
number

The total value of all of the assets holdings that are liquid

liabilities
number

The total value of the Contact’s liabilities

adjusted_gross_income
number

The Contact’s annual income adjusted for tax withholdings

estimated_taxes
number

The total amount of taxes paid by the Contact during a tax year

confirmed_by_tax_return
boolean

Flag to indicate if the Contact’s adjusted gross income and estimated taxes have been confirmed by their tax return

tax_year
number

The year of the tax return that was used to confirim the Contact’s income and tax liability

tax_bracket
number

Tax bracket that the Contact sits in according to his last recorded tax return

birth_place
string

The city/state where the Contact was born

maiden_name
string

The maiden name of the Contact is she has one

passport_number
string

The passport number of the Contact

green_card_number
string

The green card number of the Contact

occupation
Occupation

An object representing critical information about the contact’s occupation

Hide child attributesShow child attributes
name
string

The current occupation of the contact

start_date
Date

The date when the Contact started his current job

drivers_license
DriversLicense

An object representing the contact’s driver’s license

Hide child attributesShow child attributes
number
string

The ID number for this Contact’s drivers license

state
string

The state in which this Contact’s drivers license was issued

issued_date
Date

The date when the Contact’s driver’s license was last issued

expires_date
Date

The date when the Contact’s driver’s license is set to expire

retirement_date
Date

The date when the Contact hope to retire

signed_fee_agreement_date
Date

The date when the Contact’s fee agreement was signed

signed_ips_agreement_date
Date

The date when the Contact’s IPS agreement was signed

last_adv_offering_date
Date

The date when the Contact’s was last offered ADV

last_privacy_offering_date
Date

The date when the Contact last signed their privacy agreement

company_name
string

The name of the company the person is employed with

household
Household

An object representing the contact’s household

Hide child attributesShow child attributes
name
string

The name of the household of which the Contact belongs to

title
string

The title the contact holds within his/her own household

Choices: Head Spouse Partner Child Grandchild Parent Grandparent Sibling Other Dependent

id
number

The id of the household

members
Array (HouseholdMember)

A list of all contacts assoicated with this record

Hide child attributesShow child attributes
id
number

The id of the household member

first_name
string

The full name of the household member

last_name
string

The full name of the household member

title
string

The title of the household member

type
string

The type of the household member

image
string

A URL that links to the headshot for the contact

tags
Array (Tag)

An array of tags that are associated with the contact

Hide child attributesShow child attributes
id
number

The id of the object being returned

name
string

The name of the tag in question

street_addresses
Array (MailingAddress)

An arrary of the street addresses associated with the contact

Hide child attributesShow child attributes
street_line_1
string

The top line of the address

street_line_2
string

The second line of the address

city
string

The city the address is located in

state
string

The state the address is located in

zip_code
string

The zip code of the address

country
string
Default: United States

The country the address is located in

principal
boolean

A flag to indicate if the address is the primary address for the contact

kind
string

The type of the mailing address being created

Choices: Work Home Mobile Vacation Fax Other

id
number

The id of the mailing address

address
string

The top line of the address

email_addresses
Array (EmailAddress)

An arrary of the email addresses associated with the contact

Hide child attributesShow child attributes
id
number

The id of the email address

address
string, required

The address assoicated with the email address

principal
boolean

Flag to indicate if the email address is the principal address of the contact

kind
string

The type of the phone number being created

Choices: Work Home Mobile Vacation Fax Other

phone_numbers
Array (PhoneNumber)

An arrary of the phone numbers associated with the contact

Hide child attributesShow child attributes
id
number

The id of the phone number

address
string, required

The number assoicated with the phone number

principal
boolean

A flag indicating whether this number is the primary phone number for the contact

extension
string

The number extension

kind
string

The type of the phone number being created

Choices: Work Home Mobile Vacation Fax Other

websites
Array (Website)

An arrary of the websites associated with the contact

Hide child attributesShow child attributes
id
number

The id of the website

address
string, required

The address assoicated with the email address

principal
boolean

Flag to indicate if the website is principal site of the contact

kind
string

The type of the website being created

Choices: Website Facebook Blog

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "prefix": "Mr.",
  "first_name": "Kevin",
  "middle_name": "James",
  "last_name": "Anderson",
  "suffix": "M.D.",
  "nickname": "Kev",
  "job_title": "CEO",
  "twitter_name": "kev.anderson",
  "linkedin_url": "linkedin.com/in/kanderson",
  "background_information": "Met Kevin at a conference.",
  "birth_date": "1975-10-27",
  "anniversary": "1998-11-29",
  "client_since": "2002-05-21",
  "date_of_death": "2018-01-21",
  "assigned_to": 1,
  "referred_by": 1,
  "type": "Person",
  "gender": "Male",
  "contact_source": "Referral",
  "contact_type": "Client",
  "status": "Active",
  "marital_status": "Married",
  "attorney": 1,
  "cpa": 1,
  "doctor": 1,
  "insurance": 1,
  "business_manager": 1,
  "family_officer": 1,
  "assistant": 1,
  "other": 1,
  "important_information": "Has 3 kids in college",
  "personal_interests": "Skiing: Downhill, Traveling",
  "investment_objective": "Aggressive Growth",
  "time_horizon": "Short Term",
  "risk_tolerance": "Low",
  "mutual_fund_experience": 3,
  "stocks_and_bonds_experience": 2,
  "partnerships_experience": 1,
  "other_investing_experience": 5,
  "gross_annual_income": 100000,
  "assets": 250000,
  "non_liquid_assets": 50000,
  "liabilities": 50000,
  "adjusted_gross_income": 75000,
  "estimated_taxes": 18000,
  "confirmed_by_tax_return": true,
  "tax_year": 2015,
  "tax_bracket": 10,
  "birth_place": "New York, NY",
  "maiden_name": "Anderson",
  "passport_number": "AB1234CD5689",
  "green_card_number": "ZX567HG134",
  "occupation": {
    "name": "CEO",
    "start_date": "2015-11-25"
  },
  "drivers_license": {
    "number": "1111111",
    "state": "New York",
    "issued_date": "2001-10-27",
    "expires_date": "2011-10-27"
  },
  "retirement_date": "2025-09-30",
  "signed_fee_agreement_date": "2013-05-15",
  "signed_ips_agreement_date": "2014-03-12",
  "last_adv_offering_date": "2013-09-21",
  "last_privacy_offering_date": "2011-10-23",
  "company_name": "Acme Co.",
  "household": {
    "name": "The Anderson's",
    "title": "Head",
    "id": 1,
    "members": [
      {
        "id": 1,
        "first_name": "Kevin",
        "last_name": "Anderson",
        "title": "Head",
        "type": "Person"
      }
    ]
  },
  "image": "https://app.crmworkspace.com/avatar.png",
  "tags": [
    {
      "id": 1,
      "name": "Clients"
    }
  ],
  "street_addresses": [
    {
      "street_line_1": "155 12th Ave.",
      "street_line_2": "Apt 3B",
      "city": "New York",
      "state": "New York",
      "zip_code": "10001",
      "country": "United States",
      "principal": true,
      "kind": "Work",
      "id": 1,
      "address": "Hello, world!"
    }
  ],
  "email_addresses": [
    {
      "id": 1,
      "address": "kevin.anderson@example.com",
      "principal": true,
      "kind": "Work"
    }
  ],
  "phone_numbers": [
    {
      "id": 1,
      "address": "(555) 555-5555",
      "principal": true,
      "extension": "77",
      "kind": "Work"
    }
  ],
  "websites": [
    {
      "id": 1,
      "address": "https://www.example.com",
      "principal": true,
      "kind": "Website"
    }
  ],
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ]
}
PUT
Update an existing contact
/v1/contacts/{id}

Update a specific contact using it unique identifier. The contact returned will include the attributes listed below.

Parameters
id
number, required

The id of the contact to be updated

Request Attributes
first_name
string
Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

prefix
string

The preferred prefix for the Contact

first_name
string, required

The first name of the Contact

middle_name
string

The middle name of the Contact

last_name
string, required

The last name of the Contact

suffix
string

The suffix associated with the Contact

nickname
string

A preferred shortname for the Contact

job_title
string

The title the contact holds at his/her present company

twitter_name
string

The twitter handle of the contact

linkedin_url
string

The LinkedIn url for the contact

background_information
string

A brief description of the contact in a longer format

birth_date
Date

The birthdate of the contact

anniversary
Date

The wedding anniversary of the contact

client_since
Date

The date when the contact became a client

date_of_death
Date

The date of death of the contact

assigned_to
number

The id of the User who is assigned to this contact

referred_by
number

The id of the Contact who referred this Contact to the firm

type
string

The type of the Contact being created

Choices: Person Household Organization Trust

gender
string

The gender of the Contact

Choices: Male Female Unknown

contact_source
string

The method in which this contact was taken on as new business

Choices: Referral Conference Direct Mail Cold Call Other

contact_type
string

A string further classifying the Contact

Choices: Client Past Client Prospect Vendor Organization

status
string

A flag indicating whether or not the contact is currently active

Choices: Active Inactive

marital_status
string

The marital status of the contact

Choices: Married Single Divorced Widowed Life Partner Seperated Unknown

attorney
number

The id of the Contact acting as this Contact’s attorney

cpa
number

The id of the Contact acting as this Contact’s accountant

doctor
number

The id of the Contact acting as this Contact’s doctor

insurance
number

The id of the Contact acting as this Contact’s insurance agent

business_manager
number

The id of the Contact acting as this Contact’s business manager

family_officer
number

The id of the Contact acting as this Contact’s family officer

assistant
number

The id of the Contact acting as this Contact’s assistant

other
number

The id of the Contact acting as this Contact’s other

important_information
string

A block of text containing any other important info for the Contact

personal_interests
string

A block of text containing personal interests for the Contact

investment_objective
string

A basic classification of the Contact’s investment objectives

Choices: Aggressive Growth Growth Income Safety of Principal

time_horizon
string

A basic classification of the time horizon for the Contact’s investment goals

Choices: Short Term Intermediate Long Term

risk_tolerance
string

A basic classification of the Contact’s risk tolerance

Choices: Low Moderate High Risk

mutual_fund_experience
number

Years of experience the contact has in the mutual fund market

stocks_and_bonds_experience
number

Years of experience the contact has in the stocks and bonds fund market

partnerships_experience
number

Years of experience the contact has in partnerships

other_investing_experience
number

Years of experience the contact has in other aspects of the investement world

gross_annual_income
number

The Contact’s estimated gross annual income

assets
number

The value of all of the Contact’s holdings

non_liquid_assets
number

The total value of all of the assets holdings that are liquid

liabilities
number

The total value of the Contact’s liabilities

adjusted_gross_income
number

The Contact’s annual income adjusted for tax withholdings

estimated_taxes
number

The total amount of taxes paid by the Contact during a tax year

confirmed_by_tax_return
boolean

Flag to indicate if the Contact’s adjusted gross income and estimated taxes have been confirmed by their tax return

tax_year
number

The year of the tax return that was used to confirim the Contact’s income and tax liability

tax_bracket
number

Tax bracket that the Contact sits in according to his last recorded tax return

birth_place
string

The city/state where the Contact was born

maiden_name
string

The maiden name of the Contact is she has one

passport_number
string

The passport number of the Contact

green_card_number
string

The green card number of the Contact

occupation
Occupation

An object representing critical information about the contact’s occupation

Hide child attributesShow child attributes
name
string

The current occupation of the contact

start_date
Date

The date when the Contact started his current job

drivers_license
DriversLicense

An object representing the contact’s driver’s license

Hide child attributesShow child attributes
number
string

The ID number for this Contact’s drivers license

state
string

The state in which this Contact’s drivers license was issued

issued_date
Date

The date when the Contact’s driver’s license was last issued

expires_date
Date

The date when the Contact’s driver’s license is set to expire

retirement_date
Date

The date when the Contact hope to retire

signed_fee_agreement_date
Date

The date when the Contact’s fee agreement was signed

signed_ips_agreement_date
Date

The date when the Contact’s IPS agreement was signed

last_adv_offering_date
Date

The date when the Contact’s was last offered ADV

last_privacy_offering_date
Date

The date when the Contact last signed their privacy agreement

company_name
string

The name of the company the person is employed with

household
Household

An object representing the contact’s household

Hide child attributesShow child attributes
name
string

The name of the household of which the Contact belongs to

title
string

The title the contact holds within his/her own household

Choices: Head Spouse Partner Child Grandchild Parent Grandparent Sibling Other Dependent

id
number

The id of the household

members
Array (HouseholdMember)

A list of all contacts assoicated with this record

Hide child attributesShow child attributes
id
number

The id of the household member

first_name
string

The full name of the household member

last_name
string

The full name of the household member

title
string

The title of the household member

type
string

The type of the household member

image
string

A URL that links to the headshot for the contact

tags
Array (Tag)

An array of tags that are associated with the contact

Hide child attributesShow child attributes
id
number

The id of the object being returned

name
string

The name of the tag in question

street_addresses
Array (MailingAddress)

An arrary of the street addresses associated with the contact

Hide child attributesShow child attributes
street_line_1
string

The top line of the address

street_line_2
string

The second line of the address

city
string

The city the address is located in

state
string

The state the address is located in

zip_code
string

The zip code of the address

country
string
Default: United States

The country the address is located in

principal
boolean

A flag to indicate if the address is the primary address for the contact

kind
string

The type of the mailing address being created

Choices: Work Home Mobile Vacation Fax Other

id
number

The id of the mailing address

address
string

The top line of the address

email_addresses
Array (EmailAddress)

An arrary of the email addresses associated with the contact

Hide child attributesShow child attributes
id
number

The id of the email address

address
string, required

The address assoicated with the email address

principal
boolean

Flag to indicate if the email address is the principal address of the contact

kind
string

The type of the phone number being created

Choices: Work Home Mobile Vacation Fax Other

phone_numbers
Array (PhoneNumber)

An arrary of the phone numbers associated with the contact

Hide child attributesShow child attributes
id
number

The id of the phone number

address
string, required

The number assoicated with the phone number

principal
boolean

A flag indicating whether this number is the primary phone number for the contact

extension
string

The number extension

kind
string

The type of the phone number being created

Choices: Work Home Mobile Vacation Fax Other

websites
Array (Website)

An arrary of the websites associated with the contact

Hide child attributesShow child attributes
id
number

The id of the website

address
string, required

The address assoicated with the email address

principal
boolean

Flag to indicate if the website is principal site of the contact

kind
string

The type of the website being created

Choices: Website Facebook Blog

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

Request
Body
{
  "first_name": "Joseph"
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "prefix": "Mr.",
  "first_name": "Kevin",
  "middle_name": "James",
  "last_name": "Anderson",
  "suffix": "M.D.",
  "nickname": "Kev",
  "job_title": "CEO",
  "twitter_name": "kev.anderson",
  "linkedin_url": "linkedin.com/in/kanderson",
  "background_information": "Met Kevin at a conference.",
  "birth_date": "1975-10-27",
  "anniversary": "1998-11-29",
  "client_since": "2002-05-21",
  "date_of_death": "2018-01-21",
  "assigned_to": 1,
  "referred_by": 1,
  "type": "Person",
  "gender": "Male",
  "contact_source": "Referral",
  "contact_type": "Client",
  "status": "Active",
  "marital_status": "Married",
  "attorney": 1,
  "cpa": 1,
  "doctor": 1,
  "insurance": 1,
  "business_manager": 1,
  "family_officer": 1,
  "assistant": 1,
  "other": 1,
  "important_information": "Has 3 kids in college",
  "personal_interests": "Skiing: Downhill, Traveling",
  "investment_objective": "Aggressive Growth",
  "time_horizon": "Short Term",
  "risk_tolerance": "Low",
  "mutual_fund_experience": 3,
  "stocks_and_bonds_experience": 2,
  "partnerships_experience": 1,
  "other_investing_experience": 5,
  "gross_annual_income": 100000,
  "assets": 250000,
  "non_liquid_assets": 50000,
  "liabilities": 50000,
  "adjusted_gross_income": 75000,
  "estimated_taxes": 18000,
  "confirmed_by_tax_return": true,
  "tax_year": 2015,
  "tax_bracket": 10,
  "birth_place": "New York, NY",
  "maiden_name": "Anderson",
  "passport_number": "AB1234CD5689",
  "green_card_number": "ZX567HG134",
  "occupation": {
    "name": "CEO",
    "start_date": "2015-11-25"
  },
  "drivers_license": {
    "number": "1111111",
    "state": "New York",
    "issued_date": "2001-10-27",
    "expires_date": "2011-10-27"
  },
  "retirement_date": "2025-09-30",
  "signed_fee_agreement_date": "2013-05-15",
  "signed_ips_agreement_date": "2014-03-12",
  "last_adv_offering_date": "2013-09-21",
  "last_privacy_offering_date": "2011-10-23",
  "company_name": "Acme Co.",
  "household": {
    "name": "The Anderson's",
    "title": "Head",
    "id": 1,
    "members": [
      {
        "id": 1,
        "first_name": "Kevin",
        "last_name": "Anderson",
        "title": "Head",
        "type": "Person"
      }
    ]
  },
  "image": "https://app.crmworkspace.com/avatar.png",
  "tags": [
    {
      "id": 1,
      "name": "Clients"
    }
  ],
  "street_addresses": [
    {
      "street_line_1": "155 12th Ave.",
      "street_line_2": "Apt 3B",
      "city": "New York",
      "state": "New York",
      "zip_code": "10001",
      "country": "United States",
      "principal": true,
      "kind": "Work",
      "id": 1,
      "address": "Hello, world!"
    }
  ],
  "email_addresses": [
    {
      "id": 1,
      "address": "kevin.anderson@example.com",
      "principal": true,
      "kind": "Work"
    }
  ],
  "phone_numbers": [
    {
      "id": 1,
      "address": "(555) 555-5555",
      "principal": true,
      "extension": "77",
      "kind": "Work"
    }
  ],
  "websites": [
    {
      "id": 1,
      "address": "https://www.example.com",
      "principal": true,
      "kind": "Website"
    }
  ],
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ]
}
DELETE
Delete an existing contact
/v1/contacts/{id}

Delete a specific contact using it unique identifier.

Parameters
id
number, required

The id of the contact to be updated

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

prefix
string

The preferred prefix for the Contact

first_name
string, required

The first name of the Contact

middle_name
string

The middle name of the Contact

last_name
string, required

The last name of the Contact

suffix
string

The suffix associated with the Contact

nickname
string

A preferred shortname for the Contact

job_title
string

The title the contact holds at his/her present company

twitter_name
string

The twitter handle of the contact

linkedin_url
string

The LinkedIn url for the contact

background_information
string

A brief description of the contact in a longer format

birth_date
Date

The birthdate of the contact

anniversary
Date

The wedding anniversary of the contact

client_since
Date

The date when the contact became a client

date_of_death
Date

The date of death of the contact

assigned_to
number

The id of the User who is assigned to this contact

referred_by
number

The id of the Contact who referred this Contact to the firm

type
string

The type of the Contact being created

Choices: Person Household Organization Trust

gender
string

The gender of the Contact

Choices: Male Female Unknown

contact_source
string

The method in which this contact was taken on as new business

Choices: Referral Conference Direct Mail Cold Call Other

contact_type
string

A string further classifying the Contact

Choices: Client Past Client Prospect Vendor Organization

status
string

A flag indicating whether or not the contact is currently active

Choices: Active Inactive

marital_status
string

The marital status of the contact

Choices: Married Single Divorced Widowed Life Partner Seperated Unknown

attorney
number

The id of the Contact acting as this Contact’s attorney

cpa
number

The id of the Contact acting as this Contact’s accountant

doctor
number

The id of the Contact acting as this Contact’s doctor

insurance
number

The id of the Contact acting as this Contact’s insurance agent

business_manager
number

The id of the Contact acting as this Contact’s business manager

family_officer
number

The id of the Contact acting as this Contact’s family officer

assistant
number

The id of the Contact acting as this Contact’s assistant

other
number

The id of the Contact acting as this Contact’s other

important_information
string

A block of text containing any other important info for the Contact

personal_interests
string

A block of text containing personal interests for the Contact

investment_objective
string

A basic classification of the Contact’s investment objectives

Choices: Aggressive Growth Growth Income Safety of Principal

time_horizon
string

A basic classification of the time horizon for the Contact’s investment goals

Choices: Short Term Intermediate Long Term

risk_tolerance
string

A basic classification of the Contact’s risk tolerance

Choices: Low Moderate High Risk

mutual_fund_experience
number

Years of experience the contact has in the mutual fund market

stocks_and_bonds_experience
number

Years of experience the contact has in the stocks and bonds fund market

partnerships_experience
number

Years of experience the contact has in partnerships

other_investing_experience
number

Years of experience the contact has in other aspects of the investement world

gross_annual_income
number

The Contact’s estimated gross annual income

assets
number

The value of all of the Contact’s holdings

non_liquid_assets
number

The total value of all of the assets holdings that are liquid

liabilities
number

The total value of the Contact’s liabilities

adjusted_gross_income
number

The Contact’s annual income adjusted for tax withholdings

estimated_taxes
number

The total amount of taxes paid by the Contact during a tax year

confirmed_by_tax_return
boolean

Flag to indicate if the Contact’s adjusted gross income and estimated taxes have been confirmed by their tax return

tax_year
number

The year of the tax return that was used to confirim the Contact’s income and tax liability

tax_bracket
number

Tax bracket that the Contact sits in according to his last recorded tax return

birth_place
string

The city/state where the Contact was born

maiden_name
string

The maiden name of the Contact is she has one

passport_number
string

The passport number of the Contact

green_card_number
string

The green card number of the Contact

occupation
Occupation

An object representing critical information about the contact’s occupation

Hide child attributesShow child attributes
name
string

The current occupation of the contact

start_date
Date

The date when the Contact started his current job

drivers_license
DriversLicense

An object representing the contact’s driver’s license

Hide child attributesShow child attributes
number
string

The ID number for this Contact’s drivers license

state
string

The state in which this Contact’s drivers license was issued

issued_date
Date

The date when the Contact’s driver’s license was last issued

expires_date
Date

The date when the Contact’s driver’s license is set to expire

retirement_date
Date

The date when the Contact hope to retire

signed_fee_agreement_date
Date

The date when the Contact’s fee agreement was signed

signed_ips_agreement_date
Date

The date when the Contact’s IPS agreement was signed

last_adv_offering_date
Date

The date when the Contact’s was last offered ADV

last_privacy_offering_date
Date

The date when the Contact last signed their privacy agreement

company_name
string

The name of the company the person is employed with

household
Household

An object representing the contact’s household

Hide child attributesShow child attributes
name
string

The name of the household of which the Contact belongs to

title
string

The title the contact holds within his/her own household

Choices: Head Spouse Partner Child Grandchild Parent Grandparent Sibling Other Dependent

id
number

The id of the household

members
Array (HouseholdMember)

A list of all contacts assoicated with this record

Hide child attributesShow child attributes
id
number

The id of the household member

first_name
string

The full name of the household member

last_name
string

The full name of the household member

title
string

The title of the household member

type
string

The type of the household member

image
string

A URL that links to the headshot for the contact

tags
Array (Tag)

An array of tags that are associated with the contact

Hide child attributesShow child attributes
id
number

The id of the object being returned

name
string

The name of the tag in question

street_addresses
Array (MailingAddress)

An arrary of the street addresses associated with the contact

Hide child attributesShow child attributes
street_line_1
string

The top line of the address

street_line_2
string

The second line of the address

city
string

The city the address is located in

state
string

The state the address is located in

zip_code
string

The zip code of the address

country
string
Default: United States

The country the address is located in

principal
boolean

A flag to indicate if the address is the primary address for the contact

kind
string

The type of the mailing address being created

Choices: Work Home Mobile Vacation Fax Other

id
number

The id of the mailing address

address
string

The top line of the address

email_addresses
Array (EmailAddress)

An arrary of the email addresses associated with the contact

Hide child attributesShow child attributes
id
number

The id of the email address

address
string, required

The address assoicated with the email address

principal
boolean

Flag to indicate if the email address is the principal address of the contact

kind
string

The type of the phone number being created

Choices: Work Home Mobile Vacation Fax Other

phone_numbers
Array (PhoneNumber)

An arrary of the phone numbers associated with the contact

Hide child attributesShow child attributes
id
number

The id of the phone number

address
string, required

The number assoicated with the phone number

principal
boolean

A flag indicating whether this number is the primary phone number for the contact

extension
string

The number extension

kind
string

The type of the phone number being created

Choices: Work Home Mobile Vacation Fax Other

websites
Array (Website)

An arrary of the websites associated with the contact

Hide child attributesShow child attributes
id
number

The id of the website

address
string, required

The address assoicated with the email address

principal
boolean

Flag to indicate if the website is principal site of the contact

kind
string

The type of the website being created

Choices: Website Facebook Blog

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

birth_date
Date

The birthdate of the contact

anniversary
Date

The wedding anniversary of the contact

client_since
Date

The date when the contact became a client

date_of_death
Date

The date of the contact’s passing

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "prefix": "Mr.",
  "first_name": "Kevin",
  "middle_name": "James",
  "last_name": "Anderson",
  "suffix": "M.D.",
  "nickname": "Kev",
  "job_title": "CEO",
  "twitter_name": "kev.anderson",
  "linkedin_url": "linkedin.com/in/kanderson",
  "background_information": "Met Kevin at a conference.",
  "birth_date": "Hello, world!",
  "anniversary": "Hello, world!",
  "client_since": "Hello, world!",
  "date_of_death": "Hello, world!",
  "assigned_to": 1,
  "referred_by": 1,
  "type": "Person",
  "gender": "Male",
  "contact_source": "Referral",
  "contact_type": "Client",
  "status": "Active",
  "marital_status": "Married",
  "attorney": 1,
  "cpa": 1,
  "doctor": 1,
  "insurance": 1,
  "business_manager": 1,
  "family_officer": 1,
  "assistant": 1,
  "other": 1,
  "important_information": "Has 3 kids in college",
  "personal_interests": "Skiing: Downhill, Traveling",
  "investment_objective": "Aggressive Growth",
  "time_horizon": "Short Term",
  "risk_tolerance": "Low",
  "mutual_fund_experience": 3,
  "stocks_and_bonds_experience": 2,
  "partnerships_experience": 1,
  "other_investing_experience": 5,
  "gross_annual_income": 100000,
  "assets": 250000,
  "non_liquid_assets": 50000,
  "liabilities": 50000,
  "adjusted_gross_income": 75000,
  "estimated_taxes": 18000,
  "confirmed_by_tax_return": true,
  "tax_year": 2015,
  "tax_bracket": 10,
  "birth_place": "New York, NY",
  "maiden_name": "Anderson",
  "passport_number": "AB1234CD5689",
  "green_card_number": "ZX567HG134",
  "occupation": {
    "name": "CEO",
    "start_date": "2015-11-25"
  },
  "drivers_license": {
    "number": "1111111",
    "state": "New York",
    "issued_date": "2001-10-27",
    "expires_date": "2011-10-27"
  },
  "retirement_date": "2025-09-30",
  "signed_fee_agreement_date": "2013-05-15",
  "signed_ips_agreement_date": "2014-03-12",
  "last_adv_offering_date": "2013-09-21",
  "last_privacy_offering_date": "2011-10-23",
  "company_name": "Acme Co.",
  "household": {
    "name": "The Anderson's",
    "title": "Head",
    "id": 1,
    "members": [
      {
        "id": 1,
        "first_name": "Kevin",
        "last_name": "Anderson",
        "title": "Head",
        "type": "Person"
      }
    ]
  },
  "image": "https://app.crmworkspace.com/avatar.png",
  "tags": [
    {
      "id": 1,
      "name": "Clients"
    }
  ],
  "street_addresses": [
    {
      "street_line_1": "155 12th Ave.",
      "street_line_2": "Apt 3B",
      "city": "New York",
      "state": "New York",
      "zip_code": "10001",
      "country": "United States",
      "principal": true,
      "kind": "Work",
      "id": 1,
      "address": "Hello, world!"
    }
  ],
  "email_addresses": [
    {
      "id": 1,
      "address": "kevin.anderson@example.com",
      "principal": true,
      "kind": "Work"
    }
  ],
  "phone_numbers": [
    {
      "id": 1,
      "address": "(555) 555-5555",
      "principal": true,
      "extension": "77",
      "kind": "Work"
    }
  ],
  "websites": [
    {
      "id": 1,
      "address": "https://www.example.com",
      "principal": true,
      "kind": "Website"
    }
  ],
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ]
}

Collection

GET
Retrieve all tasks
/v1/tasks{?resource_id}{?resource_type}{?assigned_to}{?created_by}{?completed}

This endpoint will fetch all of the tasks that are accessible by the user. This way the user can not access any tasks they don’t have access to.

Parameters
resource_id
number

The id of the resource being searched for

resource_type
string

The type of resource being searched for

assigned_to
number

The id of the User which the task is assigned to.

created_by
number

The id of the User who created the task

completed
boolean

Return completed tasks as well

Response Attributes
tasks
Array (Task)
Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the task being returned

due_date
Datetime, required

The time at which the task is due

description
string

A short explaination of the task being returned

assigned_to
number

The id of the user who the task is assigned to

complete
boolean

Flag to indicate whether or not the task is complete

repeats
boolean

Flag to indicate whether or not the task repeats

category
number

The category the task will belong to

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

priority
string

String to indicate the priority of the task you are creating

Choices: Low Medium High

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Response  200
Body
{
  "tasks": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "name": "Return Bill's call",
      "due_date": "2015-05-24 11:00 AM -500",
      "description": "Follow up from message...",
      "assigned_to": 1,
      "complete": true,
      "repeats": true,
      "category": 1,
      "linked_to": [
        {
          "id": 1,
          "type": "Contact",
          "name": "Kevin Anderson"
        }
      ],
      "priority": "Low",
      "visible_to": "Everyone"
    }
  ]
}
POST
Create a new task
/v1/tasks

Create a new task

Request Attributes
name
string, required

The name of the task being returned

due_date
Datetime, required

The time at which the task is due

description
string

A short explaination of the task being returned

assigned_to
number

The id of the user who the task is assigned to

complete
boolean

Flag to indicate whether or not the task is complete

repeats
boolean

Flag to indicate whether or not the task repeats

category
number

The category the task will belong to

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

priority
string

String to indicate the priority of the task you are creating

Choices: Low Medium High

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the task being returned

due_date
Datetime, required

The time at which the task is due

description
string

A short explaination of the task being returned

assigned_to
number

The id of the user who the task is assigned to

complete
boolean

Flag to indicate whether or not the task is complete

repeats
boolean

Flag to indicate whether or not the task repeats

category
number

The category the task will belong to

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

priority
string

String to indicate the priority of the task you are creating

Choices: Low Medium High

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Request
Body
{
  "name": "Return Bill's call",
  "due_date": "2015-05-24 11:00 AM -500",
  "description": "Follow up from message...",
  "assigned_to": 1,
  "complete": true,
  "repeats": true,
  "category": 1,
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "priority": "Low",
  "visible_to": "Everyone"
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "name": "Return Bill's call",
  "due_date": "2015-05-24 11:00 AM -500",
  "description": "Follow up from message...",
  "assigned_to": 1,
  "complete": true,
  "repeats": true,
  "category": 1,
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "priority": "Low",
  "visible_to": "Everyone"
}

Task

GET
Fetch an existing task
/v1/tasks/{id}

Retrieve a specific task using it unique identifier. The task returned will include the attributes listed below.

Parameters
id
number, required

The id of the task to be updated

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the task being returned

due_date
Datetime, required

The time at which the task is due

description
string

A short explaination of the task being returned

assigned_to
number

The id of the user who the task is assigned to

complete
boolean

Flag to indicate whether or not the task is complete

repeats
boolean

Flag to indicate whether or not the task repeats

category
number

The category the task will belong to

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

priority
string

String to indicate the priority of the task you are creating

Choices: Low Medium High

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "name": "Return Bill's call",
  "due_date": "2015-05-24 11:00 AM -500",
  "description": "Follow up from message...",
  "assigned_to": 1,
  "complete": true,
  "repeats": true,
  "category": 1,
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "priority": "Low",
  "visible_to": "Everyone"
}
PUT
Update an existing task
/v1/tasks/{id}

Update a existing task with new properties, these properties will be saved to the database and the new task will be returned.

Parameters
id
number, required

The id of the task to be updated

Request Attributes
name
string, required

The name of the task being returned

due_date
Datetime, required

The time at which the task is due

description
string

A short explaination of the task being returned

assigned_to
number

The id of the user who the task is assigned to

complete
boolean

Flag to indicate whether or not the task is complete

repeats
boolean

Flag to indicate whether or not the task repeats

category
number

The category the task will belong to

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

priority
string

String to indicate the priority of the task you are creating

Choices: Low Medium High

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the task being returned

due_date
Datetime, required

The time at which the task is due

description
string

A short explaination of the task being returned

assigned_to
number

The id of the user who the task is assigned to

complete
boolean

Flag to indicate whether or not the task is complete

repeats
boolean

Flag to indicate whether or not the task repeats

category
number

The category the task will belong to

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

priority
string

String to indicate the priority of the task you are creating

Choices: Low Medium High

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Request
Body
{
  "name": "Return Bill's call",
  "due_date": "2015-05-24 11:00 AM -500",
  "description": "Follow up from message...",
  "assigned_to": 1,
  "complete": true,
  "repeats": true,
  "category": 1,
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "priority": "Low",
  "visible_to": "Everyone"
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "name": "Return Bill's call",
  "due_date": "2015-05-24 11:00 AM -500",
  "description": "Follow up from message...",
  "assigned_to": 1,
  "complete": true,
  "repeats": true,
  "category": 1,
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "priority": "Low",
  "visible_to": "Everyone"
}
DELETE
Delete task
/v1/tasks/{id}

Delete an existing task from your account. This task will not be available to you going forward in the future.

Parameters
id
number, required

The id of the task to be updated

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the task being returned

due_date
Datetime, required

The time at which the task is due

description
string

A short explaination of the task being returned

assigned_to
number

The id of the user who the task is assigned to

complete
boolean

Flag to indicate whether or not the task is complete

repeats
boolean

Flag to indicate whether or not the task repeats

category
number

The category the task will belong to

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

priority
string

String to indicate the priority of the task you are creating

Choices: Low Medium High

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "name": "Return Bill's call",
  "due_date": "2015-05-24 11:00 AM -500",
  "description": "Follow up from message...",
  "assigned_to": 1,
  "complete": true,
  "repeats": true,
  "category": 1,
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "priority": "Low",
  "visible_to": "Everyone"
}

Collection

GET
Retrieve all workflows
/v1/workflows{?resource_id}{?resource_type}

This endpoint will fetch all of the workflows that are accessible by the user. This way the user can not access any workflows they don’t have access to.

Parameters
resource_id
number

The id of the resource being searched for

resource_type
string

The type of resource being searched for

Response Attributes
workflows
Array (Workflow)
Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

label
string

A short name for the Workflow

linked_to
Document

An object that is linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

workflow_template
WorkflowTemplate

The workflow template related to the specified workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the WorkflowTemplate

sequential
boolean

Flag to determine if the WorkflowSteps in this template must be completed in order of their position

description
string

A short description of the WorkflowTemplate

shared
boolean

Flag to determine if this WorkflowTemplate is shared amongst all Workspaces on the account

ready
boolean

Flag to determine if this WorkflowTemplate is ready to spawn new Workflows

workflow_steps
Array (WorkflowStep)

An array of all WorkflowSteps related to this Workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the Workflow Step

description
string

A short description of the WorkflowStep

workflow
number

The id of the Workflow this step is connected to

assigned_to
number

The ID of the contact that is assigned to this workflow

due_date_set
boolean

A flag indicating a due date is set for this WorkflowStep

due_later
string

A string representing the interval of time when this workflow step is due after the start of a workflow

priority
string

The relative priority of the Workflow Step

Choices: None Low Medium High

kind
string

A string to classify the template

Choices: Contact Project Opportunity

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

workflow_steps
Array (WorkflowStep)

An array of all WorkflowSteps related to this Workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the Workflow Step

description
string

A short description of the WorkflowStep

workflow
number

The id of the Workflow this step is connected to

assigned_to
number

The ID of the contact that is assigned to this workflow

due_date_set
boolean

A flag indicating a due date is set for this WorkflowStep

due_later
string

A string representing the interval of time when this workflow step is due after the start of a workflow

priority
string

The relative priority of the Workflow Step

Choices: None Low Medium High

Response  200
Body
{
  "workflows": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "label": "Onboard a new client to the firm",
      "linked_to": {
        "id": 1,
        "type": "Contact",
        "name": "Kevin Anderson"
      },
      "visible_to": "Everyone",
      "workflow_template": {
        "id": 1,
        "creator": 1,
        "created_at": "2015-05-24 10:00 AM -500",
        "updated_at": "2015-10-12 11:30 PM -500",
        "name": "New Client Onboarding Process",
        "sequential": true,
        "description": "Onboarding workflow for our clients...",
        "shared": true,
        "ready": true,
        "workflow_steps": [
          {
            "id": 1,
            "creator": 1,
            "created_at": "2015-05-24 10:00 AM -500",
            "updated_at": "2015-10-12 11:30 PM -500",
            "name": "Schedule discover meeting",
            "description": "In this meeting, we will...",
            "workflow": 1,
            "assigned_to": 1,
            "due_date_set": true,
            "due_later": "2 days later at 5:00 PM",
            "priority": "None"
          }
        ],
        "kind": "Contact",
        "visible_to": "Everyone"
      },
      "workflow_steps": [
        {
          "id": 1,
          "creator": 1,
          "created_at": "2015-05-24 10:00 AM -500",
          "updated_at": "2015-10-12 11:30 PM -500",
          "name": "Schedule discover meeting",
          "description": "In this meeting, we will...",
          "workflow": 1,
          "assigned_to": 1,
          "due_date_set": true,
          "due_later": "2 days later at 5:00 PM",
          "priority": "None"
        }
      ]
    }
  ]
}
POST
Create a new workflow
/v1/workflows

Create a new Workflow.

Request Attributes
label
string

A short name for the Workflow

linked_to
Document

An object that is linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

workflow_template
number, required

The id of the workflow template this workflow is based on

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

label
string

A short name for the Workflow

linked_to
Document

An object that is linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

workflow_template
WorkflowTemplate

The workflow template related to the specified workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the WorkflowTemplate

sequential
boolean

Flag to determine if the WorkflowSteps in this template must be completed in order of their position

description
string

A short description of the WorkflowTemplate

shared
boolean

Flag to determine if this WorkflowTemplate is shared amongst all Workspaces on the account

ready
boolean

Flag to determine if this WorkflowTemplate is ready to spawn new Workflows

workflow_steps
Array (WorkflowStep)

An array of all WorkflowSteps related to this Workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the Workflow Step

description
string

A short description of the WorkflowStep

workflow
number

The id of the Workflow this step is connected to

assigned_to
number

The ID of the contact that is assigned to this workflow

due_date_set
boolean

A flag indicating a due date is set for this WorkflowStep

due_later
string

A string representing the interval of time when this workflow step is due after the start of a workflow

priority
string

The relative priority of the Workflow Step

Choices: None Low Medium High

kind
string

A string to classify the template

Choices: Contact Project Opportunity

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

workflow_steps
Array (WorkflowStep)

An array of all WorkflowSteps related to this Workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the Workflow Step

description
string

A short description of the WorkflowStep

workflow
number

The id of the Workflow this step is connected to

assigned_to
number

The ID of the contact that is assigned to this workflow

due_date_set
boolean

A flag indicating a due date is set for this WorkflowStep

due_later
string

A string representing the interval of time when this workflow step is due after the start of a workflow

priority
string

The relative priority of the Workflow Step

Choices: None Low Medium High

Request
Body
{
  "label": "Onboard a new client to the firm",
  "linked_to": {
    "id": 1,
    "type": "Contact",
    "name": "Kevin Anderson"
  },
  "visible_to": "Everyone",
  "workflow_template": 1
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "label": "Onboard a new client to the firm",
  "linked_to": {
    "id": 1,
    "type": "Contact",
    "name": "Kevin Anderson"
  },
  "visible_to": "Everyone",
  "workflow_template": {
    "id": 1,
    "creator": 1,
    "created_at": "2015-05-24 10:00 AM -500",
    "updated_at": "2015-10-12 11:30 PM -500",
    "name": "New Client Onboarding Process",
    "sequential": true,
    "description": "Onboarding workflow for our clients...",
    "shared": true,
    "ready": true,
    "workflow_steps": [
      {
        "id": 1,
        "creator": 1,
        "created_at": "2015-05-24 10:00 AM -500",
        "updated_at": "2015-10-12 11:30 PM -500",
        "name": "Schedule discover meeting",
        "description": "In this meeting, we will...",
        "workflow": 1,
        "assigned_to": 1,
        "due_date_set": true,
        "due_later": "2 days later at 5:00 PM",
        "priority": "None"
      }
    ],
    "kind": "Contact",
    "visible_to": "Everyone"
  },
  "workflow_steps": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "name": "Schedule discover meeting",
      "description": "In this meeting, we will...",
      "workflow": 1,
      "assigned_to": 1,
      "due_date_set": true,
      "due_later": "2 days later at 5:00 PM",
      "priority": "None"
    }
  ]
}

Workflow

GET
Fetch an existing workflow
/v1/workflows/{id}

Retrieve a specific workflow using it unique identifier. The workflow returned will include the attributes listed below.

Parameters
id
number, required

The id of the workflow to be updated

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

label
string

A short name for the Workflow

linked_to
Document

An object that is linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

workflow_template
WorkflowTemplate

The workflow template related to the specified workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the WorkflowTemplate

sequential
boolean

Flag to determine if the WorkflowSteps in this template must be completed in order of their position

description
string

A short description of the WorkflowTemplate

shared
boolean

Flag to determine if this WorkflowTemplate is shared amongst all Workspaces on the account

ready
boolean

Flag to determine if this WorkflowTemplate is ready to spawn new Workflows

workflow_steps
Array (WorkflowStep)

An array of all WorkflowSteps related to this Workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the Workflow Step

description
string

A short description of the WorkflowStep

workflow
number

The id of the Workflow this step is connected to

assigned_to
number

The ID of the contact that is assigned to this workflow

due_date_set
boolean

A flag indicating a due date is set for this WorkflowStep

due_later
string

A string representing the interval of time when this workflow step is due after the start of a workflow

priority
string

The relative priority of the Workflow Step

Choices: None Low Medium High

kind
string

A string to classify the template

Choices: Contact Project Opportunity

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

workflow_steps
Array (WorkflowStep)

An array of all WorkflowSteps related to this Workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the Workflow Step

description
string

A short description of the WorkflowStep

workflow
number

The id of the Workflow this step is connected to

assigned_to
number

The ID of the contact that is assigned to this workflow

due_date_set
boolean

A flag indicating a due date is set for this WorkflowStep

due_later
string

A string representing the interval of time when this workflow step is due after the start of a workflow

priority
string

The relative priority of the Workflow Step

Choices: None Low Medium High

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "label": "Onboard a new client to the firm",
  "linked_to": {
    "id": 1,
    "type": "Contact",
    "name": "Kevin Anderson"
  },
  "visible_to": "Everyone",
  "workflow_template": {
    "id": 1,
    "creator": 1,
    "created_at": "2015-05-24 10:00 AM -500",
    "updated_at": "2015-10-12 11:30 PM -500",
    "name": "New Client Onboarding Process",
    "sequential": true,
    "description": "Onboarding workflow for our clients...",
    "shared": true,
    "ready": true,
    "workflow_steps": [
      {
        "id": 1,
        "creator": 1,
        "created_at": "2015-05-24 10:00 AM -500",
        "updated_at": "2015-10-12 11:30 PM -500",
        "name": "Schedule discover meeting",
        "description": "In this meeting, we will...",
        "workflow": 1,
        "assigned_to": 1,
        "due_date_set": true,
        "due_later": "2 days later at 5:00 PM",
        "priority": "None"
      }
    ],
    "kind": "Contact",
    "visible_to": "Everyone"
  },
  "workflow_steps": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "name": "Schedule discover meeting",
      "description": "In this meeting, we will...",
      "workflow": 1,
      "assigned_to": 1,
      "due_date_set": true,
      "due_later": "2 days later at 5:00 PM",
      "priority": "None"
    }
  ]
}
PUT
Update an existing workflow
/v1/workflows/{id}

Update a existing workflow with new properties, these properties will be saved to the database and the new workflow will be returned.

Parameters
id
number, required

The id of the workflow to be updated

Request Attributes
label
string

A short name for the Workflow

linked_to
Document

An object that is linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

workflow_template
number, required

The id of the workflow template this workflow is based on

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

label
string

A short name for the Workflow

linked_to
Document

An object that is linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

workflow_template
WorkflowTemplate

The workflow template related to the specified workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the WorkflowTemplate

sequential
boolean

Flag to determine if the WorkflowSteps in this template must be completed in order of their position

description
string

A short description of the WorkflowTemplate

shared
boolean

Flag to determine if this WorkflowTemplate is shared amongst all Workspaces on the account

ready
boolean

Flag to determine if this WorkflowTemplate is ready to spawn new Workflows

workflow_steps
Array (WorkflowStep)

An array of all WorkflowSteps related to this Workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the Workflow Step

description
string

A short description of the WorkflowStep

workflow
number

The id of the Workflow this step is connected to

assigned_to
number

The ID of the contact that is assigned to this workflow

due_date_set
boolean

A flag indicating a due date is set for this WorkflowStep

due_later
string

A string representing the interval of time when this workflow step is due after the start of a workflow

priority
string

The relative priority of the Workflow Step

Choices: None Low Medium High

kind
string

A string to classify the template

Choices: Contact Project Opportunity

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

workflow_steps
Array (WorkflowStep)

An array of all WorkflowSteps related to this Workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the Workflow Step

description
string

A short description of the WorkflowStep

workflow
number

The id of the Workflow this step is connected to

assigned_to
number

The ID of the contact that is assigned to this workflow

due_date_set
boolean

A flag indicating a due date is set for this WorkflowStep

due_later
string

A string representing the interval of time when this workflow step is due after the start of a workflow

priority
string

The relative priority of the Workflow Step

Choices: None Low Medium High

Request
Body
{
  "label": "Onboard a new client to the firm",
  "linked_to": {
    "id": 1,
    "type": "Contact",
    "name": "Kevin Anderson"
  },
  "visible_to": "Everyone",
  "workflow_template": 1
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "label": "Onboard a new client to the firm",
  "linked_to": {
    "id": 1,
    "type": "Contact",
    "name": "Kevin Anderson"
  },
  "visible_to": "Everyone",
  "workflow_template": {
    "id": 1,
    "creator": 1,
    "created_at": "2015-05-24 10:00 AM -500",
    "updated_at": "2015-10-12 11:30 PM -500",
    "name": "New Client Onboarding Process",
    "sequential": true,
    "description": "Onboarding workflow for our clients...",
    "shared": true,
    "ready": true,
    "workflow_steps": [
      {
        "id": 1,
        "creator": 1,
        "created_at": "2015-05-24 10:00 AM -500",
        "updated_at": "2015-10-12 11:30 PM -500",
        "name": "Schedule discover meeting",
        "description": "In this meeting, we will...",
        "workflow": 1,
        "assigned_to": 1,
        "due_date_set": true,
        "due_later": "2 days later at 5:00 PM",
        "priority": "None"
      }
    ],
    "kind": "Contact",
    "visible_to": "Everyone"
  },
  "workflow_steps": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "name": "Schedule discover meeting",
      "description": "In this meeting, we will...",
      "workflow": 1,
      "assigned_to": 1,
      "due_date_set": true,
      "due_later": "2 days later at 5:00 PM",
      "priority": "None"
    }
  ]
}
DELETE
Delete workflow
/v1/workflows/{id}

Delete an existing workflow from your account. This workflow will not be available to you going forward in the future.

Parameters
id
number, required

The id of the workflow to be updated

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

label
string

A short name for the Workflow

linked_to
Document

An object that is linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

workflow_template
WorkflowTemplate

The workflow template related to the specified workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the WorkflowTemplate

sequential
boolean

Flag to determine if the WorkflowSteps in this template must be completed in order of their position

description
string

A short description of the WorkflowTemplate

shared
boolean

Flag to determine if this WorkflowTemplate is shared amongst all Workspaces on the account

ready
boolean

Flag to determine if this WorkflowTemplate is ready to spawn new Workflows

workflow_steps
Array (WorkflowStep)

An array of all WorkflowSteps related to this Workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the Workflow Step

description
string

A short description of the WorkflowStep

workflow
number

The id of the Workflow this step is connected to

assigned_to
number

The ID of the contact that is assigned to this workflow

due_date_set
boolean

A flag indicating a due date is set for this WorkflowStep

due_later
string

A string representing the interval of time when this workflow step is due after the start of a workflow

priority
string

The relative priority of the Workflow Step

Choices: None Low Medium High

kind
string

A string to classify the template

Choices: Contact Project Opportunity

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

workflow_steps
Array (WorkflowStep)

An array of all WorkflowSteps related to this Workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the Workflow Step

description
string

A short description of the WorkflowStep

workflow
number

The id of the Workflow this step is connected to

assigned_to
number

The ID of the contact that is assigned to this workflow

due_date_set
boolean

A flag indicating a due date is set for this WorkflowStep

due_later
string

A string representing the interval of time when this workflow step is due after the start of a workflow

priority
string

The relative priority of the Workflow Step

Choices: None Low Medium High

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "label": "Onboard a new client to the firm",
  "linked_to": {
    "id": 1,
    "type": "Contact",
    "name": "Kevin Anderson"
  },
  "visible_to": "Everyone",
  "workflow_template": {
    "id": 1,
    "creator": 1,
    "created_at": "2015-05-24 10:00 AM -500",
    "updated_at": "2015-10-12 11:30 PM -500",
    "name": "New Client Onboarding Process",
    "sequential": true,
    "description": "Onboarding workflow for our clients...",
    "shared": true,
    "ready": true,
    "workflow_steps": [
      {
        "id": 1,
        "creator": 1,
        "created_at": "2015-05-24 10:00 AM -500",
        "updated_at": "2015-10-12 11:30 PM -500",
        "name": "Schedule discover meeting",
        "description": "In this meeting, we will...",
        "workflow": 1,
        "assigned_to": 1,
        "due_date_set": true,
        "due_later": "2 days later at 5:00 PM",
        "priority": "None"
      }
    ],
    "kind": "Contact",
    "visible_to": "Everyone"
  },
  "workflow_steps": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "name": "Schedule discover meeting",
      "description": "In this meeting, we will...",
      "workflow": 1,
      "assigned_to": 1,
      "due_date_set": true,
      "due_later": "2 days later at 5:00 PM",
      "priority": "None"
    }
  ]
}

Collection

GET
Retrieve all workflow templates
/v1/workflow_templates

This endpoint will fetch all of the workflow templates that are accessible by the user. This way the user can not access any workflow templates they don’t have access to.

Response Attributes
workflow_templates
Array (WorkflowTemplate)
Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the WorkflowTemplate

sequential
boolean

Flag to determine if the WorkflowSteps in this template must be completed in order of their position

description
string

A short description of the WorkflowTemplate

shared
boolean

Flag to determine if this WorkflowTemplate is shared amongst all Workspaces on the account

ready
boolean

Flag to determine if this WorkflowTemplate is ready to spawn new Workflows

workflow_steps
Array (WorkflowStep)

An array of all WorkflowSteps related to this Workflow

Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the Workflow Step

description
string

A short description of the WorkflowStep

workflow
number

The id of the Workflow this step is connected to

assigned_to
number

The ID of the contact that is assigned to this workflow

due_date_set
boolean

A flag indicating a due date is set for this WorkflowStep

due_later
string

A string representing the interval of time when this workflow step is due after the start of a workflow

priority
string

The relative priority of the Workflow Step

Choices: None Low Medium High

kind
string

A string to classify the template

Choices: Contact Project Opportunity

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Response  200
Body
{
  "workflow_templates": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "name": "New Client Onboarding Process",
      "sequential": true,
      "description": "Onboarding workflow for our clients...",
      "shared": true,
      "ready": true,
      "workflow_steps": [
        {
          "id": 1,
          "creator": 1,
          "created_at": "2015-05-24 10:00 AM -500",
          "updated_at": "2015-10-12 11:30 PM -500",
          "name": "Schedule discover meeting",
          "description": "In this meeting, we will...",
          "workflow": 1,
          "assigned_to": 1,
          "due_date_set": true,
          "due_later": "2 days later at 5:00 PM",
          "priority": "None"
        }
      ],
      "kind": "Contact",
      "visible_to": "Everyone"
    }
  ]
}

Update status of a workflow step

PUT
Update status of a workflow step
/v1/workflows/{workflow_id}/steps/{id}
Parameters
workflow_id
number, required

The id of the workflow which owns the step

id
number, required

The id of the workflow step

Request Attributes
complete
boolean

Flag, which if present upon a request, marks step complete

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string

The name of the Workflow Step

description
string

A short description of the WorkflowStep

workflow
number

The id of the Workflow this step is connected to

assigned_to
number

The ID of the contact that is assigned to this workflow

due_date_set
boolean

A flag indicating a due date is set for this WorkflowStep

due_later
string

A string representing the interval of time when this workflow step is due after the start of a workflow

priority
string

The relative priority of the Workflow Step

Choices: None Low Medium High

completer
number

The id of the user who completed the event

Request  Complete a WorkflowStep
Body
{
  "complete": true
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "name": "Schedule discover meeting",
  "description": "In this meeting, we will...",
  "workflow": 1,
  "assigned_to": 1,
  "due_date_set": true,
  "due_later": "2 days later at 5:00 PM",
  "priority": "None",
  "completer": 1
}
Request  Revert a WorkflowStep
Body
{
  "revert": true
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "name": "Schedule discover meeting",
  "description": "In this meeting, we will...",
  "workflow": 1,
  "assigned_to": 1,
  "due_date_set": true,
  "due_later": "2 days later at 5:00 PM",
  "priority": "None"
}

Collection

GET
Retrieve all events
/v1/events{?resource_id}{?resource_type}

This endpoint will fetch all of the events that are accessible by the user. This way the user can not access any events they don’t have access to.

Parameters
resource_id
number

The id of the resource being searched for

resource_type
string

The type of resource being searched for

Response Attributes
events
Array (Event)
Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

title
string, required

The name of the event being returned

starts_at
Datetime, required

A timestamp signifying when the event starts

ends_at
Datetime, required

A timestamp signifying when the event ends

repeats
boolean

A flag to indicate whether or not the event repeats

event_category
number

The id of the event category to which the event belongs

all_day
boolean

A flag to indicate if the event lasts all day

location
string

The description of the location the event takes place

description
string

A short explaination of the event being returned

state
string

The current state of the event

Choices: unconfirmed confirmed tentative completed cancelled

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

email_invitees
boolean

A flag to indicate if the invitees should be emailed their invitation

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

invitees
Array (InviteeResponse)

An object that describes a contact or user who is visiting the site

Hide child attributesShow child attributes
id
number, required

The id of the Contact/User being invited

type
string, required

The type of the resource being invited

Choices: User Contact

name
string

The name of the invitee

Response  200
Body
{
  "events": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "title": "Client Meeting",
      "starts_at": "2015-05-24 10:00 AM -500",
      "ends_at": "2015-05-24 11:00 AM -500",
      "repeats": true,
      "event_category": 2,
      "all_day": true,
      "location": "Conference Room",
      "description": "Review meeting for Kevin...",
      "state": "unconfirmed",
      "visible_to": "Everyone",
      "email_invitees": true,
      "linked_to": [
        {
          "id": 1,
          "type": "Contact",
          "name": "Kevin Anderson"
        }
      ],
      "invitees": [
        {
          "id": 1,
          "type": "User",
          "name": "Kevin Anderson"
        }
      ]
    }
  ]
}
POST
Create a new event
/v1/events

Create a new event

Request Attributes
title
string, required

The name of the event being returned

starts_at
Datetime, required

A timestamp signifying when the event starts

ends_at
Datetime, required

A timestamp signifying when the event ends

repeats
boolean

A flag to indicate whether or not the event repeats

event_category
number

The id of the event category to which the event belongs

all_day
boolean

A flag to indicate if the event lasts all day

location
string

The description of the location the event takes place

description
string

A short explaination of the event being returned

state
string

The current state of the event

Choices: unconfirmed confirmed tentative completed cancelled

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

email_invitees
boolean

A flag to indicate if the invitees should be emailed their invitation

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

invitees
Array (InviteeRequest)

An object that describes a contact or user who is visiting the site

Hide child attributesShow child attributes
id
number, required

The id of the Contact/User being invited

type
string, required

The type of the resource being invited

Choices: User Contact

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

title
string, required

The name of the event being returned

starts_at
Datetime, required

A timestamp signifying when the event starts

ends_at
Datetime, required

A timestamp signifying when the event ends

repeats
boolean

A flag to indicate whether or not the event repeats

event_category
number

The id of the event category to which the event belongs

all_day
boolean

A flag to indicate if the event lasts all day

location
string

The description of the location the event takes place

description
string

A short explaination of the event being returned

state
string

The current state of the event

Choices: unconfirmed confirmed tentative completed cancelled

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

email_invitees
boolean

A flag to indicate if the invitees should be emailed their invitation

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

invitees
Array (InviteeResponse)

An object that describes a contact or user who is visiting the site

Hide child attributesShow child attributes
id
number, required

The id of the Contact/User being invited

type
string, required

The type of the resource being invited

Choices: User Contact

name
string

The name of the invitee

Request
Body
{
  "title": "Client Meeting",
  "starts_at": "2015-05-24 10:00 AM -500",
  "ends_at": "2015-05-24 11:00 AM -500",
  "repeats": true,
  "event_category": 2,
  "all_day": true,
  "location": "Conference Room",
  "description": "Review meeting for Kevin...",
  "state": "unconfirmed",
  "visible_to": "Everyone",
  "email_invitees": true,
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "invitees": [
    {
      "id": 1,
      "type": "User"
    }
  ]
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "title": "Client Meeting",
  "starts_at": "2015-05-24 10:00 AM -500",
  "ends_at": "2015-05-24 11:00 AM -500",
  "repeats": true,
  "event_category": 2,
  "all_day": true,
  "location": "Conference Room",
  "description": "Review meeting for Kevin...",
  "state": "unconfirmed",
  "visible_to": "Everyone",
  "email_invitees": true,
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "invitees": [
    {
      "id": 1,
      "type": "User",
      "name": "Kevin Anderson"
    }
  ]
}

Event

GET
Fetch an existing event
/v1/events/{id}

Retrieve a specific event using it unique identifier. The event returned will include the attributes listed below.

Parameters
id
number, required

The id of the event to be updated

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

title
string, required

The name of the event being returned

starts_at
Datetime, required

A timestamp signifying when the event starts

ends_at
Datetime, required

A timestamp signifying when the event ends

repeats
boolean

A flag to indicate whether or not the event repeats

event_category
number

The id of the event category to which the event belongs

all_day
boolean

A flag to indicate if the event lasts all day

location
string

The description of the location the event takes place

description
string

A short explaination of the event being returned

state
string

The current state of the event

Choices: unconfirmed confirmed tentative completed cancelled

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

email_invitees
boolean

A flag to indicate if the invitees should be emailed their invitation

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

invitees
Array (InviteeResponse)

An object that describes a contact or user who is visiting the site

Hide child attributesShow child attributes
id
number, required

The id of the Contact/User being invited

type
string, required

The type of the resource being invited

Choices: User Contact

name
string

The name of the invitee

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "title": "Client Meeting",
  "starts_at": "2015-05-24 10:00 AM -500",
  "ends_at": "2015-05-24 11:00 AM -500",
  "repeats": true,
  "event_category": 2,
  "all_day": true,
  "location": "Conference Room",
  "description": "Review meeting for Kevin...",
  "state": "unconfirmed",
  "visible_to": "Everyone",
  "email_invitees": true,
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "invitees": [
    {
      "id": 1,
      "type": "User",
      "name": "Kevin Anderson"
    }
  ]
}
PUT
Update an existing event
/v1/events/{id}

Update a existing event with new properties, these properties will be saved to the database and the new event will be returned.

Parameters
id
number, required

The id of the event to be updated

Request Attributes
title
string, required

The name of the event being returned

starts_at
Datetime, required

A timestamp signifying when the event starts

ends_at
Datetime, required

A timestamp signifying when the event ends

repeats
boolean

A flag to indicate whether or not the event repeats

event_category
number

The id of the event category to which the event belongs

all_day
boolean

A flag to indicate if the event lasts all day

location
string

The description of the location the event takes place

description
string

A short explaination of the event being returned

state
string

The current state of the event

Choices: unconfirmed confirmed tentative completed cancelled

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

email_invitees
boolean

A flag to indicate if the invitees should be emailed their invitation

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

invitees
Array (InviteeRequest)

An object that describes a contact or user who is visiting the site

Hide child attributesShow child attributes
id
number, required

The id of the Contact/User being invited

type
string, required

The type of the resource being invited

Choices: User Contact

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

title
string, required

The name of the event being returned

starts_at
Datetime, required

A timestamp signifying when the event starts

ends_at
Datetime, required

A timestamp signifying when the event ends

repeats
boolean

A flag to indicate whether or not the event repeats

event_category
number

The id of the event category to which the event belongs

all_day
boolean

A flag to indicate if the event lasts all day

location
string

The description of the location the event takes place

description
string

A short explaination of the event being returned

state
string

The current state of the event

Choices: unconfirmed confirmed tentative completed cancelled

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

email_invitees
boolean

A flag to indicate if the invitees should be emailed their invitation

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

invitees
Array (InviteeResponse)

An object that describes a contact or user who is visiting the site

Hide child attributesShow child attributes
id
number, required

The id of the Contact/User being invited

type
string, required

The type of the resource being invited

Choices: User Contact

name
string

The name of the invitee

Request
Body
{
  "title": "Client Meeting",
  "starts_at": "2015-05-24 10:00 AM -500",
  "ends_at": "2015-05-24 11:00 AM -500",
  "repeats": true,
  "event_category": 2,
  "all_day": true,
  "location": "Conference Room",
  "description": "Review meeting for Kevin...",
  "state": "unconfirmed",
  "visible_to": "Everyone",
  "email_invitees": true,
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "invitees": [
    {
      "id": 1,
      "type": "User"
    }
  ]
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "title": "Client Meeting",
  "starts_at": "2015-05-24 10:00 AM -500",
  "ends_at": "2015-05-24 11:00 AM -500",
  "repeats": true,
  "event_category": 2,
  "all_day": true,
  "location": "Conference Room",
  "description": "Review meeting for Kevin...",
  "state": "unconfirmed",
  "visible_to": "Everyone",
  "email_invitees": true,
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "invitees": [
    {
      "id": 1,
      "type": "User",
      "name": "Kevin Anderson"
    }
  ]
}
DELETE
Delete event
/v1/events/{id}

Delete an existing event from your account. This event will not be available to you going forward in the future.

Parameters
id
number, required

The id of the event to be updated

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

title
string, required

The name of the event being returned

starts_at
Datetime, required

A timestamp signifying when the event starts

ends_at
Datetime, required

A timestamp signifying when the event ends

repeats
boolean

A flag to indicate whether or not the event repeats

event_category
number

The id of the event category to which the event belongs

all_day
boolean

A flag to indicate if the event lasts all day

location
string

The description of the location the event takes place

description
string

A short explaination of the event being returned

state
string

The current state of the event

Choices: unconfirmed confirmed tentative completed cancelled

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

email_invitees
boolean

A flag to indicate if the invitees should be emailed their invitation

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

invitees
Array (InviteeResponse)

An object that describes a contact or user who is visiting the site

Hide child attributesShow child attributes
id
number, required

The id of the Contact/User being invited

type
string, required

The type of the resource being invited

Choices: User Contact

name
string

The name of the invitee

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "title": "Client Meeting",
  "starts_at": "2015-05-24 10:00 AM -500",
  "ends_at": "2015-05-24 11:00 AM -500",
  "repeats": true,
  "event_category": 2,
  "all_day": true,
  "location": "Conference Room",
  "description": "Review meeting for Kevin...",
  "state": "unconfirmed",
  "visible_to": "Everyone",
  "email_invitees": true,
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "invitees": [
    {
      "id": 1,
      "type": "User",
      "name": "Kevin Anderson"
    }
  ]
}

Collection

GET
Retrieve all opportunities
/v1/opportunities{?resource_id}{?resource_type}

This endpoint will fetch all of the opportunities that are accessible by the user. This way the user can not access any opportunities they don’t have access to.

Parameters
resource_id
number

The id of the resource being searched for

resource_type
string

The type of resource being searched for

Response Attributes
opportunities
Array (Opportunity)
Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the Opportunity being returned

description
string

A short explaination of the opportunity being returned

target_close
Datetime, required

A string representing the date/time when the opportunity should close

probability
number, required

A number representing the chance the opportunity will close, as a percentage

stage
number, required

A string representing the current stage the opportunity finds itself in

manager
number

The name of the person who is designated as manager of this opportunity

amounts
Array (Amount)

An array of the amounts associated with the opportunity

Hide child attributesShow child attributes
amount
number

The amount in dollars

currency
string
Default: $

The type of currency the amount was recorded in

kind
string

The type of amount represented here

Choices: Fee Commission AMU Other

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

linked_to
Array (Document)

An array containing the Contact that is linked to this Opportunity. Only the first contact specified will be used.

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Response  200
Body
{
  "opportunities": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "name": "Financial Plan",
      "description": "Opportunity to plan for...",
      "target_close": "2015-11-12 11:00 AM -500",
      "probability": 70,
      "stage": 1,
      "manager": 1,
      "amounts": [
        {
          "amount": 56.76,
          "currency": "$",
          "kind": "Fee"
        }
      ],
      "custom_fields": [
        {
          "id": 1,
          "name": "My Field",
          "value": "123456789"
        }
      ],
      "linked_to": [
        {
          "id": 1,
          "type": "Contact",
          "name": "Kevin Anderson"
        }
      ],
      "visible_to": "Everyone"
    }
  ]
}
POST
Create a new opportunity
/v1/opportunities

Create a new Opportunity.

Request Attributes
name
string, required

The name of the Opportunity being returned

description
string

A short explaination of the opportunity being returned

target_close
Datetime, required

A string representing the date/time when the opportunity should close

probability
number, required

A number representing the chance the opportunity will close, as a percentage

stage
number, required

A string representing the current stage the opportunity finds itself in

manager
number

The name of the person who is designated as manager of this opportunity

amounts
Array (Amount)

An array of the amounts associated with the opportunity

Hide child attributesShow child attributes
amount
number

The amount in dollars

currency
string
Default: $

The type of currency the amount was recorded in

kind
string

The type of amount represented here

Choices: Fee Commission AMU Other

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

linked_to
Array (Document)

An array containing the Contact that is linked to this Opportunity. Only the first contact specified will be used.

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the Opportunity being returned

description
string

A short explaination of the opportunity being returned

target_close
Datetime, required

A string representing the date/time when the opportunity should close

probability
number, required

A number representing the chance the opportunity will close, as a percentage

stage
number, required

A string representing the current stage the opportunity finds itself in

manager
number

The name of the person who is designated as manager of this opportunity

amounts
Array (Amount)

An array of the amounts associated with the opportunity

Hide child attributesShow child attributes
amount
number

The amount in dollars

currency
string
Default: $

The type of currency the amount was recorded in

kind
string

The type of amount represented here

Choices: Fee Commission AMU Other

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

linked_to
Array (Document)

An array containing the Contact that is linked to this Opportunity. Only the first contact specified will be used.

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Request
Body
{
  "name": "Financial Plan",
  "description": "Opportunity to plan for...",
  "target_close": "2015-11-12 11:00 AM -500",
  "probability": 70,
  "stage": 1,
  "manager": 1,
  "amounts": [
    {
      "amount": 56.76,
      "currency": "$",
      "kind": "Fee"
    }
  ],
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ],
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "visible_to": "Everyone"
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "name": "Financial Plan",
  "description": "Opportunity to plan for...",
  "target_close": "2015-11-12 11:00 AM -500",
  "probability": 70,
  "stage": 1,
  "manager": 1,
  "amounts": [
    {
      "amount": 56.76,
      "currency": "$",
      "kind": "Fee"
    }
  ],
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ],
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "visible_to": "Everyone"
}

Opportunity

GET
Fetch an existing opportunity
/v1/opportunities/{id}

Retrieve a specific opportunity using it unique identifier. The opportunity returned will include the attributes listed below.

Parameters
id
number, required

The id of the Opportunity to be updated

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the Opportunity being returned

description
string

A short explaination of the opportunity being returned

target_close
Datetime, required

A string representing the date/time when the opportunity should close

probability
number, required

A number representing the chance the opportunity will close, as a percentage

stage
number, required

A string representing the current stage the opportunity finds itself in

manager
number

The name of the person who is designated as manager of this opportunity

amounts
Array (Amount)

An array of the amounts associated with the opportunity

Hide child attributesShow child attributes
amount
number

The amount in dollars

currency
string
Default: $

The type of currency the amount was recorded in

kind
string

The type of amount represented here

Choices: Fee Commission AMU Other

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

linked_to
Array (Document)

An array containing the Contact that is linked to this Opportunity. Only the first contact specified will be used.

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "name": "Financial Plan",
  "description": "Opportunity to plan for...",
  "target_close": "2015-11-12 11:00 AM -500",
  "probability": 70,
  "stage": 1,
  "manager": 1,
  "amounts": [
    {
      "amount": 56.76,
      "currency": "$",
      "kind": "Fee"
    }
  ],
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ],
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "visible_to": "Everyone"
}
PUT
Update an existing opportunity
/v1/opportunities/{id}

Update a existing opportunity with new properties, these properties will be saved to the database and the new opportunity will be returned.

Parameters
id
number, required

The id of the Opportunity to be updated

Request Attributes
name
string, required

The name of the Opportunity being returned

description
string

A short explaination of the opportunity being returned

target_close
Datetime, required

A string representing the date/time when the opportunity should close

probability
number, required

A number representing the chance the opportunity will close, as a percentage

stage
number, required

A string representing the current stage the opportunity finds itself in

manager
number

The name of the person who is designated as manager of this opportunity

amounts
Array (Amount)

An array of the amounts associated with the opportunity

Hide child attributesShow child attributes
amount
number

The amount in dollars

currency
string
Default: $

The type of currency the amount was recorded in

kind
string

The type of amount represented here

Choices: Fee Commission AMU Other

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

linked_to
Array (Document)

An array containing the Contact that is linked to this Opportunity. Only the first contact specified will be used.

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the Opportunity being returned

description
string

A short explaination of the opportunity being returned

target_close
Datetime, required

A string representing the date/time when the opportunity should close

probability
number, required

A number representing the chance the opportunity will close, as a percentage

stage
number, required

A string representing the current stage the opportunity finds itself in

manager
number

The name of the person who is designated as manager of this opportunity

amounts
Array (Amount)

An array of the amounts associated with the opportunity

Hide child attributesShow child attributes
amount
number

The amount in dollars

currency
string
Default: $

The type of currency the amount was recorded in

kind
string

The type of amount represented here

Choices: Fee Commission AMU Other

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

linked_to
Array (Document)

An array containing the Contact that is linked to this Opportunity. Only the first contact specified will be used.

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Request
Body
{
  "name": "Financial Plan",
  "description": "Opportunity to plan for...",
  "target_close": "2015-11-12 11:00 AM -500",
  "probability": 70,
  "stage": 1,
  "manager": 1,
  "amounts": [
    {
      "amount": 56.76,
      "currency": "$",
      "kind": "Fee"
    }
  ],
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ],
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "visible_to": "Everyone"
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "name": "Financial Plan",
  "description": "Opportunity to plan for...",
  "target_close": "2015-11-12 11:00 AM -500",
  "probability": 70,
  "stage": 1,
  "manager": 1,
  "amounts": [
    {
      "amount": 56.76,
      "currency": "$",
      "kind": "Fee"
    }
  ],
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ],
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "visible_to": "Everyone"
}
DELETE
Delete opportunity
/v1/opportunities/{id}

Delete an existing opportunity from your account. This opportunity will not be available to you going forward in the future.

Parameters
id
number, required

The id of the Opportunity to be updated

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the Opportunity being returned

description
string

A short explaination of the opportunity being returned

target_close
Datetime, required

A string representing the date/time when the opportunity should close

probability
number, required

A number representing the chance the opportunity will close, as a percentage

stage
number, required

A string representing the current stage the opportunity finds itself in

manager
number

The name of the person who is designated as manager of this opportunity

amounts
Array (Amount)

An array of the amounts associated with the opportunity

Hide child attributesShow child attributes
amount
number

The amount in dollars

currency
string
Default: $

The type of currency the amount was recorded in

kind
string

The type of amount represented here

Choices: Fee Commission AMU Other

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

linked_to
Array (Document)

An array containing the Contact that is linked to this Opportunity. Only the first contact specified will be used.

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "name": "Financial Plan",
  "description": "Opportunity to plan for...",
  "target_close": "2015-11-12 11:00 AM -500",
  "probability": 70,
  "stage": 1,
  "manager": 1,
  "amounts": [
    {
      "amount": 56.76,
      "currency": "$",
      "kind": "Fee"
    }
  ],
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ],
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "visible_to": "Everyone"
}

Collection

GET
Retrieve all projects
/v1/projects

This endpoint will fetch all of the projects that are accessible by the user. This way the user can not access any projects they don’t have access to.

Response Attributes
projects
Array (Project)
Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the project being returned

description
string, required

A short explaination of the project being returned

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

organizer
number

The id of the user who is responsible for organizating the project

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

image
string

A url pointing to the headshot associated with this project

Response  200
Body
{
  "projects": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "name": "Client Seminar",
      "description": "Project to plan spring seminar.",
      "custom_fields": [
        {
          "id": 1,
          "name": "My Field",
          "value": "123456789"
        }
      ],
      "organizer": 1,
      "visible_to": "Everyone",
      "image": "https://app.crmworkspace.com/projects.png"
    }
  ]
}
POST
Create a new project
/v1/projects

Create a new Project.

Request Attributes
name
string, required

The name of the project being returned

description
string, required

A short explaination of the project being returned

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

organizer
number

The id of the user who is responsible for organizating the project

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the project being returned

description
string, required

A short explaination of the project being returned

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

organizer
number

The id of the user who is responsible for organizating the project

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

image
string

A url pointing to the headshot associated with this project

Request
Body
{
  "name": "Client Seminar",
  "description": "Project to plan spring seminar.",
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ],
  "organizer": 1,
  "visible_to": "Everyone"
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "name": "Client Seminar",
  "description": "Project to plan spring seminar.",
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ],
  "organizer": 1,
  "visible_to": "Everyone",
  "image": "https://app.crmworkspace.com/projects.png"
}

Project Resource

GET
Fetch an existing project
/v1/projects/{id}

Retrieve a specific project using it unique identifier. The project returned will include the attributes listed below.

Parameters
id
number, required

The id of the Project to be updated

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the project being returned

description
string, required

A short explaination of the project being returned

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

organizer
number

The id of the user who is responsible for organizating the project

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

image
string

A url pointing to the headshot associated with this project

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "name": "Client Seminar",
  "description": "Project to plan spring seminar.",
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ],
  "organizer": 1,
  "visible_to": "Everyone",
  "image": "https://app.crmworkspace.com/projects.png"
}
PUT
Update an existing project
/v1/projects/{id}

Update a existing project with new properties, these properties will be saved to the database and the new project will be returned.

Parameters
id
number, required

The id of the Project to be updated

Request Attributes
name
string, required

The name of the project being returned

description
string, required

A short explaination of the project being returned

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

organizer
number

The id of the user who is responsible for organizating the project

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the project being returned

description
string, required

A short explaination of the project being returned

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

organizer
number

The id of the user who is responsible for organizating the project

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

image
string

A url pointing to the headshot associated with this project

Request
Body
{
  "name": "Client Seminar",
  "description": "Project to plan spring seminar.",
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ],
  "organizer": 1,
  "visible_to": "Everyone"
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "name": "Client Seminar",
  "description": "Project to plan spring seminar.",
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ],
  "organizer": 1,
  "visible_to": "Everyone",
  "image": "https://app.crmworkspace.com/projects.png"
}
DELETE
Delete project
/v1/projects/{id}

Delete an existing project from your account. This project will not be available to you going forward in the future.

Parameters
id
number, required

The id of the Project to be updated

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

name
string, required

The name of the project being returned

description
string, required

A short explaination of the project being returned

custom_fields
Array (CustomField)

An array of the custom fields that are to be set on this object

Hide child attributesShow child attributes
id
number

The name of the custom field that you wish to set

name
string

The name of the custom field being returned

value
string

The value that the custom field should take on

organizer
number

The id of the user who is responsible for organizating the project

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

image
string

A url pointing to the headshot associated with this project

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "name": "Client Seminar",
  "description": "Project to plan spring seminar.",
  "custom_fields": [
    {
      "id": 1,
      "name": "My Field",
      "value": "123456789"
    }
  ],
  "organizer": 1,
  "visible_to": "Everyone",
  "image": "https://app.crmworkspace.com/projects.png"
}

Collection

GET
Retrieve all notes
/v1/notes{?resource_id}{?resource_type}

This endpoint will fetch all of the notes that are accessible by the user. This way the user can not access any notes they don’t have access to.

Parameters
resource_id
number

The id of the resource being searched for

resource_type
string

The type of resource being searched for

Response Attributes
notes
Array (StatusUpdate)
Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

content
string, required

The main body of the new StatusUpdate

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

tags
Array (Tag)

An array of tags that are associated with the StatusUpdate

Hide child attributesShow child attributes
id
number

The id of the object being returned

name
string

The name of the tag in question

Response  200
Body
{
  "notes": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "content": "Spoke with Kevin Anderson on the phone...",
      "linked_to": [
        {
          "id": 1,
          "type": "Contact",
          "name": "Kevin Anderson"
        }
      ],
      "visible_to": "Everyone",
      "tags": [
        {
          "id": 1,
          "name": "Clients"
        }
      ]
    }
  ]
}
POST
Create a new note
/v1/notes

Create a new Note.

Request Attributes
content
string, required

The main body of the new StatusUpdate

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

tags
Array (string)

An array of tags that are associated with the StatusUpdate

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

content
string, required

The main body of the new StatusUpdate

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

tags
Array (Tag)

An array of tags that are associated with the StatusUpdate

Hide child attributesShow child attributes
id
number

The id of the object being returned

name
string

The name of the tag in question

Request
Body
{
  "content": "Spoke with Kevin Anderson on the phone...",
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "visible_to": "Everyone",
  "tags": [
    "Clients"
  ]
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "content": "Spoke with Kevin Anderson on the phone...",
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "visible_to": "Everyone",
  "tags": [
    {
      "id": 1,
      "name": "Clients"
    }
  ]
}

Note

GET
Fetch an existing note
/v1/notes/{id}

Retrieve a specific note using it unique identifier. The note returned will include the attributes listed below.

Parameters
id
number, required

The id of the Note to be updated

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

content
string, required

The main body of the new StatusUpdate

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

tags
Array (Tag)

An array of tags that are associated with the StatusUpdate

Hide child attributesShow child attributes
id
number

The id of the object being returned

name
string

The name of the tag in question

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "content": "Spoke with Kevin Anderson on the phone...",
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "visible_to": "Everyone",
  "tags": [
    {
      "id": 1,
      "name": "Clients"
    }
  ]
}
PUT
Update an existing note
/v1/notes/{id}

Update a existing note with new properties, these properties will be saved to the database and the new note will be returned.

Parameters
id
number, required

The id of the Note to be updated

Request Attributes
content
string, required

The main body of the new StatusUpdate

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

tags
Array (string)

An array of tags that are associated with the StatusUpdate

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

content
string, required

The main body of the new StatusUpdate

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

tags
Array (Tag)

An array of tags that are associated with the StatusUpdate

Hide child attributesShow child attributes
id
number

The id of the object being returned

name
string

The name of the tag in question

Request
Body
{
  "content": "Spoke with Kevin Anderson on the phone...",
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "visible_to": "Everyone",
  "tags": [
    "Clients"
  ]
}
Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "content": "Spoke with Kevin Anderson on the phone...",
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "visible_to": "Everyone",
  "tags": [
    {
      "id": 1,
      "name": "Clients"
    }
  ]
}
DELETE
Delete note
/v1/notes/{id}

Delete an existing note from your account. This note will not be available to you going forward in the future.

Parameters
id
number, required

The id of the Note to be updated

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

content
string, required

The main body of the new StatusUpdate

linked_to
Array (Document)

An array of object that are linked to this StatusUpdate

Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

visible_to
string
Default: Everyone

The user group which is able to view the resource being created

tags
Array (Tag)

An array of tags that are associated with the StatusUpdate

Hide child attributesShow child attributes
id
number

The id of the object being returned

name
string

The name of the tag in question

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "content": "Spoke with Kevin Anderson on the phone...",
  "linked_to": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ],
  "visible_to": "Everyone",
  "tags": [
    {
      "id": 1,
      "name": "Clients"
    }
  ]
}

Retrieve all reports

GET
Retrieve all reports
/v1/reports

This endpoint will fetch all of the reports that are accessible by the user. This way the user can not access any reports they don’t have access to.

Response Attributes
reports
Array (Report)
Hide child attributesShow child attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

subject
string

The general type of artifact being queried by the report

Choices: Contact Note Task Workflow WorkflowStep Opportunity Project File Event

title
string

A short description of the report for reference

fields
Array (string)

The list of fields to be displayed for each result

results
Array (undefined)

The results of the report, returned as an array of objects, each of which has a key for every field to be displayed in the report

Response  200
Body
{
  "reports": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "subject": "Contact",
      "title": "Most active clients report",
      "fields": [
        "first_name, last_name"
      ],
      "results": []
    }
  ]
}

Report

GET
Fetch an existing report
/v1/reports/{id}

Retrieve a specific report using it unique identifier. The report returned will include the attributes listed below.

Parameters
id
number, required

The id of the report being requested

Response Attributes
id
number

The id of the object being returned

creator
number

The id of the user who created the object

created_at
Datetime

A timestamp representing when the object was created.

updated_at
Datetime

A timestamp representing when the object was last updated.

subject
string

The general type of artifact being queried by the report

Choices: Contact Note Task Workflow WorkflowStep Opportunity Project File Event

title
string

A short description of the report for reference

fields
Array (string)

The list of fields to be displayed for each result

results
Array (undefined)

The results of the report, returned as an array of objects, each of which has a key for every field to be displayed in the report

Response  200
Body
{
  "id": 1,
  "creator": 1,
  "created_at": "2015-05-24 10:00 AM -500",
  "updated_at": "2015-10-12 11:30 PM -500",
  "subject": "Contact",
  "title": "Most active clients report",
  "fields": [
    "first_name, last_name"
  ],
  "results": []
}

List all members of a customizable category

GET
List all members of a customizable category
/v1/categories/{type}

This endpoint will fetch every instance of the specified category name which are owned by the account of the user authenticated with the API.

Parameters
type
string, required

The name of the category type that you are trying to fetch

Choices: tagscustom_fieldsopportunity_stagescontact_typescontact_sourcestask_categoriesevent_categoriesfile_categoriesinvestment_objectivesfinancial_account_typesemail_typesphone_typesaddress_typeswebsite_types

Response Attributes
tags
Array (Document)
Hide child attributesShow child attributes
id
number, required

The id of the resource being linked to this status update

type
string, required

The type of resource being linked to this status update

name
string

The name of the resource being linked

Response  200
Body
{
  "tags": [
    {
      "id": 1,
      "type": "Contact",
      "name": "Kevin Anderson"
    }
  ]
}

Retrieve all comments

GET
Retrieve all comments
/v1/comments{?resource_id}{?resource_type}

This endpoint will fetch all of the comments that are accessible by the user for the specified resource.

Parameters
resource_id
number

The id of the resource being searched for. Ignored if no resource_type provided

resource_type
string

The type of resource being searched for

Response  200
Body
{
  "comments": [
    {
      "id": 1,
      "creator": 1,
      "created_at": "2015-05-24 10:00 AM -500",
      "updated_at": "2015-10-12 11:30 PM -500",
      "body": {
        "text": "This is the body of the comment",
        "html": "<div class='comment'>This is the body of the comment</div>"
      },
      "resource_type": "Task",
      "resource_id": {}
    }
  ]
}

Create

POST
Add member to a household
/v1/households/{household_id}/members

This endpoint will add a member to the household.

Parameters
household_id
number, required

The id of the household receiving the new member

Request Attributes
id
number, required

The id of the contact to add to household

title
string, required

The household title you wish to assign to the added contact

Choices: Head Spouse Partner Child Grandchild Parent Grandparent Sibling Other Dependent

Response Attributes
id
number

The id of the household

members
Array (string)
Hide child attributesShow child attributes
id
number

The id of the household member

first_name
string

The full name of the household member

last_name
string

The full name of the household member

title
string

The title of the household member

type
string

The type of the household member

Request
Body
{
  "id": 2,
  "title": "Head"
}
Response  200
Body
{
  "id": 1,
  "members": [
    {
      "id": 2,
      "first_name": "Kevin",
      "last_name": "Anderson",
      "title": "Head",
      "type": "Person"
    }
  ]
}

Destroy

DELETE
Delete member from a household
/v1/households/{household_id}/members/{id}

This endpoint will remove a member from a household.

Parameters
household_id
number, required

The id of the household from which the member will be deleted

id
number, required

The id of the contact to delete from the household

Response Attributes
id
number

The id of the household

members
Array (string)
Hide child attributesShow child attributes
id
number

The id of the household member

first_name
string

The full name of the household member

last_name
string

The full name of the household member

title
string

The title of the household member

type
string

The type of the household member

Response  200
Body
{
  "id": 1,
  "members": [
    {
      "id": 2,
      "first_name": "Kevin",
      "last_name": "Anderson",
      "title": "Head",
      "type": "Person"
    }
  ]
}

Retrieve all UserGroups

GET
Retrieve all UserGroups
/v1/user_groups

This endpoint will return all of the UserGroups associated with the account of the user interacting with the API access token.

Response Attributes
user_groups
Array (UserGroup)
Hide child attributesShow child attributes
id
number, required

The id of the object being returned

name
string, required

The main body of the StreamItem returned as HTML

user
number,null

The ID of the user this UserGroup is associated with. This field should only be populated for ‘Only Me’ UserGroups

Response  200
Body
{
  "user_groups": [
    {
      "id": 1,
      "name": "Everyone",
      "user": 1
    }
  ]
}