⛳

Tee-It-Up

REST API Platform v1.0.0

API Service Online
Environment
PRODUCTION
Server Port
5000
Database Status
Connected
Uptime
0h 34m 21s

API Endpoint Explorer

Explore the endpoints supported by the Tee-It-Up gateway. Click tabs to filter.

Authentication

Endpoints handling user signup, logging in, logging out, and token refreshes.

POST /api/v1/auth/register
Create a new golfer or partner account
POST /api/v1/auth/login
Authenticate and receive access cookie & token
POST /api/v1/auth/logout
Clear session tokens and log out
POST /api/v1/auth/refresh-token
Acquire new access token using refresh token

Users

Manage golfer and administrator profiles.

GET /api/v1/users/me
Retrieve current profile
PATCH /api/v1/users/me
Update profile information

Golf Courses

Browse, create, and manage golf courses.

GET /api/v1/courses
List golf courses with location/pricing filters
GET /api/v1/courses/:id
Fetch detailed data for a specific course
POST /api/v1/courses
Add a new golf course (Admin only)
PATCH /api/v1/courses/:id
Update course details (Admin only)
DELETE /api/v1/courses/:id
Delete course from catalog (Admin only)

Reviews

Course reviews and golfer feedback.

GET /api/v1/courses/:id/reviews
Get all reviews for a golf course
POST /api/v1/courses/:id/reviews
Submit a new review

Tee Times

Check available tee-times slots.

GET /api/v1/tee-times
Query active golf tee-times slots
POST /api/v1/tee-times
Generate tee-times slots (Admin only)

Bookings

Manage golf reservations and schedules.

GET /api/v1/bookings
Retrieve user bookings / Admin list
GET /api/v1/bookings/:id
View single booking details
POST /api/v1/bookings
Book a golf tee-time
PATCH /api/v1/bookings/:id/cancel
Cancel booking

Memberships

Exclusive golf course club memberships.

GET /api/v1/memberships
Retrieve membership programs
POST /api/v1/memberships/subscribe
Subscribe to a membership plan

Payments

Payment gateway integrations.

POST /api/v1/payments/checkout
Create Checkout session for bookings
POST /api/v1/payments/webhook
Stripe webhook receiver

Dashboard

Metrics for administrators.

GET /api/v1/dashboard/stats
Fetch analytics and business metrics

Media

Upload assets and golf course imagery.

POST /api/v1/media/upload
Upload file / image to uploads storage

Notifications

Real-time alerts and user messaging.

GET /api/v1/notifications
Retrieve notification history
Path copied to clipboard!