GET/desk/api/v2/notifications.json
Get a paginated list of notifications.
The following values are allowed in the filter query parameter:
- conversation
- conversationCustomerContact
- createdAt
- createdBy
- deletedAt
- deletedBy
- deliveryFailureReason
- deliveryStatus
- event
- eventState
- failures
- id
- kind
- kinds
- openFailureReason
- openStatus
- pinned
- read
- state
- thread
- threadCustomerCreator
- threadUserCreator
- ticket
- updatedAt
- updatedBy
- user
The following values are allowed in the orderBy query parameter:
-
conversation
-
conversationCustomerContact
-
createdAt
-
createdBy
-
deletedAt
-
deletedBy
-
deliveryFailureReason
-
deliveryStatus
-
event
-
eventState
-
eventType
-
failures
-
id
-
isRead
-
kind
-
kind
-
kinds
-
openFailureReason
-
openStatus
-
pinned
-
read
-
replyToken
-
state
-
thread
-
threadCustomerCreator
-
threadUserCreator
-
threads.id
-
ticket
-
tickets.id
-
tickets.state
-
updatedAt
-
updatedBy
-
user
-
users.id
The following values are allowed in the [includes](https://apidocs.teamwork.com/guides/desk/relationships-and-includes) query parameter: -
contacts
-
customers
-
ticketreviews
-
tickets
-
users
-
all
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
NotificationsAPIBody handles the listing response for notification.
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.
200 OK
NotificationsAPIBody
{ "included": { "addresses": [ { "city": "string", "country": "string", "firstLine": "string", "id": 0, "postalCode": "string", "secondLine": "string", "state": "string" } ], "agentsnotified": [ { "autoFollowOnCC": true, "avatarURL": "string", "createdAt": "2024-10-10T18:19:43.436Z",