API:Get Tickets

From WHMCS Documentation

Jump to: navigation, search

This command is used to retrieve an XML list of tickets using search parameters.

Attributes

limitstart - Optional start at which result (default 0)
limitnum - Optional limit at how many results (default 25)
clientid - Optional search for a particular client's tickets
deptid - Optional search in a particular department
status - Optional search a particular status
subject - Optional search for a word in the subject

Example Command

$postfields["action"] = "gettickets";

Returned Variables

Always returned in XML format

<whmcsapi> 
 <action>gettickets</action> 
 <result>success</result> 
 <totalresults>1</totalresults> 
 <startnumber>0</startnumber> 
 <numreturned>1</numreturned> 
 <tickets> 
  <ticket> 
   <id>1</id> 
   <tid>557168</tid> 
   <deptid>1</deptid> 
   <userid>1</userid> 
   <name><![CDATA[Array]]></name> 
   <email></email> 
   <cc></cc> 
   <c>TmDEga5v</c> 
   <date>2009-08-03 23:14:32</date> 
   <subject><![CDATA[Test Ticket]]></subject> 
   <message><![CDATA[This is a test ticket> 
   
   ---------------------------- 
   IP Address: xxx.xxx.xxx.xxx]]></message> 
   <status>Open</status> 
   <priority>Medium</priority> 
   <admin></admin> 
   <attachment></attachment> 
   <lastreply>2009-08-04 12:14:18</lastreply> 
   <flag>0</flag> 
   <service></service> 
  </ticket> 
 </tickets> 
</whmcsapi>

About the API System · Example API Usage · API Functions

API Functions
Add Client - Update Client - Delete Client - Get Clients - Get Clients Details - Get Clients Products - Get Clients Password - Send Email
Get Support Departments - Get Support Statuses - Get Tickets - Get Ticket - Get Ticket Predefined Cats - Get Ticket Predefined Replies
Open Ticket - Reply Ticket - Add Ticket Note - Delete Ticket
Module Create - Module Suspend - Module Unsuspend - Module Terminate
Create Quote - Update Quote - Delete Quote - Send Quote - Accept Quote
Get Orders - Get Order Statuses - Add Order - Accept Order - Pending Order - Cancel Order - Fraud Order - Delete Order
Get Invoice - Get Payment Methods - Create Invoice - Add Billable Item - Add Invoice Payment
Add Transaction - Add Credit - Capture Payment
Domain WHOIS Lookup - Get Activity Log - Get Admin Details - Update Admin Notes - Get Currencies - Get Email Templates
Get To-Do Items - Get To-Do Item Statuses - Get Staff Online - Get Stats - Encrypt Password - Decrypt Password