Notification Tasks

Get Notification Tasks Page

Lists the SMS and email notifications scheduled for the depot your API key belongs to, with their recipient, rendered message, scheduled send time and status. Use it to check what was queued by POST /notifications/schedule/orders or by your notification automations, and whether it has been sent.

Results are paged, most recently updated first. Use limit (up to 100) and follow the Link header for the next page (see Paging). Filters:

  • updated_at_min returns only tasks updated at or after the given time.
  • status matches the task status exactly, for example Scheduled or Cancelled.
  • type is SMS or EMAIL (case-insensitive). Any other value returns 400 INVALID_INPUT.

Each task links to the order or visit it was created for, and the other one is null. The template gives the id of the template that was used (see GET /notifications/templates).

get/notification-tasks

Request

  • Base URL: https://api.smartroutes.io/v2
  • URL: https://api.smartroutes.io/v2/notification-tasks
  • Auth: none declared

Query parameters

page_infostring

Pagination cursor generated by the API. Pass this value to retrieve the next page of results.

limitinteger

Maximum number of notification tasks to retrieve per page. Max 100.

updated_at_minstring date-time

Filter tasks modified at or after this datetime. Format: YYYY-MM-DD hh:mm:ss or YYYY-MM-DDTHH:mm:ss.SSSZ.

statusstring

Filter notification tasks by status.

type'SMS' | 'EMAIL'

Filter notification tasks by type. Accepted values: SMS, EMAIL (case-insensitive).

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.