HaloITSM

the haloitsm connector facilitates the integration of haloitsm's it service management capabilities with swimlane's security automation workflows haloitsm is a comprehensive it service management solution that streamlines incident, problem, and change management this connector enables swimlane turbine users to automate itsm processes, such as ticket management, agent actions, and it asset tracking, directly within the swimlane platform by integrating with haloitsm, security teams can enhance their incident response capabilities, reduce manual overhead, and improve overall service delivery efficiency prerequisites to effectively utilize the haloitsm connector within swimlane turbine, ensure you have the following prerequisites oauth 2 0 client credentials for secure authentication, which requires url the endpoint url for haloitsm api access client id your unique identifier issued by haloitsm for api access client secret a secret key provided by haloitsm to authenticate your api requests scopes specific permissions granted for api access to various features within haloitsm capabilities the haloitsm connector has the following capabilities add attachments get action by id get actions get agent by id get agents get array of ticket types get halo site by id get halo sites get report by id get reports get status by id get team by id get team names get ticket by id get ticket statuses and so on notes please check the following details regarding the permissions and use them wherever applicable https //halo haloservicedesk com/apidoc/resources/reports https //halo haloservicedesk com/apidoc/resources/sites https //halo haloservicedesk com/apidoc/resources/status https //halo haloservicedesk com/apidoc/resources/teams https //halo haloservicedesk com/apidoc/resources/tickettype https //halo haloservicedesk com/apidoc/resources/tickets https //halo haloservicedesk com/apidoc/resources/users https //halo haloservicedesk com/apidoc/resources/agents https //halo haloservicedesk com/apidoc/resources/actions https //halo haloservicedesk com/apidoc/resources/clients https //halo haloservicedesk com/apidoc/resources/attachments api documentation link for more information on haloitsm is found at https //halo haloservicedesk com/apidoc/info configurations haloitsm oauth 2 0 client credentials authenticates using oauth 2 0 client credentials configuration parameters parameter description type required url a url to the target host string required tenant id the tenant id string optional client id the client id string required client secret the client secret string required scope permission scopes for this action array required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions add attachments adds new or updates existing attachments in haloitsm requires base64 format; updates if id is present, otherwise creates endpoint url /api/attachment method post output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"date" "wed, 19 jun 2024 07 06 15 gmt","content type" "application/json; charset=utf 8","content length" "16093","connection" "keep alive","cache control" "no cache, no store, must revalidate","server" "","request context" "appid=cid v1\ a16f5763 e566 48d2 8ad2 e172951888ad","x content type options" "nosniff","strict transport security" "max age=31536000; includesubdomains; preload"},"reason" "ok","json body" {}} get action by id retrieves a specific action from haloitsm using a unique identifier, requiring the 'id' as a path parameter endpoint url /api/actions/{{id}} method get input argument name type required description path parameters id number required parameters for the get action by id action parameters agentonly boolean optional parameters for the get action by id action parameters emailonly boolean optional parameters for the get action by id action parameters includedetails boolean optional parameters for the get action by id action parameters includeemail boolean optional parameters for the get action by id action parameters mostrecent boolean optional parameters for the get action by id action parameters nonsystem boolean optional parameters for the get action by id action parameters penultimate boolean optional parameters for the get action by id action parameters ticket id number optional parameters for the get action by id action input example {"parameters" {"agentonly"\ false,"emailonly"\ false,"includedetails"\ false,"includeemail"\ false,"mostrecent"\ false,"nonsystem"\ false,"penultimate"\ false,"ticket id" 0},"path parameters" {"id" 4518}} output parameter type description status code number http status code of the response reason string response reason phrase note html string output field note html ticket id number unique identifier id number unique identifier outcome string output field outcome who string output field who who type number type of the resource who imgpath string output field who imgpath who agentid number unique identifier datetime string time value note string output field note emailbody string request body data emailsubject string output field emailsubject emailbody html string request body data actionuserdef number output field actionuserdef userdesc string output field userdesc actiondatecreated string output field actiondatecreated actioninvoicenumber string output field actioninvoicenumber externalinvoicenumber number output field externalinvoicenumber actionchargeamount number output field actionchargeamount actionchargehours number output field actionchargehours actionnonchargeamount number output field actionnonchargeamount actionnonchargehours number output field actionnonchargehours actioncontractid number unique identifier output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"note html" "string","ticket id" 0,"id" 0,"outcome" "string","who" "string","who type" 0,"who imgpath" "string","who agentid" 0,"datetime" "2019 08 02t14 35 54 437z","note" "string","emailbody" "string","emailsubject" "string","emailbody html" "string","actionuserdef" 0,"userdesc" "string"}} get actions retrieves a count and array of action objects from haloitsm, offering an overview of available actions endpoint url /api/actions method get input argument name type required description parameters actoutcome string optional parameters for the get actions action parameters actoutcomenum number optional parameters for the get actions action parameters agentonly boolean optional parameters for the get actions action parameters conversationonly boolean optional parameters for the get actions action parameters count number optional parameters for the get actions action parameters datesearch string optional parameters for the get actions action parameters enddate string optional parameters for the get actions action parameters excludebilling boolean optional parameters for the get actions action parameters excludehiddenfrominternalit boolean optional parameters for the get actions action parameters excludeprivate boolean optional parameters for the get actions action parameters excludesys boolean optional parameters for the get actions action parameters importantonly boolean optional parameters for the get actions action parameters importanttop boolean optional parameters for the get actions action parameters includeagentdetails boolean optional parameters for the get actions action parameters includeattachments boolean optional parameters for the get actions action parameters includefacebookfields boolean optional parameters for the get actions action parameters includehtmlemail boolean optional parameters for the get actions action parameters includehtmlnote boolean optional parameters for the get actions action parameters includenonactionattachments boolean optional parameters for the get actions action parameters includetranslations boolean optional parameters for the get actions action parameters includetwitterfields boolean optional parameters for the get actions action parameters intraticketonly boolean optional parameters for the get actions action parameters ischildnotes boolean optional parameters for the get actions action parameters isrelatednotes boolean optional parameters for the get actions action parameters slaonly boolean optional parameters for the get actions action input example {"parameters" {"actoutcome" "","actoutcomenum" 0,"agentonly"\ false,"conversationonly"\ false,"count" 0,"datesearch" "","enddate" "","excludebilling"\ false,"excludehiddenfrominternalit"\ false,"excludeprivate"\ false,"excludesys"\ false,"importantonly"\ false,"importanttop"\ false,"includeagentdetails"\ false,"includeattachments"\ false,"includefacebookfields"\ false,"includehtmlemail"\ false,"includehtmlnote"\ false,"includenonactionattachments"\ false,"includetranslations"\ false,"includetwitterfields"\ false,"intraticketonly"\ false,"ischildnotes"\ false,"isrelatednotes"\ false,"slaonly"\ false,"startdate" "","supplieronly"\ false,"ticket id" 0,"timeentriesonly"\ false}} output parameter type description status code number http status code of the response reason string response reason phrase ticket id number unique identifier record count number count value actions array output field actions actions ticket id number unique identifier actions id number unique identifier actions outcome string output field actions outcome actions who string output field actions who actions who type number type of the resource actions who techid number unique identifier actions who initials string output field actions who initials actions who colour string output field actions who colour actions who imgpath string output field actions who imgpath actions who onlinestatus number status value actions who lastonline string output field actions who lastonline actions datetime string time value actions note string output field actions note actions outcome id number unique identifier actions timetaken number output field actions timetaken actions nonbilltime number time value actions traveltime number time value actions mileage number output field actions mileage actions chargerate number output field actions chargerate actions hiddenfromuser boolean unique identifier output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"ticket id" 0,"record count" 0,"actions" \[{}]}} get agent by id retrieves a specific agent's details from haloitsm using the provided unique identifier endpoint url /api/agent/{{id}} method get input argument name type required description path parameters id number required parameters for the get agent by id action parameters clientidoverride string optional parameters for the get agent by id action parameters get htmldesigner signature boolean optional parameters for the get agent by id action parameters getholidayallowance boolean optional parameters for the get agent by id action parameters includedetails boolean optional parameters for the get agent by id action parameters isagentconfig boolean optional parameters for the get agent by id action parameters loadcache boolean optional parameters for the get agent by id action input example {"parameters" {"clientidoverride" "","get htmldesigner signature"\ true,"getholidayallowance"\ true,"includedetails"\ true,"isagentconfig"\ true,"loadcache"\ true},"path parameters" {"id" 4518}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource onlinestatus actual number status value onlinestatus number status value useadlogin number output field useadlogin container dn string output field container dn is sales boolean output field is sales warning string output field warning canupdate boolean date value canupdate moreinfo boolean output field canupdate moreinfo output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"id" 0,"name" "string","onlinestatus actual" 0,"onlinestatus" 0,"useadlogin" 0,"container dn" "string","is sales"\ true," warning" "string"," canupdate"\ true," canupdate moreinfo"\ true}} get agents retrieves an array of all agents within haloitsm, providing a comprehensive list of available agents endpoint url /api/agent method get input argument name type required description parameters activeinactive string optional parameters for the get agents action parameters appointmentscreen boolean optional parameters for the get agents action parameters can edit only boolean optional parameters for the get agents action parameters client id number optional parameters for the get agents action parameters clientidoverride string optional parameters for the get agents action parameters department id number optional parameters for the get agents action parameters departments string optional parameters for the get agents action parameters domain string optional parameters for the get agents action parameters exchangecalendars boolean optional parameters for the get agents action parameters excludeagent number optional parameters for the get agents action parameters forcequalmatch boolean optional parameters for the get agents action parameters includeapiagents boolean optional parameters for the get agents action parameters includedisabled string optional parameters for the get agents action parameters includeenabled string optional parameters for the get agents action parameters includenamedcount boolean optional parameters for the get agents action parameters includeroles boolean optional parameters for the get agents action parameters includestatus boolean optional parameters for the get agents action parameters includeunassigned string optional parameters for the get agents action parameters integration type string optional parameters for the get agents action parameters linemanagedonly boolean optional parameters for the get agents action parameters linkingagents boolean optional parameters for the get agents action parameters loadcache boolean optional parameters for the get agents action parameters onlinestatuses string optional parameters for the get agents action parameters qualifications string optional parameters for the get agents action parameters reassign boolean optional parameters for the get agents action input example {"parameters" {"activeinactive" "","appointmentscreen"\ false,"can edit only"\ false,"client id" 0,"clientidoverride" "","department id" 0,"departments" "","domain" "","exchangecalendars"\ false,"excludeagent" 0,"forcequalmatch"\ false,"includeapiagents"\ false,"includedisabled" "","includeenabled" "","includenamedcount"\ false,"includeroles"\ false,"includestatus"\ false,"includeunassigned" "","integration type" "","linemanagedonly"\ false,"linkingagents"\ false,"loadcache"\ false,"onlinestatuses" "","qualifications" "","reassign"\ false,"remoteagents"\ false,"remoteagenttype" "","role" "","search" "","shiftagentsonly"\ false,"showall"\ false,"showcounts"\ false,"team" "","team id" 0,"teams" "","thisagentonly"\ false,"ticketarea id" 0,"tickettype id" 0,"view id" 0,"withemail"\ false}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" \[{"id" 0,"name" "string","onlinestatus" 0,"lastonline" "string","team" "string","isdisabled"\ true,"email" "string","ad" "string","lastlogindate" "2017 11 01t16 03 33 030z","agentphotopath" "string","initials" "string","firstname" "string","surname" "string","colour" "string","ticket count" 0}]} get array of ticket types retrieve a list of available requesttypes from haloitsm to categorize tickets effectively endpoint url /api/tickettype method get input argument name type required description parameters access control level number optional parameters for the get array of ticket types action parameters anonanduser boolean optional parameters for the get array of ticket types action parameters can create only boolean optional parameters for the get array of ticket types action parameters can edit only boolean optional parameters for the get array of ticket types action parameters canagentsselect boolean optional parameters for the get array of ticket types action parameters canusercreate boolean optional parameters for the get array of ticket types action parameters client id number optional parameters for the get array of ticket types action parameters domain string optional parameters for the get array of ticket types action parameters group id number optional parameters for the get array of ticket types action parameters include current number optional parameters for the get array of ticket types action parameters include mandatory field check boolean optional parameters for the get array of ticket types action parameters isquicktimedropdown boolean optional parameters for the get array of ticket types action parameters itil type number optional parameters for the get array of ticket types action parameters outcome id number optional parameters for the get array of ticket types action parameters searchtickets string optional parameters for the get array of ticket types action parameters showall boolean optional parameters for the get array of ticket types action parameters showcounts boolean optional parameters for the get array of ticket types action parameters showinactive boolean optional parameters for the get array of ticket types action parameters sprints only boolean optional parameters for the get array of ticket types action parameters ticketarea id number optional parameters for the get array of ticket types action parameters user only boolean optional parameters for the get array of ticket types action parameters view id number optional parameters for the get array of ticket types action input example {"parameters" {"access control level" 0,"anonanduser"\ true,"can create only"\ true,"can edit only"\ true,"canagentsselect"\ true,"canusercreate"\ true,"client id" 0,"domain" "","group id" 0,"include current" 0,"include mandatory field check"\ true,"isquicktimedropdown"\ true,"itil type" 0,"outcome id" 0,"searchtickets" "","showall"\ true,"showcounts"\ true,"showinactive"\ true,"sprints only"\ true,"ticketarea id" 0,"user only"\ true,"view id" 0}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" \[{"id" 0,"name" "string","ticket count" 0,"use" "string","sequence" 0}]} get halo site by id retrieves detailed information for a specific haloitsm site using the provided site id endpoint url /api/site/{{id}} method get input argument name type required description path parameters id number required parameters for the get halo site by id action parameters client override number optional parameters for the get halo site by id action parameters domain string optional parameters for the get halo site by id action parameters includeactivity boolean optional parameters for the get halo site by id action parameters includedetails boolean optional parameters for the get halo site by id action parameters issetup boolean optional parameters for the get halo site by id action parameters tickettype id number optional parameters for the get halo site by id action input example {"parameters" {"client override" 0,"domain" "","includeactivity"\ false,"includedetails"\ false,"issetup"\ false,"tickettype id" 0},"path parameters" {"id" 4518}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource client id number unique identifier client name string name of the resource clientsite name string name of the resource inactive boolean output field inactive sla id number unique identifier phonenumber string output field phonenumber output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"id" 0,"name" "string","client id" 0,"client name" "string","clientsite name" "string","inactive"\ true,"sla id" 0,"phonenumber" "string"}} get halo sites retrieves an array of site objects from haloitsm, offering a comprehensive overview of all configured sites endpoint url /api/site method get input argument name type required description parameters activeinactive string optional parameters for the get halo sites action parameters advanced search string optional parameters for the get halo sites action parameters azuresites boolean optional parameters for the get halo sites action parameters client id number optional parameters for the get halo sites action parameters contract id number optional parameters for the get halo sites action parameters count number optional parameters for the get halo sites action parameters exclude internal boolean optional parameters for the get halo sites action parameters gfisites boolean optional parameters for the get halo sites action parameters idonly boolean optional parameters for the get halo sites action parameters includeactive boolean optional parameters for the get halo sites action parameters includeaddress boolean optional parameters for the get halo sites action parameters includeinactive boolean optional parameters for the get halo sites action parameters includenonstocklocations boolean optional parameters for the get halo sites action parameters includenoorderstockbin boolean optional parameters for the get halo sites action parameters includenotes boolean optional parameters for the get halo sites action parameters includestocklocations boolean optional parameters for the get halo sites action parameters iscalendarfilter boolean optional parameters for the get halo sites action parameters item id qty number optional parameters for the get halo sites action parameters item salesorder id number optional parameters for the get halo sites action parameters item salesorder line number optional parameters for the get halo sites action parameters lastupdatefromdate boolean optional parameters for the get halo sites action parameters lastupdatetodate boolean optional parameters for the get halo sites action parameters order string optional parameters for the get halo sites action parameters order2 string optional parameters for the get halo sites action parameters order3 string optional parameters for the get halo sites action input example {"parameters" {"activeinactive" "","advanced search" "","azuresites"\ false,"client id" 0,"contract id" 0,"count" 0,"exclude internal"\ false,"gfisites"\ false,"idonly"\ false,"includeactive"\ false,"includeaddress"\ false,"includeinactive"\ false,"includenonstocklocations"\ false,"includenoorderstockbin"\ false,"includenotes"\ false,"includestocklocations"\ false,"iscalendarfilter"\ false,"item id qty" 0,"item salesorder id" 0,"item salesorder line" 0,"lastupdatefromdate"\ false,"lastupdatetodate"\ false,"order" "","order2" "","order3" "","order4" "","order5" "","orderdesc"\ false,"orderdesc2"\ false,"orderdesc3"\ false,"orderdesc4"\ false,"orderdesc5"\ false,"override enablestockbins"\ false,"page no" 0,"page size" 0,"pageinate"\ false,"search" "","site id" 0,"sitefields" "","stocklocation" "","toplevel id" 0,"user override" 0}} output parameter type description status code number http status code of the response reason string response reason phrase page no number output field page no page size number output field page size record count number count value sites array output field sites sites id number unique identifier sites name string name of the resource sites client id number unique identifier sites inactive boolean output field sites inactive sites phonenumber string output field sites phonenumber sites sla id number unique identifier sites client name string name of the resource sites colour string output field sites colour sites customfields array output field sites customfields sites customfields id number unique identifier sites customfields name string name of the resource sites customfields label string output field sites customfields label sites customfields type number type of the resource sites customfields value object value for the parameter sites customfields display string output field sites customfields display sites customfields characterlimit number output field sites customfields characterlimit sites customfields characterlimittype number type of the resource sites customfields inputtype number input data for the action output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"page no" 0,"page size" 0,"record count" 0,"sites" \[{}]}} get report by id retrieves a specific report from haloitsm using the unique identifier (id) provided endpoint url /api/report/{{id}} method get input argument name type required description path parameters id number required parameters for the get report by id action parameters client id number optional parameters for the get report by id action parameters clientname string optional parameters for the get report by id action parameters dashboard id number optional parameters for the get report by id action parameters dashboard published id string optional parameters for the get report by id action parameters dontloadsystemreport boolean optional parameters for the get report by id action parameters getcompositetoken boolean optional parameters for the get report by id action parameters includedetails boolean optional parameters for the get report by id action parameters invoice id number optional parameters for the get report by id action parameters loadreport boolean optional parameters for the get report by id action parameters report access token string optional parameters for the get report by id action parameters reportingperiod number optional parameters for the get report by id action parameters reportingperiodenddate string optional parameters for the get report by id action parameters reportingperiodstartdate string optional parameters for the get report by id action input example {"parameters" {"client id" 0,"clientname" "","dashboard id" 0,"dashboard published id" "","dontloadsystemreport"\ false,"getcompositetoken"\ false,"includedetails"\ false,"invoice id" 0,"loadreport"\ false,"report access token" "","reportingperiod" 0,"reportingperiodenddate" "","reportingperiodstartdate" ""},"path parameters" {"id" 4518}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource sql string output field sql reportingperiod number output field reportingperiod availablefields string output field availablefields count boolean count value sqlhasdatefilter boolean output field sqlhasdatefilter usesdynamicsql boolean output field usesdynamicsql available columns array output field available columns available columns id number unique identifier available columns report id number unique identifier available columns name string name of the resource available columns data type string response data available columns data type group string response data available columns sequence number output field available columns sequence available columns filter string output field available columns filter available columns groupbystatus number status value available columns groupbycalc number output field available columns groupbycalc available columns hidden boolean unique identifier available columns orderby number output field available columns orderby available columns orderby desc boolean output field available columns orderby desc available columns warning string output field available columns warning columns array output field columns output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"id" 0,"name" "string","sql" "string","reportingperiod" 0,"availablefields" "string","count"\ true,"sqlhasdatefilter"\ true,"usesdynamicsql"\ true,"available columns" \[{}],"columns" \[{}],"filters" \[{}],"filterable columns" \[{}],"permissions agent" \[{}],"permissions user" \[{}],"systemreportid" 0}} get reports retrieves a list and count of available report objects from haloitsm, including details for each report endpoint url /api/report method get input argument name type required description parameters agentrestriction number optional parameters for the get reports action parameters chartonly boolean optional parameters for the get reports action parameters clientname string optional parameters for the get reports action parameters count number optional parameters for the get reports action parameters includepublished boolean optional parameters for the get reports action parameters order string optional parameters for the get reports action parameters order2 string optional parameters for the get reports action parameters order3 string optional parameters for the get reports action parameters order4 string optional parameters for the get reports action parameters order5 string optional parameters for the get reports action parameters orderdesc boolean optional parameters for the get reports action parameters orderdesc2 boolean optional parameters for the get reports action parameters orderdesc3 boolean optional parameters for the get reports action parameters orderdesc4 boolean optional parameters for the get reports action parameters orderdesc5 boolean optional parameters for the get reports action parameters page no number optional parameters for the get reports action parameters page size number optional parameters for the get reports action parameters pageinate boolean optional parameters for the get reports action parameters reportgroup id number optional parameters for the get reports action parameters search string optional parameters for the get reports action parameters type number optional parameters for the get reports action input example {"parameters" {"agentrestriction" 0,"chartonly"\ false,"clientname" "","count" 0,"includepublished"\ false,"order" "","order2" "","order3" "","order4" "","order5" "","orderdesc"\ false,"orderdesc2"\ false,"orderdesc3"\ false,"orderdesc4"\ false,"orderdesc5"\ false,"page no" 0,"page size" 0,"pageinate"\ false,"reportgroup id" 0,"search" "","type" 0}} output parameter type description status code number http status code of the response reason string response reason phrase page no number output field page no page size number output field page size record count number count value tickets array output field tickets tickets id number unique identifier tickets dateoccurred string output field tickets dateoccurred tickets summary string output field tickets summary tickets status id number unique identifier tickets tickettype id number unique identifier tickets sla id number unique identifier tickets priority id number unique identifier tickets client id number unique identifier tickets client name string name of the resource tickets site id number unique identifier tickets site name string name of the resource tickets user name string name of the resource tickets team string output field tickets team tickets agent id number unique identifier tickets agent name string name of the resource tickets category 1 string output field tickets category 1 tickets category 2 string output field tickets category 2 tickets category 3 string output field tickets category 3 tickets category 4 string output field tickets category 4 output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"page no" 0,"page size" 0,"record count" 0,"tickets" \[{}],"columns id" 0,"columns" \[{}]}} get status by id retrieve a specific status object from haloitsm using the unique id provided endpoint url /api/status/{{id}} method get input argument name type required description path parameters id number required parameters for the get status by id action parameters includedetails boolean optional parameters for the get status by id action input example {"parameters" {"includedetails"\ false},"path parameters" {"id" 4518}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource shortname string name of the resource ticket count number count value statusemailid number unique identifier statusemailfreqdays number status value statusnochangehours number status value notifystatuschange number status value timeuntilloffhold number output field timeuntilloffhold dontsendslareminders boolean output field dontsendslareminders showonquickchange boolean output field showonquickchange statusnochangehoursmanager number status value statusnochangetemplate number status value warning string output field warning type number type of the resource sequence number output field sequence colour string output field colour slaaction string output field slaaction output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"id" 0,"name" "string","shortname" "string","ticket count" 0,"statusemailid" 0,"statusemailfreqdays" 0,"statusnochangehours" 0,"notifystatuschange" 0,"timeuntilloffhold" 0,"dontsendslareminders"\ true,"showonquickchange"\ true,"statusnochangehoursmanager" 0,"statusnochangetemplate" 0," warning" "string", get team by id retrieves a specific team from haloitsm using the unique id provided, facilitating targeted data extraction endpoint url /api/team/{{id}} method get input argument name type required description path parameters id number required parameters for the get team by id action parameters includeagents boolean optional parameters for the get team by id action parameters includedetails boolean optional parameters for the get team by id action input example {"parameters" {"includeagents"\ false,"includedetails"\ false},"path parameters" {"id" 4518}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource sequence number output field sequence forrequests boolean output field forrequests foropps boolean output field foropps forprojects boolean output field forprojects ticket count number count value department id number unique identifier department name string name of the resource inactive boolean output field inactive override column id number unique identifier managers array output field managers managers id number unique identifier managers name string name of the resource managers agent id number unique identifier managers user id number unique identifier workinghoursbeforealert number output field workinghoursbeforealert emailaddress string output field emailaddress addtoallagents boolean output field addtoallagents allowlivechat boolean output field allowlivechat rtid number unique identifier mailbox override number unique identifier agents array output field agents output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"id" 0,"name" "string","sequence" 0,"forrequests"\ true,"foropps"\ true,"forprojects"\ true,"ticket count" 0,"department id" 0,"department name" "string","inactive"\ true,"override column id" 0,"managers" \[{}],"workinghoursbeforealert" 0,"emailaddress" "string","addtoallagents"\ true}} get team names retrieves an array of team names from haloitsm for use in organizing and categorizing support workflows endpoint url /api/team method get input argument name type required description parameters can edit only boolean optional parameters for the get team names action parameters chat only boolean optional parameters for the get team names action parameters department id number optional parameters for the get team names action parameters domain string optional parameters for the get team names action parameters ids string optional parameters for the get team names action parameters include managers boolean optional parameters for the get team names action parameters includeagentsforteams string optional parameters for the get team names action parameters includedisabled string optional parameters for the get team names action parameters includeenabled string optional parameters for the get team names action parameters istree boolean optional parameters for the get team names action parameters memberonly boolean optional parameters for the get team names action parameters mydeps boolean optional parameters for the get team names action parameters myteamsonly boolean optional parameters for the get team names action parameters orderbyseq boolean optional parameters for the get team names action parameters outcome id number optional parameters for the get team names action parameters showall boolean optional parameters for the get team names action parameters showcounts boolean optional parameters for the get team names action parameters ticketarea id number optional parameters for the get team names action parameters type string optional parameters for the get team names action parameters view id number optional parameters for the get team names action input example {"parameters" {"can edit only"\ false,"chat only"\ false,"department id" 0,"domain" "","ids" "","include managers"\ false,"includeagentsforteams" "","includedisabled" "","includeenabled" "","istree"\ false,"memberonly"\ false,"mydeps"\ false,"myteamsonly"\ false,"orderbyseq"\ false,"outcome id" 0,"showall"\ false,"showcounts"\ false,"ticketarea id" 0,"type" "","view id" 0}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" \[{"id" 0,"name" "string","forrequests"\ true,"foropps"\ true,"forprojects"\ true,"ticket count" 0,"agents" \[]}]} get ticket by id retrieve detailed information for a specific ticket in haloitsm using its unique identifier (id) endpoint url /api/tickets/{{id}} method get input argument name type required description path parameters id number required parameters for the get ticket by id action parameters amailentryid string optional parameters for the get ticket by id action parameters assignedto number optional parameters for the get ticket by id action parameters consignablelines boolean optional parameters for the get ticket by id action parameters debug boolean optional parameters for the get ticket by id action parameters dodatabaselookup boolean optional parameters for the get ticket by id action parameters email string optional parameters for the get ticket by id action parameters include auditing boolean optional parameters for the get ticket by id action parameters includeagent boolean optional parameters for the get ticket by id action parameters includechildids boolean optional parameters for the get ticket by id action parameters includedetails boolean optional parameters for the get ticket by id action parameters includelastaction boolean optional parameters for the get ticket by id action parameters includelastappointment boolean optional parameters for the get ticket by id action parameters includelinkedobjects boolean optional parameters for the get ticket by id action parameters includenextappointment boolean optional parameters for the get ticket by id action parameters includeparentchangeinfo boolean optional parameters for the get ticket by id action parameters includeparentsubject boolean optional parameters for the get ticket by id action parameters includeseenby boolean optional parameters for the get ticket by id action parameters is portal boolean optional parameters for the get ticket by id action parameters isdetailscreen boolean optional parameters for the get ticket by id action parameters ishalolink boolean optional parameters for the get ticket by id action parameters ispreview boolean optional parameters for the get ticket by id action parameters isteams boolean optional parameters for the get ticket by id action parameters nocache boolean optional parameters for the get ticket by id action parameters subject string optional parameters for the get ticket by id action input example {"parameters" {"amailentryid" "39201","assignedto" 0,"consignablelines"\ false,"debug"\ false,"dodatabaselookup"\ false,"email" "john\@gmail com","include auditing"\ false,"includeagent"\ false,"includechildids"\ false,"includedetails"\ false,"includelastaction"\ false,"includelastappointment"\ false,"includelinkedobjects"\ false,"includenextappointment"\ false,"includeparentchangeinfo"\ false,"includeparentsubject"\ false,"includeseenby"\ false,"is portal"\ false,"isdetailscreen"\ false,"ishalolink"\ false,"ispreview"\ false,"isteams"\ false,"nocache"\ false,"subject" "in process","ticketidonly"\ false,"utcoffset" 3 4524},"path parameters" {"id" 4518}} output parameter type description status code number http status code of the response reason string response reason phrase actioncode number output field actioncode id number unique identifier dateoccurred string output field dateoccurred summary string output field summary details string output field details status id number unique identifier tickettype id number unique identifier sla id number unique identifier priority id number unique identifier client id number unique identifier client name string name of the resource site id number unique identifier site name string name of the resource user id number unique identifier user name string name of the resource team string output field team agent id number unique identifier category 1 string output field category 1 category 2 string output field category 2 category 3 string output field category 3 category 4 string output field category 4 estimate number output field estimate timetaken number output field timetaken output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"actioncode" 0,"id" 0,"dateoccurred" "2019 08 02t14 35 55 618z","summary" "string","details" "string","status id" 0,"tickettype id" 0,"sla id" 0,"priority id" 0,"client id" 0,"client name" "string","site id" 0,"site name" "string","user id" 0,"user name" "string"}} get ticket statuses retrieve all available ticket statuses from the haloitsm system to manage and track support tickets effectively endpoint url /api/status method get input argument name type required description parameters domain string optional parameters for the get ticket statuses action parameters excludeclosed boolean optional parameters for the get ticket statuses action parameters excludepending boolean optional parameters for the get ticket statuses action parameters outcome id number optional parameters for the get ticket statuses action parameters showall boolean optional parameters for the get ticket statuses action parameters showcounts boolean optional parameters for the get ticket statuses action parameters showquickchangeoptions boolean optional parameters for the get ticket statuses action parameters split closed boolean optional parameters for the get ticket statuses action parameters ticket id number optional parameters for the get ticket statuses action parameters ticket id firstchild number optional parameters for the get ticket statuses action parameters ticketarea id number optional parameters for the get ticket statuses action parameters tickettype group id number optional parameters for the get ticket statuses action parameters tickettype id number optional parameters for the get ticket statuses action parameters tickettype ids string optional parameters for the get ticket statuses action parameters type string optional parameters for the get ticket statuses action parameters view id number optional parameters for the get ticket statuses action input example {"parameters" {"domain" "","excludeclosed"\ false,"excludepending"\ false,"outcome id" 0,"showall"\ false,"showcounts"\ false,"showquickchangeoptions"\ false,"split closed"\ false,"ticket id" 0,"ticket id firstchild" 0,"ticketarea id" 0,"tickettype group id" 0,"tickettype id" 0,"tickettype ids" "","type" "","view id" 0}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" \[{"id" 0,"name" "string","shortname" "string","ticket count" 0,"type" 0,"colour" "string"}]} get ticket type by id retrieve a specific ticket type from haloitsm using the unique id provided endpoint url /api/tickettype/{{id}} method get input argument name type required description path parameters id number required parameters for the get ticket type by id action parameters can create only boolean optional parameters for the get ticket type by id action parameters can edit only boolean optional parameters for the get ticket type by id action parameters debug boolean optional parameters for the get ticket type by id action parameters includeconfig boolean optional parameters for the get ticket type by id action parameters includedetails boolean optional parameters for the get ticket type by id action parameters includekbinfo boolean optional parameters for the get ticket type by id action parameters includeteamrestrictions boolean optional parameters for the get ticket type by id action parameters isdetailscreen boolean optional parameters for the get ticket type by id action parameters isnewticket boolean optional parameters for the get ticket type by id action parameters survey fields boolean optional parameters for the get ticket type by id action parameters ticket id number optional parameters for the get ticket type by id action input example {"parameters" {"can create only"\ true,"can edit only"\ true,"debug"\ true,"includeconfig"\ true,"includedetails"\ true,"includekbinfo"\ true,"includeteamrestrictions"\ true,"isdetailscreen"\ true,"isnewticket"\ true,"survey fields"\ true,"ticket id" 0},"path parameters" {"id" 4518}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource ticket count number count value visible boolean output field visible enduserscanselect boolean output field enduserscanselect itilrequesttype number type of the resource statusafteruserupdate number status value statusaftersupplierupdate number status value closedrequestswithupdates number output field closedrequestswithupdates includeinmobiledbsync boolean output field includeinmobiledbsync workflow id number unique identifier workflow name string name of the resource always bcc string output field always bcc reopenedstatus number status value closedrequestsemailid number unique identifier webannouncement string output field webannouncement chargerate number output field chargerate initial status number status value default team string output field default team default agent number output field default agent default agent name string name of the resource default sla number output field default sla default priority number output field default priority output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"id" 0,"name" "string","ticket count" 0,"visible"\ true,"enduserscanselect"\ true,"itilrequesttype" 0,"statusafteruserupdate" 0,"statusaftersupplierupdate" 0,"closedrequestswithupdates" 0,"includeinmobiledbsync"\ true,"workflow id" 0,"workflow name" "string","always bcc" "string","reopenedstatus" 0,"close get tickets retrieves a list of current tickets from haloitsm, offering a comprehensive overview without requiring specific input parameters endpoint url /api/tickets method get input argument name type required description parameters advanced search string optional parameters for the get tickets action parameters agent array optional parameters for the get tickets action parameters agent id number optional parameters for the get tickets action parameters alerttype string optional parameters for the get tickets action parameters asset id number optional parameters for the get tickets action parameters awaitinginput string optional parameters for the get tickets action parameters billableonly boolean optional parameters for the get tickets action parameters billing date string optional parameters for the get tickets action parameters billing type string optional parameters for the get tickets action parameters billingcontractid number optional parameters for the get tickets action parameters calendar enddate string optional parameters for the get tickets action parameters calendar startdate string optional parameters for the get tickets action parameters category 1 array optional parameters for the get tickets action parameters category 2 array optional parameters for the get tickets action parameters category 3 array optional parameters for the get tickets action parameters category 4 array optional parameters for the get tickets action parameters checkmyticketsonly boolean optional parameters for the get tickets action parameters client id number optional parameters for the get tickets action parameters client ids array optional parameters for the get tickets action parameters client ref string optional parameters for the get tickets action parameters closed only boolean optional parameters for the get tickets action parameters columns id number optional parameters for the get tickets action parameters contract id number optional parameters for the get tickets action parameters contract period number optional parameters for the get tickets action parameters count number optional parameters for the get tickets action input example {"parameters" {"advanced search" "","agent" \[1],"agent id" 0,"alerttype" "","asset id" 0,"awaitinginput" "","billableonly"\ true,"billing date" "","billing type" "","billingcontractid" 0,"calendar enddate" "","calendar startdate" "","category 1" \[1],"category 2" \[1],"category 3" \[1],"category 4" \[1],"checkmyticketsonly"\ true,"client id" 0,"client ids" \[1],"client ref" "","closed only"\ true,"columns id" 0,"contract id" 0,"contract period" 0,"count" 0,"datesearch" "","debug"\ true,"default columns"\ true,"deleted"\ true,"domain" "","enddate" "","enddatetime"\ true,"excludeslacalcs"\ true,"excludethese" \[1],"excludetickettypeallowall"\ true,"extraportalfilter" "","facebook id" "","fetchgrandchildren"\ true,"flagged" \[1],"followedandagents" \[1],"ignoremilestonerestriction"\ true,"includeaccountmanager"\ true,"includeagent"\ true,"includeallopen"\ true,"includeappointmentid"\ true,"includeapproval" \[1],"includeassetkeyfield"\ true,"includeassettype"\ true,"includebreached" \[1],"includebudgettype"\ true,"includechildids"\ true,"includechildread"\ true,"includechildren" \[1],"includeclosed" \[1],"includecolumns"\ true,"includecompleted"\ true,"includecontract"\ true,"includecountryregion"\ true,"includefirstname"\ true,"includefollowedonly" \[1],"includehold" \[1],"includeinactivetechs" \[1],"includeinactiveusers" \[1],"includeitilname"\ true,"includelastaction"\ true,"includelastincomingemail"\ true,"includelastname"\ true,"includelastnote"\ true,"includelocked"\ true,"includemailbox"\ true,"includemailid"\ true,"includemyuseronly" \[1],"includenextactivitydate"\ true,"includenextappointmenttype"\ true,"includeparentsubject"\ true,"includeprojects" \[1],"includeread" \[1],"includerelatedservices"\ true,"includerelease1"\ true,"includerelease2"\ true,"includerelease3"\ true,"includeservicecategory"\ true,"includeslaactiondate"\ true,"includeslatimer"\ true,"includestatus"\ true,"includesubmittedonly" \[1],"includesupplier"\ true,"includetickettype"\ true,"includetimetaken"\ true,"includetoplevel"\ true,"includeviewing"\ true,"includeworkflowstage"\ true,"includeworkflowstagenumber"\ true,"includuserdepartments"\ true,"inlcludeopenchildcount"\ true,"invlucebranch"\ true,"ismilestone"\ true,"isorion"\ true,"isquicktimesearch"\ true,"isscom"\ true,"isteams"\ true,"iszapier"\ true,"itil requesttype" \[1],"itil requesttype id" 0,"kanbanviewontheagentapp"\ true,"kanbanviewontheportal"\ true,"lastupdatefromdate"\ true,"lastupdatetodate"\ true,"list id" 0,"milestone id" 0,"mine"\ true,"nochargeonly"\ true,"notime"\ true,"onlytime"\ true,"open only"\ true,"order" "","order2" "","order3" "","order4" "","order5" "","orderdesc"\ true,"orderdesc2"\ true,"orderdesc3"\ true,"orderdesc4"\ true,"orderdesc5"\ true,"orion type" 0,"page no" 0,"page size" 0,"pageinate"\ true,"parent id" 0,"pending review"\ true,"per action"\ true,"prepayorcontractonly"\ true,"priority" \[1],"product" \[1],"project ids" "","ready for invoicing"\ true,"related id" 0,"release id" 0,"requesttype" \[1],"requesttype id" 0,"requesttypegroup" \[1],"search" "","search details" "","search id" "","search inventory number" "","search oppcompanyname" "","search oppcontactname" "","search oppemailaddress" "","search release1" "","search release2" "","search release3" "","search releasenote" "","search reportedby" "","search summary" "","search supplier reference" "","search user name" "","search version" "","searchactions"\ true,"searchthisticketid" 0,"service id" 0,"showonroadmap" \[1],"site id" 0,"sitepostcode"\ true,"sla" \[1],"sprint for tickettype id" 0,"sprints"\ true,"startandendset"\ true,"startdate" "","startdatetime"\ true,"status" \[1],"status id" 0,"submittedandagents" \[1],"supplier id" 0,"supplier status" \[1],"team" \[1],"team name" "","ticketarea id" 0,"ticketcontract id" 0,"ticketidonly"\ true,"ticketids" "","ticketlinktype" 0,"toplevel id" 0,"unlinked only"\ true,"user id" 0,"username" "","utcoffset" 3 1234,"view id" 0,"withattachments"\ true}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {}} post ticket type adds or updates haloitsm ticket types, creating a new type if no id exists or updating an existing one endpoint url /api/tickettype method post output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"success"\ true}} retrieve client by id retrieve a specific client object from haloitsm using the unique identifier (id) provided in the path parameters endpoint url /api/client/{{id}} method get input argument name type required description path parameters id number required parameters for the retrieve client by id action parameters domain string optional parameters for the retrieve client by id action parameters getavailablerts boolean optional parameters for the retrieve client by id action parameters includeactivity boolean optional parameters for the retrieve client by id action parameters includedetails boolean optional parameters for the retrieve client by id action parameters includeperiods boolean optional parameters for the retrieve client by id action parameters includeprepay boolean optional parameters for the retrieve client by id action parameters tickettype id number optional parameters for the retrieve client by id action input example {"parameters" {"domain" "","getavailablerts"\ true,"includeactivity"\ true,"includedetails"\ true,"includeperiods"\ true,"includeprepay"\ true,"tickettype id" 0},"path parameters" {"id" 4518}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource toplevel id number unique identifier toplevel name string name of the resource inactive boolean output field inactive colour string output field colour confirmemail number output field confirmemail actionemail number output field actionemail clearemail number output field clearemail messagegroup id number unique identifier from address override string unique identifier logo string output field logo warning string output field warning output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"id" 0,"name" "string","toplevel id" 0,"toplevel name" "string","inactive"\ true,"colour" "string","confirmemail" 0,"actionemail" 0,"clearemail" 0,"messagegroup id" 0,"from address override" "string","logo" "string"," warning" "string"}} retrieve client records retrieves a list of all client records and their count from haloitsm, providing an overview of client data endpoint url /api/client method get input argument name type required description parameters accountmanageronly boolean optional parameters for the retrieve client records action parameters activeinactive string optional parameters for the retrieve client records action parameters advanced search string optional parameters for the retrieve client records action parameters azureclients boolean optional parameters for the retrieve client records action parameters callplan boolean optional parameters for the retrieve client records action parameters columns id number optional parameters for the retrieve client records action parameters count number optional parameters for the retrieve client records action parameters domain string optional parameters for the retrieve client records action parameters exclude internal boolean optional parameters for the retrieve client records action parameters gficlients boolean optional parameters for the retrieve client records action parameters idonly boolean optional parameters for the retrieve client records action parameters includeactive boolean optional parameters for the retrieve client records action parameters includeazuretenants boolean optional parameters for the retrieve client records action parameters includecolumns boolean optional parameters for the retrieve client records action parameters includeinactive boolean optional parameters for the retrieve client records action parameters includeinvoicetemplatename boolean optional parameters for the retrieve client records action parameters includenotes boolean optional parameters for the retrieve client records action parameters includeqbofields boolean optional parameters for the retrieve client records action parameters integration tenantids array optional parameters for the retrieve client records action parameters integration type string optional parameters for the retrieve client records action parameters isjira boolean optional parameters for the retrieve client records action parameters issentinel boolean optional parameters for the retrieve client records action parameters isservicenow boolean optional parameters for the retrieve client records action parameters lastupdatefromdate boolean optional parameters for the retrieve client records action parameters lastupdatetodate boolean optional parameters for the retrieve client records action input example {"parameters" {"accountmanageronly"\ true,"activeinactive" "","advanced search" "","azureclients"\ true,"callplan"\ true,"columns id" 0,"count" 0,"domain" "","exclude internal"\ true,"gficlients"\ true,"idonly"\ true,"includeactive"\ true,"includeazuretenants"\ true,"includecolumns"\ true,"includeinactive"\ true,"includeinvoicetemplatename"\ true,"includenotes"\ true,"includeqbofields"\ true,"integration tenantids" \[1],"integration type" "","isjira"\ true,"issentinel"\ true,"isservicenow"\ true,"lastupdatefromdate"\ true,"lastupdatetodate"\ true,"order" "","order2" "","order3" "","order4" "","order5" "","orderdesc"\ true,"orderdesc2"\ true,"orderdesc3"\ true,"orderdesc4"\ true,"orderdesc5"\ true,"page no" 0,"page size" 0,"pageinate"\ true,"search" "","search name only" "","sentinelid" 0,"showcounts"\ true,"sitefields" "","snowaccountid" 0,"snowclients"\ true,"ticketarea id" 0,"toplevel id" 0,"view id" 0}} output parameter type description status code number http status code of the response reason string response reason phrase page no number output field page no page size number output field page size record count number count value clients array output field clients clients id number unique identifier clients name string name of the resource clients colour string output field clients colour clients inactive boolean output field clients inactive clients toplevel id number unique identifier clients toplevel name string name of the resource clients customfields array output field clients customfields clients customfields id number unique identifier clients customfields name string name of the resource clients customfields label string output field clients customfields label clients customfields type number type of the resource clients customfields value object value for the parameter clients customfields display string output field clients customfields display clients customfields characterlimit number output field clients customfields characterlimit clients customfields characterlimittype number type of the resource clients customfields inputtype number input data for the action output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"page no" 0,"page size" 0,"record count" 0,"clients" \[{}]}} retrieve halo user by id retrieves a haloitsm user's details using their unique identifier (id) provided in the path parameters endpoint url /api/users/{{id}} method get input argument name type required description path parameters id number required parameters for the retrieve halo user by id action parameters client id number optional parameters for the retrieve halo user by id action parameters client override number optional parameters for the retrieve halo user by id action parameters domain string optional parameters for the retrieve halo user by id action parameters includeactivity boolean optional parameters for the retrieve halo user by id action parameters includebillinginfo boolean optional parameters for the retrieve halo user by id action parameters includedetails boolean optional parameters for the retrieve halo user by id action parameters includepopups boolean optional parameters for the retrieve halo user by id action parameters includeusersassets boolean optional parameters for the retrieve halo user by id action parameters issetup boolean optional parameters for the retrieve halo user by id action parameters opp id number optional parameters for the retrieve halo user by id action parameters site id number optional parameters for the retrieve halo user by id action parameters site override number optional parameters for the retrieve halo user by id action parameters supplier id number optional parameters for the retrieve halo user by id action parameters tickettype id number optional parameters for the retrieve halo user by id action parameters username string optional parameters for the retrieve halo user by id action input example {"parameters" {"client id" 0,"client override" 0,"domain" "","includeactivity"\ false,"includebillinginfo"\ false,"includedetails"\ false,"includepopups"\ false,"includeusersassets"\ false,"issetup"\ false,"opp id" 0,"site id" 0,"site override" 0,"supplier id" 0,"tickettype id" 0,"username" ""},"path parameters" {"id" 4518}} output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource site id number unique identifier site name string name of the resource client name string name of the resource firstname string name of the resource surname string name of the resource initials string output field initials title string output field title warning string output field warning client id number unique identifier output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"id" 0,"name" "string","site id" 0,"site name" "string","client name" "string","firstname" "string","surname" "string","initials" "string","title" "string"," warning" "string","client id" 0}} retrieve halo users retrieves user details from haloitsm, including a count and an array of user objects for user management overview endpoint url /api/users method get input argument name type required description parameters activeinactive string optional parameters for the retrieve halo users action parameters advanced search string optional parameters for the retrieve halo users action parameters allapprovers boolean optional parameters for the retrieve halo users action parameters approvers only boolean optional parameters for the retrieve halo users action parameters asset id number optional parameters for the retrieve halo users action parameters client id number optional parameters for the retrieve halo users action parameters contract id number optional parameters for the retrieve halo users action parameters count number optional parameters for the retrieve halo users action parameters department id number optional parameters for the retrieve halo users action parameters exclude agents boolean optional parameters for the retrieve halo users action parameters exclude defaultsiteusers boolean optional parameters for the retrieve halo users action parameters exclude generaluser boolean optional parameters for the retrieve halo users action parameters idonly boolean optional parameters for the retrieve halo users action parameters includeactive boolean optional parameters for the retrieve halo users action parameters includebillinginfo boolean optional parameters for the retrieve halo users action parameters includeinactive boolean optional parameters for the retrieve halo users action parameters includename boolean optional parameters for the retrieve halo users action parameters includenonserviceaccount boolean optional parameters for the retrieve halo users action parameters includenotes boolean optional parameters for the retrieve halo users action parameters includeserviceaccount boolean optional parameters for the retrieve halo users action parameters integration type string optional parameters for the retrieve halo users action parameters is followers boolean optional parameters for the retrieve halo users action parameters is3cxcall boolean optional parameters for the retrieve halo users action parameters lastupdatefromdate boolean optional parameters for the retrieve halo users action parameters lastupdatetodate boolean optional parameters for the retrieve halo users action input example {"parameters" {"activeinactive" "","advanced search" "","allapprovers"\ false,"approvers only"\ false,"asset id" 0,"client id" 0,"contract id" 0,"count" 0,"department id" 0,"exclude agents"\ false,"exclude defaultsiteusers"\ false,"exclude generaluser"\ false,"idonly"\ false,"includeactive"\ false,"includebillinginfo"\ false,"includeinactive"\ false,"includename"\ false,"includenonserviceaccount"\ false,"includenotes"\ false,"includeserviceaccount"\ false,"integration type" "","is followers"\ false,"is3cxcall"\ false,"lastupdatefromdate"\ false,"lastupdatetodate"\ false,"licence id" 0,"listagentuserfirst"\ false,"myallcustomers"\ false,"myarea"\ false,"mydepartment"\ false,"mysite"\ false,"mysitecontact"\ false,"mytoplevel"\ false,"opp id" 0,"order" "","order2" "","order3" "","order4" "","order5" "","orderdesc"\ false,"orderdesc2"\ false,"orderdesc3"\ false,"orderdesc4"\ false,"orderdesc5"\ false,"organisation id" 0,"page no" 0,"page size" 0,"pageinate"\ false,"role" 0,"search" "","search phonenumbers"\ false,"site id" 0,"supplier id" 0,"tickettype id" 0,"toplevel id" 0}} output parameter type description status code number http status code of the response reason string response reason phrase page no number output field page no page size number output field page size record count number count value users array output field users users id number unique identifier users name string name of the resource users site name string name of the resource users actived string output field users actived users emailaddress string output field users emailaddress users phonenumber string output field users phonenumber users fax string output field users fax users firstname string name of the resource users inactive boolean output field users inactive users surname string name of the resource users login string output field users login users mobilenumber string output field users mobilenumber users mobilenumber2 string output field users mobilenumber2 users site id number unique identifier users homenumber string output field users homenumber users telpref number output field users telpref users title string output field users title users client id number unique identifier users client name string name of the resource output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"page no" 0,"page size" 0,"record count" 0,"users" \[{}]}} update actions adds or updates an action in haloitsm using the mandatory 'ticket id' endpoint url /api/actions method post output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"success"\ true}} update halo site adds or updates a site in haloitsm, determining the action based on the presence of a site id endpoint url /api/site method post input argument name type required description id number optional unique identifier name string optional name of the resource client id number optional unique identifier client name string optional name of the resource clientsite name string optional name of the resource inactive boolean optional parameter for update halo site sla id number optional unique identifier phonenumber string optional parameter for update halo site colour string optional parameter for update halo site timezone string optional parameter for update halo site invoice address isdelivery boolean optional parameter for update halo site datecreated string optional parameter for update halo site text number optional parameter for update halo site globx number optional parameter for update halo site globy number optional parameter for update halo site style number optional parameter for update halo site inuseby number optional parameter for update halo site notes string optional parameter for update halo site upwho number optional parameter for update halo site uptimestamp string optional parameter for update halo site xrefsite number optional parameter for update halo site zoffsetx number optional parameter for update halo site zoffsety number optional parameter for update halo site zoomx number optional parameter for update halo site zoomy number optional parameter for update halo site input example {"json body" {"id" 0,"name" "","client id" 0,"client name" "","clientsite name" "","inactive"\ true,"sla id" 0,"phonenumber" "","colour" "","timezone" "","invoice address isdelivery"\ true,"datecreated" "2019 08 02t14 35 57 189z","text" 0,"globx" 0,"globy" 0,"style" 0,"inuseby" 0,"notes" "","upwho" 0,"uptimestamp" "2019 08 02t14 35 57 189z","xrefsite" 0,"zoffsetx" 0,"zoffsety" 0,"zoomx" 0,"zoomy" 0,"smallx" 0,"smally" 0,"bigx" 0,"bigy" 0,"ldapstring" "","emaildomain" "","deliverby" 0,"isinvoicesite"\ true,"refnumber" 0,"defaultdelivery"\ true,"seriousnesslevel" 0,"geocoord1" 0,"geocoord2" 0,"todomain" "","defaultstocklocation" 0,"stopped" 0,"gfisiteid" 0,"itetimeoffset" 0,"itedateformat" 0,"disclaimermatchstring" "","emailsubjectprefix" "","regionaldirector" 0,"facilitiesmanager" 0,"actguid" "","teamviewerpassword" "","contractlastchecked" "2019 08 02t14 35 57 189z","maincontact id" 0,"maincontact name" "","wildcardref" "","monthlyreportlastrun" "2019 08 02t14 35 57 189z","monthlyreportinclude"\ true,"monthlyreportemailmanager"\ true,"accountmanagertech"\ true,"monthlyreportemaildirect"\ true,"language id" 0,"language name" "","snowname" "","linked organisation id" 0,"client" {},"users update" \[{}],"newsite contactname" "","newsite contactemail" "","newsite contacttitle" "","newsite web access level" 0,"newsite sendwelcomeemail"\ true,"delivery address" {},"invoice address" {},"popup notes" \[{}]," reassign all to user" 0,"fields" \[{}],"licences" \[{}],"open ticket count" 0,"onhold ticket count" 0,"total ticket count" 0,"opened thismonth count" 0,"guid" ""," warning" "","customfields" \[{}]}} output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"success"\ true}} update halo users adds or updates haloitsm users, modifying existing entries with an id or creating new ones when no id is present endpoint url /api/users method post output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"success"\ true}} update report adds or updates a report within haloitsm, determined by the presence of a unique identifier endpoint url /api/report method post output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"success"\ true}} update team adds or updates a team in haloitsm, with the operation depending on the presence of an id parameter endpoint url /api/team method post output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful output example {"status code" 200,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"success"\ true}} update ticket adds or updates a ticket in haloitsm, determining the action based on the presence of a ticket id endpoint url /api/tickets method post output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful output example {"status code" 201,"response headers" {"cache control" "no cache","transfer encoding" "chunked","content type" "application/json","date" "mon, 29 apr 2024 05 54 47 gmt"},"reason" "ok","json body" {"success"\ true}} response headers header description example cache control directives for caching mechanisms no cache, no store, must revalidate connection http response header connection keep alive content length the length of the response body in bytes 16093 content type the media type of the resource application/json date the date and time at which the message was originated wed, 19 jun 2024 07 06 15 gmt request context http response header request context appid=cid v1 \ a16f5763 e566 48d2 8ad2 e172951888ad server information about the software used by the origin server strict transport security http response header strict transport security max age=31536000; includesubdomains; preload transfer encoding http response header transfer encoding chunked x content type options http response header x content type options nosniff