Get the paginated list of services

get

https://api.talkdeskapp.com/locations-directory/services

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

locations-directory:read

Query Params

page

integer

≥ 1

Defaults to 1

per_page

integer

1 to 50

Defaults to 50

service_name

string

length between 0 and 150

The name of the service

service_type

string

length between 0 and 150

The type of the service

location_name

string

length between 0 and 150

The name of the location

location_type

string

length between 0 and 150

The type of the location

zip_code

string

length between 0 and 20

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

city

string

length between 0 and 100

The city of the location which can provide the service

country_name

string

length between 0 and 100

The country name of location which can provide the service

region_name

string

length between 0 and 100

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

location_id

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.

staff_id

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.

staff_name

string

length between 0 and 9999

The name of the staff who can provide the service

staff_specialty

string

length between 0 and 9999

The specialty of the staff who can provide the service

staff_visit_type

string

length between 0 and 9999

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

latitude

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.

longitude

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.

distance

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.

limit

integer

1 to 2147483647

Defaults to 15

The return locations count for per service

custom_field

string

length between 1 and 255

Filters services 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 services 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 services 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 services whose visit_category is wellness or acute_sick, and that also have parking.

Omitting the parameter leaves the results unfiltered.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Scope

200The paginated list of services

400Bad Request