Get the paginated list of locations

Get the paginated list of locations

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

locations-directory:read

Query Params
integer
≥ 1
Defaults to 1
integer
1 to 50
Defaults to 50

Search location by location name or city

string
length between 0 and 9999

The external_id of the location

string
length between 0 and 150

The name of the location

string
length between 0 and 150

The alternative name of the location

string
length between 0 and 150

The type of the location

string
length between 0 and 150

The name of the address

string
length between 0 and 20

The zip-code of the location

string
length between 0 and 100

The city of the location

string
length between 0 and 100

The country name

string
length between 0 and 100

The region name (country subdivision)

double
-90 to 90
  • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all locations within a certain radius.
  • Legacy alternative to the near_by.* parameters; cannot be combined with them.
  • Currently, these three parameters can only be used when the Feature Flag is enabled.
double
-180 to 180
  • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all locations within a certain radius.
  • Legacy alternative to the near_by.* parameters; cannot be combined with them.
  • Currently, these three parameters can only be used when the Feature Flag is enabled.
double
≥ 0
  • Distance is measured in meters.
  • If no distance is provided, the default distance configured in Industries-settings will be used.
  • Legacy alternative to the near_by.* parameters; cannot be combined with them.
  • Currently, these three parameters can only be used when the Feature Flag is enabled.
string
length between 2 and 2
  • 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.
string
length between 0 and 100
  • 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.
string
length between 0 and 20
  • 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.
double
-90 to 90
  • Latitude of the coordinate to search near. Must be provided together with near_by.longitude.
  • Cannot be combined with near_by.country/near_by.city/near_by.zip_code, or with the legacy latitude/longitude/distance parameters.
double
-180 to 180
  • Longitude of the coordinate to search near. Must be provided together with near_by.latitude.
  • Cannot be combined with near_by.country/near_by.city/near_by.zip_code, or with the legacy latitude/longitude/distance parameters.
double
≥ 0
  • Distance is measured in meters.
  • Requires either a near_by.country + near_by.city/near_by.zip_code group, or a near_by.latitude/near_by.longitude pair, to also be present.
  • If no distance is provided, the default distance configured in Industries-settings will be used.
  • Cannot be combined with the legacy latitude/longitude/distance parameters.
string
length between 0 and 150

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.

string
length between 0 and 150

The external id of the service. Accepts multiple external ids as a comma-separated list. Locations
associated with any of the given external ids are returned. This filter is combined with
OR with the service_id parameter and with AND with every other

filter. Matching is case-sensitive. Unknown external ids are ignored. When no service matches and
service_id is not given, the response is 200 with an empty page, not 404.

string
length between 0 and 9999

The name of the service provided by location

string
length between 0 and 9999

The type of the service provided by location

string
length between 0 and 150

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.

string
length between 0 and 150

The external id of the staff. Accepts multiple external ids as a comma-separated list. Locations
associated with any of the given external ids are returned. This filter is combined with
OR with the staff_id parameter and with AND with every other

filter. Matching is case-insensitive. Unknown external ids are ignored. When no staff matches and
staff_id is not given, the response is 200 with an empty page, not 404.

string
length between 0 and 9999

The name of the staff belongs to location

string
length between 0 and 9999

The specialty of the staff belongs to location

string
length between 0 and 9999

The visit type name of the staff belongs to location

string
length between 0 and 255

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

string
length between 1 and 1000

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.
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 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'.
  • fuzzy matches values that are similar to the given one.
    ?custom_field=visit_category fuzzy 'welness'
    also returns the locations 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.

integer
1 to 2147483647
Defaults to 15

The return services count for per location

string
length between 0 and 9999

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.

boolean
Defaults to true

Whether the service_name, staff_specialty, staff_name and location_name filters also match values that are similar to the term (for example "cardiologist" finds "Cardiology"), in addition to the values that contain it. Set it to false to only match values that contain the term.

number
0.4 to 1
Defaults to 0.6

How close a value must be to the term to be matched when fuzzy matching is on. Higher values are stricter. When omitted the service default is used (0.6).

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json