Sign in

v1

latestOpenAPI 3.0.22026-07-2441902.6 MB
Locations Directory

Get the paginated list of specialties

Get the paginated list of specialties

get/locations-directory/staffs/specialities-services-locations

Query parameters

pageinteger
Example:1
per_pageinteger
Example:5
zip_codestring

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

Example:1250-142
citystring

The city of the location which can provide the service

Example:Lisbon
country_namestring

The country name of location which can provide the service

Example:Portugal
region_namestring

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

Example:Lisbon
specialitystring

The specialty of the staff who can provide the service

Example:cardiology
location_namestring

The name of the location which can provide the service

Example:South Lyon
location_typestring

The type of the location which can provide the service

Example:Store
location_idstring

The external ID of the location

Example:loc-ext-id-1
staff_idstring

The external ID of the staff member

Example:staff-ext-id-1
staff_namestring

The name of the staff member

Example:Jane Smith
staff_visit_typestring

The visit type name of the staff member

Example:in-person
latitudenumber double
<ul> <li>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.</li> <li>Currently, these three parameters can only be used when the Feature Flag is enabled.</li> </ul>
Example:38.698943
longitudenumber double
<ul> <li>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.</li> <li>Currently, these three parameters can only be used when the Feature Flag is enabled.</li> </ul>
Example:-9.18423
distancenumber double
<ul> <li>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.</li> <li>Distance is measured in meters.</li> <li>If no distance is provided, the default distance configured in Industries-settings will be used.</li> <li>Currently, these three parameters can only be used when the Feature Flag is enabled.</li> </ul>
Example:10000

Response

The paginated list of services

countinteger required

The number of results in the current page

totalinteger required

The total of results

pageinteger required

The current page

per_pageinteger required

The number of results per page

total_pagesinteger required

The total number of result pages

Example response

{
  "count": 40,
  "total": 90,
  "page": 2,
  "per_page": 50,
  "total_pages": 2,
  "_embedded": {
    "specialities": [
      {
        "id": "1735627055-45272",
        "speciality": "Shopping",
        "service_name": "shopping service",
        "service_id": "5d9162f6-5c09-4817-afcf-b94752467e52",
        "location_id": "6f2e1b2a-4373-477d-ad74-6d38034fa61d",
        "location_name": "Store XYZ",
        "staff_name": "Test-Staff",
        "staff_id": "ceb3aa83-1f1e-4952-9507-7f5bed037e32",
        "created_by": "zhangjunli",
        "created_at": "2024-12-31T04:32:14.241400Z",
        "updated_by": "zhangjunli",
        "updated_at": "2024-12-31T04:32:14.257507Z"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://api-docs.talkdesk.org/locations-directory/staffs/specialities-services-locations?page=1&per_page=10"
    },
    "next": {
      "href": "http://api-docs.talkdesk.org/locations-directory/staffs/specialities-services-locations?page=2&per_page=10"
    }
  }
}