Sign in
latestOpenAPI 3.1.02026-08-085123123.9 KB

bf0b51ee8e8a

Mailings

Retrieve scheduled mailings

Retrieve a paginated list of all scheduled mailings.

get/mailings/scheduled

Query parameters

idGroupinteger

Filter to only show mailings scheduled to be sent to the specified group ID

pageinteger

The page of results to view

limitinteger

The number of results per page (max 10 000)

sort'language_asc' | 'language_desc' | 'subject_asc' | 'subject_desc' | 'recipients_asc' | 'recipients_desc' | 'date_asc' | 'date_desc'

Sort order for results

Response

Paginated list of scheduled mailings

totalCountinteger
pageinteger
limitinteger
sortstring

Example response

{
  "mailings": [
    {
      "id": 2470,
      "subject": "Test de l'API",
      "language": "fr_ca",
      "scheduledOn": "2020-10-31 08:20:00.000",
      "recipientsCount": 9,
      "mailFrom": "admin@example.org"
    }
  ],
  "totalCount": 28,
  "page": 1,
  "limit": 2
}