Skip to content

docs: add hackathons list API documentation #5313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Anushreebasics merged 3 commits into from
Jun 2, 2026
Merged

docs: add hackathons list API documentation #5313

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0162daf
docs: add hackathons list API documentation
git-Rag Jun 1, 2026
1353c50
Merge branch 'master' into docs/hackathons-list-api
git-Rag Jun 2, 2026
50845b8
Remove Backend Implementation PR references
git-Rag Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 37 additions & 6 deletions docs/API_DOCUMENTATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -865,12 +865,6 @@ curl -N http://localhost:8080/api/events/stream
```text
event:connected
data:Stream connected successfully
```

#### Backend Implementation PR
[SandeepVashishtha/Eventra-Backend#BACKEND_PR_NUMBER](https://github.com/SandeepVashishtha/Eventra-Backend/pull/BACKEND_PR_NUMBER)

---

# Project APIs

Expand Down Expand Up @@ -1096,6 +1090,43 @@ Status: `200 OK`

# Hackathon APIs

## List Hackathons

| Method | Endpoint |
|--------|----------|
| GET | `/api/hackathons` |

Fetches the list of available hackathons.

### Authentication
Public. No authentication required.

### Example Request
```bash
curl http://localhost:8080/api/hackathons
```

### Successful Response (200)
Returns a JSON array of hackathon objects. Returns `[]` if no hackathons exist.

```json
[
{
"id": 1,
"title": "Hackathon Name",
"description": "Hackathon description",
"organizer": "Organizer Name",
"startDate": "2026-06-10",
"endDate": "2026-06-12",
"location": "Bhopal",
"mode": "Offline",
"prizePool": "50000",
"registrationDeadline": "2026-06-05",
"imageUrl": "https://example.com/hackathon.png"
}
]
```

## Get Hackathon By ID

| Method | Endpoint |
Expand Down
Loading