latestOpenAPI 3.1.02026-08-085123123.9 KB

bf0b51ee8e8a

Members

Retrieve member's received mailings

Retrieve a paginated list of the member's received mailings.

get/members/{key}/mailings

Path parameters

keystring required

Can be either the member's email address or their numerical ID

Query parameters

pageinteger

The page of results to view

limitinteger

The number of results per page (max 10 000)

sort'date_sent_asc' | 'date_sent_desc' | 'date_opened_asc' | 'date_opened_desc'

Sort order for results

Response

Paginated list of the member's received mailings

totalCountinteger

pageinteger

limitinteger

sortstring

Example response

{
  "mailings": [
    {
      "id": 1,
      "subject": "yo",
      "language": "fr_ca",
      "startedOn": "2022-03-16 16:45:02.570",
      "sentOn": "2022-03-16 16:44:57.600",
      "opened": true,
      "openedOn": "2022-03-16 18:37:24.600"
    }
  ],
  "totalCount": 1,
  "page": 1,
  "limit": 20
}