GET/desk/api/v2/notifications.json

Get a paginated list of notifications.

The following values are allowed in the filter query parameter:

  • id
  • user
  • ticket
  • thread
  • threadUserCreator
  • threadCustomerCreator
  • conversation
  • conversationCustomerContact
  • kind
  • kinds
  • read
  • pinned
  • event
  • eventState
  • failures
  • deliveryStatus
  • deliveryFailureReason
  • openStatus
  • openFailureReason
  • createdAt
  • updatedAt
  • deletedAt
  • createdBy
  • updatedBy
  • deletedBy
  • state

The following values are allowed in the orderBy query parameter:

  • id
  • user
  • ticket
  • thread
  • threadUserCreator
  • threadCustomerCreator
  • conversation
  • conversationCustomerContact
  • kind
  • kinds
  • read
  • pinned
  • event
  • eventState
  • failures
  • deliveryStatus
  • deliveryFailureReason
  • openStatus
  • openFailureReason
  • createdAt
  • updatedAt
  • deletedAt
  • createdBy
  • updatedBy
  • deletedBy
  • state
  • tickets.state
  • tickets.id
  • threads.id
  • users.id
  • isRead
  • replyToken
  • kind
  • eventType

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.

Examples

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-04-23T13:33:02.895Z",