List Waitlist Entries
Retrieve a paginated list of waitlist entries with optional filtering, searching, and sorting.
GET /v1/waitlist
Authenticationโ
Requires a valid API key with waitlist:read scope.
Query Parametersโ
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
per_page | integer | Items per page, max 100 (default: 25) |
type | string | Filter by type: experience or rental |
status | string | Filter by status: waiting, notified, booked, cancelled |
experience_id | integer | Filter by experience ID |
schedule_id | integer | Filter by schedule ID |
product_id | integer | Filter by product ID |
search | string | Search by name or email |
sort | string | Sort field: id, name, email, type, status, created_at (default: -created_at) |
Request Exampleโ
curl -X GET "https://app.equipdash.com/api/v1/waitlist?status=waiting&type=experience" \
-H "Authorization: Bearer eqd_live_your_api_key"
Responseโ
{
"data": [
{
"id": 1,
"type": "experience",
"status": "waiting",
"customer": {
"id": 456,
"name": "Jane Smith",
"email": "jane@example.com",
"phone": "+1234567890"
},
"experience_id": 42,
"schedule_id": 156,
"quantity": 2,
"notes": null,
"source": "widget",
"notified_at": null,
"created_at": "2026-01-15T14:30:00+00:00",
"updated_at": "2026-01-15T14:30:00+00:00"
}
],
"meta": {
"current_page": 1,
"per_page": 25,
"total": 12,
"total_pages": 1,
"request_id": "req_abc123",
"timestamp": "2026-02-11T10:30:00+00:00"
},
"links": {
"first": "https://app.equipdash.com/api/v1/waitlist?page=1",
"prev": null,
"next": null,
"last": "https://app.equipdash.com/api/v1/waitlist?page=1"
}
}
Response Fieldsโ
| Field | Type | Description |
|---|---|---|
id | integer | Unique waitlist entry identifier |
type | string | experience or rental |
status | string | Current status |
customer.id | integer | Customer ID (if linked) |
customer.name | string | Customer name |
customer.email | string | Customer email |
customer.phone | string | Customer phone (nullable) |
experience_id | integer | Experience ID (experience type only) |
schedule_id | integer | Schedule ID (experience type only) |
product_id | integer | Product ID (rental type only) |
variation_id | integer | Product variation ID (rental type only) |
desired_start_at | string | Desired rental start datetime (ISO 8601 with time, rental type only) |
desired_end_at | string | Desired rental end datetime (ISO 8601 with time, rental type only) |
quantity | integer | Number of spots/items requested |
notes | string | Additional notes (nullable) |
source | string | Entry source: widget, pos, api, ai_assistant |
notified_at | string | When notification was sent (ISO 8601, nullable) |
created_at | string | Creation timestamp (ISO 8601) |
updated_at | string | Last update timestamp (ISO 8601) |