- Blitz Rocket API DocumentationGetting StartedAPI ReferenceWebhooksReferral Tracking
Contests
List and retrieve contest details
On this page
Contests
Manage and retrieve information about your contests.
List Contests
GET
/api/v1/contests Public or Private API Key
Returns a list of all contests belonging to the team associated with your API key.
Request
No parameters required.
curl -X GET https://blitzrocket.com/api/v1/contests \
-H "x-api-key: your_api_key_here"
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", ... }, ...]
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
{
"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
idstringUnique identifier for the contest
titlestringThe contest title
descriptionstring | nullContest description text
statusstringCurrent status: draft, active, ended, or paused
startDatestring | nullISO 8601 start date, null if not set
endDatestring | nullISO 8601 end date, null if not set
isEvergreenbooleanWhether the contest runs indefinitely
modestringContest mode: giveaway, leaderboard, or waitlist
slugstringURL-friendly unique identifier
entriesCountnumberTotal 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
Request
curl -X GET https://blitzrocket.com/api/v1/contests/clx1abc123def456 \
-H "x-api-key: your_api_key_here"
const contestId = "clx1abc123def456";
const response = await fetch(
`https://blitzrocket.com/api/v1/contests/${contestId}`,
{
headers: { "x-api-key": "your_api_key_here" },
}
);
const { success, data } = await response.json();
console.log(data);
import requests
contest_id = "clx1abc123def456"
response = requests.get(
f"https://blitzrocket.com/api/v1/contests/{contest_id}",
headers={"x-api-key": "your_api_key_here"}
)
data = response.json()
print(data["data"])
Response
{
"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,
"viewsCount": 12847
}
}
Error Responses
| Status | Error | Description |
|---|---|---|
400 | Missing contestId | The contestId path parameter is required |
401 | Invalid API key | API key is missing or invalid |
404 | Contest not found | No contest exists with the given ID |