Sirportly

Toggle Menu

Global Search

This method allows you to search all searchable data within your Sirportly account.

URL

/api/v2/search/search

Access

This method is available to fully available to account tokens. User tokens will receive data based on their access.

Supported Parameters

  • query - the query to search (required)

Example JSON

Unlike other methods, the JSON returned for each object is shorter than usual. By default, a maxmimum of 15 of each object will be returned.

{
  "contacts": [
    {
      "abbreviated_name": "Adam C",
      "company": "",
      "created_at": "2013-05-01T10:52:42Z",
      "id": 4,
      "mail_format": "both",
      "name": "Adam Cooke",
      "pin": "962763",
      "reference": ""
    }
  ],
  "tickets": [
    {
      "contact": {
        "abbreviated_name": "Adam C",
        "company": "",
        "created_at": "2013-05-13T15:51:19Z",
        "id": 9,
        "mail_format": "both",
        "name": "Adam Cooke",
        "pin": "982498",
        "reference": ""
      },
      "department": {
        "brand": {
          "id": 2,
          "name": "Codebase",
          "phone": "01202 901 222",
          "url": "http://www.codebasehq.com"
        },
        "id": 5,
        "name": "Accounts & Billing",
        "private": false
      },      
      "id": 11,
      "reference": "HG-186139",
      "status": {
        "colour": "f27800",
        "id": 3,
        "name": "Waiting for Contact",
        "status_type": 2
      },
      "subject": "Example Subject!"
    }
  ]
}