External DocumentationTo learn more, visit the Halo ITSM documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Domain | The area to filter fields by. For example, reqs for tickets, opps for opportunities, or prjs for projects. |
| Field Type | The field type to filter fields by, as an integer code. |
| Field Types | A comma-separated list of field type codes to filter fields by. |
| Input Type | The input type to filter fields by, as an integer code. |
| Type ID | The type ID to filter fields by. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Access Control Level | The access control level to filter fields by. |
| Exclude Ranges | Select to exclude range fields from the response. |
| Exclude Table Self | Select to exclude self-referencing table fields from the response. |
| Exclude Tables | Select to exclude table fields from the response. |
| Extra Type | The extra type to filter fields by, as an integer code. |
| Include Categories | Select to include category fields in the response. |
| Include Date Fields | Select to include date fields in the response. |
| Include Jira Fields | Select to include Jira fields in the response. |
| Include Remote Fields | Select to include remote fields in the response. |
| Include Values | Select to include each field’s values in the response. |
| Is Approval Step | Select to return only the fields used in approval steps. |
| Is Config | Select to return the fields as used in Halo’s configuration screens. |
| Is Custom Field Setup | Select to return the fields as used in Halo’s custom field setup. |
| System ID | The system ID to filter fields by. |
Example Output
[
{
"intent": "string",
"id": 0,
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"label": "string",
"labellong": "string",
"summary": "string",
"hint": "string",
"lookup": 0,
"type": 0,
"sequence": 0,
"entity_restriction": true,
"entity": "string",
"entity_list": [
{
"value": "string",
"label": "string",
"isnew": true
}
],
"custom": 0,
"usage": 0,
"usage_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tab_id": 0,
"tab_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"tab_name": "string",
"tab_sequence": 0,
"tab_columns": 0,
"table_id": 0,
"table_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"table_name": "string",
"readonly": true,
"addunknown": true,
"extratype": 0,
"calcfield": "string",
"characterlimit": 0,
"characterlimittype": 0,
"inputtype": 0,
"copytochild": true,
"copytoparent": true,
"searchable": true,
"user_searchable": true,
"calendar_searchable": true,
"defaultvalue": "string",
"ordervaluesalphanumerically": true,
"ordervalueby": 0,
"defaultvalue_lookup": "string",
"defaultvalue_table": [
{
"id": 0,
"fkid": 0,
"template_id": 0,
"display": "string",
"customfields": []
}
],
"values": [
{
"lookupid": 0,
"id": "string",
"name": "string",
"value2": "string",
"value2_bool": true,
"value3": "string",
"value3_bool": true,
"value4": "string",
"value4_bool": true,
"value5": "string",
"value5_bool": true,
"value6": "string",
"value6_bool": true,
"value7": "string",
"value7_bool": true,
"value8": "string",
"value8_bool": true,
"value9": "string",
"value9_bool": true,
"value10": "string",
"value10_bool": true,
"sequence": 0,
"translations": []
}
],
"table_values": [
{
"id": 0,
"fkid": 0,
"template_id": 0,
"display": "string",
"customfields": []
}
],
"new_values": "string",
"variable_name": "string",
"faults_field_name": "string",
"actions_field_name": "string",
"table_info": {
"intent": "string",
"ctfield": {},
"customfields": [],
"add_customfields": [],
"edit_customfields": [],
"delete_customfields": [],
"id": 0,
"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"db_name": "string",
"linkto_table_id": 0,
"linkto_table_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"linkto_table_name": "string",
"note": "string",
"import_folder": "string",
"table_type": 0,
"data_entry_type": 0,
"clear_on_close": true,
"modal_size": 0,
"primary_field_1": 0,
"primary_field_1_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"primary_field_1_name": "string",
"primary_field_2": 0,
"primary_field_2_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"primary_field_2_name": "string",
"fields": [],
"customextratableid": 0,
"can_load_data": true,
"_warning": "string",
"customtable_orderby": 0,
"customtable_orderby_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customtable_orderby_name": "string",
"_isimport": true,
"_isexternalrequest": true,
"_importtype": "string",
"key": 0,
"access_control": [],
"access_control_level": 0,
"import_name": "string",
"columns": 0,
"page_no": 0,
"page_size": 0,
"record_count": 0,
"sql_script": "string",
"frequency": "string",
"reporting_period": 0,
"schedule": {},
"schedule_id": 0,
"nextcreationdate": "2026-10-22T06:41:52.087Z",
"lastcreated": "2026-10-22T06:41:52.087Z",
"disabled": true,
"schema": [],
"_run_stats_now": true,
"_run_stats_now_period": "2026-10-22T06:41:52.087Z",
"_new_row_count": 0,
"rows": [],
"_add_rows": [],
"_delete_data": true,
"_delete_data_start_date": "2026-10-22T06:41:52.087Z",
"_delete_data_end_date": "2026-10-22T06:41:52.087Z",
"create_linked_field": true,
"show_as_nav_area": true
},
"client_restrictions": [
{
"id": 0,
"client_id": 0,
"client_name": "string",
"show_to_client": true,
"field_id": 0
}
],
"org_restrictions": [
{
"id": 0,
"org_id": 0,
"org_name": "string",
"field_id": 0
}
],
"database_lookup_id": 0,
"database_lookup_name": "string",
"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",
"sqllookup": "string",
"copytochildonupdate": true,
"copytograndchildonupdate": true,
"copytoparentonupdate": true,
"showintable": true,
"importalias": "string",
"hyperlink": "string",
"seq": 0,
"visibility": 0,
"groupname": "string",
"_testsql": true,
"_warning": "string",
"showhintondetails": true,
"partslookupusedin": "string",
"showondetailsscreen": true,
"selection_field_id": 0,
"selection_field_name": "string",
"variable_format_1": "string",
"variable_format_2": "string",
"customextratableid": 0,
"stored_in_table": "string",
"copytorelated": true,
"deleteafterclosure": true,
"deleteafterclosuredays": 0,
"defaultdate": 0,
"validation_data": [
{
"id": 0,
"fiid": 0,
"filinktoid": 0,
"validationtype": 0,
"askforreason": true,
"hours": 0,
"_warning": "string",
"days": 0
}
],
"only_validate_on_creation": true,
"date_error_message": "string",
"calculation": "string",
"rounding": 0,
"regex": "string",
"onlyshowforagents": true,
"excludefromallfields": true,
"mandatory": true,
"visibility_conditions": [
{
"pk": 0,
"id": 0,
"tickettype_id": 0,
"field_id": 0,
"field_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"lookup_field_id": 0,
"lookup_field_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"lookup_value_id": 0,
"lookupvalueid_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"lookup_value": "string",
"lookupvalue_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"field_value": 0,
"category_value_name": "string",
"dynamic_SQL_field": true,
"value_modified": true,
"conditiontype": 0,
"_warning": "string",
"field_usage": 0,
"criteriagroup_id": 0
}
],
"group_visibility_conditions": [
{
"id": 0,
"entity_id": 0,
"entity_name": "string",
"entity_id2": 0,
"entity_guid2": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entity_id3": 0,
"type": 0,
"desc": "string",
"seq": 0,
"allow_access": true,
"subscriber_type": 0,
"restrictions": [],
"visibility_conditions": [],
"visibility_conditions_value": [],
"user_access": [],
"subscribers": [],
"criteria": [],
"view_filter_details": [],
"ticket_area_filter_details": [],
"field_value": [],
"_warning": "string",
"_temp_id": "string"
}
],
"access_control": [
{
"id": 0,
"entity": "string",
"entity_id": 0,
"type": 0,
"agent_id": 0,
"user_id": 0,
"role_id": 0,
"team_id": 0,
"team_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"department_id": 0,
"department_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"level": 0,
"_warning": "string",
"entity_name": "string",
"entity_text_id": "string",
"thirdparty_relational_id": "string"
}
],
"access_control_level": 0,
"inherit_ac_from_tickettype": true,
"is_horizontal": true,
"sqlcfvariables": [
0
],
"showoncrmnote": true,
"database_lookup_input": 0,
"table_data_entry_type": 0,
"isencrypted": true,
"table_height": 0,
"sql_connection_type": 0,
"sql_user": "string",
"sql_new_password": "string",
"sql_server": "string",
"sql_database": "string",
"sql_certificate_id": 0,
"sql_certificate_name": "string",
"lookup_request": {
"connection_name": "string",
"sql_string": "string",
"db_params": [],
"filookup": 0
},
"max_selection": 0,
"hint_type": 0,
"defaultdays": 0,
"new_storage_method": true,
"where_sql": "string",
"load_type": 0,
"hide_from_filters": true,
"lookup_method": 0,
"integration_method_id": 0,
"integration_method_name": "string",
"integration_method_value": 0,
"integration_method_value_name": "string",
"display_property": "string",
"value_property": "string",
"showinpool": true,
"allow_pool_override": true,
"simplify_rich": true,
"details_column_group": 0,
"tickettypes": [
{
"value": "string",
"label": "string",
"isnew": true
}
],
"outcomes": [
{
"value": "string",
"label": "string",
"isnew": true
}
],
"fieldgroups": [
{
"value": "string",
"label": "string",
"isnew": true
}
],
"calculatevariablesinvalue": true,
"populatevariablesinpdfandemail": true,
"isinafaqlist": true,
"add_row_per_value": true,
"store_in_fielddata": true,
"new_field_data_storage_method": 0,
"use_non_integer_identifier": true,
"first_value_default": true,
"restrictupdate": 0,
"update_restrictions": [
{
"id": 0,
"tickettype_id": 0,
"field_id": 0,
"fieldgroup_id": 0,
"type": 0,
"role_id": 0,
"role_name": "string",
"_warning": "string",
"alloweditbeforeapproval": true,
"alloweditafterapproval": true,
"alloweditduringapproval": true,
"field_usage": 0,
"custom_table_id": 0
}
],
"update_restriction_roles": [
0
],
"restrictread": 0,
"read_restrictions": [
{
"id": 0,
"tickettype_id": 0,
"field_id": 0,
"fieldgroup_id": 0,
"type": 0,
"role_id": 0,
"role_name": "string",
"_warning": "string",
"alloweditbeforeapproval": true,
"alloweditafterapproval": true,
"alloweditduringapproval": true,
"field_usage": 0,
"custom_table_id": 0
}
],
"read_restriction_roles": [
0
],
"_isclone": true,
"copytoparentnewticket": true,
"showforresourcebooking": true,
"user_can_edit": true,
"supplier_user_can_edit": true,
"dont_load_in_entity_details": true,
"exclude_from_audit": 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"
}
],
"integration_precedence_type": 0,
"integration_precedence": [
{
"id": 0,
"seq": 0,
"field_id": 0,
"field_type": 0,
"module": 0,
"module_name": "string",
"_warning": "string"
}
]
}
]
Workflow Library Example
List Custom Fields with Halo Itsm and Send Results Via Email