Contacts

Get contacts with recent actions

GET /contacts/recent

If the contact has a case associated it is located in the "case" key.

Response
Status code 200

{
  "data": [
    {
      "id": "5901faa7-06c0-389f-b869-a1fb81fe4d95",
      "b2c": false,
      "account": {
        "id": "0272e0a0-f142-3edf-85e3-81c4b69f3a1b",
        "name": "Hedegaard & Vestergaard K/S"
      },
      "user": {
        "id": 1,
        "first_name": "Jane",
        "last_name": "Doe",
        "phone_number": "+4588888888",
        "job_title": "Sales Executive",
        "email": "demo@easir.com",
        "email_notifications": false,
        "profile_picture": "https://example/5.jpg",
        "system_user": false,
        "created_at": "2014-01-01 12:45:56",
        "updated_at": "2014-01-02 00:11:22"
      },
      "team_id": 1,
      "team": {
        "id": 1,
        "name": "Team 1",
        "address_1": "Savannah 123",
        "address_2": "Under the tree on the left",
        "zip_code": "4730",
        "city": "Umzimkulu",
        "state": "KwaZulu-Natal",
        "country": null,
        "phone_number": "031 308 7900",
        "website": "https:\/\/easir.com",
        "vat": "1234567890123456",
        "team_type": null,
        "group_id": 1,
        "use_social_lookup": false,
        "created_at": "2014-01-01 12:45:56",
        "updated_at": "2014-01-02 00:11:22"
      },
      "status": "lead",
      "fixed_fields": [
        {
          "id": 10,
          "type": "text",
          "name": "salutation",
          "label": "Salutation",
          "value": "Ms.",
          "validation": null,
          "required": false,
          "hidden": false,
          "read_only": false,
          "sort_order": 0
        },
        {
          "id": 12,
          "type": "text",
          "name": "last_name",
          "label": "Last name",
          "value": "Philipsen",
          "validation": null,
          "required": true,
          "hidden": false,
          "read_only": false,
          "sort_order": 0
        }
      ],
      "custom_fields": [
        {
          "id": 8,
          "type": "text",
          "name": "email",
          "label": "Custom E-mail",
          "value": null,
          "validation": "email",
          "required": false,
          "hidden": false,
          "read_only": false,
          "sort_order": 11
        },
        {
          "id": 10,
          "type": "date",
          "name": "date",
          "label": "Custom Date",
          "value": null,
          "validation": "date",
          "required": false,
          "hidden": false,
          "read_only": false,
          "sort_order": 9
        },
        {
          "id": 12,
          "type": "multiple_choice",
          "name": "multiple_choice",
          "label": "Custom Multiple Choice",
          "value": null,
          "validation": null,
          "required": false,
          "hidden": false,
          "read_only": false,
          "sort_order": 7
        }
      ],
      "created_at": "2017-02-24 12:34:56",
      "updated_at": "2017-02-25 12:34:56",
      "latest_activity_at": null,
      "social_profile": {}
    }
  ]
}

Get all contacts

GET /contacts

Query string parameters

Response
Status code 200

{
  "data": [
    {
      "id": "f151d85b-83b5-3db4-ace6-765c38acb542",
      "b2c": false,
      "account": {
        "id": "ea44a0bf-021d-36e0-9673-4fd080b4ec37",
        "name": "Buhl ApS"
      },
      "user": {
        "id": 8,
        "first_name": "Lilliana",
        "last_name": "Marks",
        "phone_number": "(375) 381-1608 x909",
        "job_title": "Business Analytics Director",
        "email": "6@example.com",
        "email_notifications": false,
        "profile_picture": "http:\/\/lerablog.org\/wp-content\/uploads\/2014\/05\/Smiling-man-on-Shutterstock1.jpg",
        "system_user": false,
        "created_at": "2016-11-07 10:54:34",
        "updated_at": "2016-12-31 02:04:42"
      },
      "team_id": 1,
      "team": {
        "id": 1,
        "name": "Team 1",
        "address_1": "Savannah 123",
        "address_2": "Under the tree on the left",
        "zip_code": "4730",
        "city": "Umzimkulu",
        "state": "KwaZulu-Natal",
        "country": null,
        "phone_number": "031 308 7900",
        "website": "https:\/\/easir.com",
        "vat": "1234567890123456",
        "team_type": null,
        "group_id": 1,
        "use_social_lookup": false,
        "created_at": "2014-01-01 12:45:56",
        "updated_at": "2014-01-02 00:11:22"
      },
      "status": "customer",
      "fixed_fields": [
        {
          "id": 10,
          "type": "text",
          "name": "salutation",
          "label": "Salutation",
          "value": "Dr.",
          "validation": null,
          "required": false,
          "hidden": false,
          "read_only": false,
          "sort_order": 0
        },
        {
          "id": 12,
          "type": "text",
          "name": "last_name",
          "label": "Last name",
          "value": "Dupont",
          "validation": null,
          "required": true,
          "hidden": false,
          "read_only": false,
          "sort_order": 0
        }
      ],
      "custom_fields": [
        {
          "id": 8,
          "type": "text",
          "name": "email",
          "label": "Custom E-mail",
          "value": null,
          "validation": "email",
          "required": false,
          "hidden": false,
          "read_only": false,
          "sort_order": 11
        },
        {
          "id": 10,
          "type": "date",
          "name": "date",
          "label": "Custom Date",
          "value": null,
          "validation": "date",
          "required": false,
          "hidden": false,
          "read_only": false,
          "sort_order": 9
        }
      ],
      "created_at": "2015-02-24 12:34:56",
      "updated_at": "2015-02-24 12:34:56",
      "latest_activity_at": null,
      "social_profile": {}
    }
  ],
  "pagination": {
    "total": 100,
    "page": 1,
    "per_page": 1,
    "urls": {
      "previous": null,
      "next": "http://api.easir.com/contacts/?page=2"
    }
  }
}

Get contacts for account

GET /accounts/:account_id/contacts

Query string parameters

Response
Status code 200

{
  "data": [
    {
      "id": "8dbb05f9-e19c-34f8-8885-eed4e520bf3c",
      "b2c": true,
      "account": {
        "id": "3cb87c2f-0feb-3b10-90a1-b5d01bb3eb69",
        "name": "B2C - Krogh & Vester"
      },
      "user": {
        "id": 2,
        "first_name": "Brenda",
        "last_name": "Heathcote",
        "phone_number": "1-879-788-3129 x8981",
        "job_title": "Data Miner",
        "email": "0@example.com",
        "email_notifications": false,
        "profile_picture": null,
        "system_user": false,
        "created_at": "2017-01-14 16:59:55",
        "updated_at": "2017-03-03 13:08:43"
      },
      "team_id": 1,
      "team": {
        "id": 1,
        "name": "Team 1",
        "address_1": "Savannah 123",
        "address_2": "Under the tree on the left",
        "zip_code": "4730",
        "city": "Umzimkulu",
        "state": "KwaZulu-Natal",
        "country": null,
        "phone_number": "031 308 7900",
        "website": "https:\/\/easir.com",
        "vat": "1234567890123456",
        "team_type": null,
        "group_id": 1,
        "use_social_lookup": false,
        "created_at": "2014-01-01 12:45:56",
        "updated_at": "2014-01-02 00:11:22"
      },
      "status": "opportunity",
      "fixed_fields": [
        {
          "id": 17,
          "type": "text",
          "name": "salutation",
          "label": "Salutation",
          "value": "Prof.",
          "validation": null,
          "required": false,
          "hidden": false,
          "read_only": false,
          "sort_order": 0
        },
        {
          "id": 27,
          "type": "text",
          "name": "state_region",
          "label": "State\/Region",
          "value": null,
          "validation": null,
          "required": false,
          "hidden": false,
          "read_only": false,
          "sort_order": 0
        }
      ],
      "custom_fields": [
        {
          "id": 13,
          "type": "text",
          "name": "something_other_custom",
          "label": "Something other custom",
          "value": null,
          "validation": null,
          "required": false,
          "hidden": false,
          "read_only": false,
          "sort_order": 6
        }
      ],
      "created_at": "2015-02-24 12:34:56",
      "updated_at": "2015-02-24 12:34:56",
      "latest_activity_at": null,
      "social_profile": {}
    }
  ],
  "pagination": {
    "total": 2,
    "page": 1,
    "per_page": 15,
    "urls": {
      "previous": null,
      "next": null
    }
  }
}

Find a contact

GET /accounts/:account_id/contacts/:contact_id

Response
Status code 200

{
  "id": "f151d85b-83b5-3db4-ace6-765c38acb542",
  "b2c": false,
  "account": {
    "id": "ea44a0bf-021d-36e0-9673-4fd080b4ec37",
    "name": "Buhl ApS"
  },
  "user": {
    "id": 8,
    "first_name": "Lilliana",
    "last_name": "Marks",
    "phone_number": "(375) 381-1608 x909",
    "job_title": "Business Analytics Director",
    "email": "6@example.com",
    "email_notifications": false,
    "profile_picture": "http:\/\/example.org\/wp-content\/uploads\/2014\/05\/Smiling-man-on-Shutterstock1.jpg",
    "system_user": false,
    "created_at": "2016-11-07 10:54:34",
    "updated_at": "2016-12-31 02:04:42"
  },
  "team_id": 1,
  "team": {
    "id": 1,
    "name": "Team 1",
    "address_1": "Savannah 123",
    "address_2": "Under the tree on the left",
    "zip_code": "4730",
    "city": "Umzimkulu",
    "state": "KwaZulu-Natal",
    "country": null,
    "phone_number": "031 308 7900",
    "website": "https:\/\/easir.com",
    "vat": "1234567890123456",
    "team_type": null,
    "group_id": 1,
    "use_social_lookup": false,
    "created_at": "2014-01-01 12:45:56",
    "updated_at": "2014-01-02 00:11:22"
  },
  "status": "customer",
  "fixed_fields": [
    {
      "id": 10,
      "type": "text",
      "name": "salutation",
      "label": "Salutation",
      "value": "Dr.",
      "validation": null,
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 0
    },
    {
      "id": 12,
      "type": "text",
      "name": "last_name",
      "label": "Last name",
      "value": "Dupont",
      "validation": null,
      "required": true,
      "hidden": false,
      "read_only": false,
      "sort_order": 0
    }
  ],
  "custom_fields": [
    {
      "id": 8,
      "type": "text",
      "name": "email",
      "label": "Custom E-mail",
      "value": null,
      "validation": "email",
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 11
    },
    {
      "id": 10,
      "type": "date",
      "name": "date",
      "label": "Custom Date",
      "value": null,
      "validation": "date",
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 9
    },
    {
      "id": 12,
      "type": "multiple_choice",
      "name": "multiple_choice",
      "label": "Custom Multiple Choice",
      "value": null,
      "validation": null,
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 7,
      "options": [
        {
          "id": 522,
          "value": "et"
        },
        {
          "id": 523,
          "value": "aut"
        },
        {
          "id": 524,
          "value": "occaecati"
        },
        {
          "id": 525,
          "value": "ut"
        },
        {
          "id": 526,
          "value": "unde"
        },
        {
          "id": 527,
          "value": "maxime"
        },
        {
          "id": 528,
          "value": "veniam"
        },
        {
          "id": 529,
          "value": "temporibus"
        }
      ]
    }
  ],
  "created_at": "2015-02-24 12:34:56",
  "updated_at": "2015-02-24 12:34:56",
  "latest_activity_at": null,
  "social_profile": {}
}

Create contact

POST /accounts/:account_id/contacts

Parameters

  • user_id integer
  • team_id integer
    • Required without user_id
  • Supports Fields
    • Required
    • Matching resource Contact

Payload

{
  "user_id": 76,
  "team_id": 5,
  "fixed_fields": [
    {
      "name": "first_name",
      "value": "Contact First Name"
    },
    {
      "name": "last_name",
      "value": "Contact Last Name"
    },
    {
      "name": "email",
      "value": "contact@example.com"
    }
  ],
  "custom_fields": [
    {
      "name": "number",
      "value": 123
    },
    {
      "name": "single_choice",
      "value": 512
    },
    {
      "id": 8,
      "value": "email@easir.com"
    }
  ]
}

Response
Status code 201

{
  "id": "f7108fbc-5fd3-4bba-b2f3-96cda8f7b7e8",
  "b2c": false,
  "account": {
    "id": "ea44a0bf-021d-36e0-9673-4fd080b4ec37",
    "b2c": false,
    "team_id": 1,
    "team": {
      "id": 1,
      "name": "Team 1",
      "address_1": "Savannah 123",
      "address_2": "Under the tree on the left",
      "zip_code": "4730",
      "city": "Umzimkulu",
      "state": "KwaZulu-Natal",
      "country": null,
      "phone_number": "031 308 7900",
      "website": "https:\/\/easir.com",
      "vat": "1234567890123456",
      "team_type": null,
      "group_id": 1,
      "use_social_lookup": false,
      "created_at": "2014-01-01 12:45:56",
      "updated_at": "2014-01-02 00:11:22"
    },
    "fixed_fields": [
      {
        "id": 1,
        "type": "text",
        "name": "name",
        "label": "Name",
        "value": "Buhl ApS",
        "validation": null,
        "required": true,
        "hidden": false,
        "read_only": false,
        "sort_order": 0
      },
      {
        "id": 3,
        "type": "text",
        "name": "zip_code",
        "label": "Zip code",
        "value": 4911,
        "validation": null,
        "required": false,
        "hidden": false,
        "read_only": false,
        "sort_order": 0
      },
      {
        "id": 5,
        "type": "text",
        "name": "state_region",
        "label": "State\/Region",
        "value": "Favrskov",
        "validation": null,
        "required": false,
        "hidden": false,
        "read_only": false,
        "sort_order": 0
      },
      {
        "id": 7,
        "type": "text",
        "name": "vat",
        "label": "VAT",
        "value": 25487202062,
        "validation": null,
        "required": false,
        "hidden": false,
        "read_only": false,
        "sort_order": 0
      },
      {
        "id": 2,
        "type": "text",
        "name": "address",
        "label": "Address",
        "value": "Falkvej 6, 7. th.\n2910 Kastrup",
        "validation": null,
        "required": false,
        "hidden": false,
        "read_only": false,
        "sort_order": 0
      },
      {
        "id": 4,
        "type": "text",
        "name": "city",
        "label": "City",
        "value": "Gram",
        "validation": null,
        "required": false,
        "hidden": false,
        "read_only": false,
        "sort_order": 0
      },
      {
        "id": 6,
        "type": "single_choice",
        "name": "country",
        "label": "Country",
        "value": {
          "id": 32,
          "value": "AZ"
        },
        "validation": null,
        "required": false,
        "hidden": false,
        "read_only": false,
        "sort_order": 0
      },
      {
        "id": 8,
        "type": "text",
        "name": "website",
        "label": "Website",
        "value": "http:\/\/Vinther.info\/impedit-at-quo-tempore-voluptatem-aut-voluptatem",
        "validation": "url",
        "required": false,
        "hidden": false,
        "read_only": false,
        "sort_order": 0
      }
    ],
    "custom_fields": [
      {
        "id": 1,
        "type": "text",
        "name": "email",
        "label": "Custom E-mail",
        "value": null,
        "validation": "email",
        "required": false,
        "hidden": false,
        "read_only": false,
        "sort_order": 18
      },
      {
        "id": 6,
        "type": "multiple_choice",
        "name": "multiple_choice",
        "label": "Custom Multiple Choice",
        "value": null,
        "validation": null,
        "required": false,
        "hidden": false,
        "read_only": false,
        "sort_order": 13
      },
      {
        "id": 3,
        "type": "date",
        "name": "date",
        "label": "Custom Date",
        "value": null,
        "validation": "date",
        "required": false,
        "hidden": false,
        "read_only": false,
        "sort_order": 16
      },
      {
        "id": 5,
        "type": "single_choice",
        "name": "single_choice",
        "label": "Custom Single Choice",
        "value": null,
        "validation": null,
        "required": false,
        "hidden": false,
        "read_only": false,
        "sort_order": 14
      },
      {
        "id": 2,
        "type": "numeric",
        "name": "number",
        "label": "Custom Number",
        "value": null,
        "validation": "numeric",
        "required": false,
        "hidden": false,
        "read_only": false,
        "sort_order": 17
      },
      {
        "id": 4,
        "type": "boolean",
        "name": "boolean",
        "label": "Custom Boolean",
        "value": null,
        "validation": "boolean",
        "required": false,
        "hidden": false,
        "read_only": false,
        "sort_order": 15
      }
    ],
    "created_at": "2015-02-24 12:34:56",
    "updated_at": "2015-02-24 12:34:56",
    "latest_activity_at": null
  },
  "user": {
    "id": 76,
    "first_name": "Weldon",
    "last_name": "Waters",
    "phone_number": "(686) 716-3805",
    "job_title": "Data Architect",
    "email": "74@example.com",
    "email_notifications": false,
    "profile_picture": null,
    "system_user": false,
    "created_at": "2016-09-10 19:05:08",
    "updated_at": "2016-12-25 13:01:19"
  },
  "team_id": 1,
  "team": null,
  "status": "lead",
  "fixed_fields": [
    {
      "id": 12,
      "type": "text",
      "name": "last_name",
      "label": "Last name",
      "value": "Contact Last Name",
      "validation": null,
      "required": true,
      "hidden": false,
      "read_only": false,
      "sort_order": 0
    },
    {
      "id": 13,
      "type": "text",
      "name": "email",
      "label": "Email",
      "value": "contact@example.com",
      "validation": "email",
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 0
    },
    {
      "id": 16,
      "type": "text",
      "name": "title",
      "label": "Title",
      "value": null,
      "validation": null,
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 0
    },
    {
      "id": 37,
      "type": "date",
      "name": "date_of_birth",
      "label": "Date of Birth",
      "value": null,
      "validation": "date",
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 0
    }
  ],
  "custom_fields": [
    {
      "id": 8,
      "type": "text",
      "name": "email",
      "label": "Custom E-mail",
      "value": "email@easir.com",
      "validation": "email",
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 11
    },
    {
      "id": 10,
      "type": "date",
      "name": "date",
      "label": "Custom Date",
      "value": null,
      "validation": "date",
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 9
    },
    {
      "id": 12,
      "type": "multiple_choice",
      "name": "multiple_choice",
      "label": "Custom Multiple Choice",
      "value": null,
      "validation": null,
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 7,
      "options": [
        {
          "id": 522,
          "value": "et"
        },
        {
          "id": 523,
          "value": "aut"
        },
        {
          "id": 524,
          "value": "occaecati"
        },
        {
          "id": 525,
          "value": "ut"
        },
        {
          "id": 526,
          "value": "unde"
        },
        {
          "id": 527,
          "value": "maxime"
        },
        {
          "id": 528,
          "value": "veniam"
        },
        {
          "id": 529,
          "value": "temporibus"
        }
      ]
    },
    {
      "id": 9,
      "type": "numeric",
      "name": "number",
      "label": "Custom Number",
      "value": 123,
      "validation": "numeric",
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 10
    },
    {
      "id": 11,
      "type": "single_choice",
      "name": "single_choice",
      "label": "Custom Single Choice",
      "value": null,
      "validation": null,
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 8,
      "options": [
        {
          "id": 516,
          "value": "in"
        },
        {
          "id": 517,
          "value": "et"
        },
        {
          "id": 518,
          "value": "optio"
        },
        {
          "id": 519,
          "value": "aut"
        },
        {
          "id": 520,
          "value": "inventore"
        },
        {
          "id": 521,
          "value": "eaque"
        }
      ]
    }
  ],
  "created_at": "2017-08-09 08:28:46",
  "updated_at": "2017-08-09 08:28:46",
  "latest_activity_at": null,
  "social_profile": {}
}

Update contact

PUT /accounts/:account_id/contacts/:contact_id

Parameters

  • user_id integer
  • Supports Fields
    • Required
    • Matching resource Contact
  • account_id UUID - Can be used to move contact to another account.

Payload

{
  "user_id": 1,
  "team_id": 5,
  "fixed_fields": [
    {
      "name": "first_name",
      "value": "Jane doe"
    },
    {
      "name": "last_name",
      "value": "Contact Last Name"
    },
    {
      "name": "email",
      "value": "contact@example.com"
    }
  ],
  "custom_fields": [
    {
      "name": "number",
      "value": 123
    },
    {
      "name": "single_choice",
      "value": 512
    },
    {
      "id": 8,
      "value": "email@easir.com"
    }
  ]
}

Response
Status code 200

{
  "id": "f7108fbc-5fd3-4bba-b2f3-96cda8f7b7e8",
  "b2c": false,
  "account": {
    "id": "ea44a0bf-021d-36e0-9673-4fd080b4ec37",
    "name": "Buhl ApS"
  },
  "user": {
    "id": 1,
    "first_name": "Jane",
    "last_name": "Doe",
    "phone_number": "+4588888888",
    "job_title": "Sales Executive",
    "email": "demo@easir.com",
    "email_notifications": false,
    "profile_picture": "https:\/\/randomuser.me\/api\/portraits\/thumb\/women\/5.jpg",
    "system_user": false,
    "created_at": "2014-01-01 12:45:56",
    "updated_at": "2014-01-02 00:11:22"
  },
  "team_id": 1,
  "team": {
    "id": 1,
    "name": "Team 1",
    "address_1": "Savannah 123",
    "address_2": "Under the tree on the left",
    "zip_code": "4730",
    "city": "Umzimkulu",
    "state": "KwaZulu-Natal",
    "country": null,
    "phone_number": "031 308 7900",
    "website": "https:\/\/easir.com",
    "vat": "1234567890123456",
    "team_type": null,
    "group_id": 1,
    "use_social_lookup": false,
    "created_at": "2014-01-01 12:45:56",
    "updated_at": "2014-01-02 00:11:22"
  },
  "status": "lead",
  "fixed_fields": [
    {
      "id": 10,
      "type": "text",
      "name": "salutation",
      "label": "Salutation",
      "value": null,
      "validation": null,
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 0
    },
    {
      "id": 12,
      "type": "text",
      "name": "last_name",
      "label": "Last name",
      "value": "Contact Last Name",
      "validation": null,
      "required": true,
      "hidden": false,
      "read_only": false,
      "sort_order": 0
    },
    {
      "id": 14,
      "type": "text",
      "name": "landline_phone_number",
      "label": "Landline phone number",
      "value": null,
      "validation": null,
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 0
    },
    {
      "id": 35,
      "type": "text",
      "name": "mobile_phone_number",
      "label": "Mobile phone number",
      "value": null,
      "validation": null,
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 0
    },
    {
      "id": 11,
      "type": "text",
      "name": "first_name",
      "label": "First name",
      "value": "Jane doe",
      "validation": null,
      "required": true,
      "hidden": false,
      "read_only": false,
      "sort_order": 0
    },
    {
      "id": 13,
      "type": "text",
      "name": "email",
      "label": "Email",
      "value": "contact@example.com",
      "validation": "email",
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 0
    },
    {
      "id": 16,
      "type": "text",
      "name": "title",
      "label": "Title",
      "value": null,
      "validation": null,
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 0
    },
    {
      "id": 37,
      "type": "date",
      "name": "date_of_birth",
      "label": "Date of Birth",
      "value": null,
      "validation": "date",
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 0
    }
  ],
  "custom_fields": [
    {
      "id": 8,
      "type": "text",
      "name": "email",
      "label": "Custom E-mail",
      "value": "email@easir.com",
      "validation": "email",
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 11
    },
    {
      "id": 10,
      "type": "date",
      "name": "date",
      "label": "Custom Date",
      "value": null,
      "validation": "date",
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 9
    },
    {
      "id": 12,
      "type": "multiple_choice",
      "name": "multiple_choice",
      "label": "Custom Multiple Choice",
      "value": null,
      "validation": null,
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 7,
      "options": [
        {
          "id": 522,
          "value": "et"
        },
        {
          "id": 523,
          "value": "aut"
        },
        {
          "id": 524,
          "value": "occaecati"
        },
        {
          "id": 525,
          "value": "ut"
        },
        {
          "id": 526,
          "value": "unde"
        },
        {
          "id": 527,
          "value": "maxime"
        },
        {
          "id": 528,
          "value": "veniam"
        },
        {
          "id": 529,
          "value": "temporibus"
        }
      ]
    },
    {
      "id": 9,
      "type": "numeric",
      "name": "number",
      "label": "Custom Number",
      "value": 123,
      "validation": "numeric",
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 10
    },
    {
      "id": 11,
      "type": "single_choice",
      "name": "single_choice",
      "label": "Custom Single Choice",
      "value": null,
      "validation": null,
      "required": false,
      "hidden": false,
      "read_only": false,
      "sort_order": 8,
      "options": [
        {
          "id": 516,
          "value": "in"
        },
        {
          "id": 517,
          "value": "et"
        },
        {
          "id": 518,
          "value": "optio"
        },
        {
          "id": 519,
          "value": "aut"
        },
        {
          "id": 520,
          "value": "inventore"
        },
        {
          "id": 521,
          "value": "eaque"
        }
      ]
    }
  ],
  "created_at": "2017-08-09 08:28:46",
  "updated_at": "2017-08-09 08:36:42",
  "latest_activity_at": null,
  "social_profile": {}
}

Delete contact

DELETE /accounts/:account_id/contacts/:contact_id

Response
Status code 204

Get timeline

GET /accounts/:account_id/contacts/:contact_id/timeline

  • Supports Pagination
  • start_at date - Only show events created after this date
    • Y-m-d H:i:s format
  • end_at date - Only show events created before this date
    • Y-m-d H:i:s format
    • Must be after start_date
  • types string - Only show events from one of these groups (comma separated)
    • campaign
    • case
    • consent
    • external

Response
Status code 200

{
  "data": [
    {
      "id": "64b37580-3795-4e3b-a0ee-485ade9fe79d",
      "type": "email_click",
      "data": {
        "activity": {
          "id": "746625d3-0e39-3437-af09-281dbd2a6f4d",
          "activity_types": [
            {
              "id": "a203539b-f06c-442c-8ad0-f5a56f0615f6",
              "name": "Contract"
            },
            {
              "id": "943cef92-f9b4-4fcb-b4e4-834f34915973",
              "name": "Milestone 2"
            }
          ],
          "communication_channel": "call",
          "note": null,
          "correspondence": {
            "email": {
              "id": "59db316c-9354-43b6-ac56-54e6d870840b",
              "sender": "info@easir.com",
              "recipients": [
                {
                  "email_address": "OConnell.Tressa@Lemke.com",
                  "opened_at": "2015-02-03 12:34:56",
                  "clicked_at": "2015-02-03 12:34:56"
                },
                {
                  "email_address": "Friesen.Michale@Cronin.com",
                  "opened_at": "2015-02-03 12:34:56",
                  "clicked_at": "2015-02-03 12:34:56",
                  "contact": {
                    "id": "2ad85f15-94c1-38b2-b47c-2c45e255fb82",
                    "name": "Rigmor Br\u00f8ndum"
                  },
                  "account": {
                    "id": "070fd555-ecef-34e2-a432-7703232cdd07",
                    "name": "Skov og B\u00e6k ApS"
                  }
                }
              ],
              "cc": [
                {
                  "email_address": "Miller.Karlee@Littel.com",
                  "opened_at": "2015-02-03 12:34:56",
                  "clicked_at": "2015-02-03 12:34:56"
                }
              ],
              "bcc": [
                {
                  "email_address": "tStanton@Gutkowski.org",
                  "opened_at": "2015-02-03 12:34:56",
                  "clicked_at": "2015-02-03 12:34:56",
                  "contact": {
                    "id": "2ad85f15-94c1-38b2-b47c-2c45e255fb82",
                    "name": "Rigmor Br\u00f8ndum"
                  },
                  "account": {
                    "id": "070fd555-ecef-34e2-a432-7703232cdd07",
                    "name": "Skov og B\u00e6k ApS"
                  }
                }
              ],
              "subject": "The Mouse did not quite know what.",
              "sent_at": "2015-02-03 12:34:56",
              "read_at": null,
              "created_at": "2015-02-03 12:34:56",
              "updated_at": "2015-02-03 12:34:56"
            }
          },
          "product_detail": null,
          "task": null,
          "extra_steps": [],
          "created_at": "2015-02-24 12:34:56",
          "updated_at": "2015-02-24 12:34:56"
        },
        "recipient_email": "Bernier.Shyanne@Boyle.com",
        "case": {
          "id": "a9a02c33-12a9-3590-ab87-8870fa71c368",
          "number": 13,
          "relations_path_name": "UPDATED!"
        }
      },
      "created_at": "2015-05-21 12:17:57",
      "updated_at": "2015-05-21 12:17:57"
    },
    {
      "id": "894e9aaa-9da6-48e6-b3ed-e923a4087e00",
      "type": "activity_created",
      "user": {
        "id": 1,
        "first_name": "Doe",
        "last_name": "John",
        "phone_number": "+4588888888",
        "job_title": "Animal",
        "email": "info@easir.com",
        "profile_picture": "http://api.randomuser.me/portraits/thumb/women/5.jpg",
        "created_at": "2014-01-01 12:45:56",
        "updated_at": "2014-01-02 00:11:22"
      },
      "data": {
        "activity": {
          "id": "f458075c-893e-358a-a2bd-dab161259a4a",
          "activity_types": [
            {
              "id": "943cef92-f9b4-4fcb-b4e4-834f34915973",
              "name": "Milestone 2"
            }
          ],
          "communication_channel": "call",
          "note": null,
          "correspondence": {
            "email": {
              "id": "cea244c5-bf20-4bdd-b043-940b5de0fd94",
              "sender": "info@easir.com",
              "recipients": [
                {
                  "email_address": "Friesen.Michale@Cronin.com",
                  "opened_at": "2015-02-03 12:34:56",
                  "clicked_at": "2015-02-03 12:34:56"
                },
                {
                  "email_address": "Friesen.Michale@Cronin.com",
                  "opened_at": "2015-02-03 12:34:56",
                  "clicked_at": "2015-02-03 12:34:56"
                },
                {
                  "email_address": "Horace18@Dickinson.com",
                  "opened_at": "2015-02-03 12:34:56",
                  "clicked_at": "2015-02-03 12:34:56",
                  "contact": {
                    "id": "cdc1f6a4-76ce-32f4-b8c0-f87dc81b47bc",
                    "name": "Sanne Hertz"
                  },
                  "account": {
                    "id": "d0cea3e4-b388-3a08-a8e0-77b8e51d5270",
                    "name": "Nyborg & Smed"
                  }
                }
              ],
              "cc": [
                {
                  "email_address": "Joany67@Sporer.com",
                  "opened_at": "2015-02-03 12:34:56",
                  "clicked_at": "2015-02-03 12:34:56"
                },
                {
                  "email_address": "Cali57@Paucek.com",
                  "opened_at": "2015-02-03 12:34:56",
                  "clicked_at": "2015-02-03 12:34:56"
                },
                {
                  "email_address": "Mariam.Cartwright@Cruickshank.info",
                  "opened_at": "2015-02-03 12:34:56",
                  "clicked_at": "2015-02-03 12:34:56",
                  "contact": {
                    "id": "cdc1f6a4-76ce-32f4-b8c0-f87dc81b47bc",
                    "name": "Sanne Hertz"
                  },
                  "account": {
                    "id": "d0cea3e4-b388-3a08-a8e0-77b8e51d5270",
                    "name": "Nyborg & Smed"
                  }
                }
              ],
              "bcc": [
                {
                  "email_address": "Marietta09@Kshlerin.com",
                  "opened_at": "2015-02-03 12:34:56",
                  "clicked_at": "2015-02-03 12:34:56"
                },
                {
                  "email_address": "Bernier.Shyanne@Boyle.com",
                  "opened_at": "2015-02-03 12:34:56",
                  "clicked_at": "2015-02-03 12:34:56",
                  "contact": {
                    "id": "cdc1f6a4-76ce-32f4-b8c0-f87dc81b47bc",
                    "name": "Sanne Hertz"
                  },
                  "account": {
                    "id": "d0cea3e4-b388-3a08-a8e0-77b8e51d5270",
                    "name": "Nyborg & Smed"
                  }
                }
              ],
              "subject": "I've got to see it pop down a.",
              "sent_at": "2015-02-03 12:34:56",
              "read_at": null,
              "created_at": "2015-02-03 12:34:56",
              "updated_at": "2015-02-03 12:34:56"
            }
          },
          "product_detail": null,
          "task": {
            "id": "b0e82947-8c9c-4489-b741-35037501de58",
            "type": "call",
            "case": {
              "id": "a9a02c33-12a9-3590-ab87-8870fa71c368",
              "case_number": 13
            },
            "activity_id": "97a1830f-1d3b-36ff-9ea1-daaa02b41a24",
            "account": {
              "id": "d84a475e-8002-3842-8e9d-43b31823a220",
              "name": "Truelsen og Br\u00f8ndum K/S"
            },
            "contact": {
              "id": "bcf92c6c-dcc2-387c-ac6d-7659660d659e",
              "name": "Lucas Graversen"
            },
            "start_at": "2015-04-05 07:34:26",
            "end_at": "2015-04-05 07:34:26",
            "completed_at": null,
            "created_at": "2015-04-05 07:34:26",
            "updated_at": "2015-04-05 07:34:26"
          },
          "extra_steps": [],
          "created_at": "2015-02-24 12:34:56",
          "updated_at": "2015-02-24 12:34:56"
        },
        "case": {
          "id": "a9a02c33-12a9-3590-ab87-8870fa71c368",
          "number": 13,
          "relations_path_name": "UPDATED!"
        }
      },
      "created_at": "2015-05-21 12:17:56",
      "updated_at": "2015-05-21 12:17:56"
    }
  ],
  "pagination": {
    "total": 6,
    "page": 1,
    "per_page": 15,
    "urls": {
      "previous": null,
      "next": null
    }
  }
}

Create timeline entry

You can create your own timeline entries. These entries will be of type external.

POST /accounts/:account_id/contacts/:contact_id/timeline

Parameters

  • title string
    • Max 255
  • description string
    • Required
    • Max 255
  • created_at date
    • Y-m-d H:i:s format.
    • Must be before "now".
  • files array
  • files.* UUID

Deprecated parameters

  • name string

Payload

{
  "title": "Custom timeline entry title",
  "description": "This is an external timeline entry",
  "created_at": "2012-05-02 12:00:00",
  "files": [
    "0a84d647-0415-4824-ab19-da8d912111ab"
  ]
}

Response
Status code 204

Get cases for a contact

GET /accounts/:account_id/contacts/:contact_id/cases

Query string parameters

Response
Status code 200

{
  "data": [
    {
      "id": "23a55e3b-ad9d-3649-bd3e-ce7f2ee208c2",
      "case_number": 9,
      "status": "declined",
      "account": {
        "id": "76f3b0b7-5026-36d9-bdd3-622e27a2a917",
        "name": "Sandberg A/S"
      },
      "contact": {
        "id": "d6c702ef-1806-36c7-81bc-1a4f9555ed8b",
        "name": "Alice Brandt"
      },
      "user": {
        "id": 16,
        "name": "Idell Buckridge"
      },
      "relations_path": {
        "id": "9eae431b-3d0f-4528-9c59-e9d1a40fcd04",
        "name": "UPDATED!"
      },
      "chance_of_success": 95,
      "milestones": [
        {
          "id": "a203539b-f06c-442c-8ad0-f5a56f0615f6",
          "name": "Contract",
          "done": true
        },
        {
          "id": "943cef92-f9b4-4fcb-b4e4-834f34915973",
          "name": "Milestone 2",
          "done": true
        }
      ],
      "latest_activity_at": "2015-02-24 12:34:56",
      "estimated_close_date": "2015-02-24",
      "created_at": "2015-02-24 12:34:56",
      "updated_at": "2015-02-24 12:34:56"
    },
  ],
  "pagination": {
    "total": 2,
    "page": 1,
    "per_page": 15,
    "urls": {
      "previous": null,
      "next": null
    }
  },
  "statuses": {
    "all": 2,
    "open": 1,
    "closed": 0,
    "declined": 1
  }
}