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": "clh2x4j9s0000qw3v5km8j1t2",
        "location": {
          "id": "loc_123",
          "name": "Downtown Venue",
          "address": "123 Main St, Seattle, WA 98101"
        },
        "resources": [
          {
            "id": "res_456",
            "type": "espresso_machine",
            "name": "La Marzocco GB5"
          }
        ],
        "staff": [
          {
            "id": "staff_789",
            "name": "Jane Smith",
            "role": "Lead Barista"
          }
        ],
        "addons": [
          {
            "id": "addon_101",
            "name": "Specialty Syrups Package",
            "quantity": 1
          }
        ],
        "booking": {
          "id": "book_202",
          "status": "confirmed"
        },
        "eventBriefId": "brief_303"
      }
    ]
  }
]

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?

Get EventGet Form Response