External DocumentationTo learn more, visit the Halo ITSM documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Child Relationship | Select the child-ticket relationship to filter results by.0 returns tickets that have no children and are not a child, 1 returns tickets that have children, and 2 returns tickets that are a child. |
| Closed Only | Select to return only closed tickets. |
| Open Only | Select to return only open tickets. |
| Order | The field to order the results by. |
| Page Number | The page number of the results to retrieve. Starts at 1. |
| Page Size | The maximum number of results to return per page. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Search | The search term to filter results by. |
| Sort In Descending Order | Select to order the results in descending order. |
| Status ID | The ID of the ticket status to filter results by. Can be obtained from the List Statuses action. |
| Ticket IDs | A comma-separated list of ticket IDs to retrieve. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Agent ID | The ID of the agent to filter results by. Can be obtained from the List Agents action. |
| Asset ID | The ID of the asset to filter results by. |
| Client ID | The ID of the client to filter results by. |
| Date Field | The date field to filter results by, used with Start Date and End Date.For example, dateoccured for the date opened or datecleared for the date closed. |
| Enddate | The end of the date range to filter results by, applied to the Date Field. |
| Include Custom Fields | A comma-separated list of custom field IDs to include in the response. Can be obtained from the List Custom Fields action. |
| Priority IDs | A comma-separated list of priority IDs to filter results by. |
| Startdate | The start of the date range to filter results by, applied to the Date Field. |
| Team IDs | A comma-separated list of team IDs to filter results by. Can be obtained from the List Teams action. |
| Ticket Type ID | The ID of the ticket type to filter results by. Can be obtained from the List Ticket Types action. |
| User ID | The ID of the end user to filter results by. |
Example Output
{
"page_no": 0,
"page_size": 0,
"record_count": 0,
"tickets": [
{
"id": 0,
"dateoccurred": "2026-10-22T06:41:52.087Z",
"summary": "string",
"details": "string",
"status_id": 0,
"status_name": "string",
"tickettype_id": 0,
"tickettype_name": "string",
"sla_id": 0,
"sla_name": "string",
"priority_id": 0,
"client_id": 0,
"client_name": "string",
"site_id": 0,
"site_name": "string",
"user_id": 0,
"user_name": "string",
"team_id": 0,
"team": "string",
"agent_id": 0,
"agent_name": "string",
"category_1": "string",
"category_2": "string",
"category_3": "string",
"category_4": "string",
"categoryid_1": 0,
"categoryid_2": 0,
"categoryid_3": 0,
"categoryid_4": 0,
"category_1_display": "string",
"category_2_display": "string",
"category_3_display": "string",
"category_4_display": "string",
"estimate": 0,
"estimatedays": 0,
"projecttimepercentage": 0,
"projectcompletionpercentage": 0,
"projectearlieststart": "2026-10-22T06:41:52.088Z",
"projectlatestend": "2026-10-22T06:41:52.088Z",
"timetaken": 0,
"faigeneratedsummary_list": "string",
"chargehours": 0,
"nonchargehours": 0,
"travelhours": 0,
"totalmileage": 0,
"itemsprice": 0,
"items": "string",
"supplier_name": "string",
"parent_id": 0,
"child_count": 0,
"child_count_open": 0,
"attachment_count": 0,
"flagged": true,
"read": true,
"enduserstatus": 0,
"onhold": true,
"respondbydate": "2026-10-22T06:41:52.088Z",
"responsedate": "2026-10-22T06:41:52.088Z",
"first_responsedate": "2026-10-22T06:41:52.088Z",
"responsestartdate": "2026-10-22T06:41:52.088Z",
"slaresponsestate": "string",
"fixbydate": "2026-10-22T06:41:52.088Z",
"dateclosed": "2026-10-22T06:41:52.088Z",
"dateassigned": "2026-10-22T06:41:52.088Z",
"excludefromsla": true,
"slaholdtime": 0,
"site_timezone": "string",
"parentguid": "string",
"parentassign": true,
"slaactiondate": "2026-10-22T06:41:52.088Z",
"slapercused": 0,
"slatimeleft": 0,
"currentelapsedhours": 0,
"lastactiondate": "2026-10-22T06:41:52.088Z",
"last_update": "2026-10-22T06:41:52.088Z",
"lastchildactiondate": "2026-10-22T06:41:52.088Z",
"organisation_id": 0,
"department_id": 0,
"reportedby": "string",
"user_email": "string",
"emailtolist": "string",
"emailtolistsupplier": "string",
"emailcclist": "string",
"emailcclistsupplier": "string",
"matched_kb_id": 0,
"release_note": "string",
"product_id": 0,
"product_name": "string",
"release_id": 0,
"release_name": "string",
"release2_id": 0,
"release2_name": "string",
"release3_id": 0,
"release3_name": "string",
"child_ticket_id_string": "string",
"asset_key_field_string": "string",
"asset_type_name": "string",
"workflow_name": "string",
"workflow_stage": "string",
"workflow_stage_id": 0,
"workflow_stage_number": "string",
"lastincomingemail": "2026-10-22T06:41:52.088Z",
"child_ticket_ids": [
0
],
"nextactivitydate": "2026-10-22T06:41:52.088Z",
"nextactivityorappointmentdate": "2026-10-22T06:41:52.088Z",
"inventory_number": "string",
"workflow_id": 0,
"workflow_step": 0,
"workflow_seq": 0,
"pipeline_stage_id": 0,
"pipeline_stage_name": "string",
"hasbeenclosed": true,
"unread_child_action_count": 0,
"unread_related_action_count": 0,
"child_action_count": 0,
"parent_subject": "string",
"related_action_count": 0,
"is_vip": true,
"isimportantcontact": true,
"inactive": true,
"site_inactive": true,
"area_inactive": true,
"impact": 0,
"urgency": 0,
"startdate": "2026-10-22T06:41:52.088Z",
"startdate_timezone": "string",
"startdate_with_timezone": {
"datetime": "2026-10-22T06:41:52.088Z",
"timezone": "string"
},
"starttime": "string",
"starttimeslot": 0,
"targetdate": "2026-10-22T06:41:52.088Z",
"targetdate_timezone": "string",
"targetdate_with_timezone": {
"datetime": "2026-10-22T06:41:52.088Z",
"timezone": "string"
},
"targettime": "string",
"targettimeslot": 0,
"targetpercused": 0,
"targettimeleft": 0,
"deadlinedate": "2026-10-22T06:41:52.088Z",
"followupdate": "2026-10-22T06:41:52.088Z",
"oppcontactname": "string",
"oppcompanyname": "string",
"oppemailaddress": "string",
"oppcustomertitle": "string",
"opptel": "string",
"oppaddr1": "string",
"oppaddr2": "string",
"oppaddr3": "string",
"oppaddr4": "string",
"opppostcode": "string",
"oppcountry": "string",
"oppregion": "string",
"opptype": "string",
"oppvalue": 0,
"oppvalue_monthly": 0,
"oppvalue_annual": 0,
"oppvalue_oneoff": 0,
"oppconversionprobability": 0,
"oppvalueadjusted": 0,
"oppprofit": 0,
"oppcurrentsystem": "string",
"oppcompetitors": "string",
"opptrialdate": "2026-10-22T06:41:52.088Z",
"oppdemodate": "2026-10-22T06:41:52.088Z",
"oppdiscountdate": "2026-10-22T06:41:52.088Z",
"oppattemptsmade": 0,
"oppconverteddate": "2026-10-22T06:41:52.088Z",
"oppproductchosen": "string",
"oppreason": "string",
"opphear": "string",
"opptimezonename": "string",
"oppclosurecategory": 0,
"cost": 0,
"quantity": 0,
"projecttimebudget": 0,
"projectmoneybudget": 0,
"projecttimeactual": 0,
"projectmoneyactual": 0,
"lastnote": "string",
"lastnote_date": "2026-10-22T06:41:52.088Z",
"userdef1": "string",
"userdef2": "string",
"userdef3": "string",
"userdef4": "string",
"userdef5": "string",
"source": 0,
"release_important": true,
"releasenotegroup_name": "string",
"releasenotegroup_id": 0,
"third_party_id": 0,
"third_party_id_string": "string",
"supplier_status": 0,
"contract_refextra": "string",
"appointment_type": 0,
"customfields": [
{
"id": 0,
"name": "string",
"label": "string",
"summary": "string",
"type": 0,
"value": "string",
"value_is_password_id": true,
"display": "string",
"characterlimit": 0,
"characterlimittype": 0,
"inputtype": 0,
"copytochild": true,
"copytoparent": true,
"searchable": true,
"ordervalues": true,
"ordervaluesby": 0,
"database_lookup_id": 0,
"database_lookup_auto": true,
"database_lookup_triggers": [
{
"id": 0,
"lookup_profile_id": 0,
"lookup_profile_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"field_id": 0,
"field_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"field_name": "string",
"required": true,
"type": 0,
"_warning": "string"
}
],
"third_party_name": "string",
"extratype": 0,
"copytochildonupdate": true,
"copytograndchildonupdate": true,
"copytoparentonupdate": true,
"hyperlink": "string",
"usage": 0,
"linked_table_id": 0,
"showondetailsscreen": true,
"third_party_value": "string",
"custom_extra_table_id": 0,
"copytorelated": true,
"only_validate_on_creation": true,
"calculation": "string",
"rounding": 0,
"validation_reasons": [
{
"id": "string",
"name": "string"
}
],
"int_value_is_display": true,
"regex": "string",
"onlyshowforagents": true,
"is_horizontal": true,
"copied": true,
"isencrypted": true,
"max_selection": 0,
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"selection_field_id": 0,
"variable_format_1": "string",
"variable_format_2": "string",
"validation_data": [
{
"id": 0,
"fiid": 0,
"filinktoid": 0,
"validationtype": 0,
"askforreason": true,
"hours": 0,
"_warning": "string",
"days": 0
}
],
"database_lookup_input": 0,
"table_data_entry_type": 0,
"showintable": true,
"table_height": 0,
"dont_delete_rows": true,
"table_matching_field": 0,
"new_storage_method": true,
"where_sql": "string",
"load_type": 0,
"add_rows": true,
"delete_these_rows": [
0
],
"showinpool": true,
"allow_pool_override": true,
"details_column_group": 0,
"add_row_per_value": true,
"store_in_fielddata": true,
"first_value_default": true,
"copytoparentnewticket": true,
"table_matching_field_list": [
0
],
"showforresourcebooking": true,
"dont_load_in_entity_details": true,
"integration_precedence_type": 0,
"_max_row_count_exceeded": 0
}
],
"timeentries": [
{
"id": 0,
"faultid": 0,
"actioncode": 0,
"time": 0,
"actionbillingplanid": 0,
"value": 0,
"overridden": true,
"actualtime": 0,
"_warning": "string"
}
],
"section_timezone": "string",
"itilname": "string",
"related_service_descriptions": "string",
"related_businessapps_descriptions": "string",
"related_service_category_names": "string",
"projectinternaltask": true,
"appointment_id": 0,
"nextappointmentdate": "2026-10-22T06:41:52.088Z",
"firstname": "string",
"lastname": "string",
"connectedinstance_id": 0,
"web_url": "string",
"api_url": "string",
"action_number": 0,
"action_ticket_id": 0,
"action_datetime": "2026-10-22T06:41:52.088Z",
"action_outcome": "string",
"action_chargerate": "string",
"action_travelchargerate": "string",
"action_contract_ref": "string",
"action_note": "string",
"ticket_invoices_for_each_site": 0,
"salesorder_id": 0,
"orderhead_id": 0,
"budgettype": "string",
"requesttype_name": "string",
"recalculate_billing": true,
"impactlevel": 0,
"supplier_id": 0,
"pr_id": 0,
"branch_id": 0,
"branch_name": "string",
"update_milestone_id": 0,
"milestone_id": 0,
"milestone_name": "string",
"milestone_billing_type": 0,
"milestone_value": 0,
"milestone_sequence": 0,
"milestone_status": 0,
"milestone_startdate": "2026-10-22T06:41:52.088Z",
"milestone_enddate": "2026-10-22T06:41:52.088Z",
"email_message_id": "string",
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"colour": "string",
"reviewed": true,
"action_agent_name": "string",
"merged_into_id": 0,
"reassigncount": 0,
"parent_status": 0,
"parent_agent": 0,
"child_status": 0,
"date_fully_closed": "2026-10-22T06:41:52.088Z",
"lastaction_chargerate": "string",
"hover_summary": "string",
"slatimeelapsed": 0,
"ai_summary": "string",
"search_score": 0,
"main_project_id": 0,
"is_maintenance": true,
"first_respond_by_date": "2026-10-22T06:41:52.088Z",
"sla_first_response_state": "string",
"table": 0,
"use": "string",
"canbevotedfor": true,
"supplier_reference": "string",
"contract_id": 0,
"top_level_name": "string",
"deleted_date": "2026-10-22T06:41:52.088Z",
"isbeingclosed": true,
"maximumRestrictedPriority": 0,
"primary_service_name": "string",
"idsummary": "string",
"scomclearance": "string",
"scomalertid": "string",
"statusseq": 0,
"statuscolor": "string",
"next_appointment_type": 0,
"account_manager": "string",
"orionalert": 0,
"orionnote": "string",
"orionwho": 0,
"product_key": "string",
"rapid7_action_count": "string",
"rapid7_ticketrrn": "string",
"rapid7_ticketinvid": "string",
"ticketage": 0,
"ninja_id": "string",
"teams_ticket_icon": "string",
"lastactiondateteams": "string",
"priority_name": "string",
"useful_count": 0,
"notuseful_count": 0,
"sitepostcode": "string",
"mailbox": "string",
"userdepartments": "string",
"updateservicestatus": true,
"servicestatusnote": "string",
"itil_requesttype_id": 0,
"startdatetime": "2026-10-22T06:41:52.088Z",
"enddatetime": "2026-10-22T06:41:52.088Z",
"closure_agent_id": 0,
"closed_in_integration_system": true,
"newrelic_id": "string",
"createdfromautomationstdid": 0,
"created_from_automation_entityid": 0,
"ticket_tags": "string",
"status_change_frozen": true,
"approval_status": 0,
"opp_country_name": "string",
"opp_region_name": "string",
"invoiceseperatelyoverride": true,
"purchaseordernumber": "string",
"budgethours": "string",
"created_by": "string",
"additional_agents": [
{
"faultid": 0,
"id": 0,
"name": "string",
"email": "string",
"_warning": "string"
}
],
"client_to_invoice_to_id": 0,
"primary_issue": {
"id": 0,
"table_id": 0,
"module_id": 0,
"integration_name": "string",
"halo_id": 0,
"third_party_id": "string",
"third_party_desc": "string",
"third_party_type": "string",
"third_party_url": "string",
"third_party_assigned_to": "string",
"third_party_count": 0,
"primary": true,
"halo_desc": "string",
"halo_second_id": 0,
"halo_second_desc": "string",
"extra_match_field": "string",
"details_id": 0,
"third_party_secondary_id": "string",
"_warning": "string",
"third_party_status": "string",
"third_party_priority": "string",
"_match": true,
"populate_url": true,
"date_created": "2026-10-22T06:41:52.088Z",
"date_updated": "2026-10-22T06:41:52.088Z",
"subscription_id": "string",
"new_subscription_key": "string",
"subscription_expiry": "2026-10-22T06:41:52.088Z",
"_webhookaction": 0,
"revisions": 0,
"dont_move_existing_assets": true,
"chat_message_count": 0,
"third_party_additional_id": "string",
"description": "string",
"update_existing_link": true,
"filters": [
{
"id": 0,
"integration_id": 0,
"mapping_id": 0,
"mapping_name": "string",
"filter_field": "string",
"filter_type": 0,
"filter_value": "string",
"query_string": "string",
"_warning": "string",
"details_id": 0,
"value_type": 0,
"filter_operator": 0,
"filter_type2": 0,
"apply_client_side": true,
"mapping_type": 0
}
],
"parent_id": 0,
"child_links": [
"string"
],
"url_for_linked_entity": "string",
"url_for_linked_entity_caption": "string",
"icon_for_linked_entity_caption": "string"
},
"primary_workitem": {
"id": 0,
"table_id": 0,
"module_id": 0,
"integration_name": "string",
"halo_id": 0,
"third_party_id": "string",
"third_party_desc": "string",
"third_party_type": "string",
"third_party_url": "string",
"third_party_assigned_to": "string",
"third_party_count": 0,
"primary": true,
"halo_desc": "string",
"halo_second_id": 0,
"halo_second_desc": "string",
"extra_match_field": "string",
"details_id": 0,
"third_party_secondary_id": "string",
"_warning": "string",
"third_party_status": "string",
"third_party_priority": "string",
"_match": true,
"populate_url": true,
"date_created": "2026-10-22T06:41:52.088Z",
"date_updated": "2026-10-22T06:41:52.088Z",
"subscription_id": "string",
"new_subscription_key": "string",
"subscription_expiry": "2026-10-22T06:41:52.088Z",
"_webhookaction": 0,
"revisions": 0,
"dont_move_existing_assets": true,
"chat_message_count": 0,
"third_party_additional_id": "string",
"description": "string",
"update_existing_link": true,
"filters": [
{
"id": 0,
"integration_id": 0,
"mapping_id": 0,
"mapping_name": "string",
"filter_field": "string",
"filter_type": 0,
"filter_value": "string",
"query_string": "string",
"_warning": "string",
"details_id": 0,
"value_type": 0,
"filter_operator": 0,
"filter_type2": 0,
"apply_client_side": true,
"mapping_type": 0
}
],
"parent_id": 0,
"child_links": [
"string"
],
"url_for_linked_entity": "string",
"url_for_linked_entity_caption": "string",
"icon_for_linked_entity_caption": "string"
},
"billing_plan_text": "string",
"default_appointment_summary": "string",
"default_appointment_details": "string",
"agent_signature": "string",
"customer_signature": "string",
"new_agent_signature": "string",
"new_customer_signature": "string",
"ticket_client_to_invoice_to_id": 0,
"billable_time": 0,
"invoiceable_time": 0,
"owning_service": 0,
"owning_service_name": "string",
"_open_search_score": 0,
"ticket_timezone": "string",
"reference": "string",
"latitude": 0,
"longitude": 0,
"change_all_day": true,
"change_window_type": 0,
"search_count": 0,
"slastate": "string",
"is_opportunity": true,
"user_email2": "string",
"user_email3": "string",
"dl_cf_email_value": "string",
"risklevel": 0,
"requesttype_group": "string",
"related_articles_str": "string",
"country_code_name": "string",
"country_code_alpha2": "string",
"country_code_alpha3": "string",
"country_code_numeric": 0,
"article_inactive": true,
"piipci_span_count": 0,
"is_draft": true,
"campaign_group_id": 0,
"campaign_step_seq": 0,
"campaign_step_name": "string",
"_importtypeid": 0,
"_importthirdpartyid": "string",
"_importtype": "string",
"new_external_link": {
"id": 0,
"table_id": 0,
"module_id": 0,
"integration_name": "string",
"halo_id": 0,
"third_party_id": "string",
"third_party_desc": "string",
"third_party_type": "string",
"third_party_url": "string",
"third_party_assigned_to": "string",
"third_party_count": 0,
"primary": true,
"halo_desc": "string",
"halo_second_id": 0,
"halo_second_desc": "string",
"extra_match_field": "string",
"details_id": 0,
"third_party_secondary_id": "string",
"_warning": "string",
"third_party_status": "string",
"third_party_priority": "string",
"_match": true,
"populate_url": true,
"date_created": "2026-10-22T06:41:52.088Z",
"date_updated": "2026-10-22T06:41:52.088Z",
"subscription_id": "string",
"new_subscription_key": "string",
"subscription_expiry": "2026-10-22T06:41:52.088Z",
"_webhookaction": 0,
"revisions": 0,
"dont_move_existing_assets": true,
"chat_message_count": 0,
"third_party_additional_id": "string",
"description": "string",
"update_existing_link": true,
"filters": [
{
"id": 0,
"integration_id": 0,
"mapping_id": 0,
"mapping_name": "string",
"filter_field": "string",
"filter_type": 0,
"filter_value": "string",
"query_string": "string",
"_warning": "string",
"details_id": 0,
"value_type": 0,
"filter_operator": 0,
"filter_type2": 0,
"apply_client_side": true,
"mapping_type": 0
}
],
"parent_id": 0,
"child_links": [
"string"
],
"url_for_linked_entity": "string",
"url_for_linked_entity_caption": "string",
"icon_for_linked_entity_caption": "string"
},
"import_details_id": 0,
"_isupdateimport": true,
"_match_thirdparty_id": "string",
"_match_integration_id": 0,
"_match_integration_name": "string",
"_match_additional_id": "string",
"_match_integration_button_caption": "string",
"_match_integration_button_url": "string",
"_match_integration_button_icon": "string"
}
],
"columns_id": 0,
"columns_tilehtml": "string",
"columns_dashboard_id": 0,
"columns_cardhtml": "string",
"columns_calendar_event_title": "string",
"columns": [
{
"id": 0,
"columns_id": 0,
"column_seq": 0,
"column_name": "string",
"width": 0,
"order_seq": 0,
"order_desc": true,
"column_title_override": "string",
"groupbystatus": 0,
"column_default_width": 0,
"aggregation_type": "string",
"columns_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
],
"zapier_ticket": {
"id": 0,
"dateoccurred": "2026-10-22T06:41:52.088Z",
"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",
"team": "string",
"agent_id": 0,
"category_1": "string",
"category_2": "string",
"category_3": "string",
"category_4": "string",
"user_email": "string",
"emailtolist": "string",
"reportedby": "string",
"customfields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"lastaction": {
"ticket_id": 0,
"id": 0,
"outcome": "string",
"who": "string",
"datetime": "2026-10-22T06:41:52.088Z",
"note": "string",
"customfields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"emailto": "string",
"emailcc": "string"
}
},
"_warning": "string",
"completion_perc": 0,
"include_children": true,
"collapse_by_default": true,
"_dl_warning": "string",
"statuses": [
{
"id": 0,
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"intent": "string",
"name": "string",
"shortname": "string",
"type": 0,
"sequence": 0,
"colour": "string",
"slaaction": "string",
"ticket_count": 0,
"showonquickchange": true,
"timeuntilloffhold": 0,
"statuschangeto": 0,
"statuschangetofreq": 0,
"useworkinghours": 0,
"statusemailfreqdays": 0,
"statusemailid": 0,
"statusemail_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"statusnochangehours": 0,
"nochangehoursrecurring": true,
"statusnochangehoursmanager": 0,
"statusnochangehoursmanagerrecurring": true,
"statusnochangehourssection": 0,
"statusnochangehourssectionrecurring": true,
"nochangetemplate": 0,
"nochangetemplate_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"includeinloadbalance": true,
"useworkinghours_statusnochangehours": 0,
"useworkinghours_statusnochangehourssection": 0,
"useworkinghours_statusnochangehoursmanager": 0
}
],
"priorities": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"slaid": 0,
"sla_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"priorityid": 0,
"name": "string",
"fixtime": 0,
"fixunits": "string",
"enterslaexcuse": true,
"enterslaresolutionbreachcode": true,
"responsetime": 0,
"responseunits": "string",
"ishidden": true,
"fixendofday": true,
"responseendofday": true,
"colour": "string",
"catprompt": 0,
"workdaysoverride": 0,
"responsestartofday": true,
"responsestartofdaytime": "string",
"startofday": true,
"startofdaytime": "string",
"setfixtostartdate": true,
"setfixtotargetdate": true,
"translations": [
{
"id": 0,
"language_id": 0,
"entity": "string",
"fieldname": "string",
"entity_id": 0,
"entity_id2": 0,
"entity_id3": 0,
"entity_textid": "string",
"translation": "string",
"_dotranslate": true,
"_translateonly": true,
"_isimport": true,
"default_translation": "string",
"_warning": "string"
}
],
"enterslaresponseexcuse": true,
"enterslaresponsebreachcode": true,
"_warning": "string",
"_isimport": true,
"_importtype": "string",
"sla_name": "string",
"firstresponsetime": 0,
"firstresponseunits": "string"
}
],
"agents": [
{
"id": 0,
"name": "string",
"onlinestatus_actual": 0,
"onlinestatus": 0,
"is_online": true,
"lastonline": "string",
"team": "string",
"isdisabled": true,
"email": "string",
"ad": "string",
"lastlogindate": "2026-10-22T06:41:52.088Z",
"agentphotopath": "string",
"initials": "string",
"firstname": "string",
"surname": "string",
"colour": "string",
"jobtitle": "string",
"sms": "string",
"extensionnumber": "string",
"ticket_count": 0,
"is_agent": true,
"one_client": 0,
"teams": [
{
"id": 0,
"agent_id": 0,
"agent_name": "string",
"team_id": 0,
"team_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"team_name": "string",
"department_id": 0,
"org_department_team_name": "string",
"role_id": "string",
"role_name": "string",
"is_manager": true,
"no_config_access": true,
"unassigned_access": true,
"otheragent_access": true,
"fortickets": true,
"foropps": true,
"forprojects": true,
"in_section": true,
"excludeautoassign": true,
"namewithinactive": "string",
"exclude_from_team_resource_booking": true,
"booking_priority": 0,
"isintegration": true,
"thirdparty_agent_relational_id": "string",
"thirdparty_role_relational_id": "string",
"thirdparty_team_relational_id": "string",
"is_inactive": true
}
],
"departments": [
{
"id": 0,
"agent_id": 0,
"agent_name": "string",
"department_id": 0,
"department_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"department_name": "string",
"role_id": "string",
"role_name": "string",
"membershiplevel": 0,
"includeteamsintree": true
}
],
"clients": [
{
"id": 0,
"agent_id": 0,
"agent_name": "string",
"client_id": 0,
"client_name": "string",
"role_id": "string",
"role_name": "string"
}
],
"tickettypes": [
{
"id": 0,
"agent_id": 0,
"agent_name": "string",
"tickettype_id": 0,
"tickettype_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tickettype_name": "string",
"role_id": "string",
"role_name": "string",
"cancreate": true,
"canview": true,
"canedit": true,
"can_upload_attachments": true,
"can_view_attachments": true,
"can_download_attachments": true,
"can_edit_attachments": true,
"can_view_action_history": true,
"_warning": "string"
}
],
"qualifications": [
{
"id": 0,
"agent_id": 0,
"agent_name": "string",
"qualification_id": 0,
"qualification_name": "string",
"role_id": "string",
"role_name": "string",
"date": "2026-10-22T06:41:52.088Z",
"_warning": "string",
"enddate": "2026-10-22T06:41:52.088Z"
}
],
"qualification_weighting": 0,
"qualified": true,
"role_list": "string",
"current_action_type": "string",
"current_action_name": "string",
"assettypes": [
{
"id": 0,
"agent_id": 0,
"agent_name": "string",
"assettype_id": 0,
"assettype_name": "string",
"role_id": "string",
"role_name": "string",
"cancreate": true,
"canview": true,
"canedit": true,
"_warning": "string"
}
],
"googleemail": "string",
"linemanager": 0,
"linemanager_name": "string",
"inboxes": 0,
"exchange_authorized": true,
"exchange_account": "string",
"sentinel_authorized": true,
"licence_type": 0,
"named_licences_in_use": 0,
"concurrent_licences_in_use": 0,
"concurrent_agent_total": 0,
"google_mail_authorized": true,
"inbox_clientid": "string",
"isapiagent": true,
"splashtop_authorized": true,
"gotoresolve_authorized": true,
"top_levels": [
{
"id": 0,
"agent_id": 0,
"agent_name": "string",
"top_level_id": 0,
"top_level_name": "string",
"role_id": "string",
"role_name": "string"
}
],
"use": "string",
"assetfields": [
{
"id": 0,
"agent_id": 0,
"agent_name": "string",
"field_id": 0,
"field_name": "string",
"role_id": "string",
"role_name": "string",
"field_type": "string",
"level": 0,
"_warning": "string"
}
],
"unamecustomfields": [
{
"id": 0,
"agent_id": 0,
"agent_name": "string",
"field_id": 0,
"field_name": "string",
"role_id": "string",
"role_name": "string",
"field_type": "string",
"level": 0,
"canadd": true,
"candelete": true,
"canedit": true,
"customfield_type": 0,
"_warning": "string"
}
],
"unameappointmenttypes": [
{
"id": 0,
"agent_id": 0,
"agent_name": "string",
"field_id": 0,
"field_name": "string",
"role_id": "string",
"role_name": "string",
"field_type": "string",
"level": 0,
"_warning": "string"
}
],
"_canupdate": true,
"_canupdate_moreinfo": true,
"logmeinid": "string",
"allowbeyondtrustinvites": true,
"jira_id": "string",
"namewithinactive": "string",
"apptsync": 0,
"okta_id": "string",
"sailpoint_id": "string",
"enableshifts": true,
"sendemailerrors": true,
"uname_usercustomfields": [
{
"id": 0,
"agent_id": 0,
"agent_name": "string",
"field_id": 0,
"field_name": "string",
"role_id": "string",
"role_name": "string",
"field_type": "string",
"level": 0,
"canadd": true,
"candelete": true,
"canedit": true,
"customfield_type": 0,
"_warning": "string"
}
],
"can_approve_purchaseorder": true,
"can_approve_quote": true,
"can_approve_invoice": true,
"can_approve_campaign": true,
"default_splashtop_channel": 0,
"workday_id": 0,
"workday_name": "string",
"workday_timezone": "string",
"timezone": "string",
"costprice": 0,
"chargerate": 0,
"pronouns": "string",
"first_role_id": "string",
"in_queried_team": true,
"guid_string": "string",
"third_party_guid": "string",
"timesheet_approver": 0,
"original_timesheet_approver": 0,
"is_member_of_all_departments": true,
"third_party_relational_id": "string",
"default_team_id": 0
}
],
"ticket_ids": [
0
]
}
Workflow Library Example
List Tickets with Halo Itsm and Send Results Via Email