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 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
Servers
- https://{subdomain}.{domain}.com
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
Integer | No |
Filters the email notifications by ticket, comment, or notification id. Possible values:
|
per_page |
Integer | No |
The number of records to return per page |
sort |
String | No |
The field to sort the list. Possible values are "created_at", "updated_at" (ascending order) or "-created_at", "-updated_at" (descending order) |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.