コンテスト

コンテストの管理および情報取得を行います。

コンテスト一覧

GET/api/v1/contests

Public or Private API Key

APIキーに関連付けられたチームのすべてのコンテストの一覧を返します。

リクエスト

パラメータは不要です。

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

レスポンス

json

{
  "success": true,
  "data": [
    {
      "id": "clx1abc123def456",
      "title": "Summer Giveaway 2025",
      "description": "この夏、素晴らしい賞品を獲得しよう！",
      "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
    }
  ]
}

レスポンスフィールド

idstring

コンテストの一意識別子

titlestring

コンテストのタイトル

descriptionstring | null

コンテストの説明文

statusstring

現在のステータス：draft, active, ended, または paused

startDatestring | null

ISO 8601形式の開始日、未設定の場合はnull

endDatestring | null

ISO 8601形式の終了日、未設定の場合はnull

isEvergreenboolean

コンテストが無期限に開催されるかどうか

modestring

コンテストモード：giveaway, leaderboard, または waitlist

slugstring

URLフレンドリーな一意識別子

entriesCountnumber

コンテストへのエントリー総数