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_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/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_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/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": "herminio.ward.1@example.com"
    },
    {
      "id": "email_alias_20",
      "email_alias": "orie.wolff.2@example.com"
    },
    {
      "id": "email_alias_21",
      "email_alias": "nicole.ziemann.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_49",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "type": null,
      "title": "Pariatur beatae debitis tempora est.",
      "link": "https://api-gerhardt-contactually.ngrok.io/gulgowskiratke.ca",
      "level": "info",
      "read_at": null
    },
    {
      "id": "notification_50",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "type": null,
      "title": "Molestias et veritatis est et illum.",
      "link": "https://api-gerhardt-contactually.ngrok.io/feil.com",
      "level": "info",
      "read_at": null
    },
    {
      "id": "notification_51",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "type": null,
      "title": "Laboriosam esse ut iusto sequi est quas.",
      "link": "https://api-gerhardt-contactually.ngrok.io/braun.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_528",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "link": "https://api-gerhardt-contactually.ngrok.io/v2/contacts/contact_3551/interactions",
      "type": "followup",
      "contact": {
        "id": "contact_3551",
        "created_at": "2017-02-01 22:37:26 UTC",
        "updated_at": "2017-02-01 22:37:26 UTC",
        "first_name": "Reina",
        "last_name": "Towne",
        "company": null,
        "location": null,
        "title": "Executive Consultant",
        "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,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "extra_data": {
        "program": null
      }
    },
    {
      "id": "task_529",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "link": "https://api-gerhardt-contactually.ngrok.io/v2/contacts/contact_3552/interactions",
      "type": "followup",
      "contact": {
        "id": "contact_3552",
        "created_at": "2017-02-01 22:37:26 UTC",
        "updated_at": "2017-02-01 22:37:26 UTC",
        "first_name": "Annetta",
        "last_name": "Bailey",
        "company": null,
        "location": null,
        "title": "General Finance 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,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "extra_data": {
        "program": null
      }
    },
    {
      "id": "task_530",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "link": "https://api-gerhardt-contactually.ngrok.io/v2/contacts/contact_3553/interactions",
      "type": "followup",
      "contact": {
        "id": "contact_3553",
        "created_at": "2017-02-01 22:37:26 UTC",
        "updated_at": "2017-02-01 22:37:26 UTC",
        "first_name": "Faye",
        "last_name": "Zboncak",
        "company": null,
        "location": null,
        "title": "Executive Division 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,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "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_528",
    "created_at": "2017-02-01 22:37:26 UTC",
    "updated_at": "2017-02-01 22:37:26 UTC",
    "link": "https://api-gerhardt-contactually.ngrok.io/v2/contacts/contact_3551/interactions",
    "type": "followup",
    "contact": {
      "id": "contact_3551",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "first_name": "Reina",
      "last_name": "Towne",
      "company": null,
      "location": null,
      "title": "Executive Consultant",
      "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,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "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_528",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "link": "https://api-gerhardt-contactually.ngrok.io/v2/contacts/contact_3551/interactions",
      "type": "followup",
      "contact": {
        "id": "contact_3551",
        "created_at": "2017-02-01 22:37:26 UTC",
        "updated_at": "2017-02-01 22:37:26 UTC",
        "first_name": "Reina",
        "last_name": "Towne",
        "company": null,
        "location": null,
        "title": "Executive Consultant",
        "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,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "extra_data": {
        "program": null
      }
    },
    {
      "id": "task_529",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "link": "https://api-gerhardt-contactually.ngrok.io/v2/contacts/contact_3552/interactions",
      "type": "followup",
      "contact": {
        "id": "contact_3552",
        "created_at": "2017-02-01 22:37:26 UTC",
        "updated_at": "2017-02-01 22:37:26 UTC",
        "first_name": "Annetta",
        "last_name": "Bailey",
        "company": null,
        "location": null,
        "title": "General Finance 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,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "team_last_contacted_by": null,
          "associated_tags": [],
          "associated_company": null,
          "associated_location": null,
          "assigned_to": null
        }
      },
      "extra_data": {
        "program": null
      }
    },
    {
      "id": "task_530",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "link": "https://api-gerhardt-contactually.ngrok.io/v2/contacts/contact_3553/interactions",
      "type": "followup",
      "contact": {
        "id": "contact_3553",
        "created_at": "2017-02-01 22:37:26 UTC",
        "updated_at": "2017-02-01 22:37:26 UTC",
        "first_name": "Faye",
        "last_name": "Zboncak",
        "company": null,
        "location": null,
        "title": "Executive Division 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,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "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_531",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "assigned_to_id": "user_162",
      "contact_id": "contact_3559",
      "due_at": "2017-02-02 22:37:27 UTC",
      "title": "Veniam quia voluptatem itaque voluptas quia occaecati ut illum ad sed.",
      "extra_data": {
        "assigned_at": null,
        "completed_at": "2017-02-01 22:37:28 UTC",
        "contact": {
          "id": "contact_3559",
          "created_at": "2017-02-01 22:37:27 UTC",
          "updated_at": "2017-02-01 22:37:27 UTC",
          "first_name": "Emery",
          "last_name": "Windler",
          "company": null,
          "location": null,
          "title": "Corporate President",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "00c2cb57-e448-4ca1-bae7-a35f6b8be33b",
              "full_address": "Hellerborough",
              "label": "Office",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3326",
              "label": null,
              "address": "emery.windler@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "ecf7a4c0-def6-490e-a09b-55763fc63644",
              "label": "Facebook",
              "url": "http://kihn.us"
            }
          ],
          "websites": [
            {
              "id": "4e4cf100-e2be-418b-b767-ae3029a6d8f6",
              "label": "Personal",
              "address": "http://dickenswilkinson.com"
            }
          ],
          "phone_numbers": [
            {
              "id": "c833dbc5-f5f3-411f-a01f-b38c5fffa0bb",
              "label": "Corner Payphone",
              "number": "1-152-328-3911"
            }
          ],
          "custom_fields": [
            {
              "value": "molestias",
              "field": {
                "id": "custom_field_25",
                "name": "Multi-layered encompassing flexibility"
              }
            },
            {
              "value": "eius",
              "field": {
                "id": "custom_field_26",
                "name": "Total scalable productivity"
              }
            }
          ],
          "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,
            "buckets": [],
            "sources": [],
            "followup_source": null,
            "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_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": "task_532",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "assigned_to_id": "user_162",
      "contact_id": "contact_3559",
      "due_at": "2017-02-02 22:37:27 UTC",
      "title": "Cupiditate repudiandae totam minus nemo enim rerum quis sint et illum est.",
      "extra_data": {
        "assigned_at": null,
        "completed_at": null,
        "contact": {
          "id": "contact_3559",
          "created_at": "2017-02-01 22:37:27 UTC",
          "updated_at": "2017-02-01 22:37:27 UTC",
          "first_name": "Emery",
          "last_name": "Windler",
          "company": null,
          "location": null,
          "title": "Corporate President",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "00c2cb57-e448-4ca1-bae7-a35f6b8be33b",
              "full_address": "Hellerborough",
              "label": "Office",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3326",
              "label": null,
              "address": "emery.windler@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "ecf7a4c0-def6-490e-a09b-55763fc63644",
              "label": "Facebook",
              "url": "http://kihn.us"
            }
          ],
          "websites": [
            {
              "id": "4e4cf100-e2be-418b-b767-ae3029a6d8f6",
              "label": "Personal",
              "address": "http://dickenswilkinson.com"
            }
          ],
          "phone_numbers": [
            {
              "id": "c833dbc5-f5f3-411f-a01f-b38c5fffa0bb",
              "label": "Corner Payphone",
              "number": "1-152-328-3911"
            }
          ],
          "custom_fields": [
            {
              "value": "molestias",
              "field": {
                "id": "custom_field_25",
                "name": "Multi-layered encompassing flexibility"
              }
            },
            {
              "value": "eius",
              "field": {
                "id": "custom_field_26",
                "name": "Total scalable productivity"
              }
            }
          ],
          "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,
            "buckets": [],
            "sources": [],
            "followup_source": null,
            "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_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": "task_533",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "assigned_to_id": "user_162",
      "contact_id": "contact_3559",
      "due_at": "2017-02-02 22:37:27 UTC",
      "title": "Ad consequatur vero quae dolores temporibus sint repellendus sed animi beatae libero perferendis.",
      "extra_data": {
        "assigned_at": null,
        "completed_at": null,
        "contact": {
          "id": "contact_3559",
          "created_at": "2017-02-01 22:37:27 UTC",
          "updated_at": "2017-02-01 22:37:27 UTC",
          "first_name": "Emery",
          "last_name": "Windler",
          "company": null,
          "location": null,
          "title": "Corporate President",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "00c2cb57-e448-4ca1-bae7-a35f6b8be33b",
              "full_address": "Hellerborough",
              "label": "Office",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3326",
              "label": null,
              "address": "emery.windler@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "ecf7a4c0-def6-490e-a09b-55763fc63644",
              "label": "Facebook",
              "url": "http://kihn.us"
            }
          ],
          "websites": [
            {
              "id": "4e4cf100-e2be-418b-b767-ae3029a6d8f6",
              "label": "Personal",
              "address": "http://dickenswilkinson.com"
            }
          ],
          "phone_numbers": [
            {
              "id": "c833dbc5-f5f3-411f-a01f-b38c5fffa0bb",
              "label": "Corner Payphone",
              "number": "1-152-328-3911"
            }
          ],
          "custom_fields": [
            {
              "value": "molestias",
              "field": {
                "id": "custom_field_25",
                "name": "Multi-layered encompassing flexibility"
              }
            },
            {
              "value": "eius",
              "field": {
                "id": "custom_field_26",
                "name": "Total scalable productivity"
              }
            }
          ],
          "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,
            "buckets": [],
            "sources": [],
            "followup_source": null,
            "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_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"
        }
      }
    }
  ]
}

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_1651",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "name": "Grass-roots fresh-thinking initiative",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "contact_count": 1
      }
    },
    {
      "id": "bucket_1652",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "name": "Function-based leading edge intranet",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "contact_count": 1
      }
    },
    {
      "id": "bucket_1653",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "name": "Cross-platform upward-trending paradigm",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "contact_count": 3
      }
    }
  ]
}

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_1653",
    "created_at": "2017-02-01 22:37:26 UTC",
    "updated_at": "2017-02-01 22:37:26 UTC",
    "name": "Cross-platform upward-trending paradigm",
    "goal": null,
    "reminder_interval": null,
    "extra_data": {
      "relationship_status": {
        "none": 0,
        "strong": 0,
        "fading": 0,
        "weak": 0,
        "rpa": 0,
        "grade": "C-",
        "total": 0
      },
      "contact_count": 3
    }
  },
  "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_1653",
    "created_at": "2017-02-01 22:37:26 UTC",
    "updated_at": "2017-02-01 22:37:26 UTC",
    "name": "Cross-platform upward-trending paradigm",
    "goal": null,
    "reminder_interval": null,
    "extra_data": {
      "relationship_status": {
        "none": 0,
        "strong": 0,
        "fading": 0,
        "weak": 0,
        "rpa": 0,
        "grade": "C-",
        "total": 0
      },
      "contact_count": 3
    }
  },
  "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_1653",
    "created_at": "2017-02-01 22:37:26 UTC",
    "updated_at": "2017-02-01 22:37:26 UTC",
    "name": "Cross-platform upward-trending paradigm",
    "goal": null,
    "reminder_interval": null,
    "extra_data": {
      "relationship_status": {
        "none": 0,
        "strong": 0,
        "fading": 0,
        "weak": 0,
        "rpa": 0,
        "grade": "C-",
        "total": 0
      },
      "contact_count": 3
    }
  },
  "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_1653",
    "created_at": "2017-02-01 22:37:26 UTC",
    "updated_at": "2017-02-01 22:37:26 UTC",
    "name": "Cross-platform upward-trending paradigm",
    "goal": null,
    "reminder_interval": null,
    "extra_data": {
      "relationship_status": {
        "none": 0,
        "strong": 0,
        "fading": 0,
        "weak": 0,
        "rpa": 0,
        "grade": "C-",
        "total": 0
      },
      "contact_count": 3
    }
  },
  "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_3556",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "first_name": "Lavern",
      "last_name": "Nienow",
      "company": null,
      "location": null,
      "title": "Department President",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "e41156e6-72ed-4672-bbee-2c7ff67eaebe",
          "full_address": "Leuschkehaven",
          "label": "Home",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3325",
          "label": null,
          "address": "lavern.nienow@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "df18e70a-4297-4413-af39-77661930e124",
          "label": "LinkedIn",
          "url": "http://vonrueden.biz"
        }
      ],
      "websites": [
        {
          "id": "80cec4fd-580a-4dfc-9169-3c450150f1f4",
          "label": "Personal",
          "address": "http://hackettquitzon.name"
        }
      ],
      "phone_numbers": [
        {
          "id": "7c965057-95dc-48b4-8cf9-008152b2b21c",
          "label": "Home",
          "number": "497.496.3963 x65027"
        }
      ],
      "custom_fields": [
        {
          "value": "odio",
          "field": {
            "id": "custom_field_23",
            "name": "Optimized 24/7 projection"
          }
        },
        {
          "value": "delectus",
          "field": {
            "id": "custom_field_24",
            "name": "Multi-channelled full-range frame"
          }
        }
      ],
      "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,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3559",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "first_name": "Emery",
      "last_name": "Windler",
      "company": null,
      "location": null,
      "title": "Corporate President",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "00c2cb57-e448-4ca1-bae7-a35f6b8be33b",
          "full_address": "Hellerborough",
          "label": "Office",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3326",
          "label": null,
          "address": "emery.windler@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "ecf7a4c0-def6-490e-a09b-55763fc63644",
          "label": "Facebook",
          "url": "http://kihn.us"
        }
      ],
      "websites": [
        {
          "id": "4e4cf100-e2be-418b-b767-ae3029a6d8f6",
          "label": "Personal",
          "address": "http://dickenswilkinson.com"
        }
      ],
      "phone_numbers": [
        {
          "id": "c833dbc5-f5f3-411f-a01f-b38c5fffa0bb",
          "label": "Corner Payphone",
          "number": "1-152-328-3911"
        }
      ],
      "custom_fields": [
        {
          "value": "molestias",
          "field": {
            "id": "custom_field_25",
            "name": "Multi-layered encompassing flexibility"
          }
        },
        {
          "value": "eius",
          "field": {
            "id": "custom_field_26",
            "name": "Total scalable productivity"
          }
        }
      ],
      "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,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3562",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "first_name": "Mohamed",
      "last_name": "Yost",
      "company": null,
      "location": null,
      "title": "Executive Operations Consultant",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
          "full_address": "Selmerfort",
          "label": "Mobile",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3327",
          "label": null,
          "address": "mohamed.yost@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
          "label": "Facebook",
          "url": "http://bailey.com"
        }
      ],
      "websites": [
        {
          "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
          "label": "Business",
          "address": "http://kozey.ca"
        }
      ],
      "phone_numbers": [
        {
          "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
          "label": "Work",
          "number": "1-610-660-8452 x08738"
        }
      ],
      "custom_fields": [
        {
          "value": "repellendus",
          "field": {
            "id": "custom_field_27",
            "name": "Networked clear-thinking archive"
          }
        },
        {
          "value": "ea",
          "field": {
            "id": "custom_field_28",
            "name": "Monitored fresh-thinking moratorium"
          }
        }
      ],
      "extra_data": {
        "last_contacted": null,
        "muted_at": "2017-02-01 22:37:28 UTC",
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "buckets": [
          {
            "id": "bucket_1652",
            "name": "Function-based leading edge intranet",
            "reminder_interval": null
          },
          {
            "id": "bucket_1651",
            "name": "Grass-roots fresh-thinking initiative",
            "reminder_interval": null
          }
        ],
        "sources": [],
        "followup_source": null,
        "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_3556",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "first_name": "Lavern",
      "last_name": "Nienow",
      "company": null,
      "location": null,
      "title": "Department President",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "e41156e6-72ed-4672-bbee-2c7ff67eaebe",
          "full_address": "Leuschkehaven",
          "label": "Home",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3325",
          "label": null,
          "address": "lavern.nienow@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "df18e70a-4297-4413-af39-77661930e124",
          "label": "LinkedIn",
          "url": "http://vonrueden.biz"
        }
      ],
      "websites": [
        {
          "id": "80cec4fd-580a-4dfc-9169-3c450150f1f4",
          "label": "Personal",
          "address": "http://hackettquitzon.name"
        }
      ],
      "phone_numbers": [
        {
          "id": "7c965057-95dc-48b4-8cf9-008152b2b21c",
          "label": "Home",
          "number": "497.496.3963 x65027"
        }
      ],
      "custom_fields": [
        {
          "value": "odio",
          "field": {
            "id": "custom_field_23",
            "name": "Optimized 24/7 projection"
          }
        },
        {
          "value": "delectus",
          "field": {
            "id": "custom_field_24",
            "name": "Multi-channelled full-range frame"
          }
        }
      ],
      "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,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3559",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "first_name": "Emery",
      "last_name": "Windler",
      "company": null,
      "location": null,
      "title": "Corporate President",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "00c2cb57-e448-4ca1-bae7-a35f6b8be33b",
          "full_address": "Hellerborough",
          "label": "Office",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3326",
          "label": null,
          "address": "emery.windler@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "ecf7a4c0-def6-490e-a09b-55763fc63644",
          "label": "Facebook",
          "url": "http://kihn.us"
        }
      ],
      "websites": [
        {
          "id": "4e4cf100-e2be-418b-b767-ae3029a6d8f6",
          "label": "Personal",
          "address": "http://dickenswilkinson.com"
        }
      ],
      "phone_numbers": [
        {
          "id": "c833dbc5-f5f3-411f-a01f-b38c5fffa0bb",
          "label": "Corner Payphone",
          "number": "1-152-328-3911"
        }
      ],
      "custom_fields": [
        {
          "value": "molestias",
          "field": {
            "id": "custom_field_25",
            "name": "Multi-layered encompassing flexibility"
          }
        },
        {
          "value": "eius",
          "field": {
            "id": "custom_field_26",
            "name": "Total scalable productivity"
          }
        }
      ],
      "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,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3562",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "first_name": "Mohamed",
      "last_name": "Yost",
      "company": null,
      "location": null,
      "title": "Executive Operations Consultant",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
          "full_address": "Selmerfort",
          "label": "Mobile",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3327",
          "label": null,
          "address": "mohamed.yost@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
          "label": "Facebook",
          "url": "http://bailey.com"
        }
      ],
      "websites": [
        {
          "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
          "label": "Business",
          "address": "http://kozey.ca"
        }
      ],
      "phone_numbers": [
        {
          "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
          "label": "Work",
          "number": "1-610-660-8452 x08738"
        }
      ],
      "custom_fields": [
        {
          "value": "repellendus",
          "field": {
            "id": "custom_field_27",
            "name": "Networked clear-thinking archive"
          }
        },
        {
          "value": "ea",
          "field": {
            "id": "custom_field_28",
            "name": "Monitored fresh-thinking moratorium"
          }
        }
      ],
      "extra_data": {
        "last_contacted": null,
        "muted_at": "2017-02-01 22:37:28 UTC",
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "buckets": [
          {
            "id": "bucket_1652",
            "name": "Function-based leading edge intranet",
            "reminder_interval": null
          },
          {
            "id": "bucket_1651",
            "name": "Grass-roots fresh-thinking initiative",
            "reminder_interval": null
          }
        ],
        "sources": [],
        "followup_source": null,
        "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_3556",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "first_name": "Lavern",
      "last_name": "Nienow",
      "company": null,
      "location": null,
      "title": "Department President",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "e41156e6-72ed-4672-bbee-2c7ff67eaebe",
          "full_address": "Leuschkehaven",
          "label": "Home",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3325",
          "label": null,
          "address": "lavern.nienow@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "df18e70a-4297-4413-af39-77661930e124",
          "label": "LinkedIn",
          "url": "http://vonrueden.biz"
        }
      ],
      "websites": [
        {
          "id": "80cec4fd-580a-4dfc-9169-3c450150f1f4",
          "label": "Personal",
          "address": "http://hackettquitzon.name"
        }
      ],
      "phone_numbers": [
        {
          "id": "7c965057-95dc-48b4-8cf9-008152b2b21c",
          "label": "Home",
          "number": "497.496.3963 x65027"
        }
      ],
      "custom_fields": [
        {
          "value": "odio",
          "field": {
            "id": "custom_field_23",
            "name": "Optimized 24/7 projection"
          }
        },
        {
          "value": "delectus",
          "field": {
            "id": "custom_field_24",
            "name": "Multi-channelled full-range frame"
          }
        }
      ],
      "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,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3559",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "first_name": "Emery",
      "last_name": "Windler",
      "company": null,
      "location": null,
      "title": "Corporate President",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "00c2cb57-e448-4ca1-bae7-a35f6b8be33b",
          "full_address": "Hellerborough",
          "label": "Office",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3326",
          "label": null,
          "address": "emery.windler@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "ecf7a4c0-def6-490e-a09b-55763fc63644",
          "label": "Facebook",
          "url": "http://kihn.us"
        }
      ],
      "websites": [
        {
          "id": "4e4cf100-e2be-418b-b767-ae3029a6d8f6",
          "label": "Personal",
          "address": "http://dickenswilkinson.com"
        }
      ],
      "phone_numbers": [
        {
          "id": "c833dbc5-f5f3-411f-a01f-b38c5fffa0bb",
          "label": "Corner Payphone",
          "number": "1-152-328-3911"
        }
      ],
      "custom_fields": [
        {
          "value": "molestias",
          "field": {
            "id": "custom_field_25",
            "name": "Multi-layered encompassing flexibility"
          }
        },
        {
          "value": "eius",
          "field": {
            "id": "custom_field_26",
            "name": "Total scalable productivity"
          }
        }
      ],
      "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,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3562",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "first_name": "Mohamed",
      "last_name": "Yost",
      "company": null,
      "location": null,
      "title": "Executive Operations Consultant",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
          "full_address": "Selmerfort",
          "label": "Mobile",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3327",
          "label": null,
          "address": "mohamed.yost@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
          "label": "Facebook",
          "url": "http://bailey.com"
        }
      ],
      "websites": [
        {
          "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
          "label": "Business",
          "address": "http://kozey.ca"
        }
      ],
      "phone_numbers": [
        {
          "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
          "label": "Work",
          "number": "1-610-660-8452 x08738"
        }
      ],
      "custom_fields": [
        {
          "value": "repellendus",
          "field": {
            "id": "custom_field_27",
            "name": "Networked clear-thinking archive"
          }
        },
        {
          "value": "ea",
          "field": {
            "id": "custom_field_28",
            "name": "Monitored fresh-thinking moratorium"
          }
        }
      ],
      "extra_data": {
        "last_contacted": null,
        "muted_at": "2017-02-01 22:37:28 UTC",
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "buckets": [
          {
            "id": "bucket_1652",
            "name": "Function-based leading edge intranet",
            "reminder_interval": null
          },
          {
            "id": "bucket_1651",
            "name": "Grass-roots fresh-thinking initiative",
            "reminder_interval": null
          }
        ],
        "sources": [],
        "followup_source": null,
        "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
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_3556",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "first_name": "Lavern",
      "last_name": "Nienow",
      "company": null,
      "location": null,
      "title": "Department President",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "e41156e6-72ed-4672-bbee-2c7ff67eaebe",
          "full_address": "Leuschkehaven",
          "label": "Home",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3325",
          "label": null,
          "address": "lavern.nienow@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "df18e70a-4297-4413-af39-77661930e124",
          "label": "LinkedIn",
          "url": "http://vonrueden.biz"
        }
      ],
      "websites": [
        {
          "id": "80cec4fd-580a-4dfc-9169-3c450150f1f4",
          "label": "Personal",
          "address": "http://hackettquitzon.name"
        }
      ],
      "phone_numbers": [
        {
          "id": "7c965057-95dc-48b4-8cf9-008152b2b21c",
          "label": "Home",
          "number": "497.496.3963 x65027"
        }
      ],
      "custom_fields": [
        {
          "value": "odio",
          "field": {
            "id": "custom_field_23",
            "name": "Optimized 24/7 projection"
          }
        },
        {
          "value": "delectus",
          "field": {
            "id": "custom_field_24",
            "name": "Multi-channelled full-range frame"
          }
        }
      ],
      "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,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3559",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "first_name": "Emery",
      "last_name": "Windler",
      "company": null,
      "location": null,
      "title": "Corporate President",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "00c2cb57-e448-4ca1-bae7-a35f6b8be33b",
          "full_address": "Hellerborough",
          "label": "Office",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3326",
          "label": null,
          "address": "emery.windler@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "ecf7a4c0-def6-490e-a09b-55763fc63644",
          "label": "Facebook",
          "url": "http://kihn.us"
        }
      ],
      "websites": [
        {
          "id": "4e4cf100-e2be-418b-b767-ae3029a6d8f6",
          "label": "Personal",
          "address": "http://dickenswilkinson.com"
        }
      ],
      "phone_numbers": [
        {
          "id": "c833dbc5-f5f3-411f-a01f-b38c5fffa0bb",
          "label": "Corner Payphone",
          "number": "1-152-328-3911"
        }
      ],
      "custom_fields": [
        {
          "value": "molestias",
          "field": {
            "id": "custom_field_25",
            "name": "Multi-layered encompassing flexibility"
          }
        },
        {
          "value": "eius",
          "field": {
            "id": "custom_field_26",
            "name": "Total scalable productivity"
          }
        }
      ],
      "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,
        "buckets": [],
        "sources": [],
        "followup_source": null,
        "team_last_contacted_by": null,
        "associated_tags": [],
        "associated_company": null,
        "associated_location": null,
        "assigned_to": null
      }
    },
    {
      "id": "contact_3562",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "first_name": "Mohamed",
      "last_name": "Yost",
      "company": null,
      "location": null,
      "title": "Executive Operations Consultant",
      "avatar_url": null,
      "tags": [],
      "assigned_to_id": null,
      "addresses": [
        {
          "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
          "full_address": "Selmerfort",
          "label": "Mobile",
          "street_1": null,
          "street_2": null,
          "city": null,
          "state": null,
          "zip": null,
          "country": null
        }
      ],
      "email_addresses": [
        {
          "id": "contact_identity_3327",
          "label": null,
          "address": "mohamed.yost@example.com"
        }
      ],
      "social_media_profiles": [
        {
          "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
          "label": "Facebook",
          "url": "http://bailey.com"
        }
      ],
      "websites": [
        {
          "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
          "label": "Business",
          "address": "http://kozey.ca"
        }
      ],
      "phone_numbers": [
        {
          "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
          "label": "Work",
          "number": "1-610-660-8452 x08738"
        }
      ],
      "custom_fields": [
        {
          "value": "repellendus",
          "field": {
            "id": "custom_field_27",
            "name": "Networked clear-thinking archive"
          }
        },
        {
          "value": "ea",
          "field": {
            "id": "custom_field_28",
            "name": "Monitored fresh-thinking moratorium"
          }
        }
      ],
      "extra_data": {
        "last_contacted": null,
        "muted_at": "2017-02-01 22:37:28 UTC",
        "relationship_status": "none",
        "team_last_contacted_at": null,
        "team_last_contacted_by_id": null,
        "last_bucketed_at": null,
        "buckets": [
          {
            "id": "bucket_1652",
            "name": "Function-based leading edge intranet",
            "reminder_interval": null
          },
          {
            "id": "bucket_1651",
            "name": "Grass-roots fresh-thinking initiative",
            "reminder_interval": null
          }
        ],
        "sources": [],
        "followup_source": null,
        "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}

🔒 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

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

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_3562",
    "created_at": "2017-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "first_name": "Mohamed",
    "last_name": "Yost",
    "company": null,
    "location": null,
    "title": "Executive Operations Consultant",
    "avatar_url": null,
    "tags": [],
    "assigned_to_id": null,
    "addresses": [
      {
        "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
        "full_address": "Selmerfort",
        "label": "Mobile",
        "street_1": null,
        "street_2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country": null
      }
    ],
    "email_addresses": [
      {
        "id": "contact_identity_3327",
        "label": null,
        "address": "mohamed.yost@example.com"
      }
    ],
    "social_media_profiles": [
      {
        "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
        "label": "Facebook",
        "url": "http://bailey.com"
      }
    ],
    "websites": [
      {
        "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
        "label": "Business",
        "address": "http://kozey.ca"
      }
    ],
    "phone_numbers": [
      {
        "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
        "label": "Work",
        "number": "1-610-660-8452 x08738"
      }
    ],
    "custom_fields": [
      {
        "value": "repellendus",
        "field": {
          "id": "custom_field_27",
          "name": "Networked clear-thinking archive"
        }
      },
      {
        "value": "ea",
        "field": {
          "id": "custom_field_28",
          "name": "Monitored fresh-thinking moratorium"
        }
      }
    ],
    "extra_data": {
      "last_contacted": null,
      "muted_at": "2017-02-01 22:37:28 UTC",
      "relationship_status": "none",
      "team_last_contacted_at": null,
      "team_last_contacted_by_id": null,
      "last_bucketed_at": null,
      "buckets": [
        {
          "id": "bucket_1652",
          "name": "Function-based leading edge intranet",
          "reminder_interval": null
        },
        {
          "id": "bucket_1651",
          "name": "Grass-roots fresh-thinking initiative",
          "reminder_interval": null
        }
      ],
      "sources": [],
      "followup_source": null,
      "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_3562",
    "created_at": "2017-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "first_name": "Mohamed",
    "last_name": "Yost",
    "company": null,
    "location": null,
    "title": "Executive Operations Consultant",
    "avatar_url": null,
    "tags": [],
    "assigned_to_id": null,
    "addresses": [
      {
        "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
        "full_address": "Selmerfort",
        "label": "Mobile",
        "street_1": null,
        "street_2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country": null
      }
    ],
    "email_addresses": [
      {
        "id": "contact_identity_3327",
        "label": null,
        "address": "mohamed.yost@example.com"
      }
    ],
    "social_media_profiles": [
      {
        "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
        "label": "Facebook",
        "url": "http://bailey.com"
      }
    ],
    "websites": [
      {
        "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
        "label": "Business",
        "address": "http://kozey.ca"
      }
    ],
    "phone_numbers": [
      {
        "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
        "label": "Work",
        "number": "1-610-660-8452 x08738"
      }
    ],
    "custom_fields": [
      {
        "value": "repellendus",
        "field": {
          "id": "custom_field_27",
          "name": "Networked clear-thinking archive"
        }
      },
      {
        "value": "ea",
        "field": {
          "id": "custom_field_28",
          "name": "Monitored fresh-thinking moratorium"
        }
      }
    ],
    "extra_data": {
      "last_contacted": null,
      "muted_at": "2017-02-01 22:37:28 UTC",
      "relationship_status": "none",
      "team_last_contacted_at": null,
      "team_last_contacted_by_id": null,
      "last_bucketed_at": null,
      "buckets": [
        {
          "id": "bucket_1652",
          "name": "Function-based leading edge intranet",
          "reminder_interval": null
        },
        {
          "id": "bucket_1651",
          "name": "Grass-roots fresh-thinking initiative",
          "reminder_interval": null
        }
      ],
      "sources": [],
      "followup_source": null,
      "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_3562",
    "created_at": "2017-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "first_name": "Mohamed",
    "last_name": "Yost",
    "company": null,
    "location": null,
    "title": "Executive Operations Consultant",
    "avatar_url": null,
    "tags": [],
    "assigned_to_id": null,
    "addresses": [
      {
        "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
        "full_address": "Selmerfort",
        "label": "Mobile",
        "street_1": null,
        "street_2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country": null
      }
    ],
    "email_addresses": [
      {
        "id": "contact_identity_3327",
        "label": null,
        "address": "mohamed.yost@example.com"
      }
    ],
    "social_media_profiles": [
      {
        "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
        "label": "Facebook",
        "url": "http://bailey.com"
      }
    ],
    "websites": [
      {
        "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
        "label": "Business",
        "address": "http://kozey.ca"
      }
    ],
    "phone_numbers": [
      {
        "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
        "label": "Work",
        "number": "1-610-660-8452 x08738"
      }
    ],
    "custom_fields": [
      {
        "value": "repellendus",
        "field": {
          "id": "custom_field_27",
          "name": "Networked clear-thinking archive"
        }
      },
      {
        "value": "ea",
        "field": {
          "id": "custom_field_28",
          "name": "Monitored fresh-thinking moratorium"
        }
      }
    ],
    "extra_data": {
      "last_contacted": null,
      "muted_at": "2017-02-01 22:37:28 UTC",
      "relationship_status": "none",
      "team_last_contacted_at": null,
      "team_last_contacted_by_id": null,
      "last_bucketed_at": null,
      "buckets": [
        {
          "id": "bucket_1652",
          "name": "Function-based leading edge intranet",
          "reminder_interval": null
        },
        {
          "id": "bucket_1651",
          "name": "Grass-roots fresh-thinking initiative",
          "reminder_interval": null
        }
      ],
      "sources": [],
      "followup_source": null,
      "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_3562",
    "created_at": "2017-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "first_name": "Mohamed",
    "last_name": "Yost",
    "company": null,
    "location": null,
    "title": "Executive Operations Consultant",
    "avatar_url": null,
    "tags": [],
    "assigned_to_id": null,
    "addresses": [
      {
        "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
        "full_address": "Selmerfort",
        "label": "Mobile",
        "street_1": null,
        "street_2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country": null
      }
    ],
    "email_addresses": [
      {
        "id": "contact_identity_3327",
        "label": null,
        "address": "mohamed.yost@example.com"
      }
    ],
    "social_media_profiles": [
      {
        "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
        "label": "Facebook",
        "url": "http://bailey.com"
      }
    ],
    "websites": [
      {
        "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
        "label": "Business",
        "address": "http://kozey.ca"
      }
    ],
    "phone_numbers": [
      {
        "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
        "label": "Work",
        "number": "1-610-660-8452 x08738"
      }
    ],
    "custom_fields": [
      {
        "value": "repellendus",
        "field": {
          "id": "custom_field_27",
          "name": "Networked clear-thinking archive"
        }
      },
      {
        "value": "ea",
        "field": {
          "id": "custom_field_28",
          "name": "Monitored fresh-thinking moratorium"
        }
      }
    ],
    "extra_data": {
      "last_contacted": null,
      "muted_at": "2017-02-01 22:37:28 UTC",
      "relationship_status": "none",
      "team_last_contacted_at": null,
      "team_last_contacted_by_id": null,
      "last_bucketed_at": null,
      "buckets": [
        {
          "id": "bucket_1652",
          "name": "Function-based leading edge intranet",
          "reminder_interval": null
        },
        {
          "id": "bucket_1651",
          "name": "Grass-roots fresh-thinking initiative",
          "reminder_interval": null
        }
      ],
      "sources": [],
      "followup_source": null,
      "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_3562",
    "created_at": "2017-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "first_name": "Mohamed",
    "last_name": "Yost",
    "company": null,
    "location": null,
    "title": "Executive Operations Consultant",
    "avatar_url": null,
    "tags": [],
    "assigned_to_id": null,
    "addresses": [
      {
        "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
        "full_address": "Selmerfort",
        "label": "Mobile",
        "street_1": null,
        "street_2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country": null
      }
    ],
    "email_addresses": [
      {
        "id": "contact_identity_3327",
        "label": null,
        "address": "mohamed.yost@example.com"
      }
    ],
    "social_media_profiles": [
      {
        "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
        "label": "Facebook",
        "url": "http://bailey.com"
      }
    ],
    "websites": [
      {
        "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
        "label": "Business",
        "address": "http://kozey.ca"
      }
    ],
    "phone_numbers": [
      {
        "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
        "label": "Work",
        "number": "1-610-660-8452 x08738"
      }
    ],
    "custom_fields": [
      {
        "value": "repellendus",
        "field": {
          "id": "custom_field_27",
          "name": "Networked clear-thinking archive"
        }
      },
      {
        "value": "ea",
        "field": {
          "id": "custom_field_28",
          "name": "Monitored fresh-thinking moratorium"
        }
      }
    ],
    "extra_data": {
      "last_contacted": null,
      "muted_at": "2017-02-01 22:37:28 UTC",
      "relationship_status": "none",
      "team_last_contacted_at": null,
      "team_last_contacted_by_id": null,
      "last_bucketed_at": null,
      "buckets": [
        {
          "id": "bucket_1652",
          "name": "Function-based leading edge intranet",
          "reminder_interval": null
        },
        {
          "id": "bucket_1651",
          "name": "Grass-roots fresh-thinking initiative",
          "reminder_interval": null
        }
      ],
      "sources": [],
      "followup_source": null,
      "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_1651",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "name": "Grass-roots fresh-thinking initiative",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "contact_count": 1
      }
    },
    {
      "id": "bucket_1652",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "name": "Function-based leading edge intranet",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "contact_count": 1
      }
    }
  ]
}

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_1651",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "name": "Grass-roots fresh-thinking initiative",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "contact_count": 1
      }
    },
    {
      "id": "bucket_1652",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "name": "Function-based leading edge intranet",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "contact_count": 1
      }
    }
  ]
}

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_1651",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "name": "Grass-roots fresh-thinking initiative",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "contact_count": 1
      }
    },
    {
      "id": "bucket_1652",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "name": "Function-based leading edge intranet",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "contact_count": 1
      }
    }
  ]
}

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_1651",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "name": "Grass-roots fresh-thinking initiative",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "contact_count": 1
      }
    },
    {
      "id": "bucket_1652",
      "created_at": "2017-02-01 22:37:26 UTC",
      "updated_at": "2017-02-01 22:37:26 UTC",
      "name": "Function-based leading edge intranet",
      "goal": null,
      "reminder_interval": null,
      "extra_data": {
        "relationship_status": {
          "none": 0,
          "strong": 0,
          "fading": 0,
          "weak": 0,
          "rpa": 0,
          "grade": "C-",
          "total": 0
        },
        "contact_count": 1
      }
    }
  ]
}

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_8249",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "body": null,
      "initiated_by_contact": true,
      "subject": "Open-source zero defect analyzer",
      "timestamp": "2017-02-01 22:37:27 UTC",
      "type": "email",
      "participants": [
        {
          "contact_id": "contact_3562",
          "handle": "vur3hioln7rturl5oup43q==",
          "extra_data": {
            "first_name": "Mohamed",
            "last_name": "Yost",
            "avatar_url": null
          }
        }
      ],
      "extra_data": {
        "editable": true,
        "participant_count": 1,
        "placeholder": false,
        "contact_id": "contact_3562",
        "contact_handle": "vur3hioln7rturl5oup43q==",
        "associated_account_id": null,
        "associated_user": {
          "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"
        },
        "contact": {
          "id": "contact_3562",
          "created_at": "2017-02-01 22:37:27 UTC",
          "updated_at": "2017-02-01 22:37:27 UTC",
          "first_name": "Mohamed",
          "last_name": "Yost",
          "company": null,
          "location": null,
          "title": "Executive Operations Consultant",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
              "full_address": "Selmerfort",
              "label": "Mobile",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3327",
              "label": null,
              "address": "mohamed.yost@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
              "label": "Facebook",
              "url": "http://bailey.com"
            }
          ],
          "websites": [
            {
              "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
              "label": "Business",
              "address": "http://kozey.ca"
            }
          ],
          "phone_numbers": [
            {
              "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
              "label": "Work",
              "number": "1-610-660-8452 x08738"
            }
          ],
          "custom_fields": [
            {
              "value": "repellendus",
              "field": {
                "id": "custom_field_27",
                "name": "Networked clear-thinking archive"
              }
            },
            {
              "value": "ea",
              "field": {
                "id": "custom_field_28",
                "name": "Monitored fresh-thinking moratorium"
              }
            }
          ],
          "extra_data": {
            "last_contacted": null,
            "muted_at": "2017-02-01 22:37:28 UTC",
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "buckets": [
              {
                "id": "bucket_1653",
                "name": "Cross-platform upward-trending paradigm",
                "reminder_interval": null
              },
              {
                "id": "bucket_1652",
                "name": "Function-based leading edge intranet",
                "reminder_interval": null
              },
              {
                "id": "bucket_1651",
                "name": "Grass-roots fresh-thinking initiative",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        }
      }
    },
    {
      "id": "interaction_8250",
      "created_at": "2017-02-01 22:37:28 UTC",
      "updated_at": "2017-02-01 22:37:28 UTC",
      "body": null,
      "initiated_by_contact": true,
      "subject": "Enhanced composite throughput",
      "timestamp": "2017-02-01 22:37:27 UTC",
      "type": "email",
      "participants": [
        {
          "contact_id": "contact_3562",
          "handle": "qnct0cizo5rzxe816aopmw==",
          "extra_data": {
            "first_name": "Mohamed",
            "last_name": "Yost",
            "avatar_url": null
          }
        }
      ],
      "extra_data": {
        "editable": true,
        "participant_count": 1,
        "placeholder": false,
        "contact_id": "contact_3562",
        "contact_handle": "qnct0cizo5rzxe816aopmw==",
        "associated_account_id": null,
        "associated_user": {
          "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"
        },
        "contact": {
          "id": "contact_3562",
          "created_at": "2017-02-01 22:37:27 UTC",
          "updated_at": "2017-02-01 22:37:27 UTC",
          "first_name": "Mohamed",
          "last_name": "Yost",
          "company": null,
          "location": null,
          "title": "Executive Operations Consultant",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
              "full_address": "Selmerfort",
              "label": "Mobile",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3327",
              "label": null,
              "address": "mohamed.yost@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
              "label": "Facebook",
              "url": "http://bailey.com"
            }
          ],
          "websites": [
            {
              "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
              "label": "Business",
              "address": "http://kozey.ca"
            }
          ],
          "phone_numbers": [
            {
              "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
              "label": "Work",
              "number": "1-610-660-8452 x08738"
            }
          ],
          "custom_fields": [
            {
              "value": "repellendus",
              "field": {
                "id": "custom_field_27",
                "name": "Networked clear-thinking archive"
              }
            },
            {
              "value": "ea",
              "field": {
                "id": "custom_field_28",
                "name": "Monitored fresh-thinking moratorium"
              }
            }
          ],
          "extra_data": {
            "last_contacted": null,
            "muted_at": "2017-02-01 22:37:28 UTC",
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "buckets": [
              {
                "id": "bucket_1653",
                "name": "Cross-platform upward-trending paradigm",
                "reminder_interval": null
              },
              {
                "id": "bucket_1652",
                "name": "Function-based leading edge intranet",
                "reminder_interval": null
              },
              {
                "id": "bucket_1651",
                "name": "Grass-roots fresh-thinking initiative",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        }
      }
    },
    {
      "id": "interaction_8248",
      "created_at": "2017-02-01 22:37:27 UTC",
      "updated_at": "2017-02-01 22:37:27 UTC",
      "body": null,
      "initiated_by_contact": true,
      "subject": "Configurable client-server knowledge user",
      "timestamp": "2017-02-01 22:37:27 UTC",
      "type": "email",
      "participants": [
        {
          "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
          }
        }
      ],
      "extra_data": {
        "editable": true,
        "participant_count": 3,
        "placeholder": false,
        "contact_id": "contact_3556",
        "contact_handle": "lavern.nienow@example.com",
        "associated_account_id": null,
        "associated_user": {
          "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"
        },
        "contact": {
          "id": "contact_3556",
          "created_at": "2017-02-01 22:37:27 UTC",
          "updated_at": "2017-02-01 22:37:27 UTC",
          "first_name": "Lavern",
          "last_name": "Nienow",
          "company": null,
          "location": null,
          "title": "Department President",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "e41156e6-72ed-4672-bbee-2c7ff67eaebe",
              "full_address": "Leuschkehaven",
              "label": "Home",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3325",
              "label": null,
              "address": "lavern.nienow@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "df18e70a-4297-4413-af39-77661930e124",
              "label": "LinkedIn",
              "url": "http://vonrueden.biz"
            }
          ],
          "websites": [
            {
              "id": "80cec4fd-580a-4dfc-9169-3c450150f1f4",
              "label": "Personal",
              "address": "http://hackettquitzon.name"
            }
          ],
          "phone_numbers": [
            {
              "id": "7c965057-95dc-48b4-8cf9-008152b2b21c",
              "label": "Home",
              "number": "497.496.3963 x65027"
            }
          ],
          "custom_fields": [
            {
              "value": "odio",
              "field": {
                "id": "custom_field_23",
                "name": "Optimized 24/7 projection"
              }
            },
            {
              "value": "delectus",
              "field": {
                "id": "custom_field_24",
                "name": "Multi-channelled full-range frame"
              }
            }
          ],
          "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,
            "buckets": [
              {
                "id": "bucket_1653",
                "name": "Cross-platform upward-trending paradigm",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "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_22",
      "created_at": "2017-02-01 22:37:28 UTC",
      "updated_at": "2017-02-01 22:37:28 UTC",
      "body": "Similique saepe molestias porro eum iste sed voluptatem sint modi tempore labore officiis.",
      "contact_id": "contact_3562",
      "timestamp": "2017-02-01 22:37:28 UTC",
      "extra_data": {
        "author": {
          "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"
        },
        "contact": {
          "id": "contact_3562",
          "created_at": "2017-02-01 22:37:27 UTC",
          "updated_at": "2017-02-01 22:37:27 UTC",
          "first_name": "Mohamed",
          "last_name": "Yost",
          "company": null,
          "location": null,
          "title": "Executive Operations Consultant",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
              "full_address": "Selmerfort",
              "label": "Mobile",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3327",
              "label": null,
              "address": "mohamed.yost@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
              "label": "Facebook",
              "url": "http://bailey.com"
            }
          ],
          "websites": [
            {
              "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
              "label": "Business",
              "address": "http://kozey.ca"
            }
          ],
          "phone_numbers": [
            {
              "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
              "label": "Work",
              "number": "1-610-660-8452 x08738"
            }
          ],
          "custom_fields": [
            {
              "value": "repellendus",
              "field": {
                "id": "custom_field_27",
                "name": "Networked clear-thinking archive"
              }
            },
            {
              "value": "ea",
              "field": {
                "id": "custom_field_28",
                "name": "Monitored fresh-thinking moratorium"
              }
            }
          ],
          "extra_data": {
            "last_contacted": null,
            "muted_at": "2017-02-01 22:37:28 UTC",
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "buckets": [
              {
                "id": "bucket_1652",
                "name": "Function-based leading edge intranet",
                "reminder_interval": null
              },
              {
                "id": "bucket_1651",
                "name": "Grass-roots fresh-thinking initiative",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        }
      }
    },
    {
      "id": "note_23",
      "created_at": "2017-02-01 22:37:28 UTC",
      "updated_at": "2017-02-01 22:37:28 UTC",
      "body": "Accusamus ipsum dolorem qui quibusdam consectetur quidem quasi perspiciatis autem eum et voluptate quo.",
      "contact_id": "contact_3562",
      "timestamp": "2017-02-01 22:37:28 UTC",
      "extra_data": {
        "author": {
          "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"
        },
        "contact": {
          "id": "contact_3562",
          "created_at": "2017-02-01 22:37:27 UTC",
          "updated_at": "2017-02-01 22:37:27 UTC",
          "first_name": "Mohamed",
          "last_name": "Yost",
          "company": null,
          "location": null,
          "title": "Executive Operations Consultant",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
              "full_address": "Selmerfort",
              "label": "Mobile",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3327",
              "label": null,
              "address": "mohamed.yost@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
              "label": "Facebook",
              "url": "http://bailey.com"
            }
          ],
          "websites": [
            {
              "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
              "label": "Business",
              "address": "http://kozey.ca"
            }
          ],
          "phone_numbers": [
            {
              "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
              "label": "Work",
              "number": "1-610-660-8452 x08738"
            }
          ],
          "custom_fields": [
            {
              "value": "repellendus",
              "field": {
                "id": "custom_field_27",
                "name": "Networked clear-thinking archive"
              }
            },
            {
              "value": "ea",
              "field": {
                "id": "custom_field_28",
                "name": "Monitored fresh-thinking moratorium"
              }
            }
          ],
          "extra_data": {
            "last_contacted": null,
            "muted_at": "2017-02-01 22:37:28 UTC",
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "buckets": [
              {
                "id": "bucket_1652",
                "name": "Function-based leading edge intranet",
                "reminder_interval": null
              },
              {
                "id": "bucket_1651",
                "name": "Grass-roots fresh-thinking initiative",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "team_last_contacted_by": null,
            "associated_tags": [],
            "associated_company": null,
            "associated_location": null,
            "assigned_to": null
          }
        }
      }
    },
    {
      "id": "note_24",
      "created_at": "2017-02-01 22:37:28 UTC",
      "updated_at": "2017-02-01 22:37:28 UTC",
      "body": "Temporibus tenetur quia vitae quis maxime incidunt omnis rem consequatur porro sapiente dolorem aut voluptatum.",
      "contact_id": "contact_3562",
      "timestamp": "2017-02-01 22:37:28 UTC",
      "extra_data": {
        "author": {
          "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"
        },
        "contact": {
          "id": "contact_3562",
          "created_at": "2017-02-01 22:37:27 UTC",
          "updated_at": "2017-02-01 22:37:27 UTC",
          "first_name": "Mohamed",
          "last_name": "Yost",
          "company": null,
          "location": null,
          "title": "Executive Operations Consultant",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
              "full_address": "Selmerfort",
              "label": "Mobile",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3327",
              "label": null,
              "address": "mohamed.yost@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
              "label": "Facebook",
              "url": "http://bailey.com"
            }
          ],
          "websites": [
            {
              "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
              "label": "Business",
              "address": "http://kozey.ca"
            }
          ],
          "phone_numbers": [
            {
              "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
              "label": "Work",
              "number": "1-610-660-8452 x08738"
            }
          ],
          "custom_fields": [
            {
              "value": "repellendus",
              "field": {
                "id": "custom_field_27",
                "name": "Networked clear-thinking archive"
              }
            },
            {
              "value": "ea",
              "field": {
                "id": "custom_field_28",
                "name": "Monitored fresh-thinking moratorium"
              }
            }
          ],
          "extra_data": {
            "last_contacted": null,
            "muted_at": "2017-02-01 22:37:28 UTC",
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "buckets": [
              {
                "id": "bucket_1652",
                "name": "Function-based leading edge intranet",
                "reminder_interval": null
              },
              {
                "id": "bucket_1651",
                "name": "Grass-roots fresh-thinking initiative",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "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_536",
      "created_at": "2017-02-01 22:37:28 UTC",
      "updated_at": "2017-02-01 22:37:28 UTC",
      "assigned_to_id": "user_162",
      "contact_id": "contact_3562",
      "due_at": "2017-02-02 22:37:28 UTC",
      "title": "Est nostrum velit distinctio et rerum rerum sit porro quaerat quis.",
      "extra_data": {
        "assigned_at": null,
        "completed_at": null,
        "contact": {
          "id": "contact_3562",
          "created_at": "2017-02-01 22:37:27 UTC",
          "updated_at": "2017-02-01 22:37:27 UTC",
          "first_name": "Mohamed",
          "last_name": "Yost",
          "company": null,
          "location": null,
          "title": "Executive Operations Consultant",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
              "full_address": "Selmerfort",
              "label": "Mobile",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3327",
              "label": null,
              "address": "mohamed.yost@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
              "label": "Facebook",
              "url": "http://bailey.com"
            }
          ],
          "websites": [
            {
              "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
              "label": "Business",
              "address": "http://kozey.ca"
            }
          ],
          "phone_numbers": [
            {
              "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
              "label": "Work",
              "number": "1-610-660-8452 x08738"
            }
          ],
          "custom_fields": [
            {
              "value": "repellendus",
              "field": {
                "id": "custom_field_27",
                "name": "Networked clear-thinking archive"
              }
            },
            {
              "value": "ea",
              "field": {
                "id": "custom_field_28",
                "name": "Monitored fresh-thinking moratorium"
              }
            }
          ],
          "extra_data": {
            "last_contacted": null,
            "muted_at": "2017-02-01 22:37:28 UTC",
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "buckets": [
              {
                "id": "bucket_1653",
                "name": "Cross-platform upward-trending paradigm",
                "reminder_interval": null
              },
              {
                "id": "bucket_1652",
                "name": "Function-based leading edge intranet",
                "reminder_interval": null
              },
              {
                "id": "bucket_1651",
                "name": "Grass-roots fresh-thinking initiative",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "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_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": "task_535",
      "created_at": "2017-02-01 22:37:28 UTC",
      "updated_at": "2017-02-01 22:37:28 UTC",
      "assigned_to_id": "user_162",
      "contact_id": "contact_3562",
      "due_at": "2017-02-02 22:37:28 UTC",
      "title": "Omnis a sed dolor earum sequi ut ea voluptate nam voluptatem.",
      "extra_data": {
        "assigned_at": null,
        "completed_at": null,
        "contact": {
          "id": "contact_3562",
          "created_at": "2017-02-01 22:37:27 UTC",
          "updated_at": "2017-02-01 22:37:27 UTC",
          "first_name": "Mohamed",
          "last_name": "Yost",
          "company": null,
          "location": null,
          "title": "Executive Operations Consultant",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
              "full_address": "Selmerfort",
              "label": "Mobile",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3327",
              "label": null,
              "address": "mohamed.yost@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
              "label": "Facebook",
              "url": "http://bailey.com"
            }
          ],
          "websites": [
            {
              "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
              "label": "Business",
              "address": "http://kozey.ca"
            }
          ],
          "phone_numbers": [
            {
              "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
              "label": "Work",
              "number": "1-610-660-8452 x08738"
            }
          ],
          "custom_fields": [
            {
              "value": "repellendus",
              "field": {
                "id": "custom_field_27",
                "name": "Networked clear-thinking archive"
              }
            },
            {
              "value": "ea",
              "field": {
                "id": "custom_field_28",
                "name": "Monitored fresh-thinking moratorium"
              }
            }
          ],
          "extra_data": {
            "last_contacted": null,
            "muted_at": "2017-02-01 22:37:28 UTC",
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "buckets": [
              {
                "id": "bucket_1653",
                "name": "Cross-platform upward-trending paradigm",
                "reminder_interval": null
              },
              {
                "id": "bucket_1652",
                "name": "Function-based leading edge intranet",
                "reminder_interval": null
              },
              {
                "id": "bucket_1651",
                "name": "Grass-roots fresh-thinking initiative",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "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_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": "task_534",
      "created_at": "2017-02-01 22:37:28 UTC",
      "updated_at": "2017-02-01 22:37:28 UTC",
      "assigned_to_id": "user_162",
      "contact_id": "contact_3562",
      "due_at": "2017-02-02 22:37:28 UTC",
      "title": "Voluptate reiciendis ipsum et tempore esse sit dolor et ab ad delectus.",
      "extra_data": {
        "assigned_at": null,
        "completed_at": null,
        "contact": {
          "id": "contact_3562",
          "created_at": "2017-02-01 22:37:27 UTC",
          "updated_at": "2017-02-01 22:37:27 UTC",
          "first_name": "Mohamed",
          "last_name": "Yost",
          "company": null,
          "location": null,
          "title": "Executive Operations Consultant",
          "avatar_url": null,
          "tags": [],
          "assigned_to_id": null,
          "addresses": [
            {
              "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
              "full_address": "Selmerfort",
              "label": "Mobile",
              "street_1": null,
              "street_2": null,
              "city": null,
              "state": null,
              "zip": null,
              "country": null
            }
          ],
          "email_addresses": [
            {
              "id": "contact_identity_3327",
              "label": null,
              "address": "mohamed.yost@example.com"
            }
          ],
          "social_media_profiles": [
            {
              "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
              "label": "Facebook",
              "url": "http://bailey.com"
            }
          ],
          "websites": [
            {
              "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
              "label": "Business",
              "address": "http://kozey.ca"
            }
          ],
          "phone_numbers": [
            {
              "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
              "label": "Work",
              "number": "1-610-660-8452 x08738"
            }
          ],
          "custom_fields": [
            {
              "value": "repellendus",
              "field": {
                "id": "custom_field_27",
                "name": "Networked clear-thinking archive"
              }
            },
            {
              "value": "ea",
              "field": {
                "id": "custom_field_28",
                "name": "Monitored fresh-thinking moratorium"
              }
            }
          ],
          "extra_data": {
            "last_contacted": null,
            "muted_at": "2017-02-01 22:37:28 UTC",
            "relationship_status": "none",
            "team_last_contacted_at": null,
            "team_last_contacted_by_id": null,
            "last_bucketed_at": null,
            "buckets": [
              {
                "id": "bucket_1653",
                "name": "Cross-platform upward-trending paradigm",
                "reminder_interval": null
              },
              {
                "id": "bucket_1652",
                "name": "Function-based leading edge intranet",
                "reminder_interval": null
              },
              {
                "id": "bucket_1651",
                "name": "Grass-roots fresh-thinking initiative",
                "reminder_interval": null
              }
            ],
            "sources": [],
            "followup_source": null,
            "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_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"
        }
      }
    }
  ]
}

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_8249",
    "created_at": "2017-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "body": null,
    "initiated_by_contact": true,
    "subject": "Open-source zero defect analyzer",
    "timestamp": "2017-02-01 22:37:27 UTC",
    "type": "email",
    "participants": [
      {
        "contact_id": "contact_3562",
        "handle": "vur3hioln7rturl5oup43q==",
        "extra_data": {
          "first_name": "Mohamed",
          "last_name": "Yost",
          "avatar_url": null
        }
      }
    ],
    "extra_data": {
      "editable": true,
      "participant_count": 1,
      "placeholder": false,
      "contact_id": "contact_3562",
      "contact_handle": "vur3hioln7rturl5oup43q==",
      "associated_account_id": null,
      "associated_user": {
        "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"
      },
      "contact": {
        "id": "contact_3562",
        "created_at": "2017-02-01 22:37:27 UTC",
        "updated_at": "2017-02-01 22:37:27 UTC",
        "first_name": "Mohamed",
        "last_name": "Yost",
        "company": null,
        "location": null,
        "title": "Executive Operations Consultant",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
            "full_address": "Selmerfort",
            "label": "Mobile",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3327",
            "label": null,
            "address": "mohamed.yost@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
            "label": "Facebook",
            "url": "http://bailey.com"
          }
        ],
        "websites": [
          {
            "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
            "label": "Business",
            "address": "http://kozey.ca"
          }
        ],
        "phone_numbers": [
          {
            "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
            "label": "Work",
            "number": "1-610-660-8452 x08738"
          }
        ],
        "custom_fields": [
          {
            "value": "repellendus",
            "field": {
              "id": "custom_field_27",
              "name": "Networked clear-thinking archive"
            }
          },
          {
            "value": "ea",
            "field": {
              "id": "custom_field_28",
              "name": "Monitored fresh-thinking moratorium"
            }
          }
        ],
        "extra_data": {
          "last_contacted": null,
          "muted_at": "2017-02-01 22:37:28 UTC",
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "buckets": [
            {
              "id": "bucket_1652",
              "name": "Function-based leading edge intranet",
              "reminder_interval": null
            },
            {
              "id": "bucket_1651",
              "name": "Grass-roots fresh-thinking initiative",
              "reminder_interval": null
            }
          ],
          "sources": [],
          "followup_source": null,
          "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_8249",
    "created_at": "2017-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "body": null,
    "initiated_by_contact": true,
    "subject": "Open-source zero defect analyzer",
    "timestamp": "2017-02-01 22:37:27 UTC",
    "type": "email",
    "participants": [
      {
        "contact_id": "contact_3562",
        "handle": "vur3hioln7rturl5oup43q==",
        "extra_data": {
          "first_name": "Mohamed",
          "last_name": "Yost",
          "avatar_url": null
        }
      }
    ],
    "extra_data": {
      "editable": true,
      "participant_count": 1,
      "placeholder": false,
      "contact_id": "contact_3562",
      "contact_handle": "vur3hioln7rturl5oup43q==",
      "associated_account_id": null,
      "associated_user": {
        "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"
      },
      "contact": {
        "id": "contact_3562",
        "created_at": "2017-02-01 22:37:27 UTC",
        "updated_at": "2017-02-01 22:37:27 UTC",
        "first_name": "Mohamed",
        "last_name": "Yost",
        "company": null,
        "location": null,
        "title": "Executive Operations Consultant",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
            "full_address": "Selmerfort",
            "label": "Mobile",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3327",
            "label": null,
            "address": "mohamed.yost@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
            "label": "Facebook",
            "url": "http://bailey.com"
          }
        ],
        "websites": [
          {
            "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
            "label": "Business",
            "address": "http://kozey.ca"
          }
        ],
        "phone_numbers": [
          {
            "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
            "label": "Work",
            "number": "1-610-660-8452 x08738"
          }
        ],
        "custom_fields": [
          {
            "value": "repellendus",
            "field": {
              "id": "custom_field_27",
              "name": "Networked clear-thinking archive"
            }
          },
          {
            "value": "ea",
            "field": {
              "id": "custom_field_28",
              "name": "Monitored fresh-thinking moratorium"
            }
          }
        ],
        "extra_data": {
          "last_contacted": null,
          "muted_at": "2017-02-01 22:37:28 UTC",
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "buckets": [
            {
              "id": "bucket_1652",
              "name": "Function-based leading edge intranet",
              "reminder_interval": null
            },
            {
              "id": "bucket_1651",
              "name": "Grass-roots fresh-thinking initiative",
              "reminder_interval": null
            }
          ],
          "sources": [],
          "followup_source": null,
          "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_8249",
    "created_at": "2017-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "body": null,
    "initiated_by_contact": true,
    "subject": "Open-source zero defect analyzer",
    "timestamp": "2017-02-01 22:37:27 UTC",
    "type": "email",
    "participants": [
      {
        "contact_id": "contact_3562",
        "handle": "vur3hioln7rturl5oup43q==",
        "extra_data": {
          "first_name": "Mohamed",
          "last_name": "Yost",
          "avatar_url": null
        }
      }
    ],
    "extra_data": {
      "editable": true,
      "participant_count": 1,
      "placeholder": false,
      "contact_id": "contact_3562",
      "contact_handle": "vur3hioln7rturl5oup43q==",
      "associated_account_id": null,
      "associated_user": {
        "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"
      },
      "contact": {
        "id": "contact_3562",
        "created_at": "2017-02-01 22:37:27 UTC",
        "updated_at": "2017-02-01 22:37:27 UTC",
        "first_name": "Mohamed",
        "last_name": "Yost",
        "company": null,
        "location": null,
        "title": "Executive Operations Consultant",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
            "full_address": "Selmerfort",
            "label": "Mobile",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3327",
            "label": null,
            "address": "mohamed.yost@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
            "label": "Facebook",
            "url": "http://bailey.com"
          }
        ],
        "websites": [
          {
            "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
            "label": "Business",
            "address": "http://kozey.ca"
          }
        ],
        "phone_numbers": [
          {
            "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
            "label": "Work",
            "number": "1-610-660-8452 x08738"
          }
        ],
        "custom_fields": [
          {
            "value": "repellendus",
            "field": {
              "id": "custom_field_27",
              "name": "Networked clear-thinking archive"
            }
          },
          {
            "value": "ea",
            "field": {
              "id": "custom_field_28",
              "name": "Monitored fresh-thinking moratorium"
            }
          }
        ],
        "extra_data": {
          "last_contacted": null,
          "muted_at": "2017-02-01 22:37:28 UTC",
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "buckets": [
            {
              "id": "bucket_1652",
              "name": "Function-based leading edge intranet",
              "reminder_interval": null
            },
            {
              "id": "bucket_1651",
              "name": "Grass-roots fresh-thinking initiative",
              "reminder_interval": null
            }
          ],
          "sources": [],
          "followup_source": null,
          "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_8249",
    "created_at": "2017-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "body": null,
    "initiated_by_contact": true,
    "subject": "Open-source zero defect analyzer",
    "timestamp": "2017-02-01 22:37:27 UTC",
    "type": "email",
    "participants": [
      {
        "contact_id": "contact_3562",
        "handle": "vur3hioln7rturl5oup43q==",
        "extra_data": {
          "first_name": "Mohamed",
          "last_name": "Yost",
          "avatar_url": null
        }
      }
    ],
    "extra_data": {
      "editable": true,
      "participant_count": 1,
      "placeholder": false,
      "contact_id": "contact_3562",
      "contact_handle": "vur3hioln7rturl5oup43q==",
      "associated_account_id": null,
      "associated_user": {
        "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"
      },
      "contact": {
        "id": "contact_3562",
        "created_at": "2017-02-01 22:37:27 UTC",
        "updated_at": "2017-02-01 22:37:27 UTC",
        "first_name": "Mohamed",
        "last_name": "Yost",
        "company": null,
        "location": null,
        "title": "Executive Operations Consultant",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "e5c19f1f-e532-499b-9f94-7bda7663fe48",
            "full_address": "Selmerfort",
            "label": "Mobile",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3327",
            "label": null,
            "address": "mohamed.yost@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "dbfddf91-c4e0-493d-be33-0b708c539283",
            "label": "Facebook",
            "url": "http://bailey.com"
          }
        ],
        "websites": [
          {
            "id": "9d414a14-2b6e-412e-9ebc-e4ec9c88a348",
            "label": "Business",
            "address": "http://kozey.ca"
          }
        ],
        "phone_numbers": [
          {
            "id": "226ea982-945f-4fe6-95c3-5b1b5e9187ab",
            "label": "Work",
            "number": "1-610-660-8452 x08738"
          }
        ],
        "custom_fields": [
          {
            "value": "repellendus",
            "field": {
              "id": "custom_field_27",
              "name": "Networked clear-thinking archive"
            }
          },
          {
            "value": "ea",
            "field": {
              "id": "custom_field_28",
              "name": "Monitored fresh-thinking moratorium"
            }
          }
        ],
        "extra_data": {
          "last_contacted": null,
          "muted_at": "2017-02-01 22:37:28 UTC",
          "relationship_status": "none",
          "team_last_contacted_at": null,
          "team_last_contacted_by_id": null,
          "last_bucketed_at": null,
          "buckets": [
            {
              "id": "bucket_1652",
              "name": "Function-based leading edge intranet",
              "reminder_interval": null
            },
            {
              "id": "bucket_1651",
              "name": "Grass-roots fresh-thinking initiative",
              "reminder_interval": null
            }
          ],
          "sources": [],
          "followup_source": null,
          "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",
    "retrieved_at": "2017-02-01T17:37:32-05:00"
  },
  "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_1654",
      "created_at": "2017-02-01 22:37:28 UTC",
      "updated_at": "2017-02-01 22:37:28 UTC",
      "name": "Synergistic bi-directional budgetary management",
      "contact_count": 0
    },
    {
      "id": "tag_1655",
      "created_at": "2017-02-01 22:37:28 UTC",
      "updated_at": "2017-02-01 22:37:28 UTC",
      "name": "Organic maximized system engine",
      "contact_count": 0
    },
    {
      "id": "tag_1656",
      "created_at": "2017-02-01 22:37:28 UTC",
      "updated_at": "2017-02-01 22:37:28 UTC",
      "name": "User-centric empowering access",
      "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_533",
    "created_at": "2017-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "assigned_to_id": "user_162",
    "contact_id": "contact_3559",
    "due_at": "2017-02-02 22:37:27 UTC",
    "title": "Ad consequatur vero quae dolores temporibus sint repellendus sed animi beatae libero perferendis.",
    "extra_data": {
      "assigned_at": null,
      "completed_at": null,
      "contact": {
        "id": "contact_3559",
        "created_at": "2017-02-01 22:37:27 UTC",
        "updated_at": "2017-02-01 22:37:27 UTC",
        "first_name": "Emery",
        "last_name": "Windler",
        "company": null,
        "location": null,
        "title": "Corporate President",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "00c2cb57-e448-4ca1-bae7-a35f6b8be33b",
            "full_address": "Hellerborough",
            "label": "Office",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3326",
            "label": null,
            "address": "emery.windler@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "ecf7a4c0-def6-490e-a09b-55763fc63644",
            "label": "Facebook",
            "url": "http://kihn.us"
          }
        ],
        "websites": [
          {
            "id": "4e4cf100-e2be-418b-b767-ae3029a6d8f6",
            "label": "Personal",
            "address": "http://dickenswilkinson.com"
          }
        ],
        "phone_numbers": [
          {
            "id": "c833dbc5-f5f3-411f-a01f-b38c5fffa0bb",
            "label": "Corner Payphone",
            "number": "1-152-328-3911"
          }
        ],
        "custom_fields": [
          {
            "value": "molestias",
            "field": {
              "id": "custom_field_25",
              "name": "Multi-layered encompassing flexibility"
            }
          },
          {
            "value": "eius",
            "field": {
              "id": "custom_field_26",
              "name": "Total scalable productivity"
            }
          }
        ],
        "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,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "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_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/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_533",
    "created_at": "2017-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "assigned_to_id": "user_162",
    "contact_id": "contact_3559",
    "due_at": "2017-02-02 22:37:27 UTC",
    "title": "Ad consequatur vero quae dolores temporibus sint repellendus sed animi beatae libero perferendis.",
    "extra_data": {
      "assigned_at": null,
      "completed_at": null,
      "contact": {
        "id": "contact_3559",
        "created_at": "2017-02-01 22:37:27 UTC",
        "updated_at": "2017-02-01 22:37:27 UTC",
        "first_name": "Emery",
        "last_name": "Windler",
        "company": null,
        "location": null,
        "title": "Corporate President",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "00c2cb57-e448-4ca1-bae7-a35f6b8be33b",
            "full_address": "Hellerborough",
            "label": "Office",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3326",
            "label": null,
            "address": "emery.windler@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "ecf7a4c0-def6-490e-a09b-55763fc63644",
            "label": "Facebook",
            "url": "http://kihn.us"
          }
        ],
        "websites": [
          {
            "id": "4e4cf100-e2be-418b-b767-ae3029a6d8f6",
            "label": "Personal",
            "address": "http://dickenswilkinson.com"
          }
        ],
        "phone_numbers": [
          {
            "id": "c833dbc5-f5f3-411f-a01f-b38c5fffa0bb",
            "label": "Corner Payphone",
            "number": "1-152-328-3911"
          }
        ],
        "custom_fields": [
          {
            "value": "molestias",
            "field": {
              "id": "custom_field_25",
              "name": "Multi-layered encompassing flexibility"
            }
          },
          {
            "value": "eius",
            "field": {
              "id": "custom_field_26",
              "name": "Total scalable productivity"
            }
          }
        ],
        "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,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "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_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/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_533",
    "created_at": "2017-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "assigned_to_id": "user_162",
    "contact_id": "contact_3559",
    "due_at": "2017-02-02 22:37:27 UTC",
    "title": "Ad consequatur vero quae dolores temporibus sint repellendus sed animi beatae libero perferendis.",
    "extra_data": {
      "assigned_at": null,
      "completed_at": null,
      "contact": {
        "id": "contact_3559",
        "created_at": "2017-02-01 22:37:27 UTC",
        "updated_at": "2017-02-01 22:37:27 UTC",
        "first_name": "Emery",
        "last_name": "Windler",
        "company": null,
        "location": null,
        "title": "Corporate President",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "00c2cb57-e448-4ca1-bae7-a35f6b8be33b",
            "full_address": "Hellerborough",
            "label": "Office",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3326",
            "label": null,
            "address": "emery.windler@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "ecf7a4c0-def6-490e-a09b-55763fc63644",
            "label": "Facebook",
            "url": "http://kihn.us"
          }
        ],
        "websites": [
          {
            "id": "4e4cf100-e2be-418b-b767-ae3029a6d8f6",
            "label": "Personal",
            "address": "http://dickenswilkinson.com"
          }
        ],
        "phone_numbers": [
          {
            "id": "c833dbc5-f5f3-411f-a01f-b38c5fffa0bb",
            "label": "Corner Payphone",
            "number": "1-152-328-3911"
          }
        ],
        "custom_fields": [
          {
            "value": "molestias",
            "field": {
              "id": "custom_field_25",
              "name": "Multi-layered encompassing flexibility"
            }
          },
          {
            "value": "eius",
            "field": {
              "id": "custom_field_26",
              "name": "Total scalable productivity"
            }
          }
        ],
        "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,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "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_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/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_533",
    "created_at": "2017-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "assigned_to_id": "user_162",
    "contact_id": "contact_3559",
    "due_at": "2017-02-02 22:37:27 UTC",
    "title": "Ad consequatur vero quae dolores temporibus sint repellendus sed animi beatae libero perferendis.",
    "extra_data": {
      "assigned_at": null,
      "completed_at": null,
      "contact": {
        "id": "contact_3559",
        "created_at": "2017-02-01 22:37:27 UTC",
        "updated_at": "2017-02-01 22:37:27 UTC",
        "first_name": "Emery",
        "last_name": "Windler",
        "company": null,
        "location": null,
        "title": "Corporate President",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "00c2cb57-e448-4ca1-bae7-a35f6b8be33b",
            "full_address": "Hellerborough",
            "label": "Office",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3326",
            "label": null,
            "address": "emery.windler@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "ecf7a4c0-def6-490e-a09b-55763fc63644",
            "label": "Facebook",
            "url": "http://kihn.us"
          }
        ],
        "websites": [
          {
            "id": "4e4cf100-e2be-418b-b767-ae3029a6d8f6",
            "label": "Personal",
            "address": "http://dickenswilkinson.com"
          }
        ],
        "phone_numbers": [
          {
            "id": "c833dbc5-f5f3-411f-a01f-b38c5fffa0bb",
            "label": "Corner Payphone",
            "number": "1-152-328-3911"
          }
        ],
        "custom_fields": [
          {
            "value": "molestias",
            "field": {
              "id": "custom_field_25",
              "name": "Multi-layered encompassing flexibility"
            }
          },
          {
            "value": "eius",
            "field": {
              "id": "custom_field_26",
              "name": "Total scalable productivity"
            }
          }
        ],
        "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,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "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_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": {}
}

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-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "assigned_to_id": "user_162",
    "contact_id": "contact_3559",
    "due_at": "2017-02-02 22:37:27 UTC",
    "title": "Veniam quia voluptatem itaque voluptas quia occaecati ut illum ad sed.",
    "extra_data": {
      "assigned_at": null,
      "completed_at": "2017-02-01 22:37:28 UTC",
      "contact": {
        "id": "contact_3559",
        "created_at": "2017-02-01 22:37:27 UTC",
        "updated_at": "2017-02-01 22:37:27 UTC",
        "first_name": "Emery",
        "last_name": "Windler",
        "company": null,
        "location": null,
        "title": "Corporate President",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "00c2cb57-e448-4ca1-bae7-a35f6b8be33b",
            "full_address": "Hellerborough",
            "label": "Office",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3326",
            "label": null,
            "address": "emery.windler@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "ecf7a4c0-def6-490e-a09b-55763fc63644",
            "label": "Facebook",
            "url": "http://kihn.us"
          }
        ],
        "websites": [
          {
            "id": "4e4cf100-e2be-418b-b767-ae3029a6d8f6",
            "label": "Personal",
            "address": "http://dickenswilkinson.com"
          }
        ],
        "phone_numbers": [
          {
            "id": "c833dbc5-f5f3-411f-a01f-b38c5fffa0bb",
            "label": "Corner Payphone",
            "number": "1-152-328-3911"
          }
        ],
        "custom_fields": [
          {
            "value": "molestias",
            "field": {
              "id": "custom_field_25",
              "name": "Multi-layered encompassing flexibility"
            }
          },
          {
            "value": "eius",
            "field": {
              "id": "custom_field_26",
              "name": "Total scalable productivity"
            }
          }
        ],
        "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,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "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_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": {}
}

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_533",
    "created_at": "2017-02-01 22:37:27 UTC",
    "updated_at": "2017-02-01 22:37:27 UTC",
    "assigned_to_id": "user_162",
    "contact_id": "contact_3559",
    "due_at": "2017-02-02 22:37:27 UTC",
    "title": "Ad consequatur vero quae dolores temporibus sint repellendus sed animi beatae libero perferendis.",
    "extra_data": {
      "assigned_at": null,
      "completed_at": null,
      "contact": {
        "id": "contact_3559",
        "created_at": "2017-02-01 22:37:27 UTC",
        "updated_at": "2017-02-01 22:37:27 UTC",
        "first_name": "Emery",
        "last_name": "Windler",
        "company": null,
        "location": null,
        "title": "Corporate President",
        "avatar_url": null,
        "tags": [],
        "assigned_to_id": null,
        "addresses": [
          {
            "id": "00c2cb57-e448-4ca1-bae7-a35f6b8be33b",
            "full_address": "Hellerborough",
            "label": "Office",
            "street_1": null,
            "street_2": null,
            "city": null,
            "state": null,
            "zip": null,
            "country": null
          }
        ],
        "email_addresses": [
          {
            "id": "contact_identity_3326",
            "label": null,
            "address": "emery.windler@example.com"
          }
        ],
        "social_media_profiles": [
          {
            "id": "ecf7a4c0-def6-490e-a09b-55763fc63644",
            "label": "Facebook",
            "url": "http://kihn.us"
          }
        ],
        "websites": [
          {
            "id": "4e4cf100-e2be-418b-b767-ae3029a6d8f6",
            "label": "Personal",
            "address": "http://dickenswilkinson.com"
          }
        ],
        "phone_numbers": [
          {
            "id": "c833dbc5-f5f3-411f-a01f-b38c5fffa0bb",
            "label": "Corner Payphone",
            "number": "1-152-328-3911"
          }
        ],
        "custom_fields": [
          {
            "value": "molestias",
            "field": {
              "id": "custom_field_25",
              "name": "Multi-layered encompassing flexibility"
            }
          },
          {
            "value": "eius",
            "field": {
              "id": "custom_field_26",
              "name": "Total scalable productivity"
            }
          }
        ],
        "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,
          "buckets": [],
          "sources": [],
          "followup_source": null,
          "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_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": {}
}

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

🔒 team:view team: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

🔒 team:manage all:manage

Valid types:

textfield textarea dropdown boolean

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}

🔒 team:manage all:manage

URI Parameters
HideShow
id
string (required) Example: custom_field_59

The custom field id


Generated by aglio on 26 Feb 2017