Appearance
List campaigns
GET
/api/nova/campaigns/list
Returns the account's email campaigns, newest first. Accepts page and size query parameters (size defaults to 20 and is capped at 100), an optional query matched against the campaign name and subject, an optional status filter (DRAFT, SCHEDULED, PREPARING, PAUSED, SENDING, FAILED, SENT, CANCELLED) and archived=true to list archived campaigns instead of live ones. Each campaign includes id, reference, name, subject, status, statusMessage, archived, suspended, senderName, senderEmail, distributionListId, distributionListName, scheduledOn, sentOn, ownerId, ownerName, createdOn and modifiedOn. Returns 400 for an unknown status and 401 if the API key is invalid.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
archived
archived
Type
boolean
Default
falsepage
page
Type
integer
Format
"int32"Default
0query
query
Type
string
size
size
Type
integer
Format
"int32"Default
20status
status
Type
string
Responses
OK
application/json
JSON "data": [ { "additionalProperties": { } } ], "error": "string", "message": "string", "page": 0, "requestId": "string", "size": 0, "success": true, "total": 0
{
}