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 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, in the format custom_field=<field_name>:<value>.
The parameter is optional and can be repeated, which is how AND and OR conditions are expressed:

• Repeating the same field name matches any of its values (OR).
  ?custom_field=visit_category:wellness&custom_field=visit_category:acute_sick
  returns the locations whose visit_category is either wellness or acute_sick.
• Using different field names requires all of them to match (AND).
  ?custom_field=visit_category:wellness&custom_field=has_parking:true
  returns only the locations that are in the wellness category and have parking.
• The two can be combined.
  ?custom_field=visit_category:wellness&custom_field=visit_category:acute_sick&custom_field=has_parking:true
  returns the locations whose visit_category is wellness or acute_sick, and that also have parking.

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 provided latitude and longitude.
Important: If order_by is set to proximity_distance, you must also provide the latitude and longitude query parameters. Failure to do so will result in a 400 Bad Request error.