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
Query parameters
A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.
A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.
Specifies how many records should be returned in the response. You can specify up to 100 records per page.
Response
Success response