GET
/
api
/
event
/
get-events
curl --request GET \
  --url https://app.flashquotes.com/api/event/get-events \
  --header 'x-api-key: <api-key>'
[
  {
    "event": [
      {
        "id": "evt_123",
        "clientName": "John Smith",
        "clientEmail": "john.smith@example.com",
        "clientPhone": "555-123-4567",
        "siteContactName": "Jane Doe",
        "siteContactPhone": "555-987-6543",
        "eventDescription": "Corporate Team Building Event",
        "eventAddress": "123 Business Ave, Suite 100, New York, NY 10001",
        "additionalLocationInfo": "Enter through the main lobby. Security will direct you to the conference room.",
        "specialNotes": null,
        "parkingLoadingInfo": "Parking available in the underground garage",
        "serviceStartTime": "2025-04-15T14:00:00.000Z",
        "serviceEndTime": "2025-04-15T17:00:00.000Z",
        "staffNumber": 2,
        "resourceNumber": 1,
        "companyId": "comp_456",
        "locationId": "loc_789",
        "createdAt": "2025-03-20T10:00:00.000Z",
        "updatedAt": "2025-03-25T15:30:00.000Z",
        "deletedAt": null,
        "staffDressCode": "Business Casual",
        "customData": null,
        "multiDay": false,
        "bookingId": "book_101",
        "guestCount": 50,
        "loadingTime": 30,
        "setupTime": 60,
        "breakdownTime": 45,
        "unloadingTime": 30,
        "shiftStartTime": "2025-04-15T12:00:00.000Z",
        "shiftEndTime": "2025-04-15T19:00:00.000Z",
        "specialPrepTime": 0,
        "travelToEventTime": 45,
        "travelFromEventTime": 45,
        "tipJarAllowed": false,
        "outdoors": false,
        "location": {
          "id": "loc_789",
          "name": "Downtown Office",
          "streetAddress": "123 Business Ave",
          "city": "New York",
          "state": "New York",
          "zip": "10001",
          "timeZone": "America/New_York",
          "lng": null,
          "lat": null,
          "createdAt": "2023-01-01T00:00:00.000Z",
          "updatedAt": "2024-01-01T00:00:00.000Z",
          "companyId": "comp_456",
          "defaultTaxRateId": null,
          "defaultEmailConnectionId": null,
          "color": "blue"
        },
        "resources": [
          {
            "id": "res_111",
            "name": "Coffee Cart",
            "description": "Mobile coffee service cart",
            "imageUrl": null,
            "createdAt": "2024-01-01T00:00:00.000Z",
            "updatedAt": "2024-01-01T00:00:00.000Z",
            "companyId": "comp_456",
            "locationId": "loc_789",
            "status": "Available",
            "category": "CORE",
            "eventCount": 0
          }
        ],
        "staff": [
          {
            "id": "staff_222",
            "firstName": "Alice",
            "lastName": "Johnson",
            "email": "alice.johnson@example.com",
            "phone": "555-111-2222",
            "role": "Barista",
            "status": "Active",
            "createdAt": "2024-01-01T00:00:00.000Z",
            "updatedAt": "2024-01-01T00:00:00.000Z",
            "companyId": "comp_456"
          }
        ],
        "addons": [],
        "booking": {
          "id": "book_101",
          "entityToInvoice": "John Smith",
          "fullName": "John Smith",
          "email": "john.smith@example.com",
          "phone": "5551234567",
          "paymentMethod": "Stripe",
          "billingNotes": null,
          "paymentIntentId": null,
          "stripeCustomerId": "cus_example123",
          "paymentMethodId": "pm_example456",
          "setupIntentId": "seti_example789",
          "totalPrice": 750,
          "totalPriceCents": 75000,
          "cardOnFile": true,
          "gratuity": 125,
          "gratuityAmountCents": 12500,
          "companyId": "comp_456",
          "createdAt": "2025-03-20T10:00:00.000Z",
          "updatedAt": "2025-03-25T15:30:00.000Z",
          "deletedAt": null,
          "leadId": "lead_333"
        },
        "eventBriefId": "brief_444",
        "eventBriefUrl": "https://app.flashquotes.com/event-briefs/brief_444"
      }
    ]
  }
]

This endpoint returns a list of events that fall within the specified date range. You can optionally filter events by location.

​
Response

The response includes an array of event objects containing:

  • Event identification and basic details
  • Location information (venue name, address)
  • Assigned resources (equipment, machines)
  • Staff assignments and roles
  • Associated addons
  • Booking status and details
  • Event brief reference

​
Common Use Cases

  • Retrieving events for a specific time period
  • Checking event schedules by location
  • Planning resource and staff allocation
  • Reviewing upcoming bookings
  • Generating event reports

​
Notes

  • Date ranges must be provided in ISO 8601 format with timezone offset
  • Maximum date range span is 31 days
  • Results are ordered by event start time
  • Returns a 400 error if date format is invalid
  • Access requires a valid API key with appropriate permissions

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
event_starts_after
string
required

Start of date range in ISO 8601 format with timezone offset (e.g., 2024-12-19T23:59:00-07:00)

​
event_starts_before
string
required

End of date range in ISO 8601 format with timezone offset (e.g., 2024-12-19T23:59:00-07:00)

​
location_id
string

Optional filter for specific location

Response

200
application/json
List of events in the specified date range
​
event
object[]

Was this page helpful?