{"openapi":"3.1.0","info":{"title":"Cloudbeds API (Bowmark)","version":"e833508f87ff","description":"Cloudbeds booking engine used by independent hotels, hostels and inns: find a property's booking page, its details and policies, which rooms are free on given dates and at what rate, a priced quote, a hotel group's properties, and booking a room up to the payment step.\n\nEvery function Bowmark has for Cloudbeds (cloudbeds.com) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/cloudbeds/getProperty":{"post":{"operationId":"getProperty","summary":"One property from its code (\"t7OI21\") or booking-page URL: name, description, address and coordinates, contact, check-in/out times, currency, amenities, photos, deposit terms, accepted payment methods","description":"One property from its code (\"t7OI21\") or booking-page URL: name, description, address and coordinates, contact, check-in/out times, currency, amenities, photos, deposit terms, accepted payment methods, cancellation policy and terms.\n\nCalls `bowmark.providers.cloudbeds.getProperty`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CloudbedsProperty>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"property":{"type":"string","description":"TypeScript: `string`"}},"required":["property"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/cloudbeds/searchRooms":{"post":{"operationId":"searchRooms","summary":"Rooms free at a property for a check-in/check-out: per room type its rate id, stay total, per-night rates, rooms left, occupancy and minimum stay, plus the room types not bookable for those dates and ","description":"Rooms free at a property for a check-in/check-out: per room type its rate id, stay total, per-night rates, rooms left, occupancy and minimum stay, plus the room types not bookable for those dates and the same stay's price on other channels where the property publishes it.\n\nCalls `bowmark.providers.cloudbeds.searchRooms`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CloudbedsSearchRoomsResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CloudbedsSearchRoomsArgs","description":"TypeScript: `CloudbedsSearchRoomsArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/cloudbeds/getAvailabilityCalendar":{"post":{"operationId":"getAvailabilityCalendar","summary":"For each day in a range, which room types and rates are open at a property, the nightly rate, rooms left, min/max stay and closed-to-arrival/departure flags.","description":"For each day in a range, which room types and rates are open at a property, the nightly rate, rooms left, min/max stay and closed-to-arrival/departure flags. A day with an empty `open` list has nothing bookable.\n\nCalls `bowmark.providers.cloudbeds.getAvailabilityCalendar`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CloudbedsCalendarResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CloudbedsCalendarArgs","description":"TypeScript: `CloudbedsCalendarArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/cloudbeds/getRoomType":{"post":{"operationId":"getRoomType","summary":"One room type's full detail at a property — description, photos, bed layout, occupancy and its amenity list — looked up by the `roomTypeId` searchRooms or getAvailabilityCalendar returned.","description":"One room type's full detail at a property — description, photos, bed layout, occupancy and its amenity list — looked up by the `roomTypeId` searchRooms or getAvailabilityCalendar returned. `checkIn`/`checkOut` default to a near-term date pair; the room type's own detail does not change with dates, only its availability does.\n\nCalls `bowmark.providers.cloudbeds.getRoomType`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CloudbedsRoomTypeDetail>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"property":{"type":"string"},"roomTypeId":{"type":"string"},"checkIn":{"type":"string"},"checkOut":{"type":"string"}},"required":["property","roomTypeId"],"additionalProperties":true,"description":"TypeScript: `{ property: string; roomTypeId: string; checkIn?: string; checkOut?: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/cloudbeds/listAddons":{"post":{"operationId":"listAddons","summary":"The extras a property sells with a chosen room and stay (breakfast, transfers, parking, tours): name, description, price and how it is charged.","description":"The extras a property sells with a chosen room and stay (breakfast, transfers, parking, tours): name, description, price and how it is charged. An empty `addons` list means this property sells none for that room and stay.\n\nCalls `bowmark.providers.cloudbeds.listAddons`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CloudbedsAddonsResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"property":{"type":"string"},"roomTypeId":{"type":"string"},"checkIn":{"type":"string"},"checkOut":{"type":"string"},"adults":{"type":"number"},"kids":{"type":"number"}},"required":["property","roomTypeId","checkIn","checkOut","adults"],"additionalProperties":true,"description":"TypeScript: `{ property: string; roomTypeId: string; checkIn: string; checkOut: string; adults: number; kids?: number }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/cloudbeds/getBookingQuote":{"post":{"operationId":"getBookingQuote","summary":"Prices a stay before booking it, from the rate ids searchRooms returned: nightly and total price, taxes and fees, the deposit due now, the payment and cancellation schedule when the property publishes","description":"Prices a stay before booking it, from the rate ids searchRooms returned: nightly and total price, taxes and fees, the deposit due now, the payment and cancellation schedule when the property publishes one, and the grand total. Creates a cart token and no reservation. Carries `checkout`, a handoff URL (the property's booking page on those dates) the person opens to book and pay themselves: Bowmark never books.\n\nCalls `bowmark.providers.cloudbeds.getBookingQuote`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CloudbedsPricedStay>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CloudbedsBookingQuoteArgs","description":"TypeScript: `CloudbedsBookingQuoteArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/cloudbeds/getPolicies":{"post":{"operationId":"getPolicies","summary":"A property's cancellation, deposit and payment terms in plain language, plus its house terms, privacy text and bank-transfer instructions where it takes transfers.","description":"A property's cancellation, deposit and payment terms in plain language, plus its house terms, privacy text and bank-transfer instructions where it takes transfers. Reads smart-policy text when the property has that feature enabled, otherwise its property_info terms.\n\nCalls `bowmark.providers.cloudbeds.getPolicies`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CloudbedsPolicies>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"property":{"type":"string"},"checkInDate":{"type":"string"}},"required":["property"],"additionalProperties":true,"description":"TypeScript: `{ property: string; checkInDate?: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/cloudbeds/getOrganization":{"post":{"operationId":"getOrganization","summary":"A hotel group that books through one Cloudbeds page (a hostel network, a small chain), from its numeric id (\"1\") or its slug (\"higroup\"): its name and every property in it with code, name, city, count","description":"A hotel group that books through one Cloudbeds page (a hostel network, a small chain), from its numeric id (\"1\") or its slug (\"higroup\"): its name and every property in it with code, name, city, country, currency, coordinates and check-in/out times. Pass a property `code` to any other function.\n\nCalls `bowmark.providers.cloudbeds.getOrganization`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CloudbedsOrganization>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"organization":{"type":"string"}},"required":["organization"],"additionalProperties":true,"description":"TypeScript: `{ organization: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/cloudbeds/searchOrganizationAvailability":{"post":{"operationId":"searchOrganizationAvailability","summary":"For a hotel group and a stay, which of its properties have a room free and each one's cheapest nightly rate and stay total, so a caller can compare the whole group before picking one.","description":"For a hotel group and a stay, which of its properties have a room free and each one's cheapest nightly rate and stay total, so a caller can compare the whole group before picking one. Amounts are passed through exactly as Cloudbeds returns them, with their currency.\n\nCalls `bowmark.providers.cloudbeds.searchOrganizationAvailability`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CloudbedsOrganizationAvailability>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"organization":{"type":"string"},"checkIn":{"type":"string"},"checkOut":{"type":"string"},"currency":{"type":"string"}},"required":["organization","checkIn","checkOut"],"additionalProperties":true,"description":"TypeScript: `{ organization: string; checkIn: string; checkOut: string; currency?: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/cloudbeds/bookRoom":{"post":{"operationId":"bookRoom","summary":"Books rooms as a guest checkout (no Cloudbeds account) with the rate ids from searchRooms and the guest's name, email, phone and country.","description":"Books rooms as a guest checkout (no Cloudbeds account) with the rate ids from searchRooms and the guest's name, email, phone and country. A property that takes a deposit or card up front stops before anything is reserved and returns the price, the amount due and the booking page to pay on; it never pays. When nothing is due up front it reserves only with `confirm: true` and returns the token getReservation reads.\n\nCalls `bowmark.providers.cloudbeds.bookRoom`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CloudbedsBooking>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"$ref":"#/components/schemas/CloudbedsBookRoomArgs","description":"TypeScript: `CloudbedsBookRoomArgs`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/cloudbeds/getReservation":{"post":{"operationId":"getReservation","summary":"Reads a reservation made through a property's Cloudbeds booking page, from the `data_res` token on its confirmation link (the URL or the bare token).","description":"Reads a reservation made through a property's Cloudbeds booking page, from the `data_res` token on its confirmation link (the URL or the bare token). Returns Cloudbeds' confirmation payload as it sends it. An unknown token is the caller's to fix.\n\nCalls `bowmark.providers.cloudbeds.getReservation`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<CloudbedsReservation>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"reservationToken":{"type":"string"}},"required":["reservationToken"],"additionalProperties":true,"description":"TypeScript: `{ reservationToken: string }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}},"CloudbedsBookRoomArgs":{"type":"object","properties":{"property":{"type":"string"},"checkIn":{"type":"string"},"checkOut":{"type":"string"},"rooms":{"type":"array","items":{"type":"object","properties":{"rateId":{"type":"string"},"adults":{"type":"number"},"kids":{"type":"number"}},"required":["rateId","adults"],"additionalProperties":true}},"guest":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"country":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"required":["firstName","lastName","email","phone","country"],"additionalProperties":true},"arrivalTime":{"type":"string"},"promoCode":{"type":"string"},"currency":{"type":"string"},"confirm":{"type":"boolean"}},"required":["property","checkIn","checkOut","rooms","guest"],"additionalProperties":true},"CloudbedsBookingQuoteArgs":{"type":"object","properties":{"property":{"type":"string"},"checkIn":{"type":"string"},"checkOut":{"type":"string"},"rooms":{"type":"array","items":{"type":"object","properties":{"rateId":{"type":"string"},"adults":{"type":"number"},"kids":{"type":"number"}},"required":["rateId","adults"],"additionalProperties":true}},"currency":{"type":"string"},"promoCode":{"type":"string"}},"required":["property","checkIn","checkOut","rooms"],"additionalProperties":true},"CloudbedsCalendarArgs":{"type":"object","properties":{"property":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"promoCode":{"type":"string"}},"required":["property","startDate","endDate"],"additionalProperties":true},"CloudbedsSearchRoomsArgs":{"type":"object","properties":{"property":{"type":"string"},"checkIn":{"type":"string"},"checkOut":{"type":"string"},"currency":{"type":"string"},"promoCode":{"type":"string"}},"required":["property","checkIn","checkOut"],"additionalProperties":true}}}}