Sirportly

Toggle Menu

Get contact properties

This method allows you to search for contact details based on their name, reference or ID.

URL

/api/v2/contacts/info

Supported Parameters

  • contact - this is the name, ID or reference for a contact (required)

Returned Data

The data returned will reflect the contact you have requested. If no contact is found, you will receive an error with a 404 Not Found status.

The data_items variable contains information about custom data which is stored for the contact - this information is added using Customer Data Sources.

Example JSON

{
  "id": 1,
  "reference": "ADAM",
  "name": "Adam Cooke",
  "abbreviated_name": "Adam C",
  "company": "aTech Media",
  "pin": "390976",
  "created_at": "2012-03-20T09:28:41Z",
  "discussion_count": 1,
  "contact_methods": [
    {
      "id": 1,
      "method_type": "email",
      "data": "adam@atechmedia.com",
      "default": true
    }
  ],
  "data_items": {
    "account-number": "123123123",
    "aliases": [
      {
        "name": "Dave",
        "url": "http://dave.com"
      },
      {
        "name": "Steve",
        "url": "http://steve.com"
      },
      {
        "name": "John",
        "url": "http://john.com"
      }
    ],
    "pets": {
      "cat": "Rascal",
      "dog": "Fido",
      "hamster": "Moriarty"
    }
  },
  "overrides":
    {
      "sla":
        {
          "id":1,
          "name":"Standard Response",
          "reply_in":30,
          "resolution_in":null
        },
      "priority":null
    }
}