API:search - Search

Search hostbill database for clients, services, domains and tickets.

Required parameters

query

Search Query

Request

GET http://url_to_your_hostbill.com/admin/api.php?token=:TOKEN&call=search&query=:QUERY

<?php
   include 'class.hbwrapper.php';
   $hbw = HBWrapper::singleton();
   $hbw->setAPIUrl('http://url_to_hb.com/admin/api.php');
   if($hbw->logIn("adminlogin","password")) {
     $return = $hbw->search(array('query'=>:QUERY));
     print_r($return);
   }
?>

<?php
   //Use this method to access HostBill api from HostBill modules
   $api = new ApiWrapper();
   $return = $api->search(array('query'=>:QUERY));
   print_r($return);
?>

Response

   {
      "success": true,
      "results": {
         "Clients": [
            {
               "id": "27",
               "firstname": "John",
               "lastname": "Doe",
               "email": "hostbill@hostbillapp.com",
               "companyname": "",
               "ip": "192.168.56.1"
            }
         ],
         "Domains": [
            
         ],
         "Accounts": [
            {
               "id": "91",
               "firstname": "John",
               "lastname": "Doe",
               "username": "hb_client_27_5",
               "domain": "testhostbill"
            }
         ],
         "Tickets": [
            {
               "ticket_number": "208032",
               "subject": "test",
               "id": "2",
               "name": "John Doe",
               "email": "hb.test@hostbillapp.com"
            }
         ],
         "Invoices": false,
         "Estimates": [
            
         ],
         "Transactions": [
            
         ],
         "Orders": [
            {
               "id": "105",
               "number": "1650966735",
               "firstname": "John",
               "lastname": "Doe",
               "date_created": "2016-02-24 04:53:59",
               "status": "Pending"
            }
         ],
         "RecurringInvoices": false
      },
      "call": "search",
      "server_time": 1460986923
   }