Wettbewerbe

Verwalten und abrufen von Informationen zu Ihren Wettbewerben.

Wettbewerbe auflisten

GET/api/v1/contests

Public or Private API Key

Gibt eine Liste aller Wettbewerbe zurück, die zum Team gehören, das mit Ihrem API-Schlüssel verknüpft ist.

Anfrage

Keine Parameter erforderlich.

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", ...}, ...]

Antwort

json

{
  "success": true,
  "data": [
    {
      "id": "clx1abc123def456",
      "title": "Summer Giveaway 2025",
      "description": "Gewinnen Sie diesen Sommer tolle Preise!",
      "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": "Produkt-Launch-Wettbewerb",
      "description": null,
      "status": "draft",
      "startDate": null,
      "endDate": null,
      "isEvergreen": true,
      "mode": "leaderboard",
      "slug": "product-launch",
      "entriesCount": 0
    }
  ]
}

Antwortfelder

idstring

Eindeutige Kennung für den Wettbewerb

titlestring

Der Titel des Wettbewerbs

descriptionstring | null

Beschreibungstext des Wettbewerbs

statusstring

Aktueller Status: draft, active, ended oder paused

startDatestring | null

ISO 8601 Startdatum, null wenn nicht gesetzt

endDatestring | null

ISO 8601 Enddatum, null wenn nicht gesetzt

isEvergreenboolean

Ob der Wettbewerb unbegrenzt läuft

modestring

Wettbewerbsmodus: giveaway, leaderboard oder waitlist

slugstring

URL-freundliche eindeutige Kennung

entriesCountnumber

Gesamtanzahl der Einträge im Wettbewerb

Wettbewerb abrufen

GET/api/v1/contests/:contestId

Public or Private API Key

Detaillierte Informationen zu einem bestimmten Wettbewerb abrufen.

Pfadparameter

contestIdstring required

Die eindeutige Wettbewerbskennung