get https://api.talkdeskapp.com/live-subscriptions/
Scope
live-subscriptions:read
Body Response - Schema
200 (subscription information)
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | the subscription unique identifier | yes |
| _links | object | "_links" subdivides into: 1 - "stream" (object) - list of accounts. 1.1 - "href" (string) 2 - "self" (object) 2.1 - "href" (string) | no |
| entries | object | List of subscribed entries. "entries" subdivides into: 1 - "params" (object) - set of parameters for the queries. Each one may have a default value and, if applicable, a hard limit. If a parameter does not have a default, then it is mandatory. 2 - "metadata" (object) - metadata related with the use of the query on the customer's end. 3 - "query_id" (string) - query unique identifier. 4 - "id" (string) - subscription query unique identifier. Required. 5 - "filters" (object) - set of filters for the query. 6 - "_links" (object) 6.1 - "self" (object) 6.1.1 - "href" (string) 6.2 - "query" (object) 6.2.1 - "href" (string) | no |
400 (bad request), 401 (unauthorized access), 403 (forbidden access), 404 (subscription not found), 415 (unsupported media type)
| 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.