Get the paginated list of services

Get the paginated list of services

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
string
length between 0 and 150

The name of the service

string
length between 0 and 150

The type of the service

string
length between 0 and 150

The name of the location

string
length between 0 and 150

The type of the location

string
length between 0 and 20

The zip-code of the location which can provide the service

string
length between 0 and 100

The city of the location which can provide the service

string
length between 0 and 100

The country name of location which can provide the service

string
length between 0 and 100

The region name (country subdivision) of location which can provide the service

string
length between 0 and 150

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

string
length between 0 and 150

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

string
length between 0 and 9999

The name of the staff who can provide the service

string
length between 0 and 9999

The specialty of the staff who can provide the service

string
length between 0 and 9999

The visit type name of the staff who can provide the service

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 services 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 services 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
  • Latitude and longitude are used together with distance. The search parameters include latitude and longitude to retrieve a list of all services within a certain radius.
  • 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 services 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 services 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.
integer
1 to 2147483647
Defaults to 15

The return locations count for per service

string
length between 1 and 1000

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

  • 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'.

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.

Responses

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