Sirportly

Toggle Menu

Searching Contacts

This method allows you to search for contacts based on their contact methods and customer name.

URL

/api/v2/contacts/search

Access

All users have access to this information providing they have access to the contacts interface.

Supported Parameters

  • query - the query you wish to search (required, must be greater than 3 characters)
  • limit - the number of results to return (optional, defaults to 30, 30 is maximum)
  • types - a comma separated list of contact method types to search (optional, searches all by default)

Example JSON

[
    {
        "contact": {
            "id": 4,
            "reference": "",
            "name": "Adam Cooke",
            "abbreviated_name": "Adam C",
            "company": "",
            "pin": "136539",
            "created_at": "2013-02-13T11:46:53Z"
        },
        "method": {
            "id": 1,
            "method_type": "email",
            "data": "adam@atechmedia.com",
            "default": true
        }
    }
]