---
updatedAt: 2026-04-24T14:37:02.000Z
agentTools:
  projectIndex: https://docs.talkdesk.com/llms.txt
---

# Get the paginated list of services

Get the paginated list of services for agent view

## Scope

`locations-directory:read`

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "title": "Public API",
    "version": "5.12.71",
    "description": "Documents public API endpoints. Scopes are given to external software, that we don't control",
    "contact": {
      "name": "Talkdesk",
      "url": "https://talkdesk.com"
    }
  },
  "servers": [
    {
      "url": "https://api.talkdeskapp.com",
      "description": "United States (td-us-1)"
    },
    {
      "url": "https://api.talkdeskapp.eu",
      "description": "Europe (td-eu-1)"
    },
    {
      "url": "https://api.talkdeskappca.com",
      "description": "Canada (td-ca-1)"
    },
    {
      "url": "https://api.talkdeskapp.co.uk",
      "description": "United Kingdom (td-uk-1)"
    }
  ],
  "tags": [
    {
      "name": "Locations Directory",
      "description": "API responsible to manage Location data for industry related products (ex. store locations)"
    }
  ],
  "paths": {
    "/locations-directory/services-agent": {
      "get": {
        "operationId": "getServicesAgent",
        "tags": [
          "Locations Directory"
        ],
        "summary": "Get the paginated list of services",
        "description": "Get the paginated list of services for agent view",
        "security": [
          {
            "GA": [
              "locations-directory:read"
            ]
          }
        ],
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "example": 1,
              "minimum": 1,
              "default": 1
            }
          },
          {
            "name": "per_page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "example": 5,
              "minimum": 1,
              "maximum": 50,
              "default": 50
            }
          },
          {
            "name": "service_name",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "example": "Shopping",
              "description": "The name of the service",
              "default": "",
              "minLength": 0,
              "maxLength": 150
            }
          },
          {
            "name": "service_types",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "example": "Store",
              "description": "The list of service types, multiple values should split by ',' , like type1,type2",
              "default": "",
              "minLength": 1
            }
          },
          {
            "name": "service_durations",
            "in": "query",
            "required": false,
            "example": "service duration",
            "description": "The list of service durations, multiple values should split by ',' , like duration1,duration2",
            "schema": {
              "type": "string",
              "default": "",
              "minLength": 1
            }
          },
          {
            "name": "specialities",
            "in": "query",
            "required": false,
            "description": "The list of staff speciality, multiple values should split by ',' , like speciality1,speciality2",
            "schema": {
              "type": "string",
              "minLength": 1,
              "example": "IT support"
            }
          },
          {
            "name": "service_names",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "example": "serviceName",
              "description": "The name list of the service, multiple values should split by ',' , like serviceName1,serviceName2",
              "minLength": 1
            }
          },
          {
            "name": "service_ids",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "example": "serviceId",
              "description": "The id list of the service, multiple values should split by ',' , like serviceId1,serviceId2",
              "minLength": 1
            }
          },
          {
            "name": "languages",
            "in": "query",
            "required": false,
            "description": "The list of staff language, multiple values should split by ',' , like English,Chinese",
            "schema": {
              "type": "string",
              "minLength": 1,
              "example": "English"
            }
          },
          {
            "name": "genders",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "example": "Female",
              "description": "The list of staff genders, multiple values should split by ',' , like Male,Female",
              "default": "",
              "minLength": 1
            }
          },
          {
            "name": "location_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "example": "id",
              "description": "The id of the location",
              "default": "",
              "minLength": 0,
              "maxLength": 150
            }
          },
          {
            "name": "visit_type",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "example": "type name",
              "description": "The visit type name of the staff who can provide the service",
              "default": "",
              "minLength": 0,
              "maxLength": 9999
            }
          },
          {
            "name": "tag_values",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "example": "tag",
              "description": "The list of tag values, multiple values should split by ',' , like tag1,tag2",
              "default": "",
              "minLength": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The paginated list of services",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "description": "Represents a paginated list of services",
                  "required": [
                    "count",
                    "total",
                    "total_pages",
                    "page",
                    "per_page",
                    "_embedded",
                    "_links"
                  ],
                  "properties": {
                    "count": {
                      "type": "integer",
                      "format": "int32",
                      "description": "The number of results in the current page",
                      "example": 40
                    },
                    "total": {
                      "type": "integer",
                      "format": "int32",
                      "description": "The total of results",
                      "example": 90
                    },
                    "page": {
                      "type": "integer",
                      "format": "int32",
                      "description": "The current page",
                      "example": 2
                    },
                    "per_page": {
                      "type": "integer",
                      "format": "int32",
                      "description": "The number of results per page",
                      "example": 50
                    },
                    "total_pages": {
                      "type": "integer",
                      "format": "int32",
                      "description": "The total number of result pages",
                      "example": 2
                    },
                    "_embedded": {
                      "type": "object",
                      "required": [
                        "services"
                      ],
                      "properties": {
                        "services": {
                          "type": "array",
                          "description": "The list of services in the current page",
                          "items": {
                            "type": "object",
                            "required": [
                              "id",
                              "service_name",
                              "description"
                            ],
                            "properties": {
                              "id": {
                                "type": "string",
                                "description": "The id of service",
                                "example": "a78d05cc-ac7a-11ed-afa1-0242ac120012"
                              },
                              "external_id": {
                                "type": "string",
                                "description": "The external id of the service",
                                "minLength": 1,
                                "example": 123
                              },
                              "service_name": {
                                "type": "string",
                                "description": "The name of service",
                                "example": "Shopping"
                              },
                              "service_type": {
                                "type": "string",
                                "description": "The type of service",
                                "example": "Online"
                              },
                              "duration": {
                                "type": "string",
                                "description": "The duration of service",
                                "example": "30-45 minutes"
                              },
                              "description": {
                                "type": "string",
                                "description": "The note content",
                                "example": "Shopping on Internet is amusing"
                              },
                              "virtual_location_url": {
                                "type": "string",
                                "description": "The note content",
                                "example": "https://www.talkdesk.com/customers/"
                              },
                              "price": {
                                "type": "string",
                                "description": "The price of service",
                                "example": "3$"
                              },
                              "open_hours": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "required": [
                                    "day_of_week",
                                    "slots"
                                  ],
                                  "properties": {
                                    "day_of_week": {
                                      "type": "string",
                                      "description": "The day of the week to which the open hours refer to",
                                      "minLength": 1,
                                      "enum": [
                                        "MONDAY",
                                        "TUESDAY",
                                        "WEDNESDAY",
                                        "THURSDAY",
                                        "FRIDAY",
                                        "SATURDAY",
                                        "SUNDAY"
                                      ],
                                      "example": "TUESDAY"
                                    },
                                    "slots": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "required": [
                                          "open_at",
                                          "close_at"
                                        ],
                                        "properties": {
                                          "open_at": {
                                            "type": "string",
                                            "description": "The hour at which the location opens, in the location's time zone. Formatted according to the ISO-8601 standard.",
                                            "minLength": 1,
                                            "pattern": "^\\d\\d\\:\\d\\d\\:\\d\\d$",
                                            "example": "09:00:00"
                                          },
                                          "close_at": {
                                            "type": "string",
                                            "description": "The hour at which the location closes, in the location's time zone. Formatted according to the ISO-8601 standard.",
                                            "minLength": 1,
                                            "pattern": "^\\d\\d\\:\\d\\d\\:\\d\\d$",
                                            "example": "18:00:00"
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              },
                              "special_dates": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "required": [
                                    "name",
                                    "date",
                                    "repeats"
                                  ],
                                  "properties": {
                                    "name": {
                                      "type": "string",
                                      "description": "short name of the special date.",
                                      "example": "Labor Day",
                                      "minLength": 1
                                    },
                                    "date": {
                                      "type": "string",
                                      "description": "iso local date where the special should considered. Defined by RFC 3339, section 5.6.",
                                      "format": "date",
                                      "example": "1889-05-01",
                                      "minLength": 1
                                    },
                                    "repeats": {
                                      "type": "string",
                                      "description": "recurrence of the special date.",
                                      "minLength": 1,
                                      "enum": [
                                        "DOES_NOT_REPEATS",
                                        "MONTHLY",
                                        "YEARLY"
                                      ],
                                      "example": "YEARLY"
                                    },
                                    "notes": {
                                      "type": "string",
                                      "minLength": 1,
                                      "maxLength": 9999,
                                      "description": "special date notes.",
                                      "example": "1st of may, Workers day"
                                    },
                                    "slots": {
                                      "type": "array",
                                      "items": {
                                        "type": "object",
                                        "required": [
                                          "open_at",
                                          "close_at"
                                        ],
                                        "properties": {
                                          "open_at": {
                                            "type": "string",
                                            "description": "The hour at which the location opens, in the location's time zone. Formatted according to the ISO-8601 standard.",
                                            "minLength": 1,
                                            "pattern": "^\\d\\d\\:\\d\\d\\:\\d\\d$",
                                            "example": "09:00:00"
                                          },
                                          "close_at": {
                                            "type": "string",
                                            "description": "The hour at which the location closes, in the location's time zone. Formatted according to the ISO-8601 standard.",
                                            "minLength": 1,
                                            "pattern": "^\\d\\d\\:\\d\\d\\:\\d\\d$",
                                            "example": "18:00:00"
                                          }
                                        }
                                      }
                                    }
                                  }
                                }
                              },
                              "time_zone": {
                                "type": "string",
                                "description": "The time zone of the service, according to IANA.",
                                "minLength": 1,
                                "example": "Europe/Lisbon"
                              },
                              "phone_numbers": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "description": "Represents the phone numbers of a location",
                                  "required": [
                                    "phone_number"
                                  ],
                                  "properties": {
                                    "phone_number": {
                                      "type": "string",
                                      "description": "The phone number of one person.",
                                      "example": "+351123456789",
                                      "minLength": 1
                                    },
                                    "name": {
                                      "type": "string",
                                      "description": "The phone number name",
                                      "example": "Home",
                                      "minLength": 1
                                    }
                                  }
                                }
                              },
                              "locations": {
                                "description": "The location list of the service",
                                "items": {
                                  "type": "object",
                                  "required": [
                                    "id",
                                    "location_name"
                                  ],
                                  "properties": {
                                    "id": {
                                      "type": "string",
                                      "example": "000000000000000000000001"
                                    },
                                    "location_name": {
                                      "type": "string",
                                      "example": "location name"
                                    }
                                  }
                                }
                              },
                              "created_at": {
                                "type": "string",
                                "example": "2024-06-10T10:00:00Z"
                              },
                              "updated_at": {
                                "type": "string",
                                "example": "2024-06-10T10:00:00Z"
                              }
                            }
                          }
                        }
                      }
                    },
                    "_links": {
                      "type": "object",
                      "required": [
                        "self"
                      ],
                      "properties": {
                        "self": {
                          "type": "object",
                          "required": [
                            "href"
                          ],
                          "properties": {
                            "href": {
                              "type": "string",
                              "format": "uri",
                              "example": "http://api-docs.talkdesk.org/locations-directory/services-agent?page=1&per_page=10"
                            }
                          }
                        },
                        "next": {
                          "type": "object",
                          "required": [
                            "href"
                          ],
                          "properties": {
                            "href": {
                              "type": "string",
                              "format": "uri",
                              "example": "http://api-docs.talkdesk.org/locations-directory/services-agent?page=2&per_page=10"
                            }
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "_embedded": {
                    "services": [
                      {
                        "id": "a78d05cc-ac7a-11ed-afa1-0242ac120012",
                        "service_name": "Shopping",
                        "service_type": "Online",
                        "external_id": "1",
                        "duration": "30-45 minutes",
                        "description": "Shopping on Internet is amusing",
                        "virtual_location_url": "https://www.talkdesk.com/customers/",
                        "locations": [
                          {
                            "id": "000000000000000000000001",
                            "location_name": "Store Avenida da Liberdade"
                          },
                          {
                            "id": "000000000000000000000002",
                            "location_name": "Store Avenida dos Aliados"
                          }
                        ],
                        "price": "3$",
                        "phone_numbers": [
                          {
                            "phone_number": "+351123456789",
                            "name": "Home"
                          },
                          {
                            "phone_number": "+351123456780",
                            "name": "Personal"
                          }
                        ],
                        "time_zone": "Europe/Lisbon",
                        "open_hours": [
                          {
                            "day_of_week": "SUNDAY",
                            "slots": []
                          },
                          {
                            "day_of_week": "MONDAY",
                            "slots": [
                              {
                                "open_at": "09:00:00",
                                "close_at": "12:00:00"
                              },
                              {
                                "open_at": "14:00:00",
                                "close_at": "18:00:00"
                              }
                            ]
                          },
                          {
                            "day_of_week": "TUESDAY",
                            "slots": [
                              {
                                "open_at": "09:00:00",
                                "close_at": "12:00:00"
                              },
                              {
                                "open_at": "14:00:00",
                                "close_at": "18:00:00"
                              }
                            ]
                          },
                          {
                            "day_of_week": "WEDNESDAY",
                            "slots": [
                              {
                                "open_at": "09:00:00",
                                "close_at": "12:00:00"
                              },
                              {
                                "open_at": "14:00:00",
                                "close_at": "18:00:00"
                              }
                            ]
                          },
                          {
                            "day_of_week": "THURSDAY",
                            "slots": [
                              {
                                "open_at": "09:00:00",
                                "close_at": "12:00:00"
                              },
                              {
                                "open_at": "14:00:00",
                                "close_at": "18:00:00"
                              }
                            ]
                          },
                          {
                            "day_of_week": "FRIDAY",
                            "slots": [
                              {
                                "open_at": "09:00:00",
                                "close_at": "12:00:00"
                              },
                              {
                                "open_at": "14:00:00",
                                "close_at": "18:00:00"
                              }
                            ]
                          },
                          {
                            "day_of_week": "SATURDAY",
                            "slots": [
                              {
                                "open_at": "09:00:00",
                                "close_at": "13:00:00"
                              }
                            ]
                          }
                        ],
                        "special_dates": [
                          {
                            "name": "1 de may",
                            "date": "1981-05-01",
                            "repeats": "YEARLY",
                            "notes": "note of 1 of may",
                            "slots": [
                              {
                                "open_at": "09:00:00",
                                "close_at": "23:59:00"
                              }
                            ]
                          }
                        ],
                        "created_at": "2024-06-10T10:00:00.000Z",
                        "updated_at": "2024-06-10T10:00:00.000Z"
                      },
                      {
                        "id": "b98d05cc-ac7a-11ed-afa1-0242ac120025",
                        "service_name": "Shopping",
                        "service_type": "Offline",
                        "external_id": "2",
                        "duration": "30-60 minutes",
                        "description": "Shopping on Internet is amusing",
                        "virtual_location_url": "https://www.talkdesk.com/customers/",
                        "locations": [
                          {
                            "id": "000000000000000000000001",
                            "location_name": "Store Avenida da Liberdade"
                          },
                          {
                            "id": "000000000000000000000002",
                            "location_name": "Store Avenida dos Aliados"
                          }
                        ],
                        "price": "3$",
                        "phone_numbers": [
                          {
                            "phone_number": "+351123456789",
                            "name": "Home"
                          },
                          {
                            "phone_number": "+351123456780",
                            "name": "Personal"
                          }
                        ],
                        "time_zone": "Europe/Lisbon",
                        "open_hours": [
                          {
                            "day_of_week": "SUNDAY",
                            "slots": []
                          },
                          {
                            "day_of_week": "MONDAY",
                            "slots": [
                              {
                                "open_at": "09:00:00",
                                "close_at": "12:00:00"
                              },
                              {
                                "open_at": "14:00:00",
                                "close_at": "18:00:00"
                              }
                            ]
                          },
                          {
                            "day_of_week": "TUESDAY",
                            "slots": [
                              {
                                "open_at": "09:00:00",
                                "close_at": "12:00:00"
                              },
                              {
                                "open_at": "14:00:00",
                                "close_at": "18:00:00"
                              }
                            ]
                          },
                          {
                            "day_of_week": "WEDNESDAY",
                            "slots": [
                              {
                                "open_at": "09:00:00",
                                "close_at": "12:00:00"
                              },
                              {
                                "open_at": "14:00:00",
                                "close_at": "18:00:00"
                              }
                            ]
                          },
                          {
                            "day_of_week": "THURSDAY",
                            "slots": [
                              {
                                "open_at": "09:00:00",
                                "close_at": "12:00:00"
                              },
                              {
                                "open_at": "14:00:00",
                                "close_at": "18:00:00"
                              }
                            ]
                          },
                          {
                            "day_of_week": "FRIDAY",
                            "slots": [
                              {
                                "open_at": "09:00:00",
                                "close_at": "12:00:00"
                              },
                              {
                                "open_at": "14:00:00",
                                "close_at": "18:00:00"
                              }
                            ]
                          },
                          {
                            "day_of_week": "SATURDAY",
                            "slots": [
                              {
                                "open_at": "09:00:00",
                                "close_at": "13:00:00"
                              }
                            ]
                          }
                        ],
                        "special_dates": [
                          {
                            "name": "1 de may",
                            "date": "1981-05-01",
                            "repeats": "YEARLY",
                            "notes": "note of 1 of may",
                            "slots": [
                              {
                                "open_at": "09:00:00",
                                "close_at": "23:59:00"
                              }
                            ]
                          }
                        ],
                        "created_at": "2024-06-10T10:00:00.000Z",
                        "updated_at": "2024-06-10T10:00:00.000Z"
                      }
                    ]
                  },
                  "_links": {
                    "self": {
                      "href": "http://api-docs.talkdesk.org/locations-directory/services-agent?page=1&per_page=2"
                    },
                    "next": {
                      "href": "http://api-docs.talkdesk.org/locations-directory/services-agent?page=2&per_page=2"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "code",
                    "message"
                  ],
                  "properties": {
                    "code": {
                      "type": "string"
                    },
                    "message": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "fields": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "name",
                          "description"
                        ],
                        "properties": {
                          "name": {
                            "type": "string"
                          },
                          "description": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "code": "4034000",
                  "message": "Bad request."
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "GA": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://{account_name}.talkdeskid.com/oauth/authorize",
            "tokenUrl": "https://{account_name}.talkdeskid.com/oauth/token",
            "scopes": {
              "account:read": "Show account details",
              "apps:read": "Get details about app installations for an account",
              "apps:write": "Update an app installation state programatically",
              "attributes:read": "List attributes or attribute categories for an account and get details for a specific attribute",
              "attributes:write": "Create, update and remove attributes or attributes categories for an account",
              "bulk-imports:read": "Get list of imports and export errors into CSV file",
              "bulk-imports:write": "Create and update import data",
              "messages:write": "Ability to send messages from the API",
              "callback:write": "Request a new direct callback",
              "contacts-integrations:read": "Get details for contacts' integrations",
              "contacts:read": "Get details for contact(s)",
              "contacts:write": "Create, update or delete contacts",
              "contact-gdpr:write": "GDPR Contacts",
              "continuity-settings:read": "Read business continuity settings",
              "continuity-settings:write": "Change business continuity settings",
              "continuity-settings-activation:read": "Read information on activation of the continuity settings",
              "continuity-settings-activation:write": "Edit information on activation of the continuity settings",
              "data-reports:read": "Download previously generated data reports",
              "data-reports:write": "Create new data reports",
              "data-tables:read": "Fetch and list data tables",
              "data-tables:write": "Create and update data tables",
              "data-tables-exports:read": "List and download data table exports",
              "data-tables-exports:write": "Create and cancel data table exports",
              "events:read": "Get details from received events",
              "express-provisioning:read": "Express-provisioning validate if account exists",
              "express-provisioning:write": "Provisioning of an account",
              "express-accounts-usage:read": "Read usage information for an account",
              "express-accounts:read": "Read account information",
              "express-accounts-contracts:read": "Get contract info for express accounts",
              "express-accounts-contracts-actions:write": "Create contract actions for express accounts",
              "express-accounts-contracts-actions:read": "Read contract actions of express accounts",
              "express-products:read": "Read product information",
              "express-accounts-subscriptions:read": "Read subscription information for an account",
              "express-accounts-invoices:read": "Read invoice information for an account",
              "erc-ecommerce-shopify-webhooks-handler-credentials:write": "Create or update Shopify webhook handler credentials",
              "erc-ecommerce-shopify-webhooks-handler-credentials:read": "Read Shopify webhook handler credentials",
              "flows-interactions:start": "Starts an interaction associated with a flow",
              "flows-platform:submit": "Trigger an automation flow associated with an account",
              "fsi-accounts:read": "List of accounts associated with a contact",
              "fsi-contacts:write": "Update contact information",
              "fsi-contacts:read": "List and get contact details",
              "fsi-cards:read": "List of cards from a account",
              "fsi-cards:write": "Update the status for a card",
              "fsi-payments:read": "List of payments from a specific account",
              "fsi-transactions:read": "List of transactions for a specific account",
              "fsi-payoff:read": "Get the payoff for an FSI account",
              "fsi-transfers:write": "Create an FSI Transfer",
              "fsi-stop-payment:write": "Cancel a payment before it’s been processed",
              "fsi-travel-notification:write": "Create a new endpoint for Travel Notifications",
              "fsi-checks:read": "Search for a check",
              "fsi-set-ach-transfer:write": "FSI Set ACH Transfer",
              "fsi-unlock-account:write": "Unlock account for a banking customer",
              "fsi-decrypt:read": "The decryption based on AES algorithm",
              "fsi-write-back:write": "FSI Write Data Back",
              "fsi-spend-limit:read": "Daily limit for reading debit cards",
              "fsi-spend-limit:write": "Modify the daily limit of debit cards",
              "guardian-call-quality:read": "Read Guardian call quality data.",
              "guardian-sessions:read": "Read Sessions Guardian data.",
              "guardian-users:read": "Read Users Guardian data.",
              "guardian-cases:read": "Read Cases Guardian data.",
              "identity-activity:read": "Identity activity read access",
              "identity-email-validation:read": "Identity Email Validation read access",
              "identity-ip-validation:read": "Identity IP Validation read access",
              "identity-phone-validation:read": "Identity Phone Validation read access",
              "openid": "User info endpoint",
              "recordings:read": "Get recording files",
              "recordings:delete": "Delete recording files",
              "refresh_token": "Token refresh flow",
              "reports:read": "List previously generated reports and download them",
              "reports:write": "Create new reports or delete existing ones",
              "queues:read": "List CCAAS queues",
              "queues:write": "Create/update CCAAS queues details",
              "queues-users:read": "List users assigned to a CCAAS queue",
              "users:read": "List users for an account and get details for a specific user",
              "users:write": "Create, Update and Delete users",
              "interactions:control-recordings": "Control the recording status of an interaction",
              "fsi-workspace-contact-synchronization:write": "Synchronize Talkdesk contact with fsi member information",
              "voicebiometrics-enroll:write": "Update and delete Voice Biometrics enroll data",
              "voicebiometrics-consent:read": "VoiceBiometrics consent read access",
              "voicebiometrics-consent:write": "VoiceBiometrics consent write access",
              "live-queries:read": "Read and list queries from Live API",
              "live-subscriptions:read": "Read subscriptions from Live API",
              "live-subscriptions:write": "Create a new subscription for Live API",
              "wfm-aion-public:write": "Create, Update and Delete WFM Aion related data by an external client.",
              "wfm-request-management-public:write": "Create, Update and Delete WFM Request Management related data by an external client.",
              "wfm-request-management-public:read": "Read WFM Request Management related data by an external client.",
              "account-wallets:read": "Get information about account wallets",
              "bucket-configurations:read": "Get all bucket configurations",
              "cases-public:write": "Create,update and delete case data",
              "cases-public:read": "Read case",
              "case-notes-public:read": "Read case note data",
              "case-notes-public:write": "Create, edit, and delete case note data",
              "case-fields-public:read": "Read case field",
              "do-not-call-lists:manage": "Update a DNCL by adding or deleting a entry on a do not call list",
              "do-not-call-lists:read": "Read entries in a do not call list",
              "record-lists:manage": "Ability to view, add and update records of a Record List",
              "record-lists:write": "Create and update record lists for an account",
              "role-permissions:skip": "Skip role permissions validation",
              "campaigns:write": "Create, update and delete campaigns",
              "campaigns:read": "List and view available campaigns",
              "schedule-callbacks:read": "List schedule callbacks",
              "schedule-callbacks:write": "schedule a callbacks or reschedule a callbacks",
              "po-record-list-automations:write": "Custom record list automations for proactive outbound clients",
              "prompts:read": "Read prompts",
              "prompts:write": "Create a prompt",
              "prompts:delete": "Delete a prompt",
              "prompts:download": "Get prompt download link",
              "webhooks-trigger:write": "Create, update and delete a webhook trigger",
              "cfm-public:write": "Collect feedback data",
              "digital-connect:read": "List and Get digital-connect Resources",
              "digital-connect:write": "Create, Update and Delete digital-connect Resources",
              "entitymapper-contact-interactions:write": "Update interaction's contact mappings",
              "locations-directory:read": "Read locations information",
              "locations-directory:write": "Write/update locations information and custom fields",
              "locations-directory:support": "Create/Update/Delete locations-directory support features",
              "staffs-directory:read": "Read staffs information",
              "staffs-directory:write": "Write/update staffs information",
              "automated-notifications-management:read": "Read Automated Notifications related account information",
              "automated-notifications-management:write": "Write Automated Notifications related account information",
              "automated-notifications:read": "Read Automated Notifications event information",
              "automated-notifications:write": "Write Automated Notifications event information",
              "automated-notifications-bridge:write": "Write permissions for automated-notifications-bridge webhooks",
              "automated-notifications-subscriptions:read": "Read Automated Notifications subscriptions related to a topic/channel",
              "automated-notifications-subscriptions:write": "Write (subscribe/unsubscribe) Automated Notifications subscriptions related to a topic/channel",
              "entitymapper-map:write": "Write mappings with external entities",
              "entitymapper-contacts:read": "Search Talkdesk contact",
              "entitymapper-contacts:write": "Write Talkdesk contact",
              "appointment-scheduling-va:read": "Read appointment scheduling va entries",
              "hls-coverage:read": "Read healthcare & life sciences coverage information",
              "hls-balance:read": "Read healthcare & life sciences balance information",
              "hls-patient:read": "Read healthcare & life sciences patient information",
              "hls-providers:call-answered": "Write healthcare & life sciences call answered information",
              "hls-appointment:read": "Read healthcare & life sciences patient appointments",
              "hls-medication-order:read": "Read healthcare & life sciences patient medication orders",
              "hls-appointment:write": "Write healthcare & life sciences patient appointments",
              "hls-contact:write": "Write healthcare & life sciences data into talkdesk contact",
              "hls-provider:read": "Read healthcare & life sciences provider appointments",
              "hls-phone-action:write": "Write healthcare & life sciences phone action",
              "hls-click-to-call:write": "Write healthcare & life sciences click-to-call action",
              "hls-epic-outgoing-sms:write": "Trigger outgoing SMS from Epic",
              "hls-epic-agent-status-sync:write": "Trigger agent status sync from Epic",
              "hls-inbasket-message:write": "Send in-basket message to Epic",
              "hls-popup-intent:write": "Save intent of a patient",
              "hls-prescription:read": "Read healthcare & life sciences prescription information",
              "hls-prescription:write": "Write healthcare & life sciences prescription information",
              "hls-encounter:read": "Read healthcare & life sciences patient encounters",
              "hls-service-request:read": "Read healthcare & life sciences patient service requests",
              "hls-procedure:read": "Read healthcare & life sciences patient procedures",
              "hls-payers-connections:read": "Read healthcare & life sciences payers information",
              "hls-payers-connections:write": "Write healthcare & life sciences payers information",
              "hls-symptom-checker:write": "Symptom checker for patient",
              "hls-patient:write": "Write healthcare & life sciences patient information",
              "hls-epic:call-answered": "Write healthcare & life sciences call answered information",
              "hls-sycurio:integrate": "Integrate with Sycurio platform",
              "hls-patient-case:write": "Write healthcare & life sciences patient case information",
              "hls-outstanding-order:read": "Read healthcare & life sciences outstanding orders",
              "hls-medication-order:write": "Write healthcare & life sciences medication order(request)",
              "hls-medication-statement:write": "Write healthcare & life sciences medication statement",
              "hls-medication-statement:read": "Read healthcare & life sciences medication statement",
              "hls-hl7-events:write": "Write healthcare providers HL7 events",
              "erc-ecommerce-connections-orders:write": "Update e-commerce connections orders info",
              "erc-ecommerce-connections-customers:read": "Read e-commerce connections customers info",
              "erc-ecommerce-connections-customers:write": "Write e-commerce connections customers info",
              "erc-ecommerce-connections-orders:read": "Read e-commerce connections orders info",
              "erc-ecommerce-connections-products:read": "Read e-commerce connections products info",
              "erc-ecommerce-customers:read": "Read e-commerce customers info",
              "erc-ecommerce-customers:write": "Write e-commerce customers info",
              "erc-ecommerce-return-reasons:read": "Read e-commerce return reasons",
              "erc-ecommerce-return:read": "Read e-commerce return info",
              "erc-ecommerce-return:write": "Write e-commerce return info",
              "erc-ecommerce-cart:write": "Sync e-commerce cart items",
              "erc-ecommerce-products:read": "Search e-commerce catalog products",
              "erc-ecommerce-orders:read": "Show e-commerce integrations orders info",
              "erc-ecommerce-orders:write": "Update e-commerce integrations orders info",
              "erc-ecommerce-recall:write": "Write e-commerce recall contacts",
              "industries-settings-public:write": "Write industries settings",
              "industries-contexts:write": "Create, update, and delete context values",
              "fsi-insurance-connections-automated-notifications:write": "Write Automated Notifications event information",
              "fsi-insurance-connections-contacts:write": "Sync Talkdesk contacts",
              "fsi-insurance-connections-claims:read": "Read claims by id from FSI Insurance",
              "fsi-insurance-integrations-policies:read": "Read policies from FSI Insurance",
              "fsi-insurance-integrations-accounts:read": "Read accounts from FSI Insurance",
              "fsi-insurance-integrations-claims:write": "Write claims from FSI Insurance",
              "fsi-insurance-integrations-billing:read": "Read billing info from FSI Insurance",
              "fsi-insurance-integrations-claims:read": "Read claims from FSI Insurance",
              "fsi-insurance-integrations-contacts:write": "Update contact details from FSI Insurance",
              "fsi-insurance-integrations-send-docs:read": "Send document deliveries from FSI Insurance",
              "fsi-insurance-integrations-data-back:write": "Write contact event data back to FSI Insurance",
              "automated-notifications-interactions:read": "Read Automated Notifications related with interactions",
              "industries-scheduler-teams:read": "Read teams from industries-scheduler",
              "industries-scheduler-availabilities:read": "Get users availabilities by email",
              "industries-scheduler-appointment:write": "Create cancel event on specialist's calendar",
              "industries-scheduler-appointment:read": "Read appointments from industries-scheduler",
              "industries-messaging-service:write": "Write messages in industries-messaging-service",
              "interaction-custom-fields:write": "Allows to populate interaction custom fields",
              "user-session-public:end": "Terminate a user session",
              "industries-settings-public:read": "Read industries settings",
              "industries-contexts:read": "Read context values",
              "dialer-integrations-records:read": "Read dialer integrations campaign records",
              "scim": "Access SCIM-related routes",
              "hls-epic-my-chart-reset-password:write": "Trigger Epic MyChart password reset (Deprecated - use hls-patient-password-reset:write)",
              "hls-patient-password-reset:write": "Trigger patient password reset for healthcare portal",
              "locations-directory-bulk-operation:write": "Write locations directory data",
              "locations-directory-batch-operation:write": "Apply a batch of locations directory create/update/delete operations",
              "hls-patient-location:read": "Read loction patient data",
              "hls-patient-practice:read": "Read healthcare & life sciences patient practices",
              "hls-guarantor:read": "Read guarantor identifiers from providers",
              "hls-guarantor-billing:read": "Read guarantor billing summary from providers",
              "hls-guarantor-password-reset:write": "Trigger guarantor password reset for healthcare portal",
              "hls-patient-billing:read": "Read patient billing details from providers",
              "hls-interaction-overrides:write": "Write healthcare & life sciences interaction-specific configuration overrides",
              "industries-workflows:read": "Read industries workflow schedules and workflows",
              "industries-workflows:write": "Create, update, start, and delete industries workflow schedules and workflows",
              "digital-messaging-adapter:write": "Write or update Digital Messaging Adapter data"
            }
          }
        }
      }
    }
  },
  "externalDocs": {
    "description": "External Documentation",
    "url": "https://api-docs.talkdeskapp.com/external_docs"
  }
}
```