Sign in
Email Notifications

List Email Notifications

Allowed For

  • Agents

Filters

  • By notification: api/v2/email_notifications.json?filter[notification_id]=7824075373693
  • By comment: api/v2/email_notifications.json?filter[comment_id]=7824075373565
  • By ticket: api/v2/email_notifications.json?filter[ticket_id]=623

Pagination

By default, a maximum of 100 email notifications are included per page. Use cursor-based pagination parameters (page[after] and page[before]) to navigate the records (can't be used together in the same request). See Pagination for more details.

  • Limit items per-page: api/v2/email_notifications.json?page[size]=25
  • Retrieve next page: api/v2/email_notifications.json?page[size]=25&page[after]=xxx
  • Retrieve previous page: api/v2/email_notifications.json?page[size]=25&page[before]=yyy

The values xxx and yyy are placeholder values that represent cursors.

Sorting

By default, email notifications are sorted by creation time (newest first). The query parameter is not supported for this endpoint.

  • By creation time (oldest first): api/v2/email_notifications.json?sort=created_at
  • By creation time (newest first): api/v2/email_notifications.json?sort=-created_at
  • By modification time (recently updated first): api/v2/email_notifications.json?sort=updated_at
  • By modification time (recently updated last): api/v2/email_notifications.json?sort=-updated_at
get/api/v2/email_notifications

Response

Success response

Example response

{
  "email_notifications": [
    {
      "comment_id": 7824075373565,
      "created_at": "2024-02-21T23:13:07Z",
      "email_id": "01HQ6Z3DE28F34XBFCYH0SRM95",
      "message_id": "<56Z97D7G67G_65d68382aa493_4639581606f3@example.com>",
      "notification_id": 7824075373693,
      "recipients": [
        {
          "delivery_status": {
            "code": "530 5.7.0",
            "id": 24,
            "message": "Email failed to deliver. Status code: 530",
            "name": "authentication_required"
          },
          "email_address": "recipient@example.com",
          "user_id": 7612709251581
        }
      ],
      "ticket_id": 623,
      "updated_at": "2024-02-21T23:13:07Z",
      "url": "https://example.zendesk.com/api/v2/email_notifications/7824075373693.json"
    }
  ]
}

Changes