---
title: "List Email Notifications"
method: GET
path: "/api/v2/email_notifications"
tags: ["Email Notifications"]
---

# List Email Notifications

`GET /api/v2/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](/api-reference/introduction/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`

## Query parameters

- `page[before]` string
- `page[after]` string
- `page[size]` integer

## Response `200`

Success response

- EmailNotificationsResponse
  - `email_notifications` EmailNotificationObject[]
    - `comment_id` integer — The comment ID associated to this email notification
    - `created_at` string, date-time — When this email notification was created
    - `email_id` string — The email ID of this email notification
    - `message_id` string — The value of the Message-Id header of the email
    - `notification_id` integer — The notification id of this email notification
    - `recipients` RecipientObject[] — The list of recipients associated to this email notification
      - `delivery_status` object — Details about the delivery status
        - `code` string — The delivery status code (SMTP code and DSN code)
        - `id` integer — The delivery status id
        - `message` string — The delivery status description
        - `name` string — The delivery status type (key)
      - `email_address` string — The recipient's email address
      - `user_id` integer — The recipient's user id
    - `ticket_id` integer — The ticket ID associated to this email notification
    - `updated_at` string, date-time — When this email notification was last updated
    - `url` string — The API url of this email notification

## Changes

> 29 revisions in range; 1 not diffed.

- **2025-06-12** `0402f9bb2a5c` — 3 info
  - added the new optional `query` request parameter `page[after]`
  - added the new optional `query` request parameter `page[before]`
  - added the new optional `query` request parameter `page[size]`

[Change history](https://skmtc.dev/botbrains-io/apis/support-api/changes/api/v2/email_notifications/get.md)

---

[API](https://skmtc.dev/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.dev/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/botbrains-io/support-api/revisions/d53eac07ba68/schema)