Events API Reference
Authentication
Get an access token to authenticate API requests.
HTTP Request
POST /api/v1/auth/login
cURL Example
curl -X POST https://api.eventstaffapp.com/api/v1/auth/login \
-H "Content-Type: application/json" \
-d '{
"email": "your_email@example.com",
"password": "your_password"
}'
Example Response
{
"success": true,
"data": {
"token": "6|abc123def456...",
"user": {
"id": 96351,
"uuid": "e576fcde-c503-4d90-8d04-278e847cb7b8",
"username": "testadmin",
"email": "testadmin@example.com",
"firstname": "Test",
"lastname": "Admin",
"is_admin": true
}
},
"message": ""
}
List Events
Retrieve a paginated list of events. Requires admin permissions.
HTTP Request
GET /api/v1/objects/events
Query Parameters (via JSON body)
| Parameter | Type | Description |
|---|---|---|
| status | string | Filter by status (active, draft, deleted) |
| per_page | integer | Number of items per page (default: 15) |
cURL Example
curl -X GET "https://api.eventstaffapp.com/api/v1/objects/events" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"status": "active",
"per_page": 10
}'
Example Response
{
"success": true,
"data": {
"current_page": 1,
"data": [
{
"id": 199393,
"uuid": "0c663c18-34b9-4d63-9caf-b6075b37607b",
"title": "Beach Wedding Reception",
"start_time": "2024-06-15 18:00:00",
"end_time": "2024-06-15 23:00:00",
"timezone": "America/Los_Angeles",
"venue_name": "Malibu Beach Resort",
"address": "123 Pacific Coast Highway",
"city": "Malibu",
"state": "CA",
"zip": "90265",
"description": "Elegant beach wedding reception for 150 guests",
"dress_code": "Cocktail attire",
"status": "active",
"business_id": 112,
"client_id": 1
}
],
"per_page": 10,
"total": 1
},
"message": ""
}
Get Single Event
Retrieve details of a specific event including call times. Requires admin permissions.
HTTP Request
GET /api/v1/objects/events/{uuid}
URL Parameters
| Parameter | Type | Description |
|---|---|---|
| uuid | string | The UUID of the event |
cURL Example
curl -X GET https://api.eventstaffapp.com/api/v1/objects/events/0c663c18-34b9-4d63-9caf-b6075b37607b \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"
Example Response
{
"success": true,
"data": {
"event": {
"id": 199393,
"uuid": "0c663c18-34b9-4d63-9caf-b6075b37607b",
"title": "Beach Wedding Reception",
"start_time": "2024-06-15 18:00:00",
"end_time": "2024-06-15 23:00:00",
"timezone": "America/Los_Angeles",
"venue_name": "Malibu Beach Resort",
"address": "123 Pacific Coast Highway",
"city": "Malibu",
"state": "CA",
"zip": "90265",
"description": "Elegant beach wedding reception for 150 guests",
"dress_code": "Cocktail attire",
"status": "active"
},
"call_times": [
{
"id": 1,
"position_id": 1,
"skill_level_id": 1,
"count": 5,
"start_time": "2024-06-15 17:00:00",
"end_time": "2024-06-15 24:00:00",
"payrate": "25.00",
"payrate_unit": "hour",
"dress_code": "Black suit"
}
]
},
"message": ""
}
Create Event
Create a new event. Requires admin permissions.
HTTP Request
POST /api/v1/objects/events
Required Fields
| Parameter | Type | Description |
|---|---|---|
| title | string | Event title (max 200 chars) |
| start_time | string | Start date and time (YYYY-MM-DD HH:MM:SS) |
| end_time | string | End date and time (must be after start_time) |
| timezone | string | Timezone (e.g., America/Los_Angeles) |
Optional Fields
| Parameter | Type | Description |
|---|---|---|
| client_id | integer | Client ID |
| venue_name | string | Venue name (max 250 chars) |
| address | string | Street address (max 200 chars) |
| city | string | City (max 200 chars) |
| state | string | State (max 50 chars) |
| zip | string | ZIP code (max 50 chars) |
| description | string | Event description |
| dress_code | string | Dress code requirements |
cURL Example
curl -X POST https://api.eventstaffapp.com/api/v1/objects/events \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"title": "Beach Wedding Reception",
"start_time": "2024-06-15 18:00:00",
"end_time": "2024-06-15 23:00:00",
"timezone": "America/Los_Angeles",
"venue_name": "Malibu Beach Resort",
"address": "123 Pacific Coast Highway",
"city": "Malibu",
"state": "CA",
"zip": "90265",
"description": "Elegant beach wedding reception for 150 guests",
"dress_code": "Cocktail attire",
"client_id": 1
}'
Example Response
{
"success": true,
"data": {
"uuid": "0c663c18-34b9-4d63-9caf-b6075b37607b",
"title": "Beach Wedding Reception",
"start_time": "2024-06-15 18:00:00",
"end_time": "2024-06-15 23:00:00",
"timezone": "America/Los_Angeles",
"venue_name": "Malibu Beach Resort",
"address": "123 Pacific Coast Highway",
"city": "Malibu",
"state": "CA",
"zip": "90265",
"description": "Elegant beach wedding reception for 150 guests",
"dress_code": "Cocktail attire",
"status": "active",
"business_id": 112,
"client_id": 1,
"id": 199393
},
"message": "Event created successfully"
}
Update Event
Update an existing event. Requires admin permissions for events in your business.
HTTP Request
PUT /api/v1/objects/events/{uuid}
URL Parameters
| Parameter | Type | Description |
|---|---|---|
| uuid | string | The UUID of the event to update |
cURL Example
curl -X PUT https://api.eventstaffapp.com/api/v1/objects/events/0c663c18-34b9-4d63-9caf-b6075b37607b \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"title": "Updated Beach Wedding Reception",
"venue_name": "Updated Venue Name",
"description": "Updated description for the event",
"dress_code": "Formal attire",
"status": "active"
}'
Example Response
{
"success": true,
"data": {
"id": 199393,
"uuid": "0c663c18-34b9-4d63-9caf-b6075b37607b",
"title": "Updated Beach Wedding Reception",
"start_time": "2024-06-15 18:00:00",
"end_time": "2024-06-15 23:00:00",
"timezone": "America/Los_Angeles",
"venue_name": "Updated Venue Name",
"address": "123 Pacific Coast Highway",
"city": "Malibu",
"state": "CA",
"zip": "90265",
"description": "Updated description for the event",
"dress_code": "Formal attire",
"status": "active",
"business_id": 112
},
"message": "Event updated successfully"
}
📝 Notes
- • All event operations require a valid Bearer token and admin permissions
- • Events are automatically associated with your business_id
- • UUIDs are used in URLs for event identification
- • Event status can be: active, draft, or deleted
- • Start time must be before end time
- • Call times are automatically loaded when retrieving single events