Contests

Manage and retrieve information about your contests.

List Contests

GET/api/v1/contests

Public or Private API Key

Returns a paginated-style list of campaigns belonging to the team associated with your API key. Tool contests (content gates and instant win games) are excluded by default.

Query Parameters

toolTypestring optional

Filter by tool type. Omit to return campaigns only (`toolType: null`). Use `content_gate` or `instant_win` to list those tools instead.

Request

bash

curl -X GET https://blitzrocket.com/api/v1/contests \
  -H "x-api-key: your_api_key_here"

javascript

const response = await fetch("https://blitzrocket.com/api/v1/contests", {
  headers: {
    "x-api-key": "your_api_key_here",
  },
});

const { success, data } = await response.json();
console.log(data);
// => [{ id: "abc123", title: "Summer Giveaway", ... }, ...]

python

import requests

response = requests.get(
    "https://blitzrocket.com/api/v1/contests",
    headers={"x-api-key": "your_api_key_here"}
)

data = response.json()
print(data["data"])
# => [{"id": "abc123", "title": "Summer Giveaway", ...}, ...]

Response

json

{
  "success": true,
  "data": [
    {
      "id": "clx1abc123def456",
      "title": "Summer Giveaway 2025",
      "description": "Win amazing prizes this summer!",
      "status": "active",
      "startDate": "2025-06-01T00:00:00.000Z",
      "endDate": "2025-08-31T23:59:59.000Z",
      "isEvergreen": false,
      "mode": "giveaway",
      "slug": "summer-giveaway-2025",
      "entriesCount": 1523
    },
    {
      "id": "clx2def456ghi789",
      "title": "Product Launch Contest",
      "description": null,
      "status": "draft",
      "startDate": null,
      "endDate": null,
      "isEvergreen": true,
      "mode": "leaderboard",
      "slug": "product-launch",
      "entriesCount": 0
    }
  ]
}

Response Fields

idstring

Unique identifier for the contest

titlestring

The contest title

descriptionstring | null

Contest description text

statusstring

Current status: draft, active, ended, or paused

startDatestring | null

ISO 8601 start date, null if not set

endDatestring | null

ISO 8601 end date, null if not set

isEvergreenboolean

Whether the contest runs indefinitely

modestring

Contest mode: giveaway, leaderboard, or waitlist

slugstring

URL-friendly unique identifier

entriesCountnumber

Total number of entries in the contest

Get Contest

GET/api/v1/contests/:contestId

Public or Private API Key

Retrieve detailed information about a specific contest.

Path Parameters

contestIdstring required

The unique contest identifier