API ReferenceBookings
Search appointments
Find appointments using search terms, filters, and sorting.
Search by appointment UUID or customer email. Supported filters include product, variant, order, customer, appointment status, and calendar sync status.
AuthorizationBearer <token>
Provide your SellApp API key as a bearer token.
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
trueHeader Parameters
X-STORE?string
Store slug. Required for OAuth access tokens. API keys may omit it to use their current store, or the first accessible store when no current store is selected.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://sell.app/api/v2/bookings/search" \ -H "X-STORE: launch-lab" \ -H "Content-Type: application/json" \ -d '{ "filters": [ { "field": "id", "operator": "=", "value": "018f61d6-1c46-7b42-8a94-522bc6b5c53f" } ], "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": "isabel.torres@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": "Canva deck intervention"
},
"variant": {
"id": 73,
"title": "Thirty slides or thirty minutes"
}
}
],
"links": {
"first": "https://sell.app/api/v2/bookings/search?page=1",
"last": "https://sell.app/api/v2/bookings/search?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "https://sell.app/api/v2/bookings/search",
"per_page": 15,
"to": 1,
"total": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://sell.app/api/v2/bookings/search?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
]
}
}{
"type": "invalid_request_error",
"code": "bad_request",
"message": "The request could not be understood.",
"status": 400,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#bad-request"
}{
"type": "authentication_error",
"code": "unauthenticated",
"message": "Unauthenticated.",
"status": 401,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#unauthenticated"
}{
"type": "authorization_error",
"code": "forbidden",
"message": "This action is unauthorized.",
"status": 403,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#forbidden"
}{
"type": "validation_error",
"code": "validation_failed",
"message": "The selected product variant id is invalid.",
"status": 422,
"param": "product_variant_id",
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#validation-failed",
"errors": {
"product_variant_id": [
"The selected product variant id is invalid."
]
}
}{
"type": "rate_limit_error",
"code": "rate_limit_exceeded",
"message": "Too Many Attempts.",
"status": 429,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#rate-limit-exceeded"
}{
"type": "api_error",
"code": "api_error",
"message": "Server Error",
"status": 500,
"param": null,
"request_id": "01992a65-e064-71ba-b38f-902b7966a6be",
"docs_url": "https://sell.app/docs/api/errors#api-error"
}