GuidesAPI EndpointsKnowledge BaseSupportTalkdesk WebsiteMarketplaceDiscussions API Change LogOpenAPI Specification Download
API Endpoints
Home
  1. Public API
  2. Locations Directory

Get the paginated list of locations

get
https://api.talkdeskapp.com/locations-directory/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
string
length between 0 and 255

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.
  • 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.
  • 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.
  • Currently, these three parameters can only be used when the Feature Flag is enabled.
string
length between 0 and 150

The id of the service

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

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.

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

Responses

Updated 3 months ago

Did this page help you?
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

Updated 3 months ago

Did this page help you?