Skip to main content

​
Overview

Returns the current status and details of a single booking that belongs to your partner account. Use this endpoint to poll for status changes (e.g. after creating a booking in waiting payment status) or to fetch the latest appointment information.

​
Endpoint

GET /partners/bookings/:bookingId/status

​
Authentication

Requires a valid API Key with the partner_bookings_read permission.

​
Path Parameters

ParameterTypeRequiredDescription
bookingIdUUIDYesThe CleanLife booking ID returned when the booking was created. Must be a valid UUID v4.

​
Example Request

curl -X GET "https://apiv3.thecleanlife.dev/v1/partners/bookings/11111111-0000-0000-0000-000000000001/status" \
  -H "x-api-key: YOUR_API_KEY"

​
Success Response

HTTP Status: 200 OK 
{
  "success": true,
  "data": {
    "bookingId": "11111111-0000-0000-0000-000000000001",
    "externalReference": "ORDER-20260615-001",
    "appointmentId": "22222222-0000-0000-0000-000000000002",
    "status": "in progress",
    "paymentStatus": "PAID",
    "trackingReference": "SA-0042",
    "date": "2026-06-20T00:00:00.000Z",
    "timeslot": {
      "startAt": "09:00",
      "endAt": "12:00",
      "endsAtNextDay": false
    },
    "appointment": {
      "id": "22222222-0000-0000-0000-000000000002",
      "name": "SA-0042",
      "status": "In Progress",
      "scheduledStartDateTime": "2026-06-20T09:00:00+03:00",
      "scheduledEndDateTime": "2026-06-20T12:00:00+03:00"
    }
  }
}

​
Error Responses

HTTP StatusCodeDescription
400VALIDATION_ERRORbookingId is not a valid UUID
401UNAUTHORIZEDMissing or invalid API key
403FORBIDDENMissing partner_bookings_read permission
404RESOURCE_NOT_FOUNDBooking not found or does not belong to your partner account

​
Notes

  • You can look up a booking by bookingId only. To look up by externalReference, use GET /partners/bookings?externalReference=....
  • The appointment field is null until a service appointment has been assigned.
  • paymentStatus reflects the most up-to-date payment state including PARTNER-side payment confirmations.
  • GET /partners/bookings — List all bookings with filtering
  • PATCH /partners/bookings/:bookingId — Update booking date/timeslot
  • PATCH /partners/bookings/:bookingId/cancel — Cancel the booking