Filters services by the values of their custom fields, using a structured query expression
in the format custom_field=<field_name> eq '<value>', combined with and/or and parentheses.
Two operators are supported: eq matches the exact value and fuzzy matches similar values.
- A single comparison.
?custom_field=visit_category eq 'wellness'
returns the services whose visit_category is wellness.
or matches any of the given comparisons.
?custom_field=visit_category eq 'wellness' or visit_category eq 'acute_sick'
returns the services whose visit_category is either wellness or acute_sick.
and requires all of the given comparisons to match.
?custom_field=visit_category eq 'wellness' and has_parking eq 'true'
returns only the services that are in the wellness category and have parking.
- Parentheses group comparisons and override the default precedence (
and binds tighter than or).
?custom_field=visit_category eq 'wellness' and (has_parking eq 'true' or has_parking eq 'false')
- The parameter can be repeated (up to 50 times); repeated occurrences are combined with
and.
?custom_field=visit_category eq 'wellness'&custom_field=has_parking eq 'true'
is equivalent to ?custom_field=visit_category eq 'wellness' and has_parking eq 'true'.
fuzzy matches values that are similar to the given one.
?custom_field=visit_category fuzzy 'welness'
also returns the services whose visit_category is wellness.
It can be combined with eq, and, or and parentheses:
?custom_field=visit_category fuzzy 'welness' or visit_category eq 'acute_sick'.
The fuzzy operator applies to text, tag-list, single-select and multi-select custom fields (for the
select types it matches an option that is similar to the value, in any casing, e.g. welness finds
the option Wellness); number, date and boolean fields are always matched exactly, as with eq. It follows the fuzzy and
fuzzy_threshold query parameters, and behaves as eq when fuzzy is false or when the value has
fewer than 3 characters. Similar values are found with trigram similarity on the lowercased text, so a
missing accent lowers the score: cardiologia still matches cardiología with the default threshold,
but a higher fuzzy_threshold may not.
The expression is part of the query string, so it must be percent-encoded: a space is %20, a single
quote %27, and a literal &, +, % or # inside a value is %26, %2B, %25 or %23.
For example visit_category fuzzy 'welness' is sent as custom_field=visit_category%20fuzzy%20%27welness%27.
Field names are matched case-insensitively. String values must be enclosed in single quotes;
a literal single quote within a value is escaped by doubling it ('').
Value matching is case-insensitive for regular text custom fields, but case-sensitive for
single-select and multi-select custom fields (the value must match one of the field's
defined options exactly). Omitting the parameter leaves the results unfiltered.