Campaigns

Public List Campaigns

Campaigns endpoint for GET /campaigns.

get/campaigns

Request

  • Base URL: https://public.outreach2day.com
  • URL: https://public.outreach2day.com/campaigns
  • Auth: HTTP bearer

Query parameters

workspaceIdinteger required

Response

Successful Response

idstring required
workspaceIdinteger nullable
namestring nullable
priority'HIGH' | 'MEDIUM' | 'LOW' nullable
status'draft' | 'active' | 'paused' | 'completed' | 'errored' | 'archived' | 'unknown' nullable
statusRawstring nullable

Original upstream status value before canonicalization. Present when aliased or unknown.

priorityModestring nullable
createdAtstring date-time nullable
updatedAtstring date-time nullable
mailboxCountinteger nullable

Mailboxes attached to the campaign. Omitted when the campaign provider does not report it.

Example response

[
  {
    "statusRaw": "RUNNING"
  }
]

Changes

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