EAeasybroker
Contacts

Retrieve a contact

Changed on

Returns the detailed information of a contact from your EasyBroker account.

get/contacts/{contact_id}

Request

  • Base URL
    https://api.easybroker.com/v1
  • URL
    https://api.easybroker.com/v1/contacts/{contact_id}
  • Auth
    API key in header X-Authorization

Response

Successful contact request

idinteger
full_namestring
first_namestring
last_namestring
titlestring
companystring
private_descriptionstring
tagsstring[]
sourcestring
probability'low' | 'medium' | 'high' nullable
statusstring nullable

The contact status name, exactly as shown on EasyBroker.

last_activity_atstring date-time nullable

When the last activity was recorded for the contact, such as a note, a message or a status change.

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": 123,
  "full_name": "John Smith",
  "first_name": "John",
  "last_name": "Smith",
  "title": "Accountant",
  "company": "Smith LLC",
  "private_description": "One of our top clients.",
  "tags": [
    "top_client",
    "priority"
  ],
  "source": "mywebsite.com",
  "probability": "high",
  "status": "Contacted",
  "last_activity_at": "2020-03-01T23:26:53.402Z",
  "agent": {
    "id": 1234,
    "name": "John Smith",
    "full_name": "John Smith Doe",
    "mobile_phone": "5555550000",
    "profile_image_url": "https://www.easybroker.com/assets/product/logo-be4da843987ccd1c05e26f8703f1787847471b36d08bdb1ec8a91ce4007b0e98.svg",
    "email": "john@smith.com"
  },
  "created_at": "2020-03-01T23:26:53.402Z",
  "updated_at": "2020-03-01T23:26:53.402Z",
  "emails": [
    {
      "type": "Work",
      "email": "mail@example.com"
    }
  ],
  "phones": [
    {
      "type": "Work",
      "phone": "5559090909"
    }
  ],
  "addresses": [
    {
      "type": "Work",
      "street": "Main Street 19",
      "city": "Portland",
      "administrative_division": "Oregon",
      "country": "United States of America",
      "postal_code": "01234"
    }
  ]
}

Changes

  • c4cce9eaa862Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status