GET
/
unified
/
marketing
/
campaigns
import { StackOne } from "@stackone/stackone-client-ts";

const stackOne = new StackOne({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await stackOne.marketing.listCampaigns({
    fields: "id,remote_id,name,created_at,updated_at,description,schedule_type,status,channels,first_sent_at,last_sent_at,tags,messages",
    filter: {
      updatedAfter: "2020-01-01T00:00:00.000Z",
    },
    updatedAfter: "2020-01-01T00:00:00.000Z",
    xAccountId: "<id>",
  });

  // Handle the result
  console.log(result);
}

run();
{
  "next_page": "<string>",
  "next": "<string>",
  "data": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "<string>",
      "created_at": "2021-01-01T01:01:01.000Z",
      "updated_at": "2021-01-01T01:01:01.000Z",
      "description": "<string>",
      "schedule_type": {
        "value": "immediate",
        "source_value": "Immediate"
      },
      "status": {
        "value": "email",
        "source_value": "Email"
      },
      "archived": true,
      "draft": true,
      "channels": [
        {
          "value": "sms",
          "source_value": "SMS"
        }
      ],
      "first_sent_at": "2021-01-01T01:01:01.000Z",
      "last_sent_at": "2021-01-01T01:01:01.000Z",
      "tags": [
        "<string>"
      ],
      "messages": [
        {
          "id": "message-id-1",
          "name": "SMS Message",
          "message_type": {
            "value": "sms",
            "sourceValue": "sms-message"
          },
          "message_content": {
            "body": "This is an example SMS body.",
            "from": "1-555-123-4567"
          }
        },
        {
          "id": "message-id-2",
          "name": "Email Message",
          "message_type": {
            "value": "email",
            "sourceValue": "email-message"
          },
          "message_content": {
            "subject": "Example Email Subject",
            "body": "<h1>This is an example</h1>\n            <p>email body</p>",
            "from": "Jane Smith",
            "reply-to": "reply@example.com",
            "preheader": "This is the preheader of the email."
          }
        },
        {
          "id": "message-id-3",
          "name": "iOS Push Message",
          "message_type": {
            "value": "ios_push",
            "sourceValue": "ios-push"
          },
          "message_content": {
            "body": "This is an example push notification body."
          }
        }
      ]
    }
  ],
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

Query Parameters

​
raw
boolean | null
default:false

Indicates that the raw request result is returned

​
proxy
object | null

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

​
fields
string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

​
filter
object | null

Filter parameters that allow greater customisation of the list response

​
page
string | null
deprecated

The page number of the results to fetch

​
page_size
string | null
default:25

The number of results per page

​
next
string | null

The unified cursor

​
updated_after
string | null
deprecated

Use a string with a date to only select results updated after that given date

Response

200
application/json
The list of campaigns was retrieved.
​
data
object[]
required
​
next_page
string | null
deprecated
​
next
string | null
​
raw
object[] | null

Was this page helpful?

Raise issue