Skip to main content
GET
/
campaigns
cURL
curl --request GET \
  --url https://app.masivo.ai/api/storefront/v1/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "attributes": {},
      "content": {
        "Title": {
          "name": "Title",
          "type": "input",
          "value": "Value of the title"
        },
        "BannerImage": {
          "alt": "Alternative description for the image",
          "href": "Href link for the image",
          "name": "BannerImage",
          "type": "image",
          "value": "https://URL_TO_IMAGE"
        },
        "Description": {
          "name": "Name of the description",
          "type": "input",
          "value": "Value of the description"
        }
      },
      "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "from": 0,
  "to": 9,
  "count": 10
}

Documentation Index

Fetch the complete documentation index at: https://docs.masivo.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

from
string
required

Starting record index, starting from 0

to
string
required

Ending record index, starting from 0

type
enum<string>

Filter by campaign type

Available options:
BEHAVIOR,
COUPONS,
PUNCH_CARDS,
REFERRALS
brand_id
string<uuid> | null

Filter by brand id

customer_id
string

Filter campaigns that a customer can participate

status
enum<string>

Filter by campaign status

Available options:
RUNNING,
PAUSED,
SCHEDULED,
FINISHED,
NOT FINISHED
labels
string

Filter by campaign labels (, separated values)

platform
string

Filter by platform name

funded_by
string

Filter by funder

includes
enum<string>

Whether to include additional data inside attributes Only applies to COUPONS campaigns

Available options:
CODES_SUMMARY

Response

200 - application/json

Ok

data
object[]
from
number

The starting record index

Example:

0

to
number

The ending record index

Example:

9

count
number

The total number of campaigns

Example:

10