Skip to main content

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โ€‹

ParameterTypeDescription
pageintegerPage number (default: 1)
per_pageintegerItems per page, max 100 (default: 25)
typestringFilter by type: experience or rental
statusstringFilter by status: waiting, notified, booked, cancelled
experience_idintegerFilter by experience ID
schedule_idintegerFilter by schedule ID
product_idintegerFilter by product ID
searchstringSearch by name or email
sortstringSort 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โ€‹

FieldTypeDescription
idintegerUnique waitlist entry identifier
typestringexperience or rental
statusstringCurrent status
customer.idintegerCustomer ID (if linked)
customer.namestringCustomer name
customer.emailstringCustomer email
customer.phonestringCustomer phone (nullable)
experience_idintegerExperience ID (experience type only)
schedule_idintegerSchedule ID (experience type only)
product_idintegerProduct ID (rental type only)
variation_idintegerProduct variation ID (rental type only)
desired_start_atstringDesired rental start datetime (ISO 8601 with time, rental type only)
desired_end_atstringDesired rental end datetime (ISO 8601 with time, rental type only)
quantityintegerNumber of spots/items requested
notesstringAdditional notes (nullable)
sourcestringEntry source: widget, pos, api, ai_assistant
notified_atstringWhen notification was sent (ISO 8601, nullable)
created_atstringCreation timestamp (ISO 8601)
updated_atstringLast update timestamp (ISO 8601)