How to configure searchable Custom Fields?

  • Updated on May 15, 2025
  • Published on Apr 7, 2025
Prev Next

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

Note:

If you want to know more about Custom Fields, check this article.

Configuration

  1. Go to Settings>Custom Fields.
    SearchableCustomFields1.png

  2. While adding a new Custom Field, make sure to check the Searchable option.
    SearchableCustomFields2.png

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.
      SearchableCustomFields3.png

    • For Components - In the Products section, under Components, you can search for a specific Custom Fields.
      SearchableCustomFields4.png

    • For Plans - In the Products section, under Plans, you can search for a specific Custom Fields as well as for Components.
      SearchableCustomFields5.png

  • API - You can use endpoints to filter out Customers/Contract/Subscriptions or Products s by Searchable Custom Fields:

    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 page

    • For Contracts - GET /api/v1/contracts?CustomFields.{CustomFieldApiName}={customField value}. Explore this feature by referring to our API Reference 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 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 page.

    • For Components - GET /api/v1/components. Explore this feature by referring to our API Reference page.

    • For Products (Plans) - GET /api/v1/plans. Explore this feature by referring to our API Reference page.

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})

Related articles