latestOpenAPI 3.1.02026-08-085123123.9 KB

bf0b51ee8e8a

Mailings

Retrieve sent mailings

Retrieve a paginated list of all sent mailings. Note: This does not include any archived mailings.

get/mailings/sent

Query parameters

idGroupinteger

Filter to only show mailings 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 sent mailings

totalCountinteger
pageinteger
limitinteger
sortstring

Example response

{
  "mailings": [
    {
      "id": 603,
      "subject": "Test test test",
      "language": "en_ca",
      "startedOn": "2010-06-04 14:20:40.217",
      "recipientsCount": 2
    }
  ],
  "totalCount": 793,
  "page": 1,
  "limit": 2
}