Search location by location name or city

The external_id of the location

The name of the location

The alternative name of the location

The type of the location

The name of the address

The zip-code of the location

The city of the location

The country name

The region name (country subdivision)

• The ISO 3166-1 alpha-2 country code (e.g. 'US') of the near_by.city or near_by.zip_code to resolve to a coordinate.
• Required when near_by.city or near_by.zip_code is provided; providing near_by.country on its own is not a valid filter.
• Cannot be combined with near_by.latitude/near_by.longitude, or with the legacy latitude/longitude/distance parameters.

• The city to resolve (via Google Maps), together with near_by.country, to a coordinate to retrieve a list of all locations within a certain radius.
• Mutually exclusive with near_by.zip_code; provide exactly one of the two.
• Requires near_by.country to also be provided.

• The zip/postal code to resolve (via Google Maps), together with near_by.country, to a coordinate to retrieve a list of all locations within a certain radius.
• Mutually exclusive with near_by.city; provide exactly one of the two.
• Requires near_by.country to also be provided.

The id of the service. Accepts multiple ids as a comma-separated list, in which case locations
associated with any of the given ids are returned.

The name of the service provided by location

The type of the service provided by location

The id of the staff. Accepts multiple ids as a comma-separated list, in which case locations
associated with any of the given ids are returned.

The name of the staff belongs to location

The specialty of the staff belongs to location

The visit type name of the staff belongs to location

Performs a case-insensitive substring match against the location's phone numbers. An empty string is treated as absent, and no filter is applied.

Filters locations 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.
Only the eq operator is currently supported.

• A single comparison.
  ?custom_field=visit_category eq 'wellness'
  returns the locations 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 locations 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 locations 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'.

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.

Specifies the field to order the results by. Currently, only the following value is supported:

• proximity_distance: Orders the results based on their proximity to the resolved coordinate.
Important: If order_by is set to proximity_distance, a coordinate must also be resolvable — either via the legacy latitude/longitude query parameters, or via near_by.latitude/near_by.longitude, or via near_by.country + near_by.city/near_by.zip_code. Failure to do so will result in a 400 Bad Request error.