Get

[POST] .../v1/campaign/get

Returns campaign information. Use this method to list marketing campaigns for campaign dashboards, scheduler review, delivery monitoring and editing workflows. The response returns paged Campaign records with next_offset and total, including channel type, run date, immediate-run flag, message, image URL, recipient count, status, scheduler UUID, integration identifiers and last update time. The request body is required and supports filters, sort_orders, limit, offset and ids/status/type/search fields; filters are evaluated against campaign id, status, type and name search fields. The caller must have marketing campaign select permission; missing body, denied access, invalid filters or sort_orders, database errors, CDN token lookup errors and persistent lookup errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Number of result items to return.
offset Int32 Optional Offset from the beginning of the result set.
search String Optional Search by parameter values: name - mailing name.
sort_orders Array of CampaignColumn Optional Output parameter sorting.

Filterable Fields

Field Type Description
id int Mailing IDs.
name string
status string Mailing status: New - mailing is created but not started yet, Waiting - mailing is waiting for its scheduled time, Progress - mailing has started but is not completed, Completed - mailing is completed, Error - mailing completed with an error.
type string Mailing type: SMS - SMS mailing, Telegram - Telegram mailing.

Sortable Fields

Field
date
id
image_url
last_update
message
name
recipient_count
run_date
run_immediately
status
type

Request Example

{
  "filters": [
    {
      "Field": "status",
      "Operator": "Equal",
      "Value": "New"
    },
    {
      "Field": "type",
      "Operator": "Equal",
      "Value": "SMS"
    },
    {
      "Field": "name",
      "Operator": "Like",
      "Value": "January"
    }
  ],
  "sort_orders": [
    {
      "column": "run_date",
      "direction": "ASC"
    }
  ],
  "limit": 20,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of Campaign Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 1,
      "name": "January loyalty campaign",
      "type": "SMS",
      "date": 1712345600,
      "run_date": 1712350000,
      "run_immediately": false,
      "message": "Visit us this week and get a loyalty bonus.",
      "image_url": null,
      "recipient_count": 125,
      "status": "New",
      "scheduler_uuid": "886313E1-3B8A-5372-9B90-0C9AEE199E5D",
      "connected_integration_id": "c98210addc4f4e1bb50b17a8c1299a37",
      "last_update": 1712345680
    }
  ],
  "next_offset": 0,
  "total": 1
}