Contactually API v2

Contactually helps you keep in touch with your contacts and follow up to keep yourself at top of mind. This API allows you to keep your Contactually account in sync with other systems you or your organization may have set up.

API v2 Migration Schedule

We’re deprecating our v1 API over the coming months according to the following timeline:

Date Event
April 1, 2016 API v2 goes live
July 1, 2016 https://www.contactually.com/api/v1 shut off in favor of https://api.contactually.com/v1
October 1, 2016 End of official support for API v1
December 31, 2016 All API v1 routes shut down

Create an App

To use the Contactually API, you’ll need to have a registered application.

Required Headers

You’ll need to send some headers when making API calls to identify your application, set the version and set the content type to JSON.

Header Value
Content-type application/json
Authorization Bearer [access_token]

Requests

There are some convenience methods included for common tasks, but in general the following HTTP conventions are followed

Verb Meaning
GET Retrieving a single instance or list of resources
POST Creating a new resource
PUT or PATCH* Updating a resource. Only the values given in the request will be changed
DELETE Remove a resource

*PUT and PATCH requests are treated as equivelant, but PATCH is preferred as it is more semantically accurate. If your application is unable to perform requests in this manner, send updates as PUT.

Responses

All responses will be JSON.

Rate limits will be sent via header values

Header Value
X-Rate-Limit-Limit 500/minute
X-Rate-Limit-Remaining
X-Rate-Limit-Reset seconds until reset

Often it is likely that you’ll need more than a single resource to give context to an object (e.g. when working with a contact you’ll often want to know the last time the user contacted them). This information is provided under the key extra_data. Information located in the extra_data hash CANNOT be updated with the rest of the resource. To update an associated resource, or affect a calculated field (like last_contacted_at), you’ll need to use the appropriate route or action (e.g. save a new Interaction).

Authorized User

Fetch

GET https://api.contactually.com/v2/me
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "user_179",
    "created_at": "2017-03-29 21:07:34 UTC",
    "updated_at": "2017-03-29 21:07:34 UTC",
    "first_name": "Rozella",
    "last_name": "Funk",
    "email": "rozella.funk@example.com",
    "avatar_url": null,
    "role": null,
    "status": "active"
  },
  "meta": {}
}

Fetch
GET/v2/me

🔒 user:login user:basic user:manage all:view all:manage

Note that having the login permission will only return partial data.


Update

PATCH https://api.contactually.com/v2/me
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": {
    "first_name": "Rosie",
    "last_name": "Cogswell",
    "email": "rcogswell@example.com",
    "avatar_url": "http://lorempixel.com/g/200/200/",
    "settings": {
      "default_message_subject": "Just checking in",
      "default_message_bcc": "my.awesome.assistant@example.com",
      "email_signature": "Rosie Cogswell, Robot Extraordinaire",
      "time_zone": "EDT"
    }
  }
}
Responses200
Body
{
  "data": {
    "id": "user_179",
    "created_at": "2017-03-29 21:07:34 UTC",
    "updated_at": "2017-03-29 21:07:34 UTC",
    "first_name": "Rozella",
    "last_name": "Funk",
    "email": "rozella.funk@example.com",
    "avatar_url": null,
    "role": null,
    "status": "active"
  },
  "meta": {}
}

Update
PATCH/v2/me

🔒 user:manage all:manage


Connected Accounts

GET https://api.contactually.com/v2/me/connected-accounts?created_at.before=2016-08-29T15:31:49-04:00&created_at.after=2016-08-29T15:31:49-04:00&updated_at.before=2016-08-29T15:31:49-04:00&updated_at.after=2016-08-29T15:31:49-04:00&page=2&order=-created_at
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "connected_account_67",
      "created_at": "2017-02-01 22:37:28 UTC",
      "updated_at": "2017-02-01 22:37:28 UTC",
      "handle": "dahlia.kuhic.1@example.com",
      "external_id": "demarco.hayes.2@example.com",
      "type": "google",
      "extra_data": {
        "status": {
          "contact_sync_status": null,
          "message_sync_status": null
        }
      }
    },
    {
      "id": "connected_account_68",
      "created_at": "2017-02-01 22:37:28 UTC",
      "updated_at": "2017-02-01 22:37:28 UTC",
      "handle": "terrance.bartoletti.3@example.com",
      "external_id": "willie.kuphal.4@example.com",
      "type": "google",
      "extra_data": {
        "status": {
          "contact_sync_status": null,
          "message_sync_status": null
        }
      }
    },
    {
      "id": "connected_account_69",
      "created_at": "2017-02-01 22:37:28 UTC",
      "updated_at": "2017-02-01 22:37:28 UTC",
      "handle": "arielle.ernser.5@example.com",
      "external_id": "audreanne.zieme.6@example.com",
      "type": "google",
      "extra_data": {
        "status": {
          "contact_sync_status": null,
          "message_sync_status": null
        }
      }
    }
  ]
}

List
GET/v2/me/connected-accounts{?created_at.before,created_at.after,updated_at.before,updated_at.after,page,order}

🔒 connected-accounts:view connected-accounts:manage all:view all:manage

URI Parameters
HideShow
created_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
created_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
updated_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
updated_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
page
number (optional) Example: 2

50/page

order
string (optional) Example: -created_at

Can be ordered by id, created_at, or updated_at. Defaults to ascending, - denotes “descending”


GET https://api.contactually.com/v2/me/connected-accounts/connected_account_43
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "connected_account_67",
    "created_at": "2017-02-01 22:37:28 UTC",
    "updated_at": "2017-02-01 22:37:28 UTC",
    "handle": "dahlia.kuhic.1@example.com",
    "external_id": "demarco.hayes.2@example.com",
    "type": "google",
    "extra_data": {
      "status": {
        "contact_sync_status": null,
        "message_sync_status": null
      }
    }
  },
  "meta": {}
}

Fetch
GET/v2/me/connected-accounts/{id}

🔒 connected-accounts:view connected-accounts:manage all:view all:manage

URI Parameters
HideShow
id
string (required) Example: connected_account_43

Connected account identifier


Email Aliases

This endpoint serves as a convenience for retrieving all email aliases associated with the current user.

GET https://api.contactually.com/v2/me/email-aliases
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "email_alias_19",
      "email_alias": "waino.hegmann.1@example.com"
    },
    {
      "id": "email_alias_20",
      "email_alias": "cydney.carter.2@example.com"
    },
    {
      "id": "email_alias_21",
      "email_alias": "berniece.jaskolski.3@example.com"
    }
  ]
}

Email Aliases List
GET/v2/me/email-aliases

🔒 user:login


Notifications

GET https://api.contactually.com/v2/me/notifications?created_at.before=2016-08-29T15:31:49-04:00&created_at.after=2016-08-29T15:31:49-04:00&updated_at.before=2016-08-29T15:31:49-04:00&updated_at.after=2016-08-29T15:31:49-04:00&page=2&order=-created_at
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "notification_55",
      "created_at": "2017-03-29 21:07:34 UTC",
      "updated_at": "2017-03-29 21:07:34 UTC",
      "type": null,
      "title": "Est consequatur quasi culpa voluptates asperiores.",
      "link": "https://api-gerhardt-contactually.ngrok.io/daniel.us",
      "level": "info",
      "read_at": null
    },
    {
      "id": "notification_56",
      "created_at": "2017-03-29 21:07:34 UTC",
      "updated_at": "2017-03-29 21:07:34 UTC",
      "type": null,
      "title": "Numquam voluptatem magni.",
      "link": "https://api-gerhardt-contactually.ngrok.io/grant.us",
      "level": "info",
      "read_at": null
    },
    {
      "id": "notification_57",
      "created_at": "2017-03-29 21:07:34 UTC",
      "updated_at": "2017-03-29 21:07:34 UTC",
      "type": null,
      "title": "Repellendus amet aut.",
      "link": "https://api-gerhardt-contactually.ngrok.io/kuphal.info",
      "level": "info",
      "read_at": null
    }
  ]
}

List
GET/v2/me/notifications{?created_at.before,created_at.after,updated_at.before,updated_at.after,page,order}

🔒 user:basic user:manage all:view all:manage

URI Parameters
HideShow
created_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
created_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
updated_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
updated_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
page
number (optional) Example: 2

50/page

read_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
read_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
read
boolean (optional) Example: false
order
string (optional) Example: -created_at

Can be ordered by id, created_at, or updated_at. Defaults to ascending, - denotes “descending”


Prompts

Prompts are system-generated via followup rules, programs, or unresponded messages.

These can only be completed by performing the prescribed action, NOT by this resource’s endpoint

GET https://api.contactually.com/v2/me/prompts?created_at.before=2016-08-29T15:31:49-04:00&created_at.after=2016-08-29T15:31:49-04:00&updated_at.before=2016-08-29T15:31:49-04:00&updated_at.after=2016-08-29T15:31:49-04:00&page=2&order=-due_at&due_at.before=2016-08-29T15:31:49-04:00&due_at.after=2016-08-29T15:31:49-04:00
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "task_526",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "link": "https://api-gerhardt-contactually.ngrok.io/v2/contacts/contact_3834/interactions",
      "type": "followup",
      "contact": {
        "id": "contact_3834",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "Hallie",
        "last_name": "Thompson",
        "company": null,
        "location": null,
        "title": "Finance President",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [],
        "email_addresses": [],
        "social_media_profiles": [],
        "websites": [],
        "phone_numbers": [],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "extra_data": {
        "program": null
      }
    },
    {
      "id": "task_527",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "link": "https://api-gerhardt-contactually.ngrok.io/v2/contacts/contact_3835/interactions",
      "type": "followup",
      "contact": {
        "id": "contact_3835",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "Delpha",
        "last_name": "Orn",
        "company": null,
        "location": null,
        "title": "General Secretary",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [],
        "email_addresses": [],
        "social_media_profiles": [],
        "websites": [],
        "phone_numbers": [],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "extra_data": {
        "program": null
      }
    },
    {
      "id": "task_528",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "link": "https://api-gerhardt-contactually.ngrok.io/v2/contacts/contact_3836/interactions",
      "type": "followup",
      "contact": {
        "id": "contact_3836",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "David",
        "last_name": "Champlin",
        "company": null,
        "location": null,
        "title": "Executive President",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [],
        "email_addresses": [],
        "social_media_profiles": [],
        "websites": [],
        "phone_numbers": [],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "extra_data": {
        "program": null
      }
    }
  ]
}

List
GET/v2/me/prompts{?created_at.before,created_at.after,updated_at.before,updated_at.after,page,order,due_at.before,due_at.after}

🔒 user:basic user:manage all:view all:manage

URI Parameters
HideShow
created_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
created_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
updated_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
updated_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
page
number (optional) Example: 2

50/page

due_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
due_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
order
string (optional) Example: -due_at

Can be ordered by id, created_at, updated_at, or due_at. Defaults to -due_at,-created_at. - denotes “descending”


PUT https://api.contactually.com/v2/me/prompts/task_421/postpone
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": {
    "postpone_until": "2015-10-29T12:00:00Z"
  }
}
Responses200
Body
{
  "data": {
    "id": "task_526",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "link": "https://api-gerhardt-contactually.ngrok.io/v2/contacts/contact_3834/interactions",
    "type": "followup",
    "contact": {
      "id": "contact_3834",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "first_name": "Hallie",
      "last_name": "Thompson",
      "company": null,
      "location": null,
      "title": "Finance President",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [],
      "email_addresses": [],
      "social_media_profiles": [],
      "websites": [],
      "phone_numbers": [],
      "custom_fields": [],
      "extra_data": {
        "last_contacted": null,
        "muted_at": null,
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "user_last_contacted_at": null,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "lead_pools": [],
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    "extra_data": {
      "program": null
    }
  },
  "meta": {}
}

Postpone
PUT/v2/me/prompts/{id}/postpone

🔒 user:basic user:manage all:manage

If no data object is given, defaults to 2-week delay.

URI Parameters
HideShow
id
string (required) Example: task_421

The prompt id


POST https://api.contactually.com/v2/me/prompts/generate
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "task_526",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "link": "https://api-gerhardt-contactually.ngrok.io/v2/contacts/contact_3834/interactions",
      "type": "followup",
      "contact": {
        "id": "contact_3834",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "Hallie",
        "last_name": "Thompson",
        "company": null,
        "location": null,
        "title": "Finance President",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [],
        "email_addresses": [],
        "social_media_profiles": [],
        "websites": [],
        "phone_numbers": [],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "extra_data": {
        "program": null
      }
    },
    {
      "id": "task_527",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "link": "https://api-gerhardt-contactually.ngrok.io/v2/contacts/contact_3835/interactions",
      "type": "followup",
      "contact": {
        "id": "contact_3835",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "Delpha",
        "last_name": "Orn",
        "company": null,
        "location": null,
        "title": "General Secretary",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [],
        "email_addresses": [],
        "social_media_profiles": [],
        "websites": [],
        "phone_numbers": [],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "extra_data": {
        "program": null
      }
    },
    {
      "id": "task_528",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "link": "https://api-gerhardt-contactually.ngrok.io/v2/contacts/contact_3836/interactions",
      "type": "followup",
      "contact": {
        "id": "contact_3836",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "David",
        "last_name": "Champlin",
        "company": null,
        "location": null,
        "title": "Executive President",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [],
        "email_addresses": [],
        "social_media_profiles": [],
        "websites": [],
        "phone_numbers": [],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "extra_data": {
        "program": null
      }
    }
  ]
}

Generate
POST/v2/me/prompts/generate

🔒 user:basic user:manage all:view all:manage

Creates new prompts based on current bucketing/programs/deals rules.


Tasks

This endpoint serves as a convenience for retrieving all tasks assigned to the current user, however, any edits to those tasks (such as marking them completed) occurs via the /v2/tasks/{id} endpoint.

GET https://api.contactually.com/v2/me/tasks?created_at.before=2016-08-29T15:31:49-04:00&created_at.after=2016-08-29T15:31:49-04:00&updated_at.before=2016-08-29T15:31:49-04:00&updated_at.after=2016-08-29T15:31:49-04:00&page=2&order=-due_at&due_at.before=2016-08-29T15:31:49-04:00&due_at.after=2016-08-29T15:31:49-04:00&completed_at.before=2016-08-29T15:31:49-04:00&completed_at.after=2016-08-29T15:31:49-04:00&completed=false
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "task_529",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "assigned_to_id": "user_179",
      "contact_id": "contact_3838",
      "due_at": "2017-03-30 21:07:35 UTC",
      "title": "Placeat debitis quae velit ad ipsa odit iste rerum voluptatem doloribus omnis ducimus voluptatem impedit.",
      "extra_data": {
        "assigned_at": null,
        "completed_at": null,
        "contact": {
          "id": "contact_3838",
          "created_at": "2017-03-29 21:07:35 UTC",
          "updated_at": "2017-03-29 21:07:35 UTC",
          "first_name": "Clement",
          "last_name": "Anderson",
          "company": null,
          "location": null,
          "title": "Corporate Secretary",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "7fd5c248-d972-432a-b7b0-cd8f6027ca13",
              "full_address": "North Giovanna",
              "label": "Mobile",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3680",
              "label": null,
              "address": "clement.anderson@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "820994c6-b143-4b1a-98e9-3d3680ee5490",
              "label": "LinkedIn",
              "url": "http://howe.name"
            }
          ],
          "websites": [
            {
              "id": "ff3fb18e-fe37-4614-b337-e5c4b9332bd2",
              "label": "Business",
              "address": "http://hagenesbrown.ca"
            }
          ],
          "phone_numbers": [
            {
              "id": "68082bb1-a546-4f4e-9bf6-b84d38871395",
              "label": "Home",
              "number": "(447)476-4478 x03265"
            }
          ],
          "custom_fields": [],
          "extra_data": {
            "last_contacted": null,
            "muted_at": null,
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "user_last_contacted_at": null,
            "buckets": [],
            "sources": [],
            "followup_source": null,
            "lead_pools": [],
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        },
        "created_by": null,
        "assigned_by": null,
        "assigned_to": {
          "id": "user_179",
          "created_at": "2017-03-29 21:07:34 UTC",
          "updated_at": "2017-03-29 21:07:34 UTC",
          "first_name": "Rozella",
          "last_name": "Funk",
          "email": "rozella.funk@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        }
      }
    },
    {
      "id": "task_530",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "assigned_to_id": "user_179",
      "contact_id": "contact_3838",
      "due_at": "2017-03-30 21:07:35 UTC",
      "title": "Quo magni optio fuga eaque eos aspernatur alias iste voluptatem doloribus qui delectus.",
      "extra_data": {
        "assigned_at": null,
        "completed_at": null,
        "contact": {
          "id": "contact_3838",
          "created_at": "2017-03-29 21:07:35 UTC",
          "updated_at": "2017-03-29 21:07:35 UTC",
          "first_name": "Clement",
          "last_name": "Anderson",
          "company": null,
          "location": null,
          "title": "Corporate Secretary",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "7fd5c248-d972-432a-b7b0-cd8f6027ca13",
              "full_address": "North Giovanna",
              "label": "Mobile",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3680",
              "label": null,
              "address": "clement.anderson@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "820994c6-b143-4b1a-98e9-3d3680ee5490",
              "label": "LinkedIn",
              "url": "http://howe.name"
            }
          ],
          "websites": [
            {
              "id": "ff3fb18e-fe37-4614-b337-e5c4b9332bd2",
              "label": "Business",
              "address": "http://hagenesbrown.ca"
            }
          ],
          "phone_numbers": [
            {
              "id": "68082bb1-a546-4f4e-9bf6-b84d38871395",
              "label": "Home",
              "number": "(447)476-4478 x03265"
            }
          ],
          "custom_fields": [],
          "extra_data": {
            "last_contacted": null,
            "muted_at": null,
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "user_last_contacted_at": null,
            "buckets": [],
            "sources": [],
            "followup_source": null,
            "lead_pools": [],
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        },
        "created_by": null,
        "assigned_by": null,
        "assigned_to": {
          "id": "user_179",
          "created_at": "2017-03-29 21:07:34 UTC",
          "updated_at": "2017-03-29 21:07:34 UTC",
          "first_name": "Rozella",
          "last_name": "Funk",
          "email": "rozella.funk@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        }
      }
    },
    {
      "id": "task_531",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "assigned_to_id": "user_179",
      "contact_id": "contact_3838",
      "due_at": "2017-03-30 21:07:35 UTC",
      "title": "Tempora odio eum recusandae ut voluptate et quia sint voluptatibus cum expedita.",
      "extra_data": {
        "assigned_at": null,
        "completed_at": "2017-03-29 21:07:36 UTC",
        "contact": {
          "id": "contact_3838",
          "created_at": "2017-03-29 21:07:35 UTC",
          "updated_at": "2017-03-29 21:07:35 UTC",
          "first_name": "Clement",
          "last_name": "Anderson",
          "company": null,
          "location": null,
          "title": "Corporate Secretary",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "7fd5c248-d972-432a-b7b0-cd8f6027ca13",
              "full_address": "North Giovanna",
              "label": "Mobile",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3680",
              "label": null,
              "address": "clement.anderson@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "820994c6-b143-4b1a-98e9-3d3680ee5490",
              "label": "LinkedIn",
              "url": "http://howe.name"
            }
          ],
          "websites": [
            {
              "id": "ff3fb18e-fe37-4614-b337-e5c4b9332bd2",
              "label": "Business",
              "address": "http://hagenesbrown.ca"
            }
          ],
          "phone_numbers": [
            {
              "id": "68082bb1-a546-4f4e-9bf6-b84d38871395",
              "label": "Home",
              "number": "(447)476-4478 x03265"
            }
          ],
          "custom_fields": [],
          "extra_data": {
            "last_contacted": null,
            "muted_at": null,
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "user_last_contacted_at": null,
            "buckets": [],
            "sources": [],
            "followup_source": null,
            "lead_pools": [],
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        },
        "created_by": null,
        "assigned_by": null,
        "assigned_to": {
          "id": "user_179",
          "created_at": "2017-03-29 21:07:34 UTC",
          "updated_at": "2017-03-29 21:07:34 UTC",
          "first_name": "Rozella",
          "last_name": "Funk",
          "email": "rozella.funk@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        }
      }
    }
  ]
}

Tasks List
GET/v2/me/tasks{?created_at.before,created_at.after,updated_at.before,updated_at.after,page,order,due_at.before,due_at.after,completed_at.before,completed_at.after,completed}

🔒 tasks:view tasks:manage all:view all:manage

URI Parameters
HideShow
created_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
created_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
updated_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
updated_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
page
number (optional) Example: 2

50/page

due_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
due_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
completed_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
completed_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
completed
boolean (optional) Example: false
order
string (optional) Example: -due_at

Can be ordered by id, created_at, updated_at, due_at, or completed_at. Defaults to -due_at,-created_at. - denotes “descending”


Buckets

List

GET https://api.contactually.com/v2/buckets?created_at.before=2016-08-29T15:31:49-04:00&created_at.after=2016-08-29T15:31:49-04:00&updated_at.before=2016-08-29T15:31:49-04:00&updated_at.after=2016-08-29T15:31:49-04:00&page=2&order=sort_order&q=Top+Contacts
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "bucket_2216",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "name": "Synchronised asynchronous circuit",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "cloned_from_id": null,
        "contact_count": 1,
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc06319d298>",
        "lead_pool": null
      }
    },
    {
      "id": "bucket_2217",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "name": "Reactive bifurcated artificial intelligence",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "cloned_from_id": null,
        "contact_count": 1,
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc05fe5e968>",
        "lead_pool": null
      }
    },
    {
      "id": "bucket_2218",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "name": "Intuitive user-facing database",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "cloned_from_id": null,
        "contact_count": 3,
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc061b3e9e8>",
        "lead_pool": null
      }
    }
  ]
}

List
GET/v2/buckets{?created_at.before,created_at.after,updated_at.before,updated_at.after,page,order,q}

🔒 buckets:view buckets:manage all:view all:manage

URI Parameters
HideShow
created_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
created_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
updated_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
updated_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
page
number (optional) Example: 2

50/page

q
string (optional) Example: Top+Contacts

Search term, matches on name

order
string (optional) Example: sort_order

Can be ordered by id, created_at, updated_at, or sort_order (the order the user has manually specified). Defaults to sort_order. - denotes “descending”


Create

POST https://api.contactually.com/v2/buckets
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": {
    "name": "Hot Leads",
    "goal": "Convert to sales as quickly as possible",
    "reminder_interval": 30
  }
}
Responses200
Body
{
  "data": {
    "id": "bucket_2218",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "name": "Intuitive user-facing database",
    "goal": null,
    "reminder_interval": null,
    "extra_data": {
      "cloned_from_id": null,
      "contact_count": 3,
      "relationship_status": {
        "none": 0,
        "strong": 0,
        "fading": 0,
        "weak": 0,
        "rpa": 0,
        "grade": "C-",
        "total": 0
      },
      "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc061b3e9e8>",
      "lead_pool": null
    }
  },
  "meta": {}
}

Create
POST/v2/buckets

🔒 buckets:manage all:manage


Fetch

GET https://api.contactually.com/v2/buckets/bucket_43
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "bucket_2218",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "name": "Intuitive user-facing database",
    "goal": null,
    "reminder_interval": null,
    "extra_data": {
      "cloned_from_id": null,
      "contact_count": 3,
      "relationship_status": {
        "none": 0,
        "strong": 0,
        "fading": 0,
        "weak": 0,
        "rpa": 0,
        "grade": "C-",
        "total": 0
      },
      "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc061b3e9e8>",
      "lead_pool": null
    }
  },
  "meta": {}
}

Fetch
GET/v2/buckets/{id}

🔒 buckets:view buckets:manage all:view all:manage

URI Parameters
HideShow
id
string (required) Example: bucket_43

Bucket identifier


Update

PATCH https://api.contactually.com/v2/buckets/bucket_43
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": {
    "name": "Hot Leads",
    "goal": "Convert to sales as quickly as possible",
    "reminder_interval": 30
  }
}
Responses200
Body
{
  "data": {
    "id": "bucket_2218",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "name": "Intuitive user-facing database",
    "goal": null,
    "reminder_interval": null,
    "extra_data": {
      "cloned_from_id": null,
      "contact_count": 3,
      "relationship_status": {
        "none": 0,
        "strong": 0,
        "fading": 0,
        "weak": 0,
        "rpa": 0,
        "grade": "C-",
        "total": 0
      },
      "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc061b3e9e8>",
      "lead_pool": null
    }
  },
  "meta": {}
}

Update
PATCH/v2/buckets/{id}

🔒 buckets:manage all:manage

URI Parameters
HideShow
id
string (required) Example: bucket_43

Bucket identifier


Delete

DELETE https://api.contactually.com/v2/buckets/bucket_43
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "bucket_2218",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "name": "Intuitive user-facing database",
    "goal": null,
    "reminder_interval": null,
    "extra_data": {
      "cloned_from_id": null,
      "contact_count": 3,
      "relationship_status": {
        "none": 0,
        "strong": 0,
        "fading": 0,
        "weak": 0,
        "rpa": 0,
        "grade": "C-",
        "total": 0
      },
      "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc061b3e9e8>",
      "lead_pool": null
    }
  },
  "meta": {}
}

Delete
DELETE/v2/buckets/{id}

This action does not delete the contacts within the bucket.

🔒 buckets:manage all:manage

URI Parameters
HideShow
id
string (required) Example: bucket_43

Bucket identifier


Contacts

GET https://api.contactually.com/v2/buckets/bucket_43/contacts
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "contact_3837",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "first_name": "Americo",
      "last_name": "Torphy",
      "company": null,
      "location": null,
      "title": "Assistant Vice Manager",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
          "full_address": "Schmidttown",
          "label": "Office",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3679",
          "label": null,
          "address": "americo.torphy@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "2dc8be05-b621-4878-af37-53b19be46be9",
          "label": "LinkedIn",
          "url": "http://reichert.biz"
        }
      ],
      "websites": [
        {
          "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
          "label": "Social",
          "address": "http://ogabecker.biz"
        }
      ],
      "phone_numbers": [
        {
          "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
          "label": "Corner Payphone",
          "number": "1-997-565-7190"
        }
      ],
      "custom_fields": [],
      "extra_data": {
        "last_contacted": null,
        "muted_at": null,
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "user_last_contacted_at": null,
        "buckets": [
          {
            "id": "bucket_2217",
            "name": "Reactive bifurcated artificial intelligence",
            "reminder_interval": null
          },
          {
            "id": "bucket_2216",
            "name": "Synchronised asynchronous circuit",
            "reminder_interval": null
          }
        ],
        "sources": [],
        "followup_source": null,
        "lead_pools": [],
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3838",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "first_name": "Clement",
      "last_name": "Anderson",
      "company": null,
      "location": null,
      "title": "Corporate Secretary",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "7fd5c248-d972-432a-b7b0-cd8f6027ca13",
          "full_address": "North Giovanna",
          "label": "Mobile",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3680",
          "label": null,
          "address": "clement.anderson@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "820994c6-b143-4b1a-98e9-3d3680ee5490",
          "label": "LinkedIn",
          "url": "http://howe.name"
        }
      ],
      "websites": [
        {
          "id": "ff3fb18e-fe37-4614-b337-e5c4b9332bd2",
          "label": "Business",
          "address": "http://hagenesbrown.ca"
        }
      ],
      "phone_numbers": [
        {
          "id": "68082bb1-a546-4f4e-9bf6-b84d38871395",
          "label": "Home",
          "number": "(447)476-4478 x03265"
        }
      ],
      "custom_fields": [],
      "extra_data": {
        "last_contacted": null,
        "muted_at": null,
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "user_last_contacted_at": null,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "lead_pools": [],
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3839",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "first_name": "Freda",
      "last_name": "Nikolaus",
      "company": null,
      "location": null,
      "title": "General Consultant",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "051b4d2f-67ef-4072-b24c-c00ba88335b6",
          "full_address": "Bernierstad",
          "label": "Home",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3681",
          "label": null,
          "address": "freda.nikolaus@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "daa91938-7ce0-4d16-9a9d-eb621ed09738",
          "label": "Facebook",
          "url": "http://erdman.info"
        }
      ],
      "websites": [
        {
          "id": "41affcc5-8add-442d-b370-1a4006a384b7",
          "label": "Business",
          "address": "http://stroman.us"
        }
      ],
      "phone_numbers": [
        {
          "id": "b988e3c0-2ad5-40a9-bbe4-7b43379b0dea",
          "label": "Home",
          "number": "1-959-321-8342 x6311"
        }
      ],
      "custom_fields": [],
      "extra_data": {
        "last_contacted": null,
        "muted_at": "2017-03-29 21:07:37 UTC",
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "user_last_contacted_at": null,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "lead_pools": [],
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    }
  ]
}

List
GET/v2/buckets/{id}/contacts

URI Parameters
HideShow
id
string (required) Example: bucket_43

Bucket identifier


POST https://api.contactually.com/v2/buckets/bucket_43/contacts
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": [
    {
      "id": "contact_234"
    }
  ]
}
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "contact_3837",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "first_name": "Americo",
      "last_name": "Torphy",
      "company": null,
      "location": null,
      "title": "Assistant Vice Manager",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
          "full_address": "Schmidttown",
          "label": "Office",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3679",
          "label": null,
          "address": "americo.torphy@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "2dc8be05-b621-4878-af37-53b19be46be9",
          "label": "LinkedIn",
          "url": "http://reichert.biz"
        }
      ],
      "websites": [
        {
          "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
          "label": "Social",
          "address": "http://ogabecker.biz"
        }
      ],
      "phone_numbers": [
        {
          "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
          "label": "Corner Payphone",
          "number": "1-997-565-7190"
        }
      ],
      "custom_fields": [],
      "extra_data": {
        "last_contacted": null,
        "muted_at": null,
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "user_last_contacted_at": null,
        "buckets": [
          {
            "id": "bucket_2217",
            "name": "Reactive bifurcated artificial intelligence",
            "reminder_interval": null
          },
          {
            "id": "bucket_2216",
            "name": "Synchronised asynchronous circuit",
            "reminder_interval": null
          }
        ],
        "sources": [],
        "followup_source": null,
        "lead_pools": [],
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3838",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "first_name": "Clement",
      "last_name": "Anderson",
      "company": null,
      "location": null,
      "title": "Corporate Secretary",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "7fd5c248-d972-432a-b7b0-cd8f6027ca13",
          "full_address": "North Giovanna",
          "label": "Mobile",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3680",
          "label": null,
          "address": "clement.anderson@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "820994c6-b143-4b1a-98e9-3d3680ee5490",
          "label": "LinkedIn",
          "url": "http://howe.name"
        }
      ],
      "websites": [
        {
          "id": "ff3fb18e-fe37-4614-b337-e5c4b9332bd2",
          "label": "Business",
          "address": "http://hagenesbrown.ca"
        }
      ],
      "phone_numbers": [
        {
          "id": "68082bb1-a546-4f4e-9bf6-b84d38871395",
          "label": "Home",
          "number": "(447)476-4478 x03265"
        }
      ],
      "custom_fields": [],
      "extra_data": {
        "last_contacted": null,
        "muted_at": null,
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "user_last_contacted_at": null,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "lead_pools": [],
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3839",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "first_name": "Freda",
      "last_name": "Nikolaus",
      "company": null,
      "location": null,
      "title": "General Consultant",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "051b4d2f-67ef-4072-b24c-c00ba88335b6",
          "full_address": "Bernierstad",
          "label": "Home",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3681",
          "label": null,
          "address": "freda.nikolaus@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "daa91938-7ce0-4d16-9a9d-eb621ed09738",
          "label": "Facebook",
          "url": "http://erdman.info"
        }
      ],
      "websites": [
        {
          "id": "41affcc5-8add-442d-b370-1a4006a384b7",
          "label": "Business",
          "address": "http://stroman.us"
        }
      ],
      "phone_numbers": [
        {
          "id": "b988e3c0-2ad5-40a9-bbe4-7b43379b0dea",
          "label": "Home",
          "number": "1-959-321-8342 x6311"
        }
      ],
      "custom_fields": [],
      "extra_data": {
        "last_contacted": null,
        "muted_at": "2017-03-29 21:07:37 UTC",
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "user_last_contacted_at": null,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "lead_pools": [],
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    }
  ]
}

Add
POST/v2/buckets/{id}/contacts

🔒 contacts:manage+buckets:manage all:manage

Adds the contacts with the given IDs (if accessible), to the bucket.

URI Parameters
HideShow
id
string (required) Example: bucket_43

Bucket identifier


DELETE https://api.contactually.com/v2/buckets/bucket_43/contacts
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": [
    {
      "id": "contact_234"
    }
  ]
}
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "contact_3837",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "first_name": "Americo",
      "last_name": "Torphy",
      "company": null,
      "location": null,
      "title": "Assistant Vice Manager",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
          "full_address": "Schmidttown",
          "label": "Office",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3679",
          "label": null,
          "address": "americo.torphy@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "2dc8be05-b621-4878-af37-53b19be46be9",
          "label": "LinkedIn",
          "url": "http://reichert.biz"
        }
      ],
      "websites": [
        {
          "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
          "label": "Social",
          "address": "http://ogabecker.biz"
        }
      ],
      "phone_numbers": [
        {
          "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
          "label": "Corner Payphone",
          "number": "1-997-565-7190"
        }
      ],
      "custom_fields": [],
      "extra_data": {
        "last_contacted": null,
        "muted_at": null,
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "user_last_contacted_at": null,
        "buckets": [
          {
            "id": "bucket_2217",
            "name": "Reactive bifurcated artificial intelligence",
            "reminder_interval": null
          },
          {
            "id": "bucket_2216",
            "name": "Synchronised asynchronous circuit",
            "reminder_interval": null
          }
        ],
        "sources": [],
        "followup_source": null,
        "lead_pools": [],
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3838",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "first_name": "Clement",
      "last_name": "Anderson",
      "company": null,
      "location": null,
      "title": "Corporate Secretary",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "7fd5c248-d972-432a-b7b0-cd8f6027ca13",
          "full_address": "North Giovanna",
          "label": "Mobile",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3680",
          "label": null,
          "address": "clement.anderson@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "820994c6-b143-4b1a-98e9-3d3680ee5490",
          "label": "LinkedIn",
          "url": "http://howe.name"
        }
      ],
      "websites": [
        {
          "id": "ff3fb18e-fe37-4614-b337-e5c4b9332bd2",
          "label": "Business",
          "address": "http://hagenesbrown.ca"
        }
      ],
      "phone_numbers": [
        {
          "id": "68082bb1-a546-4f4e-9bf6-b84d38871395",
          "label": "Home",
          "number": "(447)476-4478 x03265"
        }
      ],
      "custom_fields": [],
      "extra_data": {
        "last_contacted": null,
        "muted_at": null,
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "user_last_contacted_at": null,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "lead_pools": [],
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3839",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "first_name": "Freda",
      "last_name": "Nikolaus",
      "company": null,
      "location": null,
      "title": "General Consultant",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "051b4d2f-67ef-4072-b24c-c00ba88335b6",
          "full_address": "Bernierstad",
          "label": "Home",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3681",
          "label": null,
          "address": "freda.nikolaus@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "daa91938-7ce0-4d16-9a9d-eb621ed09738",
          "label": "Facebook",
          "url": "http://erdman.info"
        }
      ],
      "websites": [
        {
          "id": "41affcc5-8add-442d-b370-1a4006a384b7",
          "label": "Business",
          "address": "http://stroman.us"
        }
      ],
      "phone_numbers": [
        {
          "id": "b988e3c0-2ad5-40a9-bbe4-7b43379b0dea",
          "label": "Home",
          "number": "1-959-321-8342 x6311"
        }
      ],
      "custom_fields": [],
      "extra_data": {
        "last_contacted": null,
        "muted_at": "2017-03-29 21:07:37 UTC",
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "user_last_contacted_at": null,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "lead_pools": [],
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    }
  ]
}

Remove
DELETE/v2/buckets/{id}/contacts

🔒 contacts:manage+buckets:manage all:manage

Removes the contacts with the given IDs (if accessible), to the bucket.

URI Parameters
HideShow
id
string (required) Example: bucket_43

Bucket identifier


Contacts

List

GET https://api.contactually.com/v2/contacts?created_at.before=2016-08-29T15:31:49-04:00&created_at.after=2016-08-29T15:31:49-04:00&updated_at.before=2016-08-29T15:31:49-04:00&updated_at.after=2016-08-29T15:31:49-04:00&page=2&order=-created_at&company=Amalgamated Widget, Ltd.&tags=awesome&buckets=buckets_123&q=Samantha&custom_field_1=blue&team_search=true
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "contact_3837",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "first_name": "Americo",
      "last_name": "Torphy",
      "company": null,
      "location": null,
      "title": "Assistant Vice Manager",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
          "full_address": "Schmidttown",
          "label": "Office",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3679",
          "label": null,
          "address": "americo.torphy@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "2dc8be05-b621-4878-af37-53b19be46be9",
          "label": "LinkedIn",
          "url": "http://reichert.biz"
        }
      ],
      "websites": [
        {
          "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
          "label": "Social",
          "address": "http://ogabecker.biz"
        }
      ],
      "phone_numbers": [
        {
          "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
          "label": "Corner Payphone",
          "number": "1-997-565-7190"
        }
      ],
      "custom_fields": [],
      "extra_data": {
        "last_contacted": null,
        "muted_at": null,
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "user_last_contacted_at": null,
        "buckets": [
          {
            "id": "bucket_2217",
            "name": "Reactive bifurcated artificial intelligence",
            "reminder_interval": null
          },
          {
            "id": "bucket_2216",
            "name": "Synchronised asynchronous circuit",
            "reminder_interval": null
          }
        ],
        "sources": [],
        "followup_source": null,
        "lead_pools": [],
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3838",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "first_name": "Clement",
      "last_name": "Anderson",
      "company": null,
      "location": null,
      "title": "Corporate Secretary",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "7fd5c248-d972-432a-b7b0-cd8f6027ca13",
          "full_address": "North Giovanna",
          "label": "Mobile",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3680",
          "label": null,
          "address": "clement.anderson@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "820994c6-b143-4b1a-98e9-3d3680ee5490",
          "label": "LinkedIn",
          "url": "http://howe.name"
        }
      ],
      "websites": [
        {
          "id": "ff3fb18e-fe37-4614-b337-e5c4b9332bd2",
          "label": "Business",
          "address": "http://hagenesbrown.ca"
        }
      ],
      "phone_numbers": [
        {
          "id": "68082bb1-a546-4f4e-9bf6-b84d38871395",
          "label": "Home",
          "number": "(447)476-4478 x03265"
        }
      ],
      "custom_fields": [],
      "extra_data": {
        "last_contacted": null,
        "muted_at": null,
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "user_last_contacted_at": null,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "lead_pools": [],
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3839",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "first_name": "Freda",
      "last_name": "Nikolaus",
      "company": null,
      "location": null,
      "title": "General Consultant",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "051b4d2f-67ef-4072-b24c-c00ba88335b6",
          "full_address": "Bernierstad",
          "label": "Home",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3681",
          "label": null,
          "address": "freda.nikolaus@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "daa91938-7ce0-4d16-9a9d-eb621ed09738",
          "label": "Facebook",
          "url": "http://erdman.info"
        }
      ],
      "websites": [
        {
          "id": "41affcc5-8add-442d-b370-1a4006a384b7",
          "label": "Business",
          "address": "http://stroman.us"
        }
      ],
      "phone_numbers": [
        {
          "id": "b988e3c0-2ad5-40a9-bbe4-7b43379b0dea",
          "label": "Home",
          "number": "1-959-321-8342 x6311"
        }
      ],
      "custom_fields": [],
      "extra_data": {
        "last_contacted": null,
        "muted_at": "2017-03-29 21:07:37 UTC",
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "user_last_contacted_at": null,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "lead_pools": [],
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    }
  ]
}

List
GET/v2/contacts{?created_at.before,created_at.after,updated_at.before,updated_at.after,page,order,company,tags,buckets,q,custom_field_1,team_search}

🔒 contacts:view contacts:manage all:view all:manage

Contacts will be matched via first_name and/or last_name.

URI Parameters
HideShow
created_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
created_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
updated_at.before
string (optional) Example: 2016-08-29T15:31:49-04:00
updated_at.after
string (optional) Example: 2016-08-29T15:31:49-04:00
page
number (optional) Example: 2

50/page

team_search
string (optional) Example: true

Include contacts the user has access to through their team, but not directly connected to (e.g. had an interaction with the contact themselves)

company
string (optional) Example: Amalgamated Widget, Ltd.

Exact string matching

tags
string (optional) Example: awesome

linked tags

buckets
string (optional) Example: buckets_123

IDs of linked buckets

q
string (optional) Example: Samantha

Search term, matches across first_name, last_name, title, company, and email

custom_field_1
string (optional) Example: blue

The key is custom_field_#{id}, used to search for custom field values. You can combine multiple custom_field params

order
string (optional) Example: -created_at

Can be ordered by id, created_at, updated_at, first_name, or last_name. Defaults to ascending, - denotes “descending”


Create

POST https://api.contactually.com/v2/contacts
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": {
    "first_name": "Gustavo",
    "last_name": "Treutel",
    "company": "Amalgamated Widget, Ltd.",
    "title": "Operations Director",
    "avatar_url": "http://lorempixel.com/g/200/200/",
    "tags": [
      "blue",
      "green"
    ],
    "addresses": [
      {
        "label": "Office",
        "street_1": "9467 Ryan Court",
        "city": "Williamstown",
        "state": "NJ",
        "zip": "08094",
        "country": "USA"
      }
    ],
    "email_addresses": [
      {
        "label": "Work",
        "address": "gustavo.treutel@example.com"
      }
    ],
    "social_media_profiles": [
      {
        "label": "LinkedIn",
        "url": "https://www.linkedin.com/gtreutel"
      }
    ],
    "websites": [
      {
        "label": "Personal",
        "address": "https://www.gustavot.com"
      }
    ],
    "phone_numbers": [
      {
        "label": "Work",
        "number": "123"
      }
    ],
    "custom_field_values": [
      {
        "field": {
          "id": "custom_field_123"
        },
        "value": "3 bed, 2 bath"
      }
    ]
  }
}
Responses200
Body
{
  "data": {
    "id": "contact_3837",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "first_name": "Americo",
    "last_name": "Torphy",
    "company": null,
    "location": null,
    "title": "Assistant Vice Manager",
    "avatar_url": null,
    "tags": [],
    "assigned_to_id": null,
    "addresses": [
      {
        "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
        "full_address": "Schmidttown",
        "label": "Office",
        "street_1": null,
        "street_2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country": null
      }
    ],
    "email_addresses": [
      {
        "id": "contact_identity_3679",
        "label": null,
        "address": "americo.torphy@example.com"
      }
    ],
    "social_media_profiles": [
      {
        "id": "2dc8be05-b621-4878-af37-53b19be46be9",
        "label": "LinkedIn",
        "url": "http://reichert.biz"
      }
    ],
    "websites": [
      {
        "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
        "label": "Social",
        "address": "http://ogabecker.biz"
      }
    ],
    "phone_numbers": [
      {
        "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
        "label": "Corner Payphone",
        "number": "1-997-565-7190"
      }
    ],
    "custom_fields": [],
    "extra_data": {
      "last_contacted": null,
      "muted_at": null,
      "relationship_status": "none",
      "team_last_contacted_at": null,
      "team_last_contacted_by_id": null,
      "last_bucketed_at": null,
      "user_last_contacted_at": null,
      "buckets": [
        {
          "id": "bucket_2217",
          "name": "Reactive bifurcated artificial intelligence",
          "reminder_interval": null
        },
        {
          "id": "bucket_2216",
          "name": "Synchronised asynchronous circuit",
          "reminder_interval": null
        }
      ],
      "sources": [],
      "followup_source": null,
      "lead_pools": [],
      "team_last_contacted_by": null,
      "associated_tags": [],
      "associated_company": null,
      "associated_location": null,
      "assigned_to": null
    }
  },
  "meta": {}
}

Create
POST/v2/contacts

🔒 contacts:manage all:manage


Fetch

GET https://api.contactually.com/v2/contacts/contact_43
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "contact_3837",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "first_name": "Americo",
    "last_name": "Torphy",
    "company": null,
    "location": null,
    "title": "Assistant Vice Manager",
    "avatar_url": null,
    "tags": [],
    "assigned_to_id": null,
    "addresses": [
      {
        "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
        "full_address": "Schmidttown",
        "label": "Office",
        "street_1": null,
        "street_2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country": null
      }
    ],
    "email_addresses": [
      {
        "id": "contact_identity_3679",
        "label": null,
        "address": "americo.torphy@example.com"
      }
    ],
    "social_media_profiles": [
      {
        "id": "2dc8be05-b621-4878-af37-53b19be46be9",
        "label": "LinkedIn",
        "url": "http://reichert.biz"
      }
    ],
    "websites": [
      {
        "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
        "label": "Social",
        "address": "http://ogabecker.biz"
      }
    ],
    "phone_numbers": [
      {
        "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
        "label": "Corner Payphone",
        "number": "1-997-565-7190"
      }
    ],
    "custom_fields": [],
    "extra_data": {
      "last_contacted": null,
      "muted_at": null,
      "relationship_status": "none",
      "team_last_contacted_at": null,
      "team_last_contacted_by_id": null,
      "last_bucketed_at": null,
      "user_last_contacted_at": null,
      "buckets": [
        {
          "id": "bucket_2217",
          "name": "Reactive bifurcated artificial intelligence",
          "reminder_interval": null
        },
        {
          "id": "bucket_2216",
          "name": "Synchronised asynchronous circuit",
          "reminder_interval": null
        }
      ],
      "sources": [],
      "followup_source": null,
      "lead_pools": [],
      "team_last_contacted_by": null,
      "associated_tags": [],
      "associated_company": null,
      "associated_location": null,
      "assigned_to": null
    }
  },
  "meta": {}
}

Fetch
GET/v2/contacts/{id}

🔒 contacts:view contacts:manage all:view all:manage

URI Parameters
HideShow
id
string (required) Example: contact_43

Contact identifier


Update

PATCH https://api.contactually.com/v2/contacts/contact_43
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": {
    "first_name": "Gustavo",
    "last_name": "Treutel",
    "company": "Amalgamated Widget, Ltd.",
    "title": "Operations Director",
    "avatar_url": "http://lorempixel.com/g/200/200/",
    "tags": [
      "blue",
      "green"
    ],
    "addresses": [
      {
        "label": "Office",
        "street_1": "9467 Ryan Court",
        "city": "Williamstown",
        "state": "NJ",
        "zip": "08094",
        "country": "USA"
      }
    ],
    "email_addresses": [
      {
        "label": "Work",
        "address": "gustavo.treutel@example.com"
      }
    ],
    "social_media_profiles": [
      {
        "label": "LinkedIn",
        "url": "https://www.linkedin.com/gtreutel"
      }
    ],
    "websites": [
      {
        "label": "Personal",
        "address": "https://www.gustavot.com"
      }
    ],
    "phone_numbers": [
      {
        "label": "Work",
        "number": "123"
      }
    ],
    "custom_field_values": [
      {
        "field": {
          "id": "custom_field_123"
        },
        "value": "3 bed, 2 bath"
      }
    ]
  }
}
Responses200
Body
{
  "data": {
    "id": "contact_3837",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "first_name": "Americo",
    "last_name": "Torphy",
    "company": null,
    "location": null,
    "title": "Assistant Vice Manager",
    "avatar_url": null,
    "tags": [],
    "assigned_to_id": null,
    "addresses": [
      {
        "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
        "full_address": "Schmidttown",
        "label": "Office",
        "street_1": null,
        "street_2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country": null
      }
    ],
    "email_addresses": [
      {
        "id": "contact_identity_3679",
        "label": null,
        "address": "americo.torphy@example.com"
      }
    ],
    "social_media_profiles": [
      {
        "id": "2dc8be05-b621-4878-af37-53b19be46be9",
        "label": "LinkedIn",
        "url": "http://reichert.biz"
      }
    ],
    "websites": [
      {
        "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
        "label": "Social",
        "address": "http://ogabecker.biz"
      }
    ],
    "phone_numbers": [
      {
        "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
        "label": "Corner Payphone",
        "number": "1-997-565-7190"
      }
    ],
    "custom_fields": [],
    "extra_data": {
      "last_contacted": null,
      "muted_at": null,
      "relationship_status": "none",
      "team_last_contacted_at": null,
      "team_last_contacted_by_id": null,
      "last_bucketed_at": null,
      "user_last_contacted_at": null,
      "buckets": [
        {
          "id": "bucket_2217",
          "name": "Reactive bifurcated artificial intelligence",
          "reminder_interval": null
        },
        {
          "id": "bucket_2216",
          "name": "Synchronised asynchronous circuit",
          "reminder_interval": null
        }
      ],
      "sources": [],
      "followup_source": null,
      "lead_pools": [],
      "team_last_contacted_by": null,
      "associated_tags": [],
      "associated_company": null,
      "associated_location": null,
      "assigned_to": null
    }
  },
  "meta": {}
}

Update
PATCH/v2/contacts/{id}

🔒 contacts:manage all:manage

URI Parameters
HideShow
id
string (required) Example: contact_43

Contact identifier


Delete

DELETE https://api.contactually.com/v2/contacts/contact_43
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "contact_3837",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "first_name": "Americo",
    "last_name": "Torphy",
    "company": null,
    "location": null,
    "title": "Assistant Vice Manager",
    "avatar_url": null,
    "tags": [],
    "assigned_to_id": null,
    "addresses": [
      {
        "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
        "full_address": "Schmidttown",
        "label": "Office",
        "street_1": null,
        "street_2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country": null
      }
    ],
    "email_addresses": [
      {
        "id": "contact_identity_3679",
        "label": null,
        "address": "americo.torphy@example.com"
      }
    ],
    "social_media_profiles": [
      {
        "id": "2dc8be05-b621-4878-af37-53b19be46be9",
        "label": "LinkedIn",
        "url": "http://reichert.biz"
      }
    ],
    "websites": [
      {
        "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
        "label": "Social",
        "address": "http://ogabecker.biz"
      }
    ],
    "phone_numbers": [
      {
        "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
        "label": "Corner Payphone",
        "number": "1-997-565-7190"
      }
    ],
    "custom_fields": [],
    "extra_data": {
      "last_contacted": null,
      "muted_at": null,
      "relationship_status": "none",
      "team_last_contacted_at": null,
      "team_last_contacted_by_id": null,
      "last_bucketed_at": null,
      "user_last_contacted_at": null,
      "buckets": [
        {
          "id": "bucket_2217",
          "name": "Reactive bifurcated artificial intelligence",
          "reminder_interval": null
        },
        {
          "id": "bucket_2216",
          "name": "Synchronised asynchronous circuit",
          "reminder_interval": null
        }
      ],
      "sources": [],
      "followup_source": null,
      "lead_pools": [],
      "team_last_contacted_by": null,
      "associated_tags": [],
      "associated_company": null,
      "associated_location": null,
      "assigned_to": null
    }
  },
  "meta": {}
}

Delete
DELETE/v2/contacts/{id}

🔒 contacts:manage all:manage

URI Parameters
HideShow
id
string (required) Example: contact_43

Contact identifier


Merge

POST https://api.contactually.com/v2/contacts/contact_43/merge
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": [
    {
      "contact_ids": [
        "contact_2391",
        "contact_989"
      ]
    }
  ]
}
Responses200
Body
{
  "data": {
    "id": "contact_3837",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "first_name": "Americo",
    "last_name": "Torphy",
    "company": null,
    "location": null,
    "title": "Assistant Vice Manager",
    "avatar_url": null,
    "tags": [],
    "assigned_to_id": null,
    "addresses": [
      {
        "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
        "full_address": "Schmidttown",
        "label": "Office",
        "street_1": null,
        "street_2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country": null
      }
    ],
    "email_addresses": [
      {
        "id": "contact_identity_3679",
        "label": null,
        "address": "americo.torphy@example.com"
      }
    ],
    "social_media_profiles": [
      {
        "id": "2dc8be05-b621-4878-af37-53b19be46be9",
        "label": "LinkedIn",
        "url": "http://reichert.biz"
      }
    ],
    "websites": [
      {
        "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
        "label": "Social",
        "address": "http://ogabecker.biz"
      }
    ],
    "phone_numbers": [
      {
        "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
        "label": "Corner Payphone",
        "number": "1-997-565-7190"
      }
    ],
    "custom_fields": [],
    "extra_data": {
      "last_contacted": null,
      "muted_at": null,
      "relationship_status": "none",
      "team_last_contacted_at": null,
      "team_last_contacted_by_id": null,
      "last_bucketed_at": null,
      "user_last_contacted_at": null,
      "buckets": [
        {
          "id": "bucket_2217",
          "name": "Reactive bifurcated artificial intelligence",
          "reminder_interval": null
        },
        {
          "id": "bucket_2216",
          "name": "Synchronised asynchronous circuit",
          "reminder_interval": null
        }
      ],
      "sources": [],
      "followup_source": null,
      "lead_pools": [],
      "team_last_contacted_by": null,
      "associated_tags": [],
      "associated_company": null,
      "associated_location": null,
      "assigned_to": null
    }
  },
  "meta": {}
}

Merge
POST/v2/contacts/{id}/merge

🔒 contacts:manage all:manage

The contact into which you are merging (the base contact) will have its data overwritten by the attributes of the contacts passed in as parameters.

URI Parameters
HideShow
id
string (required) Example: contact_43

Contact identifier


Buckets

GET https://api.contactually.com/v2/contacts/contact_43/buckets
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "bucket_2216",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "name": "Synchronised asynchronous circuit",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "cloned_from_id": null,
        "contact_count": 1,
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc06319d298>",
        "lead_pool": null
      }
    },
    {
      "id": "bucket_2217",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "name": "Reactive bifurcated artificial intelligence",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "cloned_from_id": null,
        "contact_count": 1,
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc05fe5e968>",
        "lead_pool": null
      }
    }
  ]
}

List
GET/v2/contacts/{id}/buckets

🔒 buckets:view buckets:manage all:view all:manage

URI Parameters
HideShow
id
string (required) Example: contact_43

Contact identifier


POST https://api.contactually.com/v2/contacts/contact_43/buckets
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": [
    {
      "id": "bucket_123"
    }
  ]
}
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "bucket_2216",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "name": "Synchronised asynchronous circuit",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "cloned_from_id": null,
        "contact_count": 1,
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc06319d298>",
        "lead_pool": null
      }
    },
    {
      "id": "bucket_2217",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "name": "Reactive bifurcated artificial intelligence",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "cloned_from_id": null,
        "contact_count": 1,
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc05fe5e968>",
        "lead_pool": null
      }
    }
  ]
}

Add
POST/v2/contacts/{id}/buckets

🔒 contacts:manage+buckets:manage all:manage

URI Parameters
HideShow
id
string (required) Example: contact_43

Contact identifier


PUT https://api.contactually.com/v2/contacts/contact_43/buckets
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": [
    {
      "id": "bucket_123"
    }
  ]
}
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "bucket_2216",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "name": "Synchronised asynchronous circuit",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "cloned_from_id": null,
        "contact_count": 1,
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc06319d298>",
        "lead_pool": null
      }
    },
    {
      "id": "bucket_2217",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "name": "Reactive bifurcated artificial intelligence",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "cloned_from_id": null,
        "contact_count": 1,
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc05fe5e968>",
        "lead_pool": null
      }
    }
  ]
}

Update
PUT/v2/contacts/{id}/buckets

This endpoint acts like a true PUT and will remove the contact from buckets that are not sent, add them to any buckets that are new, and leave the consistent bucketing untouched.

🔒 contacts:manage+buckets:manage all:manage

URI Parameters
HideShow
id
string (required) Example: contact_43

Contact identifier


DELETE https://api.contactually.com/v2/contacts/contact_43/buckets
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": [
    {
      "id": "bucket_123"
    }
  ]
}
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "bucket_2216",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "name": "Synchronised asynchronous circuit",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "cloned_from_id": null,
        "contact_count": 1,
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc06319d298>",
        "lead_pool": null
      }
    },
    {
      "id": "bucket_2217",
      "created_at": "2017-03-29 21:07:35 UTC",
      "updated_at": "2017-03-29 21:07:35 UTC",
      "name": "Reactive bifurcated artificial intelligence",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "cloned_from_id": null,
        "contact_count": 1,
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "permissions": "#<BucketPermission::ActiveRecord_Associations_CollectionProxy:0x007fc05fe5e968>",
        "lead_pool": null
      }
    }
  ]
}

Remove
DELETE/v2/contacts/{id}/buckets

🔒 contacts:manage+buckets:manage all:manage

URI Parameters
HideShow
id
string (required) Example: contact_43

Contact identifier


Interactions

This endpoint serves as a convenience for retrieving all interactions associated with the given contact, however, any edits to those interactions occurs via the /v2/interactions/{id} endpoint.

GET https://api.contactually.com/v2/contacts/contact_43/interactions
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "interaction_5214",
      "created_at": "2017-03-29 21:07:36 UTC",
      "updated_at": "2017-03-29 21:07:36 UTC",
      "body": null,
      "initiated_by_contact": true,
      "subject": "Upgradable next generation monitoring",
      "timestamp": "2017-03-29 21:07:36 UTC",
      "type": "email",
      "participants": [
        {
          "contact_id": "contact_3837",
          "handle": "eep6k49ezai9bthdwhojhg==",
          "extra_data": {
            "first_name": "Americo",
            "last_name": "Torphy",
            "avatar_url": null
          }
        }
      ],
      "extra_data": {
        "editable": true,
        "participant_count": 1,
        "placeholder": false,
        "contact_id": "contact_3837",
        "contact_handle": "eep6k49ezai9bthdwhojhg==",
        "associated_account_id": null,
        "associated_user": {
          "id": "user_179",
          "created_at": "2017-03-29 21:07:34 UTC",
          "updated_at": "2017-03-29 21:07:34 UTC",
          "first_name": "Rozella",
          "last_name": "Funk",
          "email": "rozella.funk@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        },
        "contact": {
          "id": "contact_3837",
          "created_at": "2017-03-29 21:07:35 UTC",
          "updated_at": "2017-03-29 21:07:35 UTC",
          "first_name": "Americo",
          "last_name": "Torphy",
          "company": null,
          "location": null,
          "title": "Assistant Vice Manager",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
              "full_address": "Schmidttown",
              "label": "Office",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3679",
              "label": null,
              "address": "americo.torphy@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "2dc8be05-b621-4878-af37-53b19be46be9",
              "label": "LinkedIn",
              "url": "http://reichert.biz"
            }
          ],
          "websites": [
            {
              "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
              "label": "Social",
              "address": "http://ogabecker.biz"
            }
          ],
          "phone_numbers": [
            {
              "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
              "label": "Corner Payphone",
              "number": "1-997-565-7190"
            }
          ],
          "custom_fields": [],
          "extra_data": {
            "last_contacted": null,
            "muted_at": null,
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "user_last_contacted_at": null,
            "buckets": [
              {
                "id": "bucket_2218",
                "name": "Intuitive user-facing database",
                "reminder_interval": null
              },
              {
                "id": "bucket_2217",
                "name": "Reactive bifurcated artificial intelligence",
                "reminder_interval": null
              },
              {
                "id": "bucket_2216",
                "name": "Synchronised asynchronous circuit",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "lead_pools": [],
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        }
      }
    },
    {
      "id": "interaction_5215",
      "created_at": "2017-03-29 21:07:36 UTC",
      "updated_at": "2017-03-29 21:07:36 UTC",
      "body": null,
      "initiated_by_contact": true,
      "subject": "Distributed intermediate superstructure",
      "timestamp": "2017-03-29 21:07:36 UTC",
      "type": "email",
      "participants": [
        {
          "contact_id": "contact_3837",
          "handle": "ivy0xm8xdkqb7zsametm5w==",
          "extra_data": {
            "first_name": "Americo",
            "last_name": "Torphy",
            "avatar_url": null
          }
        }
      ],
      "extra_data": {
        "editable": true,
        "participant_count": 1,
        "placeholder": false,
        "contact_id": "contact_3837",
        "contact_handle": "ivy0xm8xdkqb7zsametm5w==",
        "associated_account_id": null,
        "associated_user": {
          "id": "user_179",
          "created_at": "2017-03-29 21:07:34 UTC",
          "updated_at": "2017-03-29 21:07:34 UTC",
          "first_name": "Rozella",
          "last_name": "Funk",
          "email": "rozella.funk@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        },
        "contact": {
          "id": "contact_3837",
          "created_at": "2017-03-29 21:07:35 UTC",
          "updated_at": "2017-03-29 21:07:35 UTC",
          "first_name": "Americo",
          "last_name": "Torphy",
          "company": null,
          "location": null,
          "title": "Assistant Vice Manager",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
              "full_address": "Schmidttown",
              "label": "Office",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3679",
              "label": null,
              "address": "americo.torphy@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "2dc8be05-b621-4878-af37-53b19be46be9",
              "label": "LinkedIn",
              "url": "http://reichert.biz"
            }
          ],
          "websites": [
            {
              "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
              "label": "Social",
              "address": "http://ogabecker.biz"
            }
          ],
          "phone_numbers": [
            {
              "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
              "label": "Corner Payphone",
              "number": "1-997-565-7190"
            }
          ],
          "custom_fields": [],
          "extra_data": {
            "last_contacted": null,
            "muted_at": null,
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "user_last_contacted_at": null,
            "buckets": [
              {
                "id": "bucket_2218",
                "name": "Intuitive user-facing database",
                "reminder_interval": null
              },
              {
                "id": "bucket_2217",
                "name": "Reactive bifurcated artificial intelligence",
                "reminder_interval": null
              },
              {
                "id": "bucket_2216",
                "name": "Synchronised asynchronous circuit",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "lead_pools": [],
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        }
      }
    },
    {
      "id": "interaction_5213",
      "created_at": "2017-03-29 21:07:36 UTC",
      "updated_at": "2017-03-29 21:07:36 UTC",
      "body": null,
      "initiated_by_contact": false,
      "subject": "Triple-buffered bi-directional archive",
      "timestamp": "2017-03-29 21:07:35 UTC",
      "type": "email",
      "participants": [
        {
          "contact_id": "contact_3837",
          "handle": "americo.torphy@example.com",
          "extra_data": {
            "first_name": "Americo",
            "last_name": "Torphy",
            "avatar_url": null
          }
        },
        {
          "contact_id": "contact_3838",
          "handle": "clement.anderson@example.com",
          "extra_data": {
            "first_name": "Clement",
            "last_name": "Anderson",
            "avatar_url": null
          }
        },
        {
          "contact_id": "contact_3839",
          "handle": "freda.nikolaus@example.com",
          "extra_data": {
            "first_name": "Freda",
            "last_name": "Nikolaus",
            "avatar_url": null
          }
        }
      ],
      "extra_data": {
        "editable": true,
        "participant_count": 3,
        "placeholder": false,
        "contact_id": "contact_3837",
        "contact_handle": "americo.torphy@example.com",
        "associated_account_id": null,
        "associated_user": {
          "id": "user_179",
          "created_at": "2017-03-29 21:07:34 UTC",
          "updated_at": "2017-03-29 21:07:34 UTC",
          "first_name": "Rozella",
          "last_name": "Funk",
          "email": "rozella.funk@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        },
        "contact": {
          "id": "contact_3837",
          "created_at": "2017-03-29 21:07:35 UTC",
          "updated_at": "2017-03-29 21:07:35 UTC",
          "first_name": "Americo",
          "last_name": "Torphy",
          "company": null,
          "location": null,
          "title": "Assistant Vice Manager",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
              "full_address": "Schmidttown",
              "label": "Office",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3679",
              "label": null,
              "address": "americo.torphy@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "2dc8be05-b621-4878-af37-53b19be46be9",
              "label": "LinkedIn",
              "url": "http://reichert.biz"
            }
          ],
          "websites": [
            {
              "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
              "label": "Social",
              "address": "http://ogabecker.biz"
            }
          ],
          "phone_numbers": [
            {
              "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
              "label": "Corner Payphone",
              "number": "1-997-565-7190"
            }
          ],
          "custom_fields": [],
          "extra_data": {
            "last_contacted": null,
            "muted_at": null,
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "user_last_contacted_at": null,
            "buckets": [
              {
                "id": "bucket_2218",
                "name": "Intuitive user-facing database",
                "reminder_interval": null
              },
              {
                "id": "bucket_2217",
                "name": "Reactive bifurcated artificial intelligence",
                "reminder_interval": null
              },
              {
                "id": "bucket_2216",
                "name": "Synchronised asynchronous circuit",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "lead_pools": [],
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        }
      }
    }
  ]
}

Interactions List
GET/v2/contacts/{id}/interactions

🔒 interactions:view interactions:manage all:view all:manage

URI Parameters
HideShow
id
string (required) Example: contact_43

Contact identifier


Notes

This endpoint serves as a convenience for retrieving all notes associated with the given contact, however, any edits to those notes occurs via the /v2/notes/{id} endpoint.

GET https://api.contactually.com/v2/contacts/contact_43/notes
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "note_27",
      "created_at": "2017-03-29 21:07:36 UTC",
      "updated_at": "2017-03-29 21:07:36 UTC",
      "body": "Maxime qui vel non vitae perferendis eveniet et nulla et aperiam fugiat accusamus et nam.",
      "contact_id": "contact_3837",
      "timestamp": "2017-03-29 21:07:36 UTC",
      "extra_data": {
        "author": {
          "id": "user_179",
          "created_at": "2017-03-29 21:07:34 UTC",
          "updated_at": "2017-03-29 21:07:34 UTC",
          "first_name": "Rozella",
          "last_name": "Funk",
          "email": "rozella.funk@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        },
        "contact": {
          "id": "contact_3837",
          "created_at": "2017-03-29 21:07:35 UTC",
          "updated_at": "2017-03-29 21:07:35 UTC",
          "first_name": "Americo",
          "last_name": "Torphy",
          "company": null,
          "location": null,
          "title": "Assistant Vice Manager",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
              "full_address": "Schmidttown",
              "label": "Office",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3679",
              "label": null,
              "address": "americo.torphy@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "2dc8be05-b621-4878-af37-53b19be46be9",
              "label": "LinkedIn",
              "url": "http://reichert.biz"
            }
          ],
          "websites": [
            {
              "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
              "label": "Social",
              "address": "http://ogabecker.biz"
            }
          ],
          "phone_numbers": [
            {
              "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
              "label": "Corner Payphone",
              "number": "1-997-565-7190"
            }
          ],
          "custom_fields": [],
          "extra_data": {
            "last_contacted": null,
            "muted_at": null,
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "user_last_contacted_at": null,
            "buckets": [
              {
                "id": "bucket_2217",
                "name": "Reactive bifurcated artificial intelligence",
                "reminder_interval": null
              },
              {
                "id": "bucket_2216",
                "name": "Synchronised asynchronous circuit",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "lead_pools": [],
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        }
      }
    },
    {
      "id": "note_28",
      "created_at": "2017-03-29 21:07:36 UTC",
      "updated_at": "2017-03-29 21:07:36 UTC",
      "body": "Sit est qui ut occaecati cupiditate sit et sequi ipsam fugit.",
      "contact_id": "contact_3837",
      "timestamp": "2017-03-29 21:07:36 UTC",
      "extra_data": {
        "author": {
          "id": "user_179",
          "created_at": "2017-03-29 21:07:34 UTC",
          "updated_at": "2017-03-29 21:07:34 UTC",
          "first_name": "Rozella",
          "last_name": "Funk",
          "email": "rozella.funk@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        },
        "contact": {
          "id": "contact_3837",
          "created_at": "2017-03-29 21:07:35 UTC",
          "updated_at": "2017-03-29 21:07:35 UTC",
          "first_name": "Americo",
          "last_name": "Torphy",
          "company": null,
          "location": null,
          "title": "Assistant Vice Manager",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
              "full_address": "Schmidttown",
              "label": "Office",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3679",
              "label": null,
              "address": "americo.torphy@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "2dc8be05-b621-4878-af37-53b19be46be9",
              "label": "LinkedIn",
              "url": "http://reichert.biz"
            }
          ],
          "websites": [
            {
              "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
              "label": "Social",
              "address": "http://ogabecker.biz"
            }
          ],
          "phone_numbers": [
            {
              "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
              "label": "Corner Payphone",
              "number": "1-997-565-7190"
            }
          ],
          "custom_fields": [],
          "extra_data": {
            "last_contacted": null,
            "muted_at": null,
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "user_last_contacted_at": null,
            "buckets": [
              {
                "id": "bucket_2217",
                "name": "Reactive bifurcated artificial intelligence",
                "reminder_interval": null
              },
              {
                "id": "bucket_2216",
                "name": "Synchronised asynchronous circuit",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "lead_pools": [],
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        }
      }
    },
    {
      "id": "note_29",
      "created_at": "2017-03-29 21:07:36 UTC",
      "updated_at": "2017-03-29 21:07:36 UTC",
      "body": "Dolores vero incidunt rerum distinctio et atque saepe voluptatum qui consequuntur sit corporis voluptas autem.",
      "contact_id": "contact_3837",
      "timestamp": "2017-03-29 21:07:36 UTC",
      "extra_data": {
        "author": {
          "id": "user_179",
          "created_at": "2017-03-29 21:07:34 UTC",
          "updated_at": "2017-03-29 21:07:34 UTC",
          "first_name": "Rozella",
          "last_name": "Funk",
          "email": "rozella.funk@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        },
        "contact": {
          "id": "contact_3837",
          "created_at": "2017-03-29 21:07:35 UTC",
          "updated_at": "2017-03-29 21:07:35 UTC",
          "first_name": "Americo",
          "last_name": "Torphy",
          "company": null,
          "location": null,
          "title": "Assistant Vice Manager",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
              "full_address": "Schmidttown",
              "label": "Office",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3679",
              "label": null,
              "address": "americo.torphy@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "2dc8be05-b621-4878-af37-53b19be46be9",
              "label": "LinkedIn",
              "url": "http://reichert.biz"
            }
          ],
          "websites": [
            {
              "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
              "label": "Social",
              "address": "http://ogabecker.biz"
            }
          ],
          "phone_numbers": [
            {
              "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
              "label": "Corner Payphone",
              "number": "1-997-565-7190"
            }
          ],
          "custom_fields": [],
          "extra_data": {
            "last_contacted": null,
            "muted_at": null,
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "user_last_contacted_at": null,
            "buckets": [
              {
                "id": "bucket_2217",
                "name": "Reactive bifurcated artificial intelligence",
                "reminder_interval": null
              },
              {
                "id": "bucket_2216",
                "name": "Synchronised asynchronous circuit",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "lead_pools": [],
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        }
      }
    }
  ]
}

Notes List
GET/v2/contacts/{id}/notes

🔒 notes:view notes:manage all:view all:manage

URI Parameters
HideShow
id
string (required) Example: contact_43

Contact identifier


Tasks

This endpoint serves as a convenience for retrieving all tasks associated with the given contact, however, any edits to those tasks occurs via the /v2/tasks/{id} endpoint.

GET https://api.contactually.com/v2/contacts/contact_43/tasks
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "task_534",
      "created_at": "2017-03-29 21:07:36 UTC",
      "updated_at": "2017-03-29 21:07:36 UTC",
      "assigned_to_id": "user_179",
      "contact_id": "contact_3837",
      "due_at": "2017-03-30 21:07:36 UTC",
      "title": "Beatae sequi laborum ut velit soluta reiciendis consequuntur exercitationem corrupti non ut aut.",
      "extra_data": {
        "assigned_at": null,
        "completed_at": null,
        "contact": {
          "id": "contact_3837",
          "created_at": "2017-03-29 21:07:35 UTC",
          "updated_at": "2017-03-29 21:07:35 UTC",
          "first_name": "Americo",
          "last_name": "Torphy",
          "company": null,
          "location": null,
          "title": "Assistant Vice Manager",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
              "full_address": "Schmidttown",
              "label": "Office",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3679",
              "label": null,
              "address": "americo.torphy@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "2dc8be05-b621-4878-af37-53b19be46be9",
              "label": "LinkedIn",
              "url": "http://reichert.biz"
            }
          ],
          "websites": [
            {
              "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
              "label": "Social",
              "address": "http://ogabecker.biz"
            }
          ],
          "phone_numbers": [
            {
              "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
              "label": "Corner Payphone",
              "number": "1-997-565-7190"
            }
          ],
          "custom_fields": [],
          "extra_data": {
            "last_contacted": null,
            "muted_at": null,
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "user_last_contacted_at": null,
            "buckets": [
              {
                "id": "bucket_2218",
                "name": "Intuitive user-facing database",
                "reminder_interval": null
              },
              {
                "id": "bucket_2217",
                "name": "Reactive bifurcated artificial intelligence",
                "reminder_interval": null
              },
              {
                "id": "bucket_2216",
                "name": "Synchronised asynchronous circuit",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "lead_pools": [],
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        },
        "created_by": null,
        "assigned_by": null,
        "assigned_to": {
          "id": "user_179",
          "created_at": "2017-03-29 21:07:34 UTC",
          "updated_at": "2017-03-29 21:07:34 UTC",
          "first_name": "Rozella",
          "last_name": "Funk",
          "email": "rozella.funk@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        }
      }
    },
    {
      "id": "task_533",
      "created_at": "2017-03-29 21:07:36 UTC",
      "updated_at": "2017-03-29 21:07:36 UTC",
      "assigned_to_id": "user_179",
      "contact_id": "contact_3837",
      "due_at": "2017-03-30 21:07:36 UTC",
      "title": "Esse qui quidem natus itaque fugiat repellat suscipit praesentium consequuntur quis voluptatem doloremque.",
      "extra_data": {
        "assigned_at": null,
        "completed_at": null,
        "contact": {
          "id": "contact_3837",
          "created_at": "2017-03-29 21:07:35 UTC",
          "updated_at": "2017-03-29 21:07:35 UTC",
          "first_name": "Americo",
          "last_name": "Torphy",
          "company": null,
          "location": null,
          "title": "Assistant Vice Manager",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
              "full_address": "Schmidttown",
              "label": "Office",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3679",
              "label": null,
              "address": "americo.torphy@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "2dc8be05-b621-4878-af37-53b19be46be9",
              "label": "LinkedIn",
              "url": "http://reichert.biz"
            }
          ],
          "websites": [
            {
              "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
              "label": "Social",
              "address": "http://ogabecker.biz"
            }
          ],
          "phone_numbers": [
            {
              "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
              "label": "Corner Payphone",
              "number": "1-997-565-7190"
            }
          ],
          "custom_fields": [],
          "extra_data": {
            "last_contacted": null,
            "muted_at": null,
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "user_last_contacted_at": null,
            "buckets": [
              {
                "id": "bucket_2218",
                "name": "Intuitive user-facing database",
                "reminder_interval": null
              },
              {
                "id": "bucket_2217",
                "name": "Reactive bifurcated artificial intelligence",
                "reminder_interval": null
              },
              {
                "id": "bucket_2216",
                "name": "Synchronised asynchronous circuit",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "lead_pools": [],
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        },
        "created_by": null,
        "assigned_by": null,
        "assigned_to": {
          "id": "user_179",
          "created_at": "2017-03-29 21:07:34 UTC",
          "updated_at": "2017-03-29 21:07:34 UTC",
          "first_name": "Rozella",
          "last_name": "Funk",
          "email": "rozella.funk@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        }
      }
    },
    {
      "id": "task_532",
      "created_at": "2017-03-29 21:07:36 UTC",
      "updated_at": "2017-03-29 21:07:36 UTC",
      "assigned_to_id": "user_179",
      "contact_id": "contact_3837",
      "due_at": "2017-03-30 21:07:36 UTC",
      "title": "Ut ab consectetur enim occaecati quia veritatis aut officia quasi fuga.",
      "extra_data": {
        "assigned_at": null,
        "completed_at": null,
        "contact": {
          "id": "contact_3837",
          "created_at": "2017-03-29 21:07:35 UTC",
          "updated_at": "2017-03-29 21:07:35 UTC",
          "first_name": "Americo",
          "last_name": "Torphy",
          "company": null,
          "location": null,
          "title": "Assistant Vice Manager",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
              "full_address": "Schmidttown",
              "label": "Office",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3679",
              "label": null,
              "address": "americo.torphy@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "2dc8be05-b621-4878-af37-53b19be46be9",
              "label": "LinkedIn",
              "url": "http://reichert.biz"
            }
          ],
          "websites": [
            {
              "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
              "label": "Social",
              "address": "http://ogabecker.biz"
            }
          ],
          "phone_numbers": [
            {
              "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
              "label": "Corner Payphone",
              "number": "1-997-565-7190"
            }
          ],
          "custom_fields": [],
          "extra_data": {
            "last_contacted": null,
            "muted_at": null,
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "user_last_contacted_at": null,
            "buckets": [
              {
                "id": "bucket_2218",
                "name": "Intuitive user-facing database",
                "reminder_interval": null
              },
              {
                "id": "bucket_2217",
                "name": "Reactive bifurcated artificial intelligence",
                "reminder_interval": null
              },
              {
                "id": "bucket_2216",
                "name": "Synchronised asynchronous circuit",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "lead_pools": [],
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        },
        "created_by": null,
        "assigned_by": null,
        "assigned_to": {
          "id": "user_179",
          "created_at": "2017-03-29 21:07:34 UTC",
          "updated_at": "2017-03-29 21:07:34 UTC",
          "first_name": "Rozella",
          "last_name": "Funk",
          "email": "rozella.funk@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        }
      }
    }
  ]
}

Tasks List
GET/v2/contacts/{id}/tasks

🔒 contacts:view contacts:manage all:view all:manage

URI Parameters
HideShow
id
string (required) Example: contact_43

Contact identifier


Interactions

Use to manually create interactions between the user and contacts. These will be created automatically by any integrations the user has enabled, so only create interactions that would not be otherwise recorded.

Valid types:

email facebook other in_person
linked_in mad_mimi mail_chimp phone
sms twitter zapier

Create

POST https://api.contactually.com/v2/interactions
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": {
    "body": "Hey there, just wanted to reach out and see how you're doing.",
    "initiated_by_contact": false,
    "subject": "Just checking in",
    "timestamp": "2016-08-26 14:37:11 UTC",
    "type": "email",
    "participants": [
      {
        "contact_id": "contact_123",
        "handle": "liz.lemon@example.com"
      }
    ]
  }
}
Responses200
Body
{
  "data": {
    "id": "interaction_5213",
    "created_at": "2017-03-29 21:07:36 UTC",
    "updated_at": "2017-03-29 21:07:36 UTC",
    "body": null,
    "initiated_by_contact": false,
    "subject": "Triple-buffered bi-directional archive",
    "timestamp": "2017-03-29 21:07:35 UTC",
    "type": "email",
    "participants": [
      {
        "contact_id": "contact_3837",
        "handle": "americo.torphy@example.com",
        "extra_data": {
          "first_name": "Americo",
          "last_name": "Torphy",
          "avatar_url": null
        }
      },
      {
        "contact_id": "contact_3838",
        "handle": "clement.anderson@example.com",
        "extra_data": {
          "first_name": "Clement",
          "last_name": "Anderson",
          "avatar_url": null
        }
      },
      {
        "contact_id": "contact_3839",
        "handle": "freda.nikolaus@example.com",
        "extra_data": {
          "first_name": "Freda",
          "last_name": "Nikolaus",
          "avatar_url": null
        }
      }
    ],
    "extra_data": {
      "editable": true,
      "participant_count": 3,
      "placeholder": false,
      "contact_id": "contact_3837",
      "contact_handle": "americo.torphy@example.com",
      "associated_account_id": null,
      "associated_user": {
        "id": "user_179",
        "created_at": "2017-03-29 21:07:34 UTC",
        "updated_at": "2017-03-29 21:07:34 UTC",
        "first_name": "Rozella",
        "last_name": "Funk",
        "email": "rozella.funk@example.com",
        "avatar_url": null,
        "role": null,
        "status": "active"
      },
      "contact": {
        "id": "contact_3837",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "Americo",
        "last_name": "Torphy",
        "company": null,
        "location": null,
        "title": "Assistant Vice Manager",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
            "full_address": "Schmidttown",
            "label": "Office",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3679",
            "label": null,
            "address": "americo.torphy@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "2dc8be05-b621-4878-af37-53b19be46be9",
            "label": "LinkedIn",
            "url": "http://reichert.biz"
          }
        ],
        "websites": [
          {
            "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
            "label": "Social",
            "address": "http://ogabecker.biz"
          }
        ],
        "phone_numbers": [
          {
            "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
            "label": "Corner Payphone",
            "number": "1-997-565-7190"
          }
        ],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [
            {
              "id": "bucket_2217",
              "name": "Reactive bifurcated artificial intelligence",
              "reminder_interval": null
            },
            {
              "id": "bucket_2216",
              "name": "Synchronised asynchronous circuit",
              "reminder_interval": null
            }
          ],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      }
    }
  },
  "meta": {}
}

Create
POST/v2/interactions

🔒 interactions:manage all:manage


Fetch

GET https://api.contactually.com/v2/interactions/interaction_2022
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "interaction_5213",
    "created_at": "2017-03-29 21:07:36 UTC",
    "updated_at": "2017-03-29 21:07:36 UTC",
    "body": null,
    "initiated_by_contact": false,
    "subject": "Triple-buffered bi-directional archive",
    "timestamp": "2017-03-29 21:07:35 UTC",
    "type": "email",
    "participants": [
      {
        "contact_id": "contact_3837",
        "handle": "americo.torphy@example.com",
        "extra_data": {
          "first_name": "Americo",
          "last_name": "Torphy",
          "avatar_url": null
        }
      },
      {
        "contact_id": "contact_3838",
        "handle": "clement.anderson@example.com",
        "extra_data": {
          "first_name": "Clement",
          "last_name": "Anderson",
          "avatar_url": null
        }
      },
      {
        "contact_id": "contact_3839",
        "handle": "freda.nikolaus@example.com",
        "extra_data": {
          "first_name": "Freda",
          "last_name": "Nikolaus",
          "avatar_url": null
        }
      }
    ],
    "extra_data": {
      "editable": true,
      "participant_count": 3,
      "placeholder": false,
      "contact_id": "contact_3837",
      "contact_handle": "americo.torphy@example.com",
      "associated_account_id": null,
      "associated_user": {
        "id": "user_179",
        "created_at": "2017-03-29 21:07:34 UTC",
        "updated_at": "2017-03-29 21:07:34 UTC",
        "first_name": "Rozella",
        "last_name": "Funk",
        "email": "rozella.funk@example.com",
        "avatar_url": null,
        "role": null,
        "status": "active"
      },
      "contact": {
        "id": "contact_3837",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "Americo",
        "last_name": "Torphy",
        "company": null,
        "location": null,
        "title": "Assistant Vice Manager",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
            "full_address": "Schmidttown",
            "label": "Office",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3679",
            "label": null,
            "address": "americo.torphy@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "2dc8be05-b621-4878-af37-53b19be46be9",
            "label": "LinkedIn",
            "url": "http://reichert.biz"
          }
        ],
        "websites": [
          {
            "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
            "label": "Social",
            "address": "http://ogabecker.biz"
          }
        ],
        "phone_numbers": [
          {
            "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
            "label": "Corner Payphone",
            "number": "1-997-565-7190"
          }
        ],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [
            {
              "id": "bucket_2217",
              "name": "Reactive bifurcated artificial intelligence",
              "reminder_interval": null
            },
            {
              "id": "bucket_2216",
              "name": "Synchronised asynchronous circuit",
              "reminder_interval": null
            }
          ],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      }
    }
  },
  "meta": {}
}

Fetch
GET/v2/interactions/{id}

🔒 interactions:view interactions:manage all:view all:manage

URI Parameters
HideShow
id
string (required) Example: interaction_2022

Interaction identifier


Update

PATCH https://api.contactually.com/v2/interactions/interaction_2022
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": {
    "body": "Hey there, just wanted to reach out and see how you're doing.",
    "initiated_by_contact": false,
    "subject": "Just checking in",
    "timestamp": "2016-08-26 14:37:11 UTC",
    "type": "email",
    "participants": [
      {
        "contact_id": "contact_123",
        "handle": "liz.lemon@example.com"
      }
    ]
  }
}
Responses200
Body
{
  "data": {
    "id": "interaction_5213",
    "created_at": "2017-03-29 21:07:36 UTC",
    "updated_at": "2017-03-29 21:07:36 UTC",
    "body": null,
    "initiated_by_contact": false,
    "subject": "Triple-buffered bi-directional archive",
    "timestamp": "2017-03-29 21:07:35 UTC",
    "type": "email",
    "participants": [
      {
        "contact_id": "contact_3837",
        "handle": "americo.torphy@example.com",
        "extra_data": {
          "first_name": "Americo",
          "last_name": "Torphy",
          "avatar_url": null
        }
      },
      {
        "contact_id": "contact_3838",
        "handle": "clement.anderson@example.com",
        "extra_data": {
          "first_name": "Clement",
          "last_name": "Anderson",
          "avatar_url": null
        }
      },
      {
        "contact_id": "contact_3839",
        "handle": "freda.nikolaus@example.com",
        "extra_data": {
          "first_name": "Freda",
          "last_name": "Nikolaus",
          "avatar_url": null
        }
      }
    ],
    "extra_data": {
      "editable": true,
      "participant_count": 3,
      "placeholder": false,
      "contact_id": "contact_3837",
      "contact_handle": "americo.torphy@example.com",
      "associated_account_id": null,
      "associated_user": {
        "id": "user_179",
        "created_at": "2017-03-29 21:07:34 UTC",
        "updated_at": "2017-03-29 21:07:34 UTC",
        "first_name": "Rozella",
        "last_name": "Funk",
        "email": "rozella.funk@example.com",
        "avatar_url": null,
        "role": null,
        "status": "active"
      },
      "contact": {
        "id": "contact_3837",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "Americo",
        "last_name": "Torphy",
        "company": null,
        "location": null,
        "title": "Assistant Vice Manager",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
            "full_address": "Schmidttown",
            "label": "Office",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3679",
            "label": null,
            "address": "americo.torphy@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "2dc8be05-b621-4878-af37-53b19be46be9",
            "label": "LinkedIn",
            "url": "http://reichert.biz"
          }
        ],
        "websites": [
          {
            "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
            "label": "Social",
            "address": "http://ogabecker.biz"
          }
        ],
        "phone_numbers": [
          {
            "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
            "label": "Corner Payphone",
            "number": "1-997-565-7190"
          }
        ],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [
            {
              "id": "bucket_2217",
              "name": "Reactive bifurcated artificial intelligence",
              "reminder_interval": null
            },
            {
              "id": "bucket_2216",
              "name": "Synchronised asynchronous circuit",
              "reminder_interval": null
            }
          ],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      }
    }
  },
  "meta": {}
}

Update
PATCH/v2/interactions/{id}

🔒 interactions:manage all:manage

URI Parameters
HideShow
id
string (required) Example: interaction_2022

Interaction identifier


Delete

DELETE https://api.contactually.com/v2/interactions/interaction_2022
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "interaction_5213",
    "created_at": "2017-03-29 21:07:36 UTC",
    "updated_at": "2017-03-29 21:07:36 UTC",
    "body": null,
    "initiated_by_contact": false,
    "subject": "Triple-buffered bi-directional archive",
    "timestamp": "2017-03-29 21:07:35 UTC",
    "type": "email",
    "participants": [
      {
        "contact_id": "contact_3837",
        "handle": "americo.torphy@example.com",
        "extra_data": {
          "first_name": "Americo",
          "last_name": "Torphy",
          "avatar_url": null
        }
      },
      {
        "contact_id": "contact_3838",
        "handle": "clement.anderson@example.com",
        "extra_data": {
          "first_name": "Clement",
          "last_name": "Anderson",
          "avatar_url": null
        }
      },
      {
        "contact_id": "contact_3839",
        "handle": "freda.nikolaus@example.com",
        "extra_data": {
          "first_name": "Freda",
          "last_name": "Nikolaus",
          "avatar_url": null
        }
      }
    ],
    "extra_data": {
      "editable": true,
      "participant_count": 3,
      "placeholder": false,
      "contact_id": "contact_3837",
      "contact_handle": "americo.torphy@example.com",
      "associated_account_id": null,
      "associated_user": {
        "id": "user_179",
        "created_at": "2017-03-29 21:07:34 UTC",
        "updated_at": "2017-03-29 21:07:34 UTC",
        "first_name": "Rozella",
        "last_name": "Funk",
        "email": "rozella.funk@example.com",
        "avatar_url": null,
        "role": null,
        "status": "active"
      },
      "contact": {
        "id": "contact_3837",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "Americo",
        "last_name": "Torphy",
        "company": null,
        "location": null,
        "title": "Assistant Vice Manager",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "2568ca5f-1bf9-4b80-b48b-7b95935a8af2",
            "full_address": "Schmidttown",
            "label": "Office",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3679",
            "label": null,
            "address": "americo.torphy@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "2dc8be05-b621-4878-af37-53b19be46be9",
            "label": "LinkedIn",
            "url": "http://reichert.biz"
          }
        ],
        "websites": [
          {
            "id": "a8333cd3-c50e-4619-8094-0e6b33300a5c",
            "label": "Social",
            "address": "http://ogabecker.biz"
          }
        ],
        "phone_numbers": [
          {
            "id": "71115982-2a0f-41ab-bdef-7043f69f2f7d",
            "label": "Corner Payphone",
            "number": "1-997-565-7190"
          }
        ],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [
            {
              "id": "bucket_2217",
              "name": "Reactive bifurcated artificial intelligence",
              "reminder_interval": null
            },
            {
              "id": "bucket_2216",
              "name": "Synchronised asynchronous circuit",
              "reminder_interval": null
            }
          ],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      }
    }
  },
  "meta": {}
}

Delete
DELETE/v2/interactions/{id}

This action does not delete the contacts within the bucket.

🔒 interactions:manage all:manage

URI Parameters
HideShow
id
string (required) Example: interaction_2022

Interaction identifier


Content

GET https://api.contactually.com/v2/interactions/interaction_2022/content
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "body": "<h1>Hi</h1>",
    "plaintext": "Hi",
<<<<<<< HEAD:blueprints/v2/_responses/interactions/:id/content.json
Body
{
  "data": {
    "body": "<h1>Hi</h1>",
    "plaintext": "Hi",
<<<<<<< HEAD:blueprints/v2/_responses/interactions/:id/content.json
    "retrieved_at": "2017-02-01T17:37:32-05:00"
=======
"retrieved_at": "2017-03-29T16:47:52-04:00"
>>>>>>> Updates responses for all object types:blueprints/alpha/_responses/interactions/:id/content.json
  },
  "meta": {
  }
}

Content
GET/v2/interactions/{id}/content

🔒 interactions:view interactions:manage all:view all:manage

URI Parameters
HideShow
id
string (required) Example: interaction_2022

Interaction identifier


Participants

GET https://api.contactually.com/v2/interactions/interaction_2022/participants
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "contact_id": "contact_3556",
      "handle": "lavern.nienow@example.com",
      "extra_data": {
        "first_name": "Lavern",
        "last_name": "Nienow",
        "avatar_url": null
      }
    },
    {
      "contact_id": "contact_3559",
      "handle": "emery.windler@example.com",
      "extra_data": {
        "first_name": "Emery",
        "last_name": "Windler",
        "avatar_url": null
      }
    },
    {
      "contact_id": "contact_3562",
      "handle": "mohamed.yost@example.com",
      "extra_data": {
        "first_name": "Mohamed",
        "last_name": "Yost",
        "avatar_url": null
      }
    }
  ]
}

Participants
GET/v2/interactions/{id}/participants

🔒 interactions:view interactions:manage all:view all:manage

URI Parameters
HideShow
id
string (required) Example: interaction_2022

Interaction identifier


Tags

Fetch

GET https://api.contactually.com/v2/tags
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "tag_2219",
      "created_at": "2017-03-29 21:07:36 UTC",
      "updated_at": "2017-03-29 21:07:36 UTC",
      "name": "Centralized bottom-line Graphic Interface",
      "contact_count": 0
    },
    {
      "id": "tag_2220",
      "created_at": "2017-03-29 21:07:36 UTC",
      "updated_at": "2017-03-29 21:07:36 UTC",
      "name": "Programmable logistical parallelism",
      "contact_count": 0
    },
    {
      "id": "tag_2221",
      "created_at": "2017-03-29 21:07:36 UTC",
      "updated_at": "2017-03-29 21:07:36 UTC",
      "name": "Stand-alone multi-state array",
      "contact_count": 0
    }
  ]
}

Fetch
GET/v2/tags

🔒 contacts:view


Tasks

Create

POST https://api.contactually.com/v2/tasks
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": {
    "assigned_to_id": "user_234",
    "contact_id": "contact_123",
    "due_at": "2015-10-29T12:00:00Z",
    "title": "Ask how their application went"
  }
}
Responses200
Body
{
  "data": {
    "id": "task_530",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "assigned_to_id": "user_179",
    "contact_id": "contact_3838",
    "due_at": "2017-03-30 21:07:35 UTC",
    "title": "Quo magni optio fuga eaque eos aspernatur alias iste voluptatem doloribus qui delectus.",
    "extra_data": {
      "assigned_at": null,
      "completed_at": null,
      "contact": {
        "id": "contact_3838",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "Clement",
        "last_name": "Anderson",
        "company": null,
        "location": null,
        "title": "Corporate Secretary",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "7fd5c248-d972-432a-b7b0-cd8f6027ca13",
            "full_address": "North Giovanna",
            "label": "Mobile",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3680",
            "label": null,
            "address": "clement.anderson@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "820994c6-b143-4b1a-98e9-3d3680ee5490",
            "label": "LinkedIn",
            "url": "http://howe.name"
          }
        ],
        "websites": [
          {
            "id": "ff3fb18e-fe37-4614-b337-e5c4b9332bd2",
            "label": "Business",
            "address": "http://hagenesbrown.ca"
          }
        ],
        "phone_numbers": [
          {
            "id": "68082bb1-a546-4f4e-9bf6-b84d38871395",
            "label": "Home",
            "number": "(447)476-4478 x03265"
          }
        ],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "created_by": null,
      "assigned_by": null,
      "assigned_to": {
        "id": "user_179",
        "created_at": "2017-03-29 21:07:34 UTC",
        "updated_at": "2017-03-29 21:07:34 UTC",
        "first_name": "Rozella",
        "last_name": "Funk",
        "email": "rozella.funk@example.com",
        "avatar_url": null,
        "role": null,
        "status": "active"
      }
    }
  },
  "meta": {}
}

Create
POST/v2/tasks

🔒 tasks:manage all:manage


Fetch

GET https://api.contactually.com/v2/tasks/task_424
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "task_530",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "assigned_to_id": "user_179",
    "contact_id": "contact_3838",
    "due_at": "2017-03-30 21:07:35 UTC",
    "title": "Quo magni optio fuga eaque eos aspernatur alias iste voluptatem doloribus qui delectus.",
    "extra_data": {
      "assigned_at": null,
      "completed_at": null,
      "contact": {
        "id": "contact_3838",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "Clement",
        "last_name": "Anderson",
        "company": null,
        "location": null,
        "title": "Corporate Secretary",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "7fd5c248-d972-432a-b7b0-cd8f6027ca13",
            "full_address": "North Giovanna",
            "label": "Mobile",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3680",
            "label": null,
            "address": "clement.anderson@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "820994c6-b143-4b1a-98e9-3d3680ee5490",
            "label": "LinkedIn",
            "url": "http://howe.name"
          }
        ],
        "websites": [
          {
            "id": "ff3fb18e-fe37-4614-b337-e5c4b9332bd2",
            "label": "Business",
            "address": "http://hagenesbrown.ca"
          }
        ],
        "phone_numbers": [
          {
            "id": "68082bb1-a546-4f4e-9bf6-b84d38871395",
            "label": "Home",
            "number": "(447)476-4478 x03265"
          }
        ],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "created_by": null,
      "assigned_by": null,
      "assigned_to": {
        "id": "user_179",
        "created_at": "2017-03-29 21:07:34 UTC",
        "updated_at": "2017-03-29 21:07:34 UTC",
        "first_name": "Rozella",
        "last_name": "Funk",
        "email": "rozella.funk@example.com",
        "avatar_url": null,
        "role": null,
        "status": "active"
      }
    }
  },
  "meta": {}
}

Fetch
GET/v2/tasks/{id}

🔒 tasks:view tasks:manage all:view all:manage

URI Parameters
HideShow
id
string (required) Example: task_424

The id of the reminder


Update

PATCH https://api.contactually.com/v2/tasks/task_424
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": {
    "assigned_to_id": "user_234",
    "contact_id": "contact_123",
    "due_at": "2015-10-29T12:00:00Z",
    "title": "Ask how their application went"
  }
}
Responses200
Body
{
  "data": {
    "id": "task_530",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "assigned_to_id": "user_179",
    "contact_id": "contact_3838",
    "due_at": "2017-03-30 21:07:35 UTC",
    "title": "Quo magni optio fuga eaque eos aspernatur alias iste voluptatem doloribus qui delectus.",
    "extra_data": {
      "assigned_at": null,
      "completed_at": null,
      "contact": {
        "id": "contact_3838",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "Clement",
        "last_name": "Anderson",
        "company": null,
        "location": null,
        "title": "Corporate Secretary",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "7fd5c248-d972-432a-b7b0-cd8f6027ca13",
            "full_address": "North Giovanna",
            "label": "Mobile",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3680",
            "label": null,
            "address": "clement.anderson@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "820994c6-b143-4b1a-98e9-3d3680ee5490",
            "label": "LinkedIn",
            "url": "http://howe.name"
          }
        ],
        "websites": [
          {
            "id": "ff3fb18e-fe37-4614-b337-e5c4b9332bd2",
            "label": "Business",
            "address": "http://hagenesbrown.ca"
          }
        ],
        "phone_numbers": [
          {
            "id": "68082bb1-a546-4f4e-9bf6-b84d38871395",
            "label": "Home",
            "number": "(447)476-4478 x03265"
          }
        ],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "created_by": null,
      "assigned_by": null,
      "assigned_to": {
        "id": "user_179",
        "created_at": "2017-03-29 21:07:34 UTC",
        "updated_at": "2017-03-29 21:07:34 UTC",
        "first_name": "Rozella",
        "last_name": "Funk",
        "email": "rozella.funk@example.com",
        "avatar_url": null,
        "role": null,
        "status": "active"
      }
    }
  },
  "meta": {}
}

Update
PATCH/v2/tasks/{id}

🔒 tasks:manage all:manage

URI Parameters
HideShow
id
string (required) Example: task_424

The id of the reminder


Delete

DELETE https://api.contactually.com/v2/tasks/task_424
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "task_530",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "assigned_to_id": "user_179",
    "contact_id": "contact_3838",
    "due_at": "2017-03-30 21:07:35 UTC",
    "title": "Quo magni optio fuga eaque eos aspernatur alias iste voluptatem doloribus qui delectus.",
    "extra_data": {
      "assigned_at": null,
      "completed_at": null,
      "contact": {
        "id": "contact_3838",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "Clement",
        "last_name": "Anderson",
        "company": null,
        "location": null,
        "title": "Corporate Secretary",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "7fd5c248-d972-432a-b7b0-cd8f6027ca13",
            "full_address": "North Giovanna",
            "label": "Mobile",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3680",
            "label": null,
            "address": "clement.anderson@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "820994c6-b143-4b1a-98e9-3d3680ee5490",
            "label": "LinkedIn",
            "url": "http://howe.name"
          }
        ],
        "websites": [
          {
            "id": "ff3fb18e-fe37-4614-b337-e5c4b9332bd2",
            "label": "Business",
            "address": "http://hagenesbrown.ca"
          }
        ],
        "phone_numbers": [
          {
            "id": "68082bb1-a546-4f4e-9bf6-b84d38871395",
            "label": "Home",
            "number": "(447)476-4478 x03265"
          }
        ],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "created_by": null,
      "assigned_by": null,
      "assigned_to": {
        "id": "user_179",
        "created_at": "2017-03-29 21:07:34 UTC",
        "updated_at": "2017-03-29 21:07:34 UTC",
        "first_name": "Rozella",
        "last_name": "Funk",
        "email": "rozella.funk@example.com",
        "avatar_url": null,
        "role": null,
        "status": "active"
      }
    }
  },
  "meta": {}
}

Delete
DELETE/v2/tasks/{id}

🔒 tasks:manage all:manage

URI Parameters
HideShow
id
string (required) Example: task_424

The id of the reminder


Task Completion

NOTE that these endpoints do not require bodies, but instead use the HTTP verb to determine the update to perform

POST https://api.contactually.com/v2/tasks/task_424/complete
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "task_531",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "assigned_to_id": "user_179",
    "contact_id": "contact_3838",
    "due_at": "2017-03-30 21:07:35 UTC",
    "title": "Tempora odio eum recusandae ut voluptate et quia sint voluptatibus cum expedita.",
    "extra_data": {
      "assigned_at": null,
      "completed_at": "2017-03-29 21:07:36 UTC",
      "contact": {
        "id": "contact_3838",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "Clement",
        "last_name": "Anderson",
        "company": null,
        "location": null,
        "title": "Corporate Secretary",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "7fd5c248-d972-432a-b7b0-cd8f6027ca13",
            "full_address": "North Giovanna",
            "label": "Mobile",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3680",
            "label": null,
            "address": "clement.anderson@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "820994c6-b143-4b1a-98e9-3d3680ee5490",
            "label": "LinkedIn",
            "url": "http://howe.name"
          }
        ],
        "websites": [
          {
            "id": "ff3fb18e-fe37-4614-b337-e5c4b9332bd2",
            "label": "Business",
            "address": "http://hagenesbrown.ca"
          }
        ],
        "phone_numbers": [
          {
            "id": "68082bb1-a546-4f4e-9bf6-b84d38871395",
            "label": "Home",
            "number": "(447)476-4478 x03265"
          }
        ],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "created_by": null,
      "assigned_by": null,
      "assigned_to": {
        "id": "user_179",
        "created_at": "2017-03-29 21:07:34 UTC",
        "updated_at": "2017-03-29 21:07:34 UTC",
        "first_name": "Rozella",
        "last_name": "Funk",
        "email": "rozella.funk@example.com",
        "avatar_url": null,
        "role": null,
        "status": "active"
      }
    }
  },
  "meta": {}
}

Mark Completed
POST/v2/tasks/{id}/complete

🔒 tasks:manage all:manage

URI Parameters
HideShow
id
string (required) Example: task_424

The id of the reminder


DELETE https://api.contactually.com/v2/tasks/task_424/complete
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "task_530",
    "created_at": "2017-03-29 21:07:35 UTC",
    "updated_at": "2017-03-29 21:07:35 UTC",
    "assigned_to_id": "user_179",
    "contact_id": "contact_3838",
    "due_at": "2017-03-30 21:07:35 UTC",
    "title": "Quo magni optio fuga eaque eos aspernatur alias iste voluptatem doloribus qui delectus.",
    "extra_data": {
      "assigned_at": null,
      "completed_at": null,
      "contact": {
        "id": "contact_3838",
        "created_at": "2017-03-29 21:07:35 UTC",
        "updated_at": "2017-03-29 21:07:35 UTC",
        "first_name": "Clement",
        "last_name": "Anderson",
        "company": null,
        "location": null,
        "title": "Corporate Secretary",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "7fd5c248-d972-432a-b7b0-cd8f6027ca13",
            "full_address": "North Giovanna",
            "label": "Mobile",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3680",
            "label": null,
            "address": "clement.anderson@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "820994c6-b143-4b1a-98e9-3d3680ee5490",
            "label": "LinkedIn",
            "url": "http://howe.name"
          }
        ],
        "websites": [
          {
            "id": "ff3fb18e-fe37-4614-b337-e5c4b9332bd2",
            "label": "Business",
            "address": "http://hagenesbrown.ca"
          }
        ],
        "phone_numbers": [
          {
            "id": "68082bb1-a546-4f4e-9bf6-b84d38871395",
            "label": "Home",
            "number": "(447)476-4478 x03265"
          }
        ],
        "custom_fields": [],
        "extra_data": {
          "last_contacted": null,
          "muted_at": null,
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "user_last_contacted_at": null,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "lead_pools": [],
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "created_by": null,
      "assigned_by": null,
      "assigned_to": {
        "id": "user_179",
        "created_at": "2017-03-29 21:07:34 UTC",
        "updated_at": "2017-03-29 21:07:34 UTC",
        "first_name": "Rozella",
        "last_name": "Funk",
        "email": "rozella.funk@example.com",
        "avatar_url": null,
        "role": null,
        "status": "active"
      }
    }
  },
  "meta": {}
}

Mark Incomplete
DELETE/v2/tasks/{id}/complete

🔒 tasks:manage all:manage

URI Parameters
HideShow
id
string (required) Example: task_424

The id of the reminder


Team

Manage

GET https://api.contactually.com/v2/team
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "team_103",
    "created_at": "2017-02-01 22:37:26 UTC",
    "updated_at": "2017-02-01 22:37:32 UTC",
    "name": "Buckridge-Deckow",
    "settings": {
      "shares_unbucketed_contacts": false,
      "allows_contact_deletion": false,
      "allows_contact_exports": true
    },
    "extra_data": {
      "trial_end_at": "2017-02-15 22:37:26 UTC",
      "credits_remaining": {
        "physical_messages": 0
      }
    },
    "partner": null
  },
  "meta": {}
}

Fetch
GET/v2/team

🔒 team:view team:manage all:view all:manage


PATCH https://api.contactually.com/v2/team
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": {
    "name": "Team Jetsons",
    "settings": {
      "shares_unbucketed_contacts": false,
      "allows_contact_deletion": false,
      "allows_contact_exports": false
    }
  }
}
Responses200
Body
{
  "data": {
    "id": "team_103",
    "created_at": "2017-02-01 22:37:26 UTC",
    "updated_at": "2017-02-01 22:37:32 UTC",
    "name": "Buckridge-Deckow",
    "settings": {
      "shares_unbucketed_contacts": false,
      "allows_contact_deletion": false,
      "allows_contact_exports": true
    },
    "extra_data": {
      "trial_end_at": "2017-02-15 22:37:26 UTC",
      "credits_remaining": {
        "physical_messages": 0
      }
    },
    "partner": null
  },
  "meta": {}
}

Update
PATCH/v2/team

🔒 team:manage all:manage


Custom Fields

GET https://api.contactually.com/v2/team/custom-fields
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "meta": {
    "total": 3,
    "next_page": null,
    "previous_page": null
  },
  "data": [
    {
      "id": "custom_field_29",
      "created_at": "2017-02-01 22:37:31 UTC",
      "updated_at": "2017-02-01 22:37:31 UTC",
      "name": "Implemented value-added groupware",
      "type": "textfield",
      "default_value": null,
      "extra_data": {
        "usage_count": 0,
        "created_by": {
          "id": "user_162",
          "created_at": "2017-02-01 22:37:26 UTC",
          "updated_at": "2017-02-01 22:37:26 UTC",
          "first_name": "Zoe",
          "last_name": "Nikolaus",
          "email": "zoe.nikolaus@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        }
      }
    },
    {
      "id": "custom_field_30",
      "created_at": "2017-02-01 22:37:32 UTC",
      "updated_at": "2017-02-01 22:37:32 UTC",
      "name": "Operative fresh-thinking project",
      "type": "textfield",
      "default_value": null,
      "extra_data": {
        "usage_count": 0,
        "created_by": {
          "id": "user_162",
          "created_at": "2017-02-01 22:37:26 UTC",
          "updated_at": "2017-02-01 22:37:26 UTC",
          "first_name": "Zoe",
          "last_name": "Nikolaus",
          "email": "zoe.nikolaus@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        }
      }
    },
    {
      "id": "custom_field_31",
      "created_at": "2017-02-01 22:37:32 UTC",
      "updated_at": "2017-02-01 22:37:32 UTC",
      "name": "Distributed secondary parallelism",
      "type": "textfield",
      "default_value": null,
      "extra_data": {
        "usage_count": 0,
        "created_by": {
          "id": "user_162",
          "created_at": "2017-02-01 22:37:26 UTC",
          "updated_at": "2017-02-01 22:37:26 UTC",
          "first_name": "Zoe",
          "last_name": "Nikolaus",
          "email": "zoe.nikolaus@example.com",
          "avatar_url": null,
          "role": null,
          "status": "active"
        }
      }
    }
  ]
}

List
GET/v2/team/custom-fields

🔒 custom-fields:view custom-fields:manage all:view all:manage


POST https://api.contactually.com/v2/team/custom-fields
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": {
    "name": "House Search Status",
    "type": "dropdown",
    "default_value": "Inactive",
    "dropdown_options": [
      "Inactive",
      "Active Buyer",
      "Active Seller"
    ]
  }
}
Responses200
Body
{
  "data": {
    "id": "custom_field_29",
    "created_at": "2017-02-01 22:37:31 UTC",
    "updated_at": "2017-02-01 22:37:31 UTC",
    "name": "Implemented value-added groupware",
    "type": "textfield",
    "default_value": null,
    "extra_data": {
      "usage_count": 0,
      "created_by": {
        "id": "user_162",
        "created_at": "2017-02-01 22:37:26 UTC",
        "updated_at": "2017-02-01 22:37:26 UTC",
        "first_name": "Zoe",
        "last_name": "Nikolaus",
        "email": "zoe.nikolaus@example.com",
        "avatar_url": null,
        "role": null,
        "status": "active"
      }
    }
  },
  "meta": {}
}

Create
POST/v2/team/custom-fields

🔒 custom-fields:manage all:manage

Valid types:

textfield textarea dropdown boolean

GET https://api.contactually.com/v2/team/custom-fields/custom_field_59
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "custom_field_29",
    "created_at": "2017-02-01 22:37:31 UTC",
    "updated_at": "2017-02-01 22:37:31 UTC",
    "name": "Implemented value-added groupware",
    "type": "textfield",
    "default_value": null,
    "extra_data": {
      "usage_count": 0,
      "created_by": {
        "id": "user_162",
        "created_at": "2017-02-01 22:37:26 UTC",
        "updated_at": "2017-02-01 22:37:26 UTC",
        "first_name": "Zoe",
        "last_name": "Nikolaus",
        "email": "zoe.nikolaus@example.com",
        "avatar_url": null,
        "role": null,
        "status": "active"
      }
    }
  },
  "meta": {}
}

Fetch
GET/v2/team/custom-fields/{id}

🔒 custom-fields:view custom-fields:manage all:view all:manage

URI Parameters
HideShow
id
string (required) Example: custom_field_59

The custom field id


PATCH https://api.contactually.com/v2/team/custom-fields/custom_field_59
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Body
{
  "data": {
    "name": "House Search Status",
    "type": "dropdown",
    "default_value": "Inactive",
    "dropdown_options": [
      "Inactive",
      "Active Buyer",
      "Active Seller"
    ]
  }
}
Responses200
Body
{
  "data": {
    "id": "custom_field_29",
    "created_at": "2017-02-01 22:37:31 UTC",
    "updated_at": "2017-02-01 22:37:31 UTC",
    "name": "Implemented value-added groupware",
    "type": "textfield",
    "default_value": null,
    "extra_data": {
      "usage_count": 0,
      "created_by": {
        "id": "user_162",
        "created_at": "2017-02-01 22:37:26 UTC",
        "updated_at": "2017-02-01 22:37:26 UTC",
        "first_name": "Zoe",
        "last_name": "Nikolaus",
        "email": "zoe.nikolaus@example.com",
        "avatar_url": null,
        "role": null,
        "status": "active"
      }
    }
  },
  "meta": {}
}

Update
PATCH/v2/team/custom-fields/{id}

🔒 custom-fields:manage all:manage

URI Parameters
HideShow
id
string (required) Example: custom_field_59

The custom field id


DELETE https://api.contactually.com/v2/team/custom-fields/custom_field_59
Requestsexample 1
Headers
HideShow
Content-Type: application/json
Authorization: Bearer [access_token]
Responses200
Body
{
  "data": {
    "id": "custom_field_29",
    "created_at": "2017-02-01 22:37:31 UTC",
    "updated_at": "2017-02-01 22:37:31 UTC",
    "name": "Implemented value-added groupware",
    "type": "textfield",
    "default_value": null,
    "extra_data": {
      "usage_count": 0,
      "created_by": {
        "id": "user_162",
        "created_at": "2017-02-01 22:37:26 UTC",
        "updated_at": "2017-02-01 22:37:26 UTC",
        "first_name": "Zoe",
        "last_name": "Nikolaus",
        "email": "zoe.nikolaus@example.com",
        "avatar_url": null,
        "role": null,
        "status": "active"
      }
    }
  },
  "meta": {}
}

Remove
DELETE/v2/team/custom-fields/{id}

🔒 custom-fields:manage all:manage

URI Parameters
HideShow
id
string (required) Example: custom_field_59

The custom field id


Generated by aglio on 16 Aug 2017