Skip to main content
Server path: /haloitsm-people | Type: Application | PCID required: Yes

​
Tools

ToolDescription
haloitsm_people_create_agentPOST /Agent
haloitsm_people_create_clientPOST /Client
haloitsm_people_create_sitePOST /Site
haloitsm_people_create_teamPOST /Team
haloitsm_people_create_usersPOST /Users
haloitsm_people_delete_agent_by_idDELETE /Agent/{id}
haloitsm_people_delete_client_by_idDELETE /Client/{id}
haloitsm_people_delete_site_by_idDELETE /Site/{id}
haloitsm_people_delete_team_by_idDELETE /Team/{id}
haloitsm_people_delete_users_by_idDELETE /Users/{id}
haloitsm_people_get_agent_by_idGet one Uname
haloitsm_people_get_client_by_idGet one Area
haloitsm_people_get_site_by_idGet one Site
haloitsm_people_get_team_by_idGet one SectionDetail
haloitsm_people_get_users_by_idGet one Users
haloitsm_people_list_agentList of Uname
haloitsm_people_list_agent_meGET /Agent/me
haloitsm_people_list_clientList of Area
haloitsm_people_list_client_meGET /Client/me
haloitsm_people_list_siteList of Site
haloitsm_people_list_site_stock_binsGET /Site/StockBins
haloitsm_people_list_teamList of SectionDetail
haloitsm_people_list_team_treeGET /Team/Tree
haloitsm_people_list_usersList of Users
haloitsm_people_list_users_meGET /Users/me
haloitsm_people_prefs_users_prefsPOST /Users/prefs

​
haloitsm_people_create_agent

POST /Agent Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]No—Request body

​
haloitsm_people_create_client

POST /Client Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]No—Request body

​
haloitsm_people_create_site

POST /Site Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]No—Request body

​
haloitsm_people_create_team

POST /Team Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]No—Request body

​
haloitsm_people_create_users

POST /Users Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]No—Request body

​
haloitsm_people_delete_agent_by_id

DELETE /Agent/{id} Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value

​
haloitsm_people_delete_client_by_id

DELETE /Client/{id} Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value

​
haloitsm_people_delete_site_by_id

DELETE /Site/{id} Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value

​
haloitsm_people_delete_team_by_id

DELETE /Team/{id} Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value

​
haloitsm_people_delete_users_by_id

DELETE /Users/{id} Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value

​
haloitsm_people_get_agent_by_id

Get one Uname Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value
clientidoverridestringNo—The clientidoverride value
get_htmldesigner_signaturebooleanNo—Get Htmldesigner Signature
getholidayallowancebooleanNo—The getholidayallowance value
includedetailsbooleanNo—(bool) Include extra objects in the response.
isagentconfigbooleanNo—The isagentconfig value
loadcachebooleanNo—The loadcache value

​
haloitsm_people_get_client_by_id

Get one Area Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value
domainstringNo—(string) Filter on client permissions - ‘opps’ defaults client opportunities.
getavailablertsbooleanNo—(bool) Include a list of a ticket types the client can log.
includeactivitybooleanNo—(bool) Whether to include customer ticket activity in the response.
includedetailsbooleanNo—(bool) Include extra objects in the response.
includeperiodsbooleanNo—(bool) Include pre-pay periods in the response.
includeprepaybooleanNo—(bool) Include pre-pay in the response.
tickettype_idintegerNo—Tickettype Id

​
haloitsm_people_get_site_by_id

Get one Site Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value
client_overrideintegerNo—(int) Filters on a given client id.
domainstringNo—(string) Filter on site permissions - ‘opps’ defaults sites opportunities.
includeactivitybooleanNo—(bool) Whether to include site ticket activity in the response.
includedetailsbooleanNo—(bool) Include extra objects in the response.
issetupbooleanNo—The issetup value
tickettype_idintegerNo—Tickettype Id

​
haloitsm_people_get_team_by_id

Get one SectionDetail Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value
includeagentsbooleanNo—(bool) Include agent details in the response.
includedetailsbooleanNo—(bool) Include extra objects in the response.

​
haloitsm_people_get_users_by_id

Get one Users Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value
client_idintegerNo—(int) Filters by the specified client.
client_overrideintegerNo—Client Override
domainstringNo—(string) Filter on site permissions - ‘opps’ defaults users opportunities.
includeactivitybooleanNo—(bool) Whether to include site ticket activity in the response.
includebillinginfobooleanNo—(bool) Include billing information in the response.
includedetailsbooleanNo—(bool) Include extra objects in the response.
includepopupsbooleanNo—(bool) Whether to include customer pop ups in the response.
includeusersassetsbooleanNo—(bool) Include user assets in the response.
issetupbooleanNo—The issetup value
opp_idintegerNo—(int) Filter by User assigned to a particular opportunity.
site_idintegerNo—(int) Filters by the specified site.
site_overrideintegerNo—Site Override
supplier_idintegerNo—(int) Filters by the specified supplier.
tickettype_idintegerNo—Tickettype Id
usernamestringNo—(string) Filters by the specified username.

​
haloitsm_people_list_agent

List of Uname Parameters:
ParameterTypeRequiredDefaultDescription
activeinactivestringNo—(string) Takes two comma separated values, the first sets includeactive and the second sets includeinactive.
appointmentscreenbooleanNo—The appointmentscreen value
basic_fields_onlybooleanNo—Reduces the number of fields returned.
can_edit_onlybooleanNo—(bool) Filter on Agents that you have permission to edit.
client_idintegerNo—(int) Filters by Agents belonging to a particular client.
clientidoverridestringNo—The clientidoverride value
department_idintegerNo—(int) Filters Agents belonging to a particular department.
departmentsstringNo—(string) Filter on Agents that belong to a department, comma separated.
domainstringNo—(string) Filter on Agent permissions - values: ‘opps’ - ‘prjs’ - ‘reqs’.
exchangecalendarsbooleanNo—(bool) Filters on Agents that have exchange calendars synced.
exclude_membership_infobooleanNo—Removes team and department membership information from the response.
excludeAgentintegerNo—(int) Exclude agent with id.
forcequalmatchbooleanNo—The forcequalmatch value
include_membership_infobooleanNo—Always include team and department membership information in the response.
includeapiagentsbooleanNo—The includeapiagents value
includedisabledstringNo—(bool) Include Agents that are inactive in the response.
includeenabledstringNo—(bool) Include Agents that are active in the response.
includenamedcountbooleanNo—(bool) Include the count of the number of Agents in the response.
includerolesbooleanNo—(bool) Include Agent roles in the response.
includestatusbooleanNo—(bool) Include Agent status in the response.
includeunassignedstringNo—(bool) Include the unassigned Agent in the response.
is_agent_cachebooleanNo—Special behaviour for Agent app Agent Cache build.
integration_typestringNo—(string) Filter on Agents that belong to an integration - Possible values are ‘okta’.
linemanagedonlybooleanNo—(bool) Filters on Agents that have a line manager.
linkingagentsbooleanNo—The linkingagents value
loadcachebooleanNo—The loadcache value
onlinestatusesstringNo—(string) Filter on Agents that have a certain online status, comma separated.
orderstringNo—The order value
order2stringNo—The order2 value
order3stringNo—The order3 value
order4stringNo—The order4 value
order5stringNo—The order5 value
orderdescbooleanNo—The orderdesc value
orderdesc2booleanNo—The orderdesc2 value
orderdesc3booleanNo—The orderdesc3 value
orderdesc4booleanNo—The orderdesc4 value
orderdesc5booleanNo—The orderdesc5 value
page_nointegerNo—Page No
page_sizeintegerNo—Number of results per page
pageinatebooleanNo—The pageinate value
qualificationsstringNo—(string) Filter by Agents with a certain qualifications - comma separated.
reassignbooleanNo—(bool) Filters on Agents that can assign to Agents in sections that agent is not a member of.
remoteagentsbooleanNo—(bool) Filters on Agent invite permissions - if the field rlmiallowothertechinvites is false it will match to your agent id.
remoteagenttypestringNo—(string) Filters on Agent invite permissions - if remoteagent is true and the field rlmiallowothertechinvites is true - values: ‘beyondtrust’ and ‘logmein’.
rolestringNo—(string) Filter by Agents who have a particular role. Requires an int passed as a string.
searchstringNo—(string) Filter by Agents with a name, email address or telephone number like your search.
shiftagentsonlybooleanNo—The shiftagentsonly value
showallbooleanNo—(bool) Used to override org restrictions for main search - admin only.
showcountsbooleanNo—(bool) Include Agents ticket counts in the response.
teamstringNo—(string) Filter by Agents within a particular team.
team_idintegerNo—(int) Filter by Agents within a particular team id.
teamsstringNo—(string) Filter on Agents that belong to a team, comma separated.
thisAgentOnlybooleanNo—(bool) Only include your agent in the response.
ticketarea_idintegerNo—(int) Only for showcounts - ticket area filter.
tickettype_idintegerNo—(int) Filters by Agents that have access to particluar ticket types.
view_idintegerNo—(int) Only for showcounts - ticket view filter.
withemailbooleanNo—(bool) Filters on Agents that have an email.

​
haloitsm_people_list_agent_me

GET /Agent/me

​
haloitsm_people_list_client

List of Area Parameters:
ParameterTypeRequiredDefaultDescription
accountmanageronlybooleanNo—(bool) Include only clients that you are an account manager of in the response.
activeinactivestringNo—(string) Takes two comma separated values, the first sets includeactive and the second sets includeinactive.
advanced_searchstringNo—Advanced Search
azureclientsbooleanNo—(bool) Include only azure clients in the response.
callplanbooleanNo—(bool) Include only clients that have the field acalldate in the past in the response.
columns_idintegerNo—Columns Id
countintegerNo—(int) When not using pagination, the number of results to return.
domainstringNo—The domain value
exclude_internalbooleanNo—Exclude Internal
gficlientsbooleanNo—(bool) Include only GFI clients in the response.
idonlybooleanNo—(bool) Returns only the ID field (Area ID) of the Clients (Not compatible with Pagination).
includeactivebooleanNo—(bool) Include clients that are active in the response.
includeazuretenantsbooleanNo—(bool) Include azure tenants in the response.
includecolumnsbooleanNo—The includecolumns value
includeinactivebooleanNo—(bool) Include clients that are inactive in the response.
includeinvoicetemplatenamebooleanNo—(bool) Include invoice template names in the response.
includenotesbooleanNo—(bool) Include client notes in the response.
includeqbofieldsbooleanNo—The includeqbofields value
include_custom_fieldsstringNo—(string) Comma separated list of Custom Field IDs to include in the response.
integration_tenantidsinteger[]No—Integration Tenantids
integration_typestringNo—Integration Type
isjirabooleanNo—The isjira value
issentinelbooleanNo—(bool) Include only sentinel clients in the response.
isservicenowbooleanNo—The isservicenow value
lastupdatefromdatebooleanNo—(bool) Include the field lastupdatefromdate in the response.
lastupdatetodatebooleanNo—(bool) Include the field lastupdatetodate in the response.
orderstringNo—(string) The name of the field to order by first.
order2stringNo—(string) The name of the field to order by second.
order3stringNo—(string) The name of the field to order by third.
order4stringNo—(string) The name of the field to order by fourth.
order5stringNo—(string) The name of the field to order by fifth.
orderdescbooleanNo—(bool) Whether to order ascending or descending on first order.
orderdesc2booleanNo—(bool) Whether to order ascending or descending on second order.
orderdesc3booleanNo—(bool) Whether to order ascending or descending on third order.
orderdesc4booleanNo—(bool) Whether to order ascending or descending on fourth order.
orderdesc5booleanNo—(bool) Whether to order ascending or descending on fifth order.
page_nointegerNo—(int) When using Pagination, the page number to return.
page_sizeintegerNo—(int) When using Pagination, the size of the page.
pageinatebooleanNo—(bool) Whether to use Pagination in the response.
searchstringNo—(string) Filter by Customers like your search string.
search_name_onlystringNo—Search Name Only
sentinelidintegerNo—(int) Filter by sentinel id.
showcountsbooleanNo—The showcounts value
sitefieldsstringNo—(string) IDs of site fields to include in the response.
snowaccountidintegerNo—The snowaccountid value
snowclientsbooleanNo—(bool) Include only snow clients in the response.
ticketarea_idintegerNo—Ticketarea Id
toplevel_idintegerNo—(int) Filter by Customers belonging to a particular top level.
view_idintegerNo—View Id

​
haloitsm_people_list_client_me

GET /Client/me

​
haloitsm_people_list_site

List of Site Parameters:
ParameterTypeRequiredDefaultDescription
activeinactivestringNo—(string) Takes two comma separated values, the first sets includeactive and the second sets includeinactive.
advanced_searchstringNo—Advanced Search
azuresitesbooleanNo—(bool) Include only azure sites in the response.
client_idintegerNo—(int) Filters by the specified client.
contract_idintegerNo—Contract Id
countintegerNo—(int) When not using pagination, the number of results to return.
exclude_internalbooleanNo—Exclude Internal
gfisitesbooleanNo—(bool) Include only GFI sites in the response.
idonlybooleanNo—(bool) Returns only the ID field (Site ID) of the Sites (Not compatible with Pagination).
includeactivebooleanNo—(bool) Include sites that are active in the response.
includeaddressbooleanNo—(bool) Include site address in the response.
includeinactivebooleanNo—(bool) Include sites that are inactive in the response.
includenonstocklocationsbooleanNo—(bool) Include sites that are not a stock location in the response.
includenoorderstockbinbooleanNo—The includenoorderstockbin value
includenotesbooleanNo—(bool) Include site notes in the response.
includestocklocationsbooleanNo—(bool) Include sites that are a stock location in the response.
include_custom_fieldsstringNo—(string) Comma separated list of Custom Field IDs to include in the response.
iscalendarfilterbooleanNo—The iscalendarfilter value
item_id_qtyintegerNo—(bool) Include stock information fields for the specified item id in the response.
item_salesorder_idintegerNo—(bool) Include stock information fields for the specified sales order id in the response.
item_salesorder_lineintegerNo—(bool) Include stock information fields for the specified sales oreder line id in the response.
lastupdatefromdatebooleanNo—(bool) Include the field lastupdatefromdate in the response.
lastupdatetodatebooleanNo—(bool) Include the field lastupdatetodate in the response.
orderstringNo—(string) The name of the field to order by first.
order2stringNo—(string) The name of the field to order by second.
order3stringNo—(string) The name of the field to order by third.
order4stringNo—(string) The name of the field to order by fourth.
order5stringNo—(string) The name of the field to order by fifth.
orderdescbooleanNo—(bool) Whether to order ascending or descending on first order.
orderdesc2booleanNo—(bool) Whether to order ascending or descending on second order.
orderdesc3booleanNo—(bool) Whether to order ascending or descending on third order.
orderdesc4booleanNo—(bool) Whether to order ascending or descending on fourth order.
orderdesc5booleanNo—(bool) Whether to order ascending or descending on fifth order.
override_enablestockbinsbooleanNo—Override Enablestockbins
page_nointegerNo—(int) When using Pagination, the page number to return.
page_sizeintegerNo—(int) When using Pagination, the size of the page.
pageinatebooleanNo—(bool) Whether to use Pagination in the response.
searchstringNo—(string) Filter by Customers like your search string.
site_idintegerNo—Site Id
sitefieldsstringNo—(string) IDs of site fields to include in the response.
stocklocationstringNo—(string) Filter on stock locations, comma separated.
toplevel_idintegerNo—(int) Filters by the specified top level.
user_overrideintegerNo—User Override

​
haloitsm_people_list_site_stock_bins

GET /Site/StockBins

​
haloitsm_people_list_team

List of SectionDetail Parameters:
ParameterTypeRequiredDefaultDescription
can_edit_onlybooleanNo—(bool) Filter on teams that you have permission to edit.
chat_onlybooleanNo—(bool) Filter on teams that are enabled fro live chat.
department_idintegerNo—(int) Filter Teams belonging to a particular department.
domainstringNo—(string) For use with counts: reqs - tickets, opps - opportunities, prjs - projects.
idsstringNo—(string) Filter by team ids, comma seperated.
include_managersbooleanNo—(bool) Show the managers in the response.
includeagentsforteamsstringNo—(string) Comma separated list of team names. Agents in these teams will be returned.
includedisabledstringNo—(string) Include disabled Teams in the response.
includeenabledstringNo—(string) Include enabled Teams in the response.
istreebooleanNo—The istree value
memberonlybooleanNo—(bool) Only returns sections that the current agent is a member of.
mydepsbooleanNo—The mydeps value
myteamsonlybooleanNo—(bool) Only returns sections that you are a member of.
orderbyseqbooleanNo—(bool) Order by sequence number.
outcome_idintegerNo—Outcome Id
showallbooleanNo—(bool) Admin override to show all teams, overriding team permissions.
showcountsbooleanNo—(bool) Show the count of tickets in the response.
ticketarea_idintegerNo—(int) Only for showcounts - ticket area filter.
typestringNo—(string) Filter by team domain: reqs - tickets, opps - opportunities, prjs - projects.
view_idintegerNo—(int) Only for showcounts - ticket view filter.

​
haloitsm_people_list_team_tree

GET /Team/Tree

​
haloitsm_people_list_users

List of Users Parameters:
ParameterTypeRequiredDefaultDescription
activeinactivestringNo—(string) Takes two comma separated values, the first sets includeactive and the second sets includeinactive.
advanced_searchstringNo—Advanced Search
allapproversbooleanNo—(bool) Adds an or condition to show all Users that are approvers in the response.
approvers_onlybooleanNo—(bool) Include only users that are an approver in the response.
asset_idintegerNo—(int) Filter by Users assigned to a particular asset.
client_idintegerNo—(int) Filters by Users belonging to a particular client.
contract_idintegerNo—(int) Filter by Users assigned to a particular device application type.
countintegerNo—(int) When not using pagination, the number of results to return.
department_idintegerNo—(int) Filters Users belonging to a particular department.
exclude_agentsbooleanNo—(bool) Exclude users that are also an agent in the response.
exclude_defaultsiteusersbooleanNo—Exclude Defaultsiteusers
exclude_generaluserbooleanNo—(bool) Exclude general users in the response.
idonlybooleanNo—(bool) Returns only the ID field (User ID) of the Users (Not compatible with Pagination).
includeactivebooleanNo—(bool) Include users that are active in the response.
includebillinginfobooleanNo—(bool) Include billing information in the response.
include_custom_fieldsstringNo—(string) Comma separated list of Custom Field IDs to include in the response.
includeinactivebooleanNo—(bool) Include users that are inactive in the response.
includenamebooleanNo—The includename value
includenonserviceaccountbooleanNo—(bool) Include users that are a non-service account in the response.
includenotesbooleanNo—(bool) Include user notes in the response.
includeserviceaccountbooleanNo—(bool) Include users that are a service account in the response.
integration_typestringNo—(string) Filter on Users that belong to an integration - Possible values are ‘okta’ and ‘azure’.
is_followersbooleanNo—Is Followers
is3cxcallbooleanNo—The is3cxcall value
lastupdatefromdatebooleanNo—(bool) Include the field lastupdatefromdate in the response.
lastupdatetodatebooleanNo—(bool) Include the field lastupdatetodate in the response.
licence_idintegerNo—Licence Id
listagentuserfirstbooleanNo—(bool) Order by users that are also agents first in the response.
myallcustomersbooleanNo—The myallcustomers value
myareabooleanNo—(bool) Include only Users that belong to your area in the response.
mydepartmentbooleanNo—(bool) Include only Users that belong to your department in the response.
mysitebooleanNo—(bool) Include only Users that belong to your site in the response.
mysitecontactbooleanNo—(bool) Include only Users that belong to your site contact in the response.
mytoplevelbooleanNo—(bool) Include only Users that belong to your top level in the response.
opp_idintegerNo—(int) Filter by Users assigned to a particular opportunity.
orderstringNo—(string) The name of the field to order by first.
order2stringNo—(string) The name of the field to order by second.
order3stringNo—(string) The name of the field to order by third.
order4stringNo—(string) The name of the field to order by fourth.
order5stringNo—(string) The name of the field to order by fifth.
orderdescbooleanNo—(bool) Whether to order ascending or descending on first order.
orderdesc2booleanNo—(bool) Whether to order ascending or descending on second order.
orderdesc3booleanNo—(bool) Whether to order ascending or descending on third order.
orderdesc4booleanNo—(bool) Whether to order ascending or descending on fourth order.
orderdesc5booleanNo—(bool) Whether to order ascending or descending on fifth order.
organisation_idintegerNo—(int) Filters by Users belonging to a particular organisation.
page_nointegerNo—(int) When using Pagination, the page number to return.
page_sizeintegerNo—(int) When using Pagination, the size of the page.
pageinatebooleanNo—(bool) Whether to use Pagination in the response.
roleintegerNo—The role value
searchstringNo—(string) Filter by Users like your search string.
search_phonenumbersbooleanNo—(bool) Filter by Users with a phone number like your search.
site_idintegerNo—(int) Filters by Users belonging to a particular site.
supplier_idintegerNo—(int) Filters by Users belonging to the specified supplier.
tickettype_idintegerNo—Tickettype Id
toplevel_idintegerNo—(int) Filter by Users belonging to a particular top level.
linked_to_user_idintegerNo—(int) Filter by Users that are linked to the specified User ID.

​
haloitsm_people_list_users_me

GET /Users/me

​
haloitsm_people_prefs_users_prefs

POST /Users/prefs Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]No—Request body