API Reference

Wedstrijden

Wedstrijdgegevens weergeven en ophalen

Wedstrijden

Beheer en haal informatie op over je wedstrijden.


Wedstrijden Lijst

GET/api/v1/contests
Public or Private API Key

Geeft een lijst terug van alle wedstrijden die behoren tot het team dat gekoppeld is aan je API-sleutel.

Verzoek

Geen parameters vereist.

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

Antwoord

json
{
  "success": true,
  "data": [
    {
      "id": "clx1abc123def456",
      "title": "Summer Giveaway 2025",
      "description": "Win geweldige prijzen deze zomer!",
      "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
    }
  ]
}

Antwoord Velden

idstring

Unieke identificatie voor de wedstrijd

titlestring

De titel van de wedstrijd

descriptionstring | null

Beschrijvingstekst van de wedstrijd

statusstring

Huidige status: concept, actief, beëindigd, of gepauzeerd

startDatestring | null

ISO 8601 startdatum, null als niet ingesteld

endDatestring | null

ISO 8601 einddatum, null als niet ingesteld

isEvergreenboolean

Of de wedstrijd onbeperkt doorloopt

modestring

Wedstrijdmodus: giveaway, leaderboard, of wachtlijst

slugstring

URL-vriendelijke unieke identificatie

entriesCountnumber

Totaal aantal inzendingen in de wedstrijd


Wedstrijd Ophalen

GET/api/v1/contests/:contestId
Public or Private API Key

Haal gedetailleerde informatie op over een specifieke wedstrijd.

Padparameters

contestIdstring required

De unieke wedstrijdidentificatie

Verzoek

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

Antwoord

json
{
  "success": true,
  "data": {
    "id": "clx1abc123def456",
    "title": "Summer Giveaway 2025",
    "description": "Win geweldige prijzen deze zomer!",
    "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,
    "viewsCount": 12847
  }
}

Foutantwoorden

StatusFoutBeschrijving
400Ontbrekende contestIdDe contestId padparameter is verplicht
401Ongeldige API-sleutelAPI-sleutel ontbreekt of is ongeldig
404Wedstrijd niet gevondenEr bestaat geen wedstrijd met de opgegeven ID