Get Tickets

description retrieve an array of ticket objects from halopsa, offering a summary of existing tickets endpoint url /api/tickets method get inputs parameters (object) pageinate (boolean) whether to use pagination in the response page size (number) when using pagination, the size of the page maximum size is 100 page no (number) when using pagination, the page number to return order (string) the name of the field to order by orderdesc (boolean) whether to order ascending or descending ticketidonly (boolean) returns only the id fields (ticket id, sla id, status id, client id and name and lastincomingemail date) of the tickets (not compatible with pagination) view id (number) the id of the filter profile to filter by columns id (number) the column profile id includecolumns (boolean) include column details in the response includeslaactiondate (boolean) include the sla action date in the response includeslatimer (boolean) include sla timer in the response includetimetaken (boolean) include time taken in the response includesupplier (boolean) include supplier details in the response includerelease1 (boolean) include release 1 details in the response includerelease2 (boolean) include release 2 details in the response includerelease3 (boolean) include release 3 details in the response includechildids (boolean) include child ticket ids in the response includenextactivitydate (boolean) include nextactivitydate in the response includefirstresponse (boolean) include first response data in the response list id (number) filters by the specified list agent id (number) filters by the specified agent status id (number) filters by the specified status requesttype id (number) filters by the specified request type supplier id (number) filters by the specified supplier client id (number) filters by the specified client site (number) filters by the specified site username (string) filters by the specified user user id (number) filters by the specified user release id (number) filters by the specified release asset id (number) filters by the specified asset itil requesttype id (number) filters by the specified itil request type open only (boolean) returns only open tickets in the response closed only (boolean) returns only closed tickets in the response unlinked only (boolean) returns only unlinked tickets in the response contract id (number) filters by the specified contract withattachments (boolean) returns only tickets with 1 or more attachment team (array) returns tickets based on team id's in the array agent (array) returns tickets based on agent id's in the array status (array) returns tickets based on status id's in the array requesttype (array) returns tickets based on request type id's in the array itil requesttype (array) returns tickets based on itil request type id's in the array category 1 (array) returns tickets based on category 1 id's in the array category 2 (array) returns tickets based on category 2 id's in the array category 3 (array) returns tickets based on category 3 id's in the array category 4 (array) returns tickets based on category 4 id's in the array sla (array) returns tickets based on sla id's in the array priority (array) returns tickets based on priority id's in the array products (array) returns tickets based on product id's in the array flagged (array) returns tickets based on flagged ticket id's in the array excludethese (array) excludes these tickets from the response search (string) filters response based on the search string searchactions (boolean) whether to search actions when using search datesearch (string) the date field to search against examples are date opened 'dateoccured', date closed 'datecleared' startdate (string) for use with the datesearch parameter enddate (string) for use with the datesearch parameter search user name (string) returns tickets based on users matching the search search summary (string) returns tickets based on the summary matching the search search details (string) returns tickets based on the details matching the search search reportedby (string) returns tickets based on the reportedby field matching the search search version (string) returns tickets based on the software version matching the search search release1 (string) returns tickets based on release 1 matching the search search release2 (string) returns tickets based on release 2 matching the search search release3 (string) returns tickets based on release 3 matching the search search releasenote (string) returns tickets based on the release note matching the search search inventory number (string) returns tickets based on an asset tag matching the search search oppcontactname (string) returns tickets based on the opportunity contact name matching the search search oppcompanyname (string) returns tickets based on the opportunity company name matching the search output example \[ { "status code" 200, "response headers" { "content type" "text/html; charset=utf 8", "x hsci cache time" "2024 10 21t12 01 22 328z", "content encoding" "gzip", "expires" "mon, 21 oct 2024 12 08 57 gmt", "cache control" "max age=0, no cache, no store", "pragma" "no cache", "date" "mon, 21 oct 2024 12 08 57 gmt", "content length" "106931", "connection" "keep alive" }, "reason" "ok", "json body" { "page no" 0, "page size" 0, "record count" 0, "tickets" \[ { "id" 0, "dateoccurred" "2017 11 01t16 03 32 714z", "summary" "", "status id" 0, "tickettype id" 0, "sla id" 0, "priority id" 0, "client id" 0, "client name" "", "site id" 0, "site name" "", "user name" "", "team" "", "agent id" 0, "agent name" "", "category 1" "", "category 2" "", "category 3" "", "category 4" "", "estimate" 0, "timetaken" 0, "parent id" 0, "flagged" true, "read" true, "enduserstatus" 0, "onhold" true, "respondbydate" "2017 11 01t16 03 32 714z", "slaresponsestate" "", "fixbydate" "2017 11 01t16 03 32 714z", "dateclosed" "2017 11 01t16 03 32 714z", "excludefromsla" true, "slaholdtime" 0, "site timezone" "", "slaactiondate" "2017 11 01t16 03 32 714z", "slapercused" 0, "slatimeleft" 0, "responsedate" "2017 11 01t16 03 32 714z" } ], "columns id" 0, "columns" \[ { "id" 0, "columns id" 0, "column seq" 0, "column name" "", "width" 0, "order seq" 0, "order desc" true } ] } } ] output parameters status code (number) reason (string) json body (object) page no (number) page size (number) record count (number) tickets (array) id (number) dateoccurred (string) summary (string) status id (number) tickettype id (number) sla id (number) priority id (number) client id (number) client name (string) site id (number) site name (string) user name (string) team (string) agent id (number) agent name (string) category 1 (string) category 2 (string) category 3 (string) category 4 (string) estimate (number) timetaken (number) parent id (number) flagged (boolean) read (boolean) enduserstatus (number) onhold (boolean) respondbydate (string) slaresponsestate (string) fixbydate (string) dateclosed (string) excludefromsla (boolean) slaholdtime (number) site timezone (string) slaactiondate (string) slapercused (number) slatimeleft (number) responsedate (string) columns id (number) columns (array) id (number) columns id (number) column seq (number) column name (string) width (number) order seq (number) order desc (boolean) response headers header type content type string x hsci cache time string content encoding string expires string cache control string pragma string date string content length string connection string