List

GET /v1/campaigns

Lists all campaigns.

Query Parameters

page

integer

Optional

Defaults to 1

The number of the results page.

per_page

integer

Optional

Defaults to 10

The number of items to show per page.

targeting_method

string

Optional

Defaults to all

The targeting method used in the campaign (map, csv, all).

status

string

Optional

The status of the campaign (draft, queued, processing, sent, mailed).

sent_at[from]

time

Optional

The start date for the sent_at attribute.

sent_at[to]

time

Optional

The end date for the sent_at attribute.

meta_data[][key]

string

Optional

The key of the additional information stored with the campaign. For examples check the Making Requests page.

meta_data[][value]

string

Optional

The value of the additional information stored with the campaign. For examples check the Making Requests page.

Example Request

curl -X GET https://api.realmailers.com/v1/campaigns \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response Schema

{
  items: Array(Campaign)
  current_page: Number
  total_count: Number
  total_pages: Number
}