get https://api.talkdeskapp.com/ring-groups//users
Scope
user-ring-groups:read
Body Response - Schema
200 (list of users assigned to ring group)
| Parameter | Type | Description |
|---|---|---|
| total | integer | n/a |
| page | integer | n/a |
| per_page | integer | n/a |
| count | integer | n/a |
| ring_group | string | n/a |
| _embedded | object | A subset of the list of users for the ring group. "_embedded" subdivides into: 1 - "users" (array[object]), which subdivides into: 1.1 - "id" (string) - the ID of the user (required) 1.2 - "_links" (object) - the defined links (required) |
| _links | object | HAL API related links. "_links" subdivides into: 1 - "self" (object), which subdivides into: 1.1 - "href" (string) 2 - "next" (object), which subdivides into: 2.1 - "href" (string) 3 - "previous" (object), which subdivides into: 3.1 - "href" (string) 4 - "page" (object), which subdivides into: 4.1 - "templated" (boolean) 4.2 - "href" (string) |
401 (the request does not contain one of the mandatory headers), 403 (the user is authenticated but does not have sufficient permissions to perform the action), 404 (not found)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.