---
title: "How to configure searchable Custom Fields?"
slug: "how-to-configure-searchable-custom-fields"
updated: 2025-07-10T15:47:03Z
published: 2025-07-10T15:47:03Z
canonical: "help.frisbii.com/how-to-configure-searchable-custom-fields"
---

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

# How to configure searchable Custom Fields?

We have enhanced Custom Fields to include search functionality for Customers/Contracts/Subscriptions and Products (Components), allowing for filtering based on Custom Fields.

> [!NOTE]
> **Note:**
> 
> If you want to know more about Custom Fields, check this [article](/frisbii-transform/docs/how-can-i-configure-custom-fields).

## Configuration

1. Go to **Settings>Custom Fields**.
2. While adding a new Custom Field, make sure to check the **Searchable** option. ![](https://cdn.document360.io/b84e1b5d-2ba6-4465-8c62-fb45a2f31314/Images/Documentation/sear(1).png)

> [!NOTE]
> **Note:**
> 
> Please activate this checkbox **only for Custom Fields that require a search functionality**. Once a field is newly marked as **searchable**, it may take some time until the search returns an expected result.

### Filtering

The filtering is possible via UI and API:

- **UI** - You can use User Interface to filter out multiple elements like Customers/Contracts or Plans and Components:
  - For Customers/Contracts - In the **Customers** section, inside **Additional search attributes** drop-down, you are able to search for a specific **Custom Fields**. ![](https://cdn.document360.io/b84e1b5d-2ba6-4465-8c62-fb45a2f31314/Images/Documentation/ci.png)
  - For Components - In the **Products** section, under **Components**, you can search for a specific **Custom Fields**. ![](https://cdn.document360.io/b84e1b5d-2ba6-4465-8c62-fb45a2f31314/Images/Documentation/pr.png)
  - For Plans - In the **Products** section, under **Plans**, you can search for a specific **Custom Fields** as well as for Components. ![](https://cdn.document360.io/b84e1b5d-2ba6-4465-8c62-fb45a2f31314/Images/Documentation/pl.png)
- **API** - You can use endpoints to filter out Customers/Contract/Subscriptions or Products s by Searchable **Custom Fields**:

> [!NOTE]
> **Note:**
> 
> To find customers/contracts/products or subscriptions by customField value, customFieldApiName should be provided exactly as it is set for Custom Field (case-sensitive). Searchable CustomField value **is case-insensitive**.
  - For Customers - `GET /api/v1/customers?CustomFields.{CustomFieldApiName}={customField value}`. Explore this feature by referring to our [API Reference](https://docs.frisbii-transform.com/reference/customers_getlist_search_statusfilter_externalid_from_skip_take_customfields_get) page
  - For Contracts - `GET /api/v1/contracts?CustomFields.{CustomFieldApiName}={customField value}`. Explore this feature by referring to our [API Reference](https://docs.frisbii-transform.com/reference/contracts_getlist_from_skip_take_externalsubscriptionid_externalid_customfields_get) page.
  - For subscriptions by Contract's custom fields `GET /api/v1/subscriptions?Contract.CustomFields.{CustomFieldApiName}={customField value}`. Explore this feature by referring to our [API Reference](https://docs.frisbii-transform.com/reference/subscriptions_getlist_showhidden_search_defaultbearermedium_plangroupid_planid_planvariantid_componentid_componentusageid_discountid_paymentmethod_contractstatus_dunningtemplateid_recurringpayments_automaticbilling_paymentescalation_balancetype_contractstartfrom_contractstartto_contractendfrom_contractendto_locale_salesentityid_iban_prepaidcardserialnumberorsecretcode_customersfordeletion_contractsfordeletion_customercustomfields_contractcustomfields_componentsubscriptioncustomfields_meteredusagecustomfields_discountsubscriptioncustomfields_from_take_detaillevel_get) page.
  - For subscriptions by Customer's custom fields `GET /api/v1/subscriptions?Customer.CustomFields.{CustomFieldApiName}={customField value}`. Explore this feature by referring to our [API Reference](https://docs.frisbii-transform.com/reference/subscriptions_getlist_showhidden_search_defaultbearermedium_plangroupid_planid_planvariantid_componentid_componentusageid_discountid_paymentmethod_contractstatus_dunningtemplateid_recurringpayments_automaticbilling_paymentescalation_balancetype_contractstartfrom_contractstartto_contractendfrom_contractendto_locale_salesentityid_iban_prepaidcardserialnumberorsecretcode_customersfordeletion_contractsfordeletion_customercustomfields_contractcustomfields_componentsubscriptioncustomfields_meteredusagecustomfields_discountsubscriptioncustomfields_from_take_detaillevel_get) page.
  - For Components - GET /api/v1/components. Explore this feature by referring to our [API Reference](https://docs.frisbii-transform.com/reference/components_getgeneric_from_skip_take_customfields_get) page.
  - For Products (Plans) - GET /api/v1/plans. Explore this feature by referring to our [API Reference](https://docs.frisbii-transform.com/reference/plans_get_plangroupid_from_skip_take_customfields_get) page.

> [!NOTE]
> **Note:**
> 
> By filtering using these endpoints, it is possible to filter by few Custom Fields:
> 
> For example, using endpoints mentioned before:
> 
> `GET /api/v1/customers?CustomFields.{CustomFieldApiName}={customField 1 value}&&CustomFields.{CustomField2ApiName}={customField 2 value})`