campaign_mailings

Fetch campaign mailings

Return json data about Paubox Marketing Campaign Emails

get/campaign_mailings

Request

  • Base URL: https://api.paubox.com/v1/marketing
  • URL: https://api.paubox.com/v1/marketing/campaign_mailings
  • Auth: API key in header authorization

Query parameters

searchstring

Regex string to search on. Compares against subject

template_typestring

Return only mailings authored in this editor, for example quill, bee or html

order_bystring

Attribute to sort on. Must be a campaign mailing column name, for example subject or created_at. When omitted, no explicit ordering is applied.

order'asc' | 'desc'

Direction to sort. Only applied when order_by is supplied.

itemsinteger

Number of records to return per page

pageinteger

For pagination of results

paginationboolean

Set to false to disable pagination and return every matching campaign mailing in one response.

Response

Campaign mailings data

Changes

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