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

string
length between 0 and 150

The id of the staff

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.
  • 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.
  • 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.
  • Currently, these three parameters can only be used when the Feature Flag is enabled.
integer
1 to 2147483647
Defaults to 15

The return locations count for per service

boolean
Defaults to true

Whether the service_name, staff_specialty and staff_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