The BrightStar REST API enables programmatic access to events, tickets, orders, and attendees. All endpoints use JSON and require authentication.
Base URL & Authentication
bash
# Base URL
https://api.brightstarevents.com/v1
# Authentication
Authorization: Bearer {your_api_key}
Content-Type: application/json
# Test environment
https://api.brightstarevents.com/v1/test
Use test API keys (bs_test_*)Events Endpoints
bash
# List events
GET /v1/events
Params: status, limit, offset, sort
# Get event
GET /v1/events/{event_id}
# Create event
POST /v1/events
Body: { title, description, start_date, ... }
# Update event
PATCH /v1/events/{event_id}
Body: { fields to update }
# Delete event (draft only)
DELETE /v1/events/{event_id}Tickets Endpoints
bash
# List ticket types for event
GET /v1/events/{event_id}/tickets
# Create ticket type
POST /v1/events/{event_id}/tickets
Body: { name, price, quantity, ... }
# Update ticket type
PATCH /v1/tickets/{ticket_type_id}
# Get sold tickets (attendees)
GET /v1/events/{event_id}/attendees
Params: ticket_type, checked_in, limit, offsetInteractive API explorer
Interactive component coming soon
Orders Endpoints
bash
# List orders for event
GET /v1/events/{event_id}/orders
Params: status, date_from, date_to
# Get order details
GET /v1/orders/{order_id}
# Issue refund
POST /v1/orders/{order_id}/refund
Body: { amount, reason } // amount optional for full
# Resend confirmation
POST /v1/orders/{order_id}/resendPagination
Parameters
limit: Number of results (default: 20, max: 100)
offset: Skip N results (for pagination)
Response Headers
X-Total-Count: Total results available
X-Page: Current page number
X-Per-Page: Results per page
Example
GET /v1/events?limit=20&offset=40
Returns: Results 41-60 of total
Error Responses
json
// Standard error format
{
"error": {
"code": "VALIDATION_ERROR",
"message": "title is required",
"field": "title"
}
}
// HTTP Status Codes
200 OK - Success
201 Created - Resource created
400 Bad Request - Invalid input
401 Unauthorized - Bad/missing API key
403 Forbidden - Insufficient permissions
404 Not Found - Resource doesn't exist
429 Too Many Requests - Rate limited
500 Internal Error - Server issueUse the test environment (bs_test_* keys) for development. Test events and orders don't affect your production data or billing.