ResourcesBookings
Search appointments
Search appointments and compose supported filters and sorting.
Search by appointment UUID or customer email. Supported filters include product, variant, order, customer, appointment status, and calendar sync status.
Authorization
bearerAuth storeAuth AuthorizationBearer <token>
Provide your SellApp API key as a bearer token.
In: header
X-STORE<token>
Select the SellApp store for this API request.
In: header
Query Parameters
limit?integer
Number of items to return per page.
Default
15Range
1 <= value <= 100page?integer
Page number to return.
Default
1Range
1 <= valuepagination?boolean
Set to false to return at most 100 matching items in one data array without pagination links or metadata.
Default
trueRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://sell.app/api/v2/bookings/search" \ -H "Content-Type: application/json" \ -d '{ "filters": [ { "field": "id", "operator": "=", "value": 1 } ], "sort": [ { "field": "created_at", "direction": "desc" } ] }'{
"data": [
{
"id": "018f61d6-1c46-7b42-8a94-522bc6b5c53f",
"product_id": 41,
"product_variant_id": 73,
"order_id": 501,
"invoice_id": 901,
"customer_id": 301,
"customer_email": "buyer@example.com",
"slot_start_at": "2028-03-26T09:00:00Z",
"slot_end_at": "2028-03-26T09:30:00Z",
"timezone": "Europe/London",
"quantity": 1,
"status": "confirmed",
"calendar_sync_status": "synced",
"external_event_link": "https://calendar.google.com/calendar/event?eid=example",
"video_join_url": "https://meet.google.com/abc-defg-hij",
"confirmed_at": "2028-03-01T12:00:00Z",
"cancelled_at": null,
"created_at": "2028-03-01T11:59:00Z",
"updated_at": "2028-03-01T12:00:00Z",
"product": {
"id": 41,
"title": "Writing consultation"
},
"variant": {
"id": 73,
"title": "Thirty minutes"
}
}
],
"links": {},
"meta": {}
}{
"message": "Unauthenticated."
}{
"message": "This action is unauthorized."
}{
"message": "The given data was invalid.",
"errors": {
"data": [
"The data field is required."
]
}
}