> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Suppliers

Search for suppliers by name.

> [!NOTE]
>
> External Documentation
>
> To learn more, visit the [Halo ITSM documentation](https://www.usehalo.com/swagger).

## Basic Parameters

| Parameter | Description |
| - | - |
| 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. |

## Advanced Parameters

| Parameter | Description |
| - | - |
| Include Active Suppliers | Select to include active suppliers in the response. |
| Include Inactive Suppliers | Select to include inactive suppliers in the response. |
| Order | The field to order the results by. |
| Sort In Descending Order | Select to order the results in descending order. |
| Top Level ID | The ID of the top level to filter suppliers by. |

## Example Output

```json theme={"dark"}
{
	"page_no": 0,
	"page_size": 0,
	"record_count": 0,
	"suppliers": [
		{
			"id": 0,
			"name": "string",
			"toplevel_id": 0,
			"toplevel_name": "string",
			"contact_name": "string",
			"email_address": "string",
			"support_email_address": "string",
			"ordering_email_address": "string",
			"phone_number": "string",
			"inactive": true,
			"emailtemplate_id": 0,
			"default_contract_id": 0,
			"default_contract_sla_id": 0,
			"thirdpartynhdapiurl": "string",
			"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
				}
			],
			"custombuttons": [
				{
					"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
					"intent": "string",
					"id": 0,
					"usage": 0,
					"name": "string",
					"label": "string",
					"seq": 0,
					"icon": "string",
					"url": "string",
					"newtab": true,
					"msid": 0,
					"type": 0,
					"runbook_id": "string",
					"runbook_name": "string",
					"_warning": "string",
					"button_visibility_ac": 0,
					"restrict_by_asset_status": true,
					"button_visibility_statuses": [
						{
							"id": "string",
							"name": "string"
						}
					],
					"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": [
								{
									"id": 0,
									"criteriagroup_id": 0,
									"field_id": 0,
									"type": 0,
									"value_entity": 0,
									"value_id": 0,
									"value_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
									"value_name": "string",
									"fieldname": "string",
									"value_type": "string",
									"value_type_id": 0,
									"value_int": 0,
									"valueint_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
									"value_string": "string",
									"value_datetime": "2026-10-22T06:39:45.945Z",
									"value_float": 0,
									"value_display": "string",
									"alt_value_display": "string",
									"tablename": "string",
									"timezonestring": "string",
									"match_after_start": true,
									"match_after_target": 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
								}
							],
							"visibility_conditions_value": [
								{
									"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
								}
							],
							"user_access": [
								{
									"id": 0,
									"criteriagroup_id": 0,
									"service_category_id": 0,
									"service_id": 0,
									"type": "string",
									"data_id": 0,
									"svrdata_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
									"data_name": "string",
									"allow_access": true,
									"data_string": "string",
									"_warning": "string"
								}
							],
							"subscribers": [
								{
									"id": 0,
									"criteriagroup_id": 0,
									"service_name": "string",
									"type": "string",
									"data_id": 0,
									"data_name": "string",
									"emailupdates": true,
									"subscriber_type": 0,
									"_warning": "string"
								}
							],
							"criteria": [
								{
									"id": 0,
									"rule_id": 0,
									"autoassign_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
									"qualification_criteria_id": 0,
									"fieldname": "string",
									"property_name": "string",
									"value_type": "string",
									"value_type_id": 0,
									"value_int": 0,
									"valueint_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
									"value_string": "string",
									"value_datetime": "2026-10-22T06:39:45.945Z",
									"partialmatch": true,
									"value_float": 0,
									"matchseparatedvalues": true,
									"value_display": "string",
									"alt_value_display": "string",
									"tablename": "string",
									"type": 0,
									"flowsubdetails_criteria_id": 0,
									"use": 0,
									"chatprofile_id": "string",
									"chatprofile_flow_seq": 0,
									"timezonestring": "string",
									"match_after_start": true,
									"match_after_target": true,
									"_warning": "string",
									"stdid": 0,
									"contract_rule_id": 0,
									"function_id": 0,
									"utcoffset": 0,
									"eventrule_id": 0,
									"eventrule_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
									"comma_separated_match_output": "string",
									"exact_word_match": true,
									"flow_id": 0,
									"flow_type": 0,
									"flow_seq": 0,
									"criteria_group_id": 0,
									"chat_input_suggestion_id": 0,
									"thirdparty_relational_id": "string"
								}
							],
							"view_filter_details": [
								{
									"id": 0,
									"filter_id": 0,
									"list_id": 0,
									"itemsupplier_id": 0,
									"area_id": 0,
									"filter_name": "string",
									"filter_type": 0,
									"filter_value": "string",
									"filter_values": [
										{
											"id": "string",
											"name": "string"
										}
									],
									"multiselect_value": [
										{
											"id": "string",
											"name": "string"
										}
									],
									"criteria_group_id": 0,
									"istextsearch": true,
									"filter_value2": "string",
									"filter_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
									"list_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
									"itemsupplier_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
									"filter_value_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
								}
							],
							"ticket_area_filter_details": [
								{
									"id": 0,
									"filter_id": 0,
									"list_id": 0,
									"itemsupplier_id": 0,
									"area_id": 0,
									"filter_name": "string",
									"filter_type": 0,
									"filter_value": "string",
									"filter_values": [
										{
											"id": "string",
											"name": "string"
										}
									],
									"multiselect_value": [
										{
											"id": "string",
											"name": "string"
										}
									],
									"criteria_group_id": 0,
									"istextsearch": true,
									"filter_value2": "string",
									"filter_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
									"list_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
									"itemsupplier_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
									"filter_value_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
								}
							],
							"field_value": [
								{
									"value": "string",
									"label": "string",
									"isnew": true
								}
							],
							"_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,
					"colour": "string",
					"colour_type": 0,
					"disable_runbook_popup": true,
					"fields": [
						{
							"id": 0,
							"custom_button_id": 0,
							"field_type": 0,
							"field_name": "string",
							"label": "string",
							"techaction": 0,
							"seq": 0
						}
					],
					"status_after_action": 0
				}
			],
			"contract_count": 0,
			"use": "string",
			"logo": "string",
			"qbo_company_id": "string",
			"jira_validated": true,
			"default_currency_code": 0,
			"supplier_currency_symbol": "string",
			"supplier_currency_rate": 0,
			"supplier_mailbox_override": 0,
			"supplier_mailbox_address": "string",
			"servicenow_validated": true,
			"messagegroup_id": 0,
			"website": "string",
			"mobile": "string",
			"runbook_id": "string",
			"override_costs": [
				{
					"id": 0,
					"guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
					"item_id": 0,
					"item_name": "string",
					"supplier_id": 0,
					"supplier_name": "string",
					"price": 0,
					"cost": 0,
					"client_id": 0,
					"client_name": "string",
					"note": "string",
					"supplier_sku": "string",
					"stock": 0,
					"filters": [
						{
							"id": 0,
							"filter_id": 0,
							"list_id": 0,
							"itemsupplier_id": 0,
							"area_id": 0,
							"filter_name": "string",
							"filter_type": 0,
							"filter_value": "string",
							"filter_values": [
								{
									"id": "string",
									"name": "string"
								}
							],
							"multiselect_value": [
								{
									"id": "string",
									"name": "string"
								}
							],
							"criteria_group_id": 0,
							"istextsearch": true,
							"filter_value2": "string",
							"filter_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
							"list_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
							"itemsupplier_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
							"filter_value_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
						}
					],
					"_is_new": true,
					"_warning": "string",
					"currency_id": 0,
					"currency_name": "string",
					"top_level_id": 0,
					"top_level_name": "string",
					"customer_type_id": 0,
					"customer_type_name": "string"
				}
			],
			"phone_number_2": "string",
			"phone_number_3": "string",
			"address_list": "string",
			"address": "string",
			"companyaddress": {
				"id": 0,
				"type": 0,
				"description": "string",
				"note": "string",
				"line1": "string",
				"line2": "string",
				"line3": "string",
				"line4": "string",
				"lineextra": "string",
				"postcode": "string",
				"primary": true,
				"inactive": true,
				"date_active": "2026-10-22T06:39:45.945Z",
				"date_inactive": "2026-10-22T06:39:45.945Z",
				"lat": 0,
				"long": 0,
				"client_name": "string",
				"site_id": 0,
				"site_name": "string",
				"user_id": 0,
				"user_name": "string",
				"user_email": "string",
				"_isimport": true,
				"_add_to_site": true,
				"_warning": "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:39:45.945Z",
				"date_updated": "2026-10-22T06:39:45.945Z",
				"subscription_id": "string",
				"new_subscription_key": "string",
				"subscription_expiry": "2026-10-22T06:39:45.945Z",
				"_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": [
		{
			"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"
		}
	]
}
```

## Workflow Library Example

[Search Suppliers with Halo Itsm and Send Results Via Email](https://library.blinkops.com/workflows/search-suppliers-with-halo-itsm-and-send-results-via-email)

![Workflow Library](https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max\&auto=format\&n=ojHYuDeYX5FWuN8a\&q=85\&s=b8af968e71438a9499c3223c9bd29fb2)

Preview this Workflow on desktop

[https://library.blinkops.com/workflows/search-suppliers-with-halo-itsm-and-send-results-via-email/canvas](https://library.blinkops.com/workflows/search-suppliers-with-halo-itsm-and-send-results-via-email/canvas)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.