Sign in
Campaigns

List Campaigns

List campaigns for a project. Requires API key with campaign:read.

get/v1/campaigns

Query parameters

projectIdstring required

Project ID

status'draft' | 'pending_review' | 'scheduled' | 'sending' | 'throttled' | 'sent' | 'failed' | 'cancelled'

Filter by campaign status

pageinteger

Page number for pagination

limitinteger

Number of results per page

Response

List of campaigns

successboolean required
errorstring nullable

Changes

Changed in 2 of the 6 revisions of this API.12

  • 6b3357db6cf61See the full diff
    • ○

      added the optional property allOf[subschema #2]/data/campaigns/items/recipientIds to the response with the 200 status

      response-optional-property-added

  • 3f3dba69574b11See the full diff
    • ●

      added the new pending_review enum value to the allOf[subschema #2]/data/campaigns/items/status response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new enum value pending_review to the query request parameter status

      request-parameter-enum-value-added