Looking up people via custom field

API Q&A
1

Hi folks, I use Keragon to look up data from my EHR in Keap Max Classic.

My team is telling me that later this year this will no longer be possible due to the new API not having the same functionality.

Besides moving to a new CRM (which would be bad), what else can I do to regain this ability to look up by custom field?

2

@RedBeardBrian - I have mentioned to Keap several times about this issue, but they have a poor excuse in not wanting to implement a solution.

There stance is that it is a performance issue. So for nearly 20 years it was okay to do it via the XML-RPC without a restriction put into place. Oddly you can manually create a Saved Search to search on a particular Custom Field and run it via REST. Saved Searches are worse for performance because you can create complex queries.

What is even more funny, there will be endpoints to add / edit the custom fields for the various areas, but without the querying capabilities.

I have posted workaround solutions in this thread below.

If more people complain about this issue then hopefully Keap will do something about it.

3

Hi @RedBeardBrian and @Pav.

Custom field filtering is now available in REST v2 for the following resources:

  • Contacts

  • Companies

  • Orders

  • Affiliates

For these supported resources, custom fields can be filtered just like any other field using the filter parameter.

Some highlights:

  • Filter custom fields by their field name (case-insensitive, as returned by GET /v2/{resource}/model).

  • Support varies by field type:

    • Text-like fields (text, name, email, phone, website): == (with an optional trailing wildcard *)

    • Choice fields (dropdown, radio, yes/no, user, state): ==

    • Numeric fields: ==, >, <, >=, <=

    • Date fields: ==, >, <, >=, <= using full ISO 8601 format

    • Multi-select fields: == matches records containing the specified option

If a standard field and a custom field have the same name, the standard field takes precedence.

Please note that filtering on non-indexed custom fields is supported but may result in slower query performance.

For complete details and examples, please refer to the API documentation.

Support for the remaining resources that currently support custom field filtering in XML-RPC will also be added to REST v2 soon.