GuidesAPI EndpointsKnowledge BaseSupportTalkdesk WebsiteMarketplaceDiscussions API Change LogOpenAPI Specification Download
API Endpoints
Home

List Ring Groups

get deprecated
https://api.talkdeskapp.com/ring-groups

Returns a paginated list of ring groups for the account.
Use this endpoint to retrieve all ring groups and their details, for example to build a directory or to support ring group assignment workflows.
Results can be filtered by name and sorted by name in ascending or descending order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

ring-groups:read

Query Params
integer
Defaults to 1

Desired page. Defaults to 1.

integer
Defaults to 50

Limit the number of keys to display

string

Filter the results by ring group whose name partially match with the provided argument

string

The order_by parameter allows you to sort the retrieved interaction contacts.

Supported sort fields

  • name - Sort by ring group name

By default, the sort direction is ascending, i.e. :asc, however you can request to retrieve the results in
descending order by specifying :desc with the field.

If no order_by is not provided the ring groups come in an undefined order.

Examples

  • order_by=name:desc
Responses

Updated about 1 month ago

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 about 1 month ago