Introduction

  • SCHEMAS

  • Contacts

    Deals

    Activities

    Lists

    Users

    Companies

    Forms

Introduction

A single schema to push and pull CRM data across connectors.


Supported Connectors

Live

Freshsales Classic

HubSpot

Microsoft Dynamics 365

Pipedrive

Salesforce

Zoho

Beta

logo for Agile CRM

Agile CRM

logo for Copper

Copper

logo for Outreach

Outreach

Activities

Activities include events and tasks.

Properties



id

string


note

string


type

string


title

string


active

boolean


status

string


deal_id

string


location

string


owner_id

string


company_id

string


contact_id

string


created_at

string


owner_name

string


string


updated_at

string


description

string


owner_email

string


call_details

object


from_number

string


meeting_url

string


recording_url

string


to_number

string


end_datetime

string


custom_fields

object [ ]


label

string


name

string


type

string


value

any


email_details

object


bcc

string [ ]


cc

string [ ]


from_email

string


to_emails

string [ ]


recording_url

string


start_datetime

string


duration_seconds

integer


location_address

object


city

string


country

string


id

string


line1

string


line2

string


line3

string


postal_code

string


state

string


activity_datetime

string

Example

COPY TO CLIPBOARD
{
  "id": "12345",
  "note": "An internal note about the meeting",
  "type": "meeting",
  "title": "Meeting",
  "active": true,
  "deal_id": "12345",
  "location": "Space",
  "owner_id": "12345",
  "attendees": [
    {
      "id": "12345",
      "type": "contact"
    }
  ],
  "company_id": "12345",
  "contact_id": "12345",
  "created_at": "2020-09-30T07:43:32.000Z",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "description": "More info about the meeting",
  "end_datetime": "2021-05-01T12:30:00.000Z",
  "custom_fields": [
    {
      "name": "requested_info",
      "value": "Asked about Salesforce integration"
    }
  ],
  "start_datetime": "2021-05-01T12:00:00.000Z",
  "duration_seconds": 1800,
  "location_address": {
    "id": "123",
    "city": "San Francisco",
    "line1": "Main street",
    "line2": "apt #",
    "line3": "Suite #",
    "state": "CA",
    "country": "US",
    "postal_code": "94104",
    "street_number": "25"
  },
  "activity_datetime": "2021-05-01T12:00:00.000Z"
}

Companies

The object used for any organization saved in your CRM.

Properties



id

string


name

string


type

string


image

string


active

boolean


source

string


status

string


website

string


campaign

string


industry

string


owner_id

string


addresses

object [ ]


city

string


country

string


id

string


line1

string


line2

string


line3

string


postal_code

string


state

string


created_at

string


owner_name

string


updated_at

string


description

string


owner_email

string


string [ ]


at_competitor

boolean


custom_fields

object [ ]


label

string


name

string


type

string


value

any


date_acquired

string


phone_numbers

object [ ]


number

string


type

string

Example

COPY TO CLIPBOARD
{
  "id": "12345",
  "name": "SpaceX",
  "image": "https://www.spacex.com/static/images/share.jpg",
  "active": true,
  "status": "Open",
  "website": "http://example.com",
  "industry": "Apparel",
  "owner_id": "12345",
  "addresses": [
    {
      "id": "123",
      "city": "San Francisco",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "state": "CA",
      "country": "US",
      "postal_code": "94104"
    }
  ],
  "created_at": "2020-09-30T07:43:32.000Z",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.",
  "custom_fields": [
    {
      "name": "hq_country",
      "value": "USA"
    }
  ],
  "phone_numbers": [
    {
      "type": "primary",
      "number": "111-111-1111"
    }
  ]
}

Contacts

Represents a contact, which is a person associated with an account.

Properties



id

string


name

string


type

string


email

string


lists

string [ ]


title

string


active

boolean


rating

string


status

string


website

string


industry

string


owner_id

string


addresses

object [ ]


city

string


country

string


id

string


line1

string


line2

string


line3

string


postal_code

string


state

string


birthdate

string


campaigns

object [ ]


active

boolean


custom_fields

array [ ]


end_date

string


id

string


name

string


start_date

string


status

string


type

string


last_name

string


photo_url

string


company_id

string


created_at

string


department

string


first_name

string


owner_name

string


salutation

string


updated_at

string


description

string


external_id

object


name

string


value

string


lead_source

string


middle_name

string


owner_email

string


company_name

string


unsubscribed

boolean


custom_fields

object [ ]


label

string


name

string


type

string


value

any


phone_numbers

object [ ]


number

string


type

string


annual_revenue

number


additional_emails

string [ ]


number_of_employees

integer

Example

COPY TO CLIPBOARD
{
  "id": "12345",
  "name": "Elon Musk",
  "type": "contact",
  "email": "elon@musk.com",
  "lists": [
    "1234",
    "5678"
  ],
  "title": "CEO",
  "active": true,
  "status": "open",
  "owner_id": "54321",
  "addresses": [
    {
      "id": "123",
      "city": "San Francisco",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "state": "CA",
      "country": "US",
      "postal_code": "94104"
    }
  ],
  "last_name": "Musk",
  "photo_url": "https://unavatar.io/elon-musk",
  "company_id": "23456",
  "created_at": "2017-08-12T20:43:21.291Z",
  "department": "Engineering",
  "first_name": "Elon",
  "updated_at": "2017-08-12T20:43:21.291Z",
  "description": "Internal champion",
  "lead_source": "Cold Call",
  "middle_name": "D.",
  "company_name": "23456",
  "custom_fields": [
    {
      "name": "assistant",
      "value": "Mark Cuban"
    }
  ],
  "phone_numbers": [
    {
      "type": "primary",
      "number": "111-111-1111"
    }
  ]
}

Deals

The object used to store information about ongoing transactions throughout the stages of your sales process.

Properties



id

string


type

string

Type of the deal. Defined by the user of CRM.


lists

string [ ]

Array of list ids this deal is part of.


title

string

Title of the deal


active

boolean


status

string


currency

string


owner_id

string


pipeline

string

Name of the pipeline this deal is in


priority

string


source_id

string


status_id

string

Deal status id in the pipeline.


close_date

string


company_id

string

The id of the company this deal is for


contact_id

string


created_at

string


owner_name

string


updated_at

string


won_reason

string


description

string

Description of this deal


external_id

object


name

string


value

string


lead_source

string


loss_reason

string


owner_email

string


pipeline_id

string

The id of the pipeline this deal is in


company_name

string

The name of the company this deal is for


contact_email

string


custom_fields

object [ ]


label

string


name

string


type

string


value

any


won_reason_id

string


loss_reason_id

string


monetary_amount

number


win_probability

number


expected_revenue

number


pipeline_stage_id

string


contact_external_id

object


name

string


value

string


expected_close_date

string

Example

COPY TO CLIPBOARD
{
  "id": "12345",
  "type": "Existing Customer - Upgrade",
  "title": "New Rocket",
  "active": true,
  "status": "Open",
  "currency": "USD",
  "owner_id": "12345",
  "priority": "None",
  "source_id": "12345",
  "status_id": "12345",
  "close_date": "2020-10-30",
  "company_id": "12345",
  "contact_id": "12345",
  "created_at": "2020-09-30T07:43:32.000Z",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "won_reason": "Best pitch",
  "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
  "lead_source": "Website",
  "loss_reason": "No budget",
  "pipeline_id": "12345",
  "company_name": "Copper",
  "custom_fields": [
    {
      "name": "sales_rep",
      "value": "Tim Cook"
    }
  ],
  "won_reason_id": "12345",
  "loss_reason_id": "12345",
  "monetary_amount": 75000,
  "win_probability": 40,
  "expected_revenue": 75000,
  "pipeline_stage_id": "12345"
}

Forms

Forms are used to gather important information about your visitors and contacts.

Properties



id

string


name

string


active

boolean


created_at

string


updated_at

string

Example

COPY TO CLIPBOARD
{
  "id": "e950d342-8fb8-46df-8ebd-9fffa20ea4af",
  "name": "See It In Action Sign Up Form",
  "active": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Lists

Filtered lists of CRM objects

Properties



id

string

Id of the list


name

string

Name of the list


size

integer

Size of the list


type

string

Deal, Company, or Contact


active

boolean


created_at

string


updated_at

string

Example

COPY TO CLIPBOARD
{
  "id": "abc-def-ghi",
  "name": "Recently Viewed Contacts",
  "size": 150,
  "type": "Contact"
}

Users

Users of the CRM

Properties



id

string


email

string


phone

string


active

boolean


last_name

string


created_at

string


first_name

string


updated_at

string

Example

COPY TO CLIPBOARD
{
  "id": "4561207",
  "email": "tom@cruise.com",
  "phone": "301-555-5555",
  "active": true,
  "last_name": "Cruise",
  "created_at": "2019-08-24T14:15:22Z",
  "first_name": "Tom",
  "updated_at": "2019-08-24T14:15:22Z"
}