Event Staff App API Documentation

Introduction

Welcome to the Event Staff App API documentation. This API provides endpoints for managing events and users in the Event Staff App platform. The API follows RESTful principles and uses JSON for request and response payloads.

Base URL

All API requests should be made to:

https://api.eventstaffapp.com/api/v1

Authentication

The API uses Bearer token authentication. Include your API token in the Authorization header of your requests:

1. Login to get a token:

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"
  }'

2. Use the token in subsequent requests:

Authorization: Bearer YOUR_ACCESS_TOKEN

Example authenticated request:

curl -X GET https://api.eventstaffapp.com/api/v1/objects/users \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Response Format

All responses are returned in JSON format with the following structure:

{
    "success": true,
    "data": {
        // Response data here
    },
    "message": "Optional message"
}

Error Handling

Errors are returned with appropriate HTTP status codes and messages:

{
    "success": false,
    "message": "Error message describing what went wrong"
}

Available Resources

• Events - Create, read, update, and delete event records
• Users - Manage user accounts and profiles

Rate Limiting

API requests are limited to 60 requests per minute per API token. The following headers are included in the response:

• X-RateLimit-Limit: Number of requests allowed per window
• X-RateLimit-Remaining: Number of requests remaining in the current window
• X-RateLimit-Reset: Time when the rate limit will reset

Quick Start

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"
  }'

curl -X GET https://api.eventstaffapp.com/api/v1/objects/users \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"