TAtalkdesk
Locations Directory

Get the paginated list of services

Get the paginated list of services for agent view

get/locations-directory/services-agent

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/locations-directory/services-agent
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: locations-directory:read

Query parameters

pageinteger
Example:1
per_pageinteger
Example:5
service_namestring

The name of the service

Example:Shopping
service_typesstring

The list of service types, multiple values should split by ',' , like type1,type2

Example:Store
service_durationsstring

The list of service durations, multiple values should split by ',' , like duration1,duration2

specialitiesstring
Example:IT support

The list of staff speciality, multiple values should split by ',' , like speciality1,speciality2

service_namesstring

The name list of the service, multiple values should split by ',' , like serviceName1,serviceName2

Example:serviceName
service_idsstring

The id list of the service, multiple values should split by ',' , like serviceId1,serviceId2

Example:serviceId
languagesstring
Example:English

The list of staff language, multiple values should split by ',' , like English,Chinese

gendersstring

The list of staff genders, multiple values should split by ',' , like Male,Female

Example:Female
location_idstring required

The id of the location

Example:id
visit_typestring

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

Example:type name
tag_valuesstring

The list of tag values, multiple values should split by ',' , like tag1,tag2

Example:tag

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": {
    "services": [
      {
        "id": "a78d05cc-ac7a-11ed-afa1-0242ac120012",
        "service_name": "Shopping",
        "service_type": "Online",
        "duration": "30-45 minutes",
        "description": "Shopping on Internet is amusing",
        "virtual_location_url": "https://www.talkdesk.com/customers/",
        "price": "3$",
        "open_hours": [
          {
            "day_of_week": "TUESDAY",
            "slots": [
              {
                "open_at": "09:00:00",
                "close_at": "18:00:00"
              }
            ]
          }
        ],
        "special_dates": [
          {
            "name": "Labor Day",
            "date": "1889-05-01",
            "repeats": "YEARLY",
            "notes": "1st of may, Workers day",
            "slots": [
              {
                "open_at": "09:00:00",
                "close_at": "18:00:00"
              }
            ]
          }
        ],
        "time_zone": "Europe/Lisbon",
        "phone_numbers": [
          {
            "phone_number": "+351123456789",
            "name": "Home"
          }
        ],
        "locations": [
          {
            "id": "000000000000000000000001",
            "location_name": "location name"
          }
        ],
        "created_at": "2024-06-10T10:00:00Z",
        "updated_at": "2024-06-10T10:00:00Z"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://api-docs.talkdesk.org/locations-directory/services-agent?page=1&per_page=10"
    },
    "next": {
      "href": "http://api-docs.talkdesk.org/locations-directory/services-agent?page=2&per_page=10"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.