> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flashquotes.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Introduction
> Welcome to the Flashquotes API documentation
export const ScaleBadge = () =>
Scale
;
## Welcome to the Flashquotes API
The Flashquotes API enables you to programmatically access and manage your events, bookings, forms, invoices, and tasks. Our REST API provides endpoints for retrieving event data, creating tasks, managing form responses, and accessing invoice information.
**Scale access required.** API access is limited to Flashquotes Scale plan customers. You can easily
upgrade in [Plan Settings](https://app.flashquotes.com/settings/plans).
## Authentication
All API endpoints require authentication using an API key. You must include your API key in the request headers:
```bash theme={null}
'x-api-key: your_api_key_here'
```
Keep your API key secure and never share it publicly. If you're subscribed to
the Scale plan, access your API key in the [Integrations
Settings](https://app.flashquotes.com/settings/integrations).
## Base URL
All API requests should be made to:
```bash theme={null}
https://app.flashquotes.com/api
```
## Available Endpoints
Our API provides several endpoint groups:
Manage events, retrieve event details, and list events within date ranges
Create and manage tasks on events programmatically
Access form submission data and response details
Retrieve invoice information and payment details
## Response Format
All responses are returned in JSON format. Successful responses will have a 2xx status code, while errors will return appropriate 4xx or 5xx status codes with error details.
### Conventions
The current public API follows Stripe-style conventions:
* **`snake_case` query parameters, `camelCase` response keys.**
* Every returned object carries an **`object` discriminator** (e.g. `"object": "event"`) at the top of its JSON.
* List endpoints return a standard envelope:
```json theme={null}
{
"object": "list",
"url": "/api/events",
"hasMore": true,
"data": [ /* ... */ ]
}
```
* Default responses include only an object's own scalar fields plus the foreign-key ids for its relations. Related objects are inlined only when explicitly requested via `expand[]`.
### Expanding related objects
By default, an endpoint returns the object's own scalar fields plus foreign-key ids (e.g. an event includes `bookingId`, `locationId`, `eventBriefId`, but not the booking or location objects themselves). To inline a related object, pass its path in `expand[]`:
```bash theme={null}
GET /api/events/evt_123?expand[]=location&expand[]=booking.lead
```
**Dot notation** walks the object graph. `booking.lead` reads "expand the booking, then expand the lead inside that booking." Each path segment must be an allow-listed relation on its parent — unknown paths return `400`.
```jsonc theme={null}
// expand[]=booking.lead → lead nested inside booking
{
"object": "event",
"id": "evt_123",
"booking": {
"object": "booking",
"id": "bkg_456",
"lead": { "object": "lead", "id": "led_789", "...": "..." }
}
}
```
**Parent auto-promote.** Requesting any nested path automatically expands its parents. `expand[]=booking.lead` includes `booking` in the response even if you don't list `booking` separately.
**Multiple paths.** Repeat `expand[]` to combine paths. Comma-separated values are also accepted: `?expand[]=location,services`.
#### `data.` prefix on list endpoints
On list endpoints, each path **must** be prefixed with `data.` because the objects you're expanding live inside the envelope's `data` array, not at the top level:
```bash theme={null}
# Single object — no prefix
GET /api/events/evt_123?expand[]=booking.lead
# List — every path is prefixed with data.
GET /api/events?expand[]=data.booking.lead&expand[]=data.location
```
A list request that omits the `data.` prefix returns `400` with an `invalid_request_error` describing the offending path.
#### Limits
* Maximum **20** paths per request (duplicates are deduplicated, so `?expand[]=booking&expand[]=booking` counts once).
* Maximum nesting depth of **4** segments. On list endpoints, the `data.` prefix doesn't count against the depth — `data.a.b.c.d` is allowed.
* Paths must use only allow-listed relation names; the allowed paths are documented on each endpoint.
### Pagination
List endpoints use cursor-based pagination:
* `limit` — page size (default `10`, maximum `100`).
* `starting_after` — the `id` of the last item from the previous page.
The response `hasMore` flag indicates whether more pages are available.
### Date-range filters
Date fields on list endpoints accept Stripe-style bracket-notation operators: `[gt]`, `[gte]`, `[lt]`, `[lte]`. Values must be full ISO 8601 datetimes including a timezone designator (e.g. `2026-06-01T00:00:00Z` or `2026-06-01T00:00:00-05:00`).
```
?service_start_time[gte]=2026-06-01T00:00:00Z&service_start_time[lt]=2026-07-01T00:00:00Z
```
### Error envelope
Errors return a structured envelope:
```json theme={null}
{
"error": {
"type": "invalid_request_error",
"code": "invalid_parameter",
"message": "limit must be an integer between 1 and 100",
"param": "limit"
}
}
```
The `type` field is one of `api_error`, `invalid_request_error`, `authentication_error`, `permission_error`, `rate_limit_error`, or `idempotency_error`. The `code` field is a machine-readable identifier and `param` (when present) names the offending parameter.
## Need Help?
If you need assistance or have questions about the API:
* Email us at [support@flashquotes.com](mailto:support@flashquotes.com)
* Check our documentation for examples and guides
* Contact your account manager for enterprise support