Close.io integration summary

Stitch’s Close.io integration replicates data using the Close.io REST API . Refer to the Schema section for a list of objects available for replication.

Close.io feature snapshot

A high-level look at Stitch's Close.io (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status

Released on September 17, 2018

 Supported by

Stitch
Stitch plan

Standard

 API availability

Available
Singer GitHub repository

singer-io/tap-closeio
REPLICATION SETTINGS
Anchor Scheduling

Supported

 Advanced Scheduling

Supported
Table-level reset

Unsupported

 Configurable Replication Methods

Unsupported
DATA SELECTION
Table selection

Unsupported

 Column selection

Unsupported
Select all

Unsupported
TRANSPARENCY
Extraction Logs

Supported

 Loading Reports

Supported

Connecting Close.io

Step 1: Generate a Close.io API Key

  1. Sign into your Close.io account.
  2. Click the user menu (your icon) in the top right corner.
  3. Click Settings.
  4. In the Company menu (located under the You menu), click Your API Keys.
  5. In the Your API Keys section, click the Generate New API Key button.
  6. A new API Key will display. Keep this handy; you’ll need it in the next step.

Step 2: Add Close.io as a Stitch data source

  1. Sign into your Stitch account.

  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the Close.io icon.

  4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

    For example, the name “Stitch Close.io” would create a schema called stitch_closeio in the destination. Note: Schema names cannot be changed after you save the integration.

  5. In the API Key field, paste your Close.io API Key.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Close.io integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Close.io’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Close.io integrations support the following replication scheduling methods:

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Initial and historical replication jobs

After you finish setting up Close.io, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Close.io replication

Replicating activity data

Every time Stitch runs a replication job for Close.io, the last 24 hours’ worth of data will be replicated for the activities table.

As Close.io doesn’t currently provide a way to query for activities based on modification time, Stitch replicates data in this way to ensure updated activities are captured. A list of available querying methods can be found in Close.io’s documentation.

Setting the Replication Frequency to a higher frequency - like 30 minutes - can result in re-replicating recent data and contribute to greater row usage. Selecting a lower frequency can help keep your row count low.

Refer to the documentation for each of these tables in the next section for more info.

Attribution window examples

In the tabs below are examples of attribution windows behave during historical (initial) and ongoing replication jobs.

For historical and full re-replications of Close.io data, Stitch will query for and extract data newer than or equal to the date defined in the Start Date field in the Integration Settings page.

The Start Date, in conjunction with the Attribution Window, defines the minimum date Stitch should query for when extracting historical data. This is calculated as:

Start Date - Attribution Window = Minimum Extraction Date

Example

During the initial set up, the Start Date field is set to 07/03/2017, or ``.

To account for the Attribution Window, Stitch would calculate the Minimum Extraction Date value as: 2017-07-03 00:00:00 - 24 hours = 2017-07-02 00:00:00

If you were to write a SQL query using this date for the activities table, it might look like this:

  SELECT *
    FROM closeio.activities
   WHERE date_created >= '2017-07-02 00:00:00'   /* Min. Extraction Date */
ORDER BY date_created

For ongoing replication jobs, Stitch will query for and extract data using the last saved maximum value in the table’s Replication Key column and the Attribution Window for the table.

Note: This applies to every replication job that takes place after the historical replication job.

Example

The last maximum saved Replication Key value for the activities table is 2017-10-01 00:00:00.

To account for the Attribution Window of 24 hours, we’d subtract this from the last maximum saved Replication Key value:

2017-10-01 00:00:00 - 24 hours = 2017-09-30 00:00:00

In this case, Stitch would query for and extract data that is newer than or equal to 2017-09-30 00:00:00 and older than or equal to 2017-10-01 00:00:00.

If this were a SQL query, it might look like this:

  SELECT *
    FROM activities
   WHERE date_created >= '2017-09-30 00:00:00'
                              /* max Replication Key value - Attribution Window */
     AND date_created <= '2017-10-01 00:00:00'
                              /* max Replication Key value from previous job */
ORDER BY date_created

Historical event log data limitations

Due to how Close.io’s API functions, only 30 days of historical data is available for event logs:

Most actions in Close.io that change an object are logged in the event log. For example, creating a lead, sending an email, or deleting a note will create an event log entry. The event log API allows you to access these events, up to 30 days back in history.

This means that despite what the integration’s Start Date is set to, Stitch will only be able to retrieve 30 days of historical data from the connection date for the event_log table.

Additionally, note that if you ever reset the integration, this will also apply to the date the integration is reset.

Close.io table reference

activities

View table schema on GitHub
API endpoint :

List or filter all activity types

The activities table contains info about various activities in your Close.io account.

An activity belongs to a lead and can represent any type of activity that was performed on a lead or its contact. This includes calls, emails, notes, and so on.

Attribution window

When Stitch replicates data for this table, it will use an attribution window of 24 hours to fetch updated activities.

This means that every time a replication job runs, the last 24 hours’ worth of data will be replicated for this table. This is because Close.io doesn’t provide a way to query for activites based on a modification time, only when activities are created. A list of available querying methods can be found in Close.io’s documentation.

Refer to the Replication section for more info and examples of how the attribution window is used to query for data.

activities table schema

id
STRING

The activity ID.

date_created
STRING

The date the activity was created.

_type
STRING

The activity type. Possible values:

  • Call
  • Created
  • Email
  • EmailThread
  • LeadStatusChange
  • OpportunityStatusChange
  • TaskCompleted
  • SMS

attachments
ARRAY

A list of attachments associated with the activity.

Click to expand attachments

content_id
STRING

The attachment’s content ID.

content_type
STRING

The attachment’s content type.

filename
STRING

The file name of the attachment.

size
INTEGER

The size of the attachment.

url
STRING

The full URL of the attachment.
activities (table), attachments (attribute)

bcc
ARRAY

For Email activities, a list of those BCC’d on the email.

Click to expand bcc

value
STRING

The bcc on the email.
activities (table), bcc (attribute)

body_html
STRING

For Email activities, the body content of the email in HTML format.

body_html_quoted
ARRAY

Click to expand body_html_quoted

expand
BOOLEAN, INTEGER

html
STRING

activities (table), body_html_quoted (attribute)

body_preview
STRING

A preview of the body content.

body_text
STRING

For Email activities, the plain text version of the email body.

body_text_quoted
ARRAY

Click to expand body_text_quoted

expand
BOOLEAN, INTEGER

text
STRING

activities (table), body_text_quoted (attribute)

cc
ARRAY

For Email activities, a list of those CC’d on the email.

Click to expand cc

value
STRING

The cc on the email.
activities (table), cc (attribute)

contact_id
STRING

The contact ID associated with the activity.

Reference:

created_by
STRING

The ID of the user who created the activity.

Reference:

created_by_name
STRING

The name of the user who created the activity.

date_scheduled
STRING

The date the activity was scheduled for.

date_sent
STRING

The date the activity was sent.

date_updated
STRING

The date the activity was last updated.

dialer_id
STRING

For Call activities, the ID of the person who initiated the call.

direction
STRING

The direction of the call, email, or SMS. Possible values are:

  • For Call or SMS activities: outbound or inbound
  • For Email activities: incoming or outgoing

duration
INTEGER

For Call activities, the duration of the call.

email_account_id
STRING

For Email activities, the ID of the email account associated with the activity.

envelope
OBJECT

For Email activities, details about the email associated with the activity.

Click to expand envelope

bcc
ARRAY

A list of those BCC’d on the email.

Click to expand bcc

email
STRING

The email of the bcc.

name
STRING

The name of the bcc.
activities (table), bcc (attribute)

cc
ARRAY

A list of those CC’d on the email.

Click to expand cc

email
STRING

The email of the cc.

name
STRING

The name of the cc.
activities (table), cc (attribute)

date
DATE-TIME

The date the email was sent.

from
ARRAY

Details about who sent the email.

Click to expand from

email
STRING

The address the email was sent from.

name
STRING

The name of the person who sent the email.
activities (table), from (attribute)

in_reply_to
STRING

is_autoreply
BOOLEAN, INTEGER

If true, the email was an autoreply email.

message_id
STRING

The ID of the message.

reply_to
ARRAY

Click to expand reply_to

email
STRING

name
STRING

activities (table), reply_to (attribute)

sender
ARRAY

Details about the sender of the email.

Click to expand sender

email
STRING

The email address of the sender.

name
STRING

The name of the sender.
activities (table), sender (attribute)

subject
STRING

The subject of the email.

to
ARRAY

Details about who the email was sent to.

Click to expand to

email
STRING

The email address the email was sent to.

name
STRING

The name of the email recipient.
activities (table), to (attribute)
activities (table), envelope (attribute)

import_id
STRING

in_reply_to_id
STRING

lead_id
STRING

The ID of the lead associated with the activity.

Reference:

local_phone
STRING

For Call and SMS activities, the local phone number associated with the call or SMS.

message_ids
ARRAY

A list of messages associated with the activity.

Click to expand message_ids

value
STRING

The message ID.
activities (table), message_ids (attribute)

need_smtp_credentials
BOOLEAN, INTEGER

new_status_id
STRING

For LeadStatusChange and OpportunityStatusChange activities, the new status ID.

new_status_label
STRING

For LeadStatusChange and OpportunityStatusChange activities, the new status label.

new_status_type
STRING

For LeadStatusChange and OpportunityStatusChange activities, the new status type.

note
STRING

For Note activities, the content of the note.

old_status_id
STRING

For LeadStatusChange and OpportunityStatusChange activities, the old status ID.

old_status_label
STRING

For LeadStatusChange and OpportunityStatusChange activities, the old status label.

old_status_type
STRING

For LeadStatusChange and OpportunityStatusChange activities, the old status type.

opens
ARRAY

For Email activities, details about the person who opened the email.

Click to expand opens

ip_address
STRING

The IP address of the person who opened the email.

opened_at
STRING

The date the email was opened.

opened_by
STRING

The ID of the person who opened the email.

user_agent
STRING

The user agent of the person who opened the email.
activities (table), opens (attribute)

opens_summary
STRING

opportunity_confidence
INTEGER

For OpportunityStatusChange activities, the confidence score of the opportunity.

opportunity_date_won
STRING

For OpportunityStatusChange activities, the date the opportunity was marked as won.

opportunity_id
STRING

For OpportunityStatusChange activities, the ID of the opportunity.

opportunity_value
INTEGER

For OpportunityStatusChange activities, the value of the opportunity.

opportunity_value_currency
STRING

For OpportunityStatusChange activities, the currency code of the opportunity value.

opportunity_value_formatted
STRING

For OpportunityStatusChange activities, the formatted version of `opportunity_value.

opportunity_value_period
STRING

For OpportunityStatusChange activities, the value period of the opportunity. For example: one_time

organization_id
STRING

The ID of the organization associated with the activity.

Reference:

phone
STRING

For Call activities, the phone number associated with the activity.

recording_url
STRING

For Call activities, the URL of the recording, if applicable.

references
ARRAY

A list of references associated with the activity.

Click to expand references

value
STRING

The reference.
activities (table), references (attribute)

remote_phone
STRING

For Call and SMS activities, the remote phone number associated with the call or SMS.

send_attempts
ARRAY

For Email activities, details about the send attempts.

Click to expand send_attempts

date
STRING

The date the send was attempted.

error_class
STRING

The error class associated with the send failure.

error_message
STRING

The error message associated with the send failure.
activities (table), send_attempts (attribute)

sender
STRING

For Email activities, the email address of the user who sent the email.

source
STRING

The source of the activity.

status
STRING

For Email activities, the status of the email. (inbox)

subject
STRING

For Email activities, the subject of the email.

task_assigned_to
STRING

The ID of the user who the task is assigned to.

Reference:

task_assigned_to_name
STRING

The name of the user who the task is assigned to.

task_id
STRING

For TaskCompleted activities, the ID of the completed task.

Reference:

task_text
STRING

For TaskCompleted activities, the text of the completed task.

template_id
STRING

For Email activities, the ID of the template that was used in the email.

template_name
STRING

For Email activities, the name of the template that was used in the email.

thread_id
STRING

to
ARRAY

For Email activities, a list of the people the email was sent to.

Click to expand to

value
STRING

The email address the email was sent to.
activities (table), to (attribute)

transferred_from
STRING

transferred_to
STRING

updated_by
STRING

The ID of the user who last updated the activity.

Reference:

updated_by_name
STRING

The name of the user who last updated the activity.

user_id
STRING

The ID of the user associated with the activity.

Reference:

user_name
STRING

The name of the user associated with the activity.

users
ARRAY

For Created activities, the list of users associated with the activity.

Click to expand users

id
STRING

The user ID.

Reference:

date_created
STRING

The date the user was created.

date_updated
STRING

The date the user was last updated.

email
STRING

The email address associated with the user.

first_name
STRING

The first name of the user.

image
STRING

The URL of the user’s avatar.

last_name
STRING

The last name of the user.

last_used_timezone
STRING

The user’s last used timezone.

organizations
ARRAY

The list of organizations associated with the user.

Click to expand organizations

value
STRING

The ID of the organization associated with the user.
activities (table), organizations (attribute)
activities (table), users (attribute)

voicemail_duration
INTEGER

For Call activities, the duration of the voicemail, if applicable.

voicemail_url
STRING

For Call activities, the URL of the voicemail, if applicable.

custom_fields

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

date_updated
Primary Key :

id

 API endpoint :

List all custom fields for your organization

The custom_fields table contains info about the custom fields in your Close.io account.

Custom fields allow you to store arbitrary data on leads in Close.io. Refer to Close.io’s documentation for more info.

custom_fields table schema

id
STRING

The custom field ID.

date_updated
STRING

The date the custom field was last updated.

choices
ARRAY

For choices custom fields, a list of choices available for the custom field.

Click to expand choices

value
STRING

The choice available for the field.
custom_fields (table), choices (attribute)

created_by
STRING

The ID of the user who created the custom field.

Reference:

date_created
STRING

The date the custom field was created.

editable_with_roles
ARRAY

Click to expand editable_with_roles

value
STRING

custom_fields (table), editable_with_roles (attribute)

name
STRING

The name of the custom field.

organization_id
STRING

The ID of the organization associated with the custom field.

Reference:

type
STRING

The type of the custom field. Possible values include:

  • choices
  • date
  • date/time
  • hidden
  • number
  • text
  • user

updated_by
STRING

The ID of the user who last updated the custom field.

Reference:

event_log

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

date_updated
Primary Key :

id

 API endpoint :

Retrieve a list of events

The event_log table contains info about events generated in your Close.io account. This could include creating a lead, sending an email, or deleting a note.

Historical data limitations

Due to how Close.io’s API functions, only 30 days of historical data is available for this table from the initial connection date.

Refer to the Replication section for more info.

event_log table schema

id
STRING

The event ID.

date_updated
STRING

The time the event was last updated.

action
STRING

The type of action that was performed on the object_type. Possible values vary depending on the object_type, but the most common types are:

  • created
  • deleted
  • updated

Refer to Close.io’s documentation for a full list of possible values.

changed_fields
ARRAY

For events where action: updated, a list of fields that have changed.

Click to expand changed_fields

value
STRING

The name of the field that was changed.
event_log (table), changed_fields (attribute)

data
STRING

The payload of the affected object, as if it were retrieved via Close.io’s API. This is null for events where action: deleted, and is only returned for organization admins.

date_created
STRING

The date the event was created.

lead_id
STRING

The ID of the lead associated with the event, if applicable. In the case where object_type: lead, this will be equivalent to object_id.

Reference:

meta
OBJECT

Additional information for certain activity types.

Click to expand meta

request_method
STRING

For events associated with an HTTP request, the method of the request. For example: POST

request_path
STRING

For events associated with an HTTP request, the path of the request. For example: /api/v1/lead
event_log (table), meta (attribute)

object_id
STRING

The ID of the affected object. In the case where object_type: lead, this will be equivalent to lead_id.

object_type
STRING

The type of object associated with the event. Possible values include:

  • activity.email
  • activity.email_thread
  • activity.call
  • activity.note
  • activity.lead_status_change
  • activity.opportunity_status_change
  • activity.task_completed
  • bulk_action.delete
  • bulk_action.edit
  • bulk_action.email
  • bulk_action.sequence_subscription
  • contact
  • custom_fields.lead
  • email_template
  • export.lead
  • export.opportunity
  • import
  • lead
  • membership
  • opportunity
  • saved_search
  • sequence
  • sequence_subscription
  • status.lead
  • status.opportunity

organization_id
STRING

The ID of the organization associated with the event.

Reference:

previous_data
STRING

This field is only returned for Close.io organization admins. For events where action: updated, the fields that have been changed and their previous values.

request_id
STRING

The unique request identifier.

user_id
STRING

The ID of the user who generated the event. This will be null if the event wasn’t directly generated by a user action.

Reference:

leads

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

date_updated
Primary Key :

id

 API endpoint :

List or search for leads

The leads table contains info about the leads in your Close.io account.

Leads represent a company or organization and may contain contacts, tasks, opportunities, and activities. In Close.io, a lead is synonymous with “account” in other CRMs.

leads table schema

id
STRING

The lead ID.

Reference:

date_updated
STRING

The time the lead was last updated.

addresses
ARRAY

A list of physical addresses associated with the lead.

Click to expand addresses

address_1
STRING

The first line of the lead’s address.

address_2
STRING

The second line of the lead’s address.

city
STRING

The city.

country
STRING

The country.

label
STRING

The label for the address. For example: business or home

state
STRING

The state.

zipcode
STRING

The zipcode.
leads (table), addresses (attribute)

contacts
ARRAY

A list of contacts associated with the lead.

Click to expand contacts

id
STRING

The contact ID.

Reference:

created_by
STRING

The ID of the user who created the contact.

Reference:

date_created
STRING

The date the contact was created.

date_updated
STRING

The date the contact was updated.

display_name
STRING

The display name of the contact.

emails
ARRAY

A list of the email addresses associated with the contact.

Click to expand emails

email
STRING

The contact’s email address.

type
STRING

The type of email address. For example: office
leads (table), emails (attribute)

integration_links
ARRAY

A list of integration links associated with the contact.

lead_id
STRING

The lead ID associated with the contact.

Reference:

name
STRING

The name of the contact.

organization_id
STRING

The ID of the organization associated with the contact.

Reference:

phones
ARRAY

A list of phone numbers associated with the contact.

Click to expand phones

phone
STRING

The phone number associated with the contact.

phone_formatted
STRING

The formatted version of phone.

type
STRING

The type of phone number. For example: office
leads (table), phones (attribute)

title
STRING

The contact’s title.

updated_by
STRING

The ID of the user who last updated the contact.

Reference:

urls
ARRAY

Click to expand urls

value
STRING

leads (table), urls (attribute)
leads (table), contacts (attribute)

created_by
STRING

The ID of the user who created the lead.

Reference:

created_by_name
STRING

The name of the user who created the lead.

custom_fields
ARRAY

A list of custom fields associated with the lead, if applicable.

Click to expand custom_fields

value
STRING

leads (table), custom_fields (attribute)

date_created
STRING

The date the lead was created.

description
STRING

The description of the lead.

display_name
STRING

The display name of the lead.

html_url
STRING

The Close.io URL for the lead.

integration_links
ARRAY

A list of integration links associated with the lead.

name
STRING

The name of the lead.

opportunities
ARRAY

A list of opportunities associated with the lead.

Click to expand opportunities

id
STRING

The opportunity ID.

confidence
INTEGER

The opportunity’s confidence score.

contact_id
STRING

The contact ID associated with the opportunity.

Reference:

contact_name
STRING

The contact name associated with the opportunity.

created_by
STRING

The ID of the user who created the opportunity.

Reference:

created_by_name
STRING

The name of the user who created the opportunity.

date_created
STRING

The date the opportunity was created.

date_lost
STRING

The date the opportunity was lost.

date_updated
STRING

The date the opportunity was last updated.

date_won
STRING

The date the opportunity was won.

integration_links
ARRAY

A list of integration links associated with the opportunity.

lead_id
STRING

The ID of the lead associated with the opportunity.

Reference:

lead_name
STRING

The name of the lead associated with the opportunity.

note
STRING

Any notes about the opportunity.

organization_id
STRING

The ID of the organization associated with the opportunity.

Reference:

status_id
STRING

The ID of the status associated with the opportunity.

status_label
STRING

The status label. For example: Active

status_type
STRING

The status type. For example: active

updated_by
STRING

The ID of the user who last updated the opportunity.

Reference:

updated_by_name
STRING

The name of the user who last updated the opportunity.

user_id
STRING

The ID of the user associated with the opportunity.

Reference:

user_name
STRING

The name of the user associated with the opportunity.

value
INTEGER

The value of the opportunity.

value_currency
STRING

The currency code of the opportunity’s value.

value_formatted
STRING

The formatted version of value.

value_period
STRING

The opportunity’s value period. For example: one_time
leads (table), opportunities (attribute)

organization_id
STRING

The ID of the organization associated with the lead.

Reference:

status_id
STRING

The ID of the status associated with the lead.

status_label
STRING

The status label. For example: Active

tasks
ARRAY

A list of tasks associated with the lead.

Click to expand tasks

id
STRING

The task ID.

Reference:

_type
STRING

The task type. Possible values are:

  • answered_detached_call
  • email_followup
  • incoming_email
  • incoming_sms
  • lead
  • missed_call
  • opportunity_due
  • voicemail

assigned_to
STRING

The ID of the user the task is assigned to.

Reference:

assigned_to_name
STRING

The name of the user the task is assigned to.

contact_id
STRING

The ID of the contact associated with the task.

Reference:

contact_name
STRING

The name of the contact associated with the task.

created_by
STRING

The ID of the user who created the task.

Reference:

created_by_name
STRING

The name of the user who created the task.

date
STRING

The date of the task.

date_created
STRING

The date the task was created.

date_updated
STRING

The date the task was updated.

due_date
STRING

The date the task is due.

is_complete
BOOLEAN, INTEGER

Indicates if the task is complete.

is_dateless
BOOLEAN, INTEGER

Indicates if the task is dateless.

lead_id
STRING

The ID of the lead associated with the task.

Reference:

lead_name
STRING

The name of the lead associated with the task.

object_id
STRING

The object ID. The value of this field varies depending on a task’s _type:

  • answered_detached_call - The ID of the corresponding call.
  • email_followup - The ID of the corresponding email thread.
  • incoming_email - The ID of the corresponding email thread.
  • incoming_sms - The ID of the corresponding SMS.
  • missed_call - The activity ID of the call that was missed.
  • opportunity_due - The ID of the corresponding opportunity.
  • voicemail - The activity ID of the call that was missed.

object_type
STRING

The object type. Possible values vary depending on a task’s _type:

  • answered_detached_call - call
  • email_followup - emailthread
  • incoming_email - emailthread
  • incoming_sms - sms
  • missed_call - call
  • opportunity_due - opportunity
  • voicemail - call

organization_id
STRING

The ID of the organization associated with the lead.

Reference:

text
STRING

For lead and incoming_sms tasks, the text that was sent.

updated_by
STRING

The ID of the user who last updated the task.

Reference:

updated_by_name
STRING

The name of the user who last updated the task.

view
STRING

The view associated with the task.
leads (table), tasks (attribute)

updated_by
STRING

The ID of the user who last updated the lead.

Reference:

updated_by_name
STRING

The name of the user who last updated the lead.

url
STRING

The Close.io URL of the lead.

tasks

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

date_updated
Primary Key :

id

 API endpoint :

List or filter tasks

The tasks table contains info about the tasks in your Close.io account. Tasks are action items with a given date that are assigned to a sales rep.

tasks table schema

id
STRING

The task ID.

date_updated
STRING

The date the task was last updated.

_type
STRING

The task type. Possible values are:

  • answered_detached_call
  • email_followup
  • incoming_email
  • incoming_sms
  • lead
  • missed_call
  • opportunity_due
  • voicemail

assigned_to
STRING

The ID of the user the task is assigned to.

Reference:

assigned_to_name
STRING

The name of the user the task is assigned to.

body_preview
STRING

For incoming_email tasks, a preview of the body content of the email.

contact_id
STRING

The contact ID associated with the task.

Reference:

contact_name
STRING

The name of the contact associated with the task.

created_by
STRING

The ID of the user who created the task.

Reference:

created_by_name
STRING

The name of the user who created the task.

date
STRING

The date of the task.

date_created
STRING

The date the task was created.

due_date
STRING

The date the task is due.

email_id
STRING

For email_followup tasks, the ID of the email.

emails
ARRAY

For incoming_email tasks, a list email activity IDs related to the task.

Click to expand emails

value
STRING

The email ID.
tasks (table), emails (attribute)

is_complete
BOOLEAN

Indicates if the task has been completed.

is_dateless
BOOLEAN

Indicates if the task is dateless.

lead_id
STRING

The ID of the lead associated with the task.

Reference:

lead_name
STRING

The name of the lead associated with the task.

local_phone
STRING

For incoming_sms and missed_call tasks, the local phone number.

object_id
STRING

The object ID. The value of this field varies depending on a task’s _type:

  • answered_detached_call - The ID of the corresponding call.
  • email_followup - The ID of the corresponding email thread.
  • incoming_email - The ID of the corresponding email thread.
  • incoming_sms - The ID of the corresponding SMS.
  • missed_call - The activity ID of the call that was missed.
  • opportunity_due - The ID of the corresponding opportunity.
  • voicemail - The activity ID of the call that was missed.

object_type
STRING

The object type. Possible values vary depending on a task’s _type:

  • answered_detached_call - call
  • email_followup - emailthread
  • incoming_email - emailthread
  • incoming_sms - sms
  • missed_call - call
  • opportunity_due - opportunity
  • voicemail - call

opportunity_note
STRING

For opportunity_due tasks, the note associated with the task.

opportunity_value
INTEGER

For opportunity_due tasks, the value of the opportunity.

opportunity_value_currency
STRING

For opportunity_due tasks, the currency code of opportunity_value.

opportunity_value_formatted
STRING

For opportunity_due tasks, the formatted version of opportunity_value.

opportunity_value_period
STRING

For opportunity_due tasks, the value period of the opportunity. For example: one_time

organization_id
STRING

The ID of the organization associated with the task.

Reference:

phone
STRING

For missed_call and voicemail tasks, the phone number.

phone_formatted
STRING

For missed_call and voicemail tasks, the formatted version of phone.

phone_number_description
STRING

For answered_detached_call and missed_call tasks, the phone number description.

recording_url
STRING

For answered_detached_call tasks, the URL of the call recording.

remote_phone
STRING

For incoming_sms tasks, the phone number of the sender.

remote_phone_description
STRING

For incoming_sms tasks, the remote_phone description.

remote_phone_formatted
STRING

For incoming_sms tasks, the formatted version of remote_phone.

subject
STRING

For incoming_email and email_followup tasks, the subject of the email.

text
STRING

For lead and incoming_sms tasks, the text that was sent.

updated_by
STRING

The ID of the user who last updated the task.

Reference:

updated_by_name
STRING

The name of the user who last updated the task.

view
STRING

The view associated with the task.

voicemail_duration
INTEGER

For voicemail tasks, the duration of the voicemail.

voicemail_url
STRING

For voicemail tasks, the URL of the voicemail.

users

View table schema on GitHub
Replication Method :

Key-based Incremental

 Replication Key :

date_updated
Primary Key :

id

 API endpoint :

List all users who are members of your organizations

The users table contains info about the users in your Close.io account.

In Close.io, users are typically your co-workers and sales reps, or those inside your company.

users table schema

id
STRING

The user ID.

Reference:

date_updated
STRING

The date the user was last updated.

date_created
STRING

The date the user was created.

email
STRING

The user’s email address.

first_name
STRING

The first name of the user.

image
STRING

The URL of the user’s avatar.

last_name
STRING

The last name of the user.

last_used_timezone
STRING

The user’s last used timezone.

organizations
ARRAY

A list of organizations associated with the user.
Related Troubleshooting
Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.