BookingKoala by Cotlet

The 40 tools it listed

"Read only" and "Changes data" are the server's own marks. Underlined parameters are required.

1. assign_providerChanges data

   Assign provider

   Assign a provider or team to a booking, or to its whole recurring schedule. Puts the provider on the booking, as Assign in the booking's sidebar does, and returns the booking as get_booking shows it. BookingKoala tells the provider about the job. A provider who is not available at that time is refused unless even_if_unavailable is true. Waits for the owner's approval.

   booking_id provider_id whole_schedule even_if_unavailable

2. cancel_bookingChanges data

   Cancel booking

   Cancel one booking or its whole recurring schedule, without a cancellation fee. Checks the store's cancellation rules first (a store that requires a reason gets the 'Other' reason with your text), then cancels as Cancel in the booking's sidebar does, with no fee. Nobody is told unless notify is true. Cancelled bookings leave list_bookings. Waits for the owner's approval.

   notify reason booking_id whole_schedule

3. cotlet_app_guideRead only

   Cotlet: how to work in an app

   How to work in an app by clicking in the user's Cloud Browser with Cotlet's browser tools: which browser to use for this workspace and the sign-in link, the method step by step, the app's screens, menus and actions, notes, and the app's dedicated tools when Cotlet has them. Call it before the first browser step in an app. Works for any web app; one outside Cotlet's catalog gets the general method. Free, no browser session.

   app task

4. cotlet_appsRead only

   Cotlet: apps I can use

   The apps of the user's workspace and whether each works now: access granted or requested, the app account in the user's Cloud Browser (connected, signed out, signed in but not connected), and the one step the user has to take, with the console link. Free. Needs the user's Cotlet API key or sign-in.

   app

5. cotlet_browser_backRead only

   Go back a page

   Goes back one page in the user's BookingKoala Cloud Browser, like the browser's Back button (with `forward`, forward again). Returns the URL and title. Run browser steps one at a time and wait for each answer; steps sent together run in no set order. Every started minute of the session costs credits; it ends when closed or 3 minutes after the last call in the browser.

   forward

6. cotlet_browser_clickChanges data

   Click on the page

   Clicks a link, button, option or other element of the current page in the user's BookingKoala Cloud Browser, by its number in the page's element list, or a point of the screenshot (`x`, `y`) for boards, canvases and maps. Returns the URL and title after the click, and says when nothing on the page changed. It acts as the user on that site. Buttons that pay or buy and buttons on account or sign-in pages are refused. Run browser steps one at a time and wait for each answer; steps sent together run in no set order. Every started minute of the session costs credits; it ends when closed or 3 minutes after the last call in the browser.

   element x y double

7. cotlet_browser_close

   Close the browser

   Ends the session in the user's BookingKoala Cloud Browser: the browser keeps its cookies, goes to sleep and the per-minute charge stops. Returns the session's minutes and credits.

8. cotlet_browser_dragChanges data

   Drag on the page

   Drags from one element or point of the screenshot to another in the user's BookingKoala Cloud Browser: a piece on a board, a card between columns, a field into a form builder, a slider's handle. Run browser steps one at a time and wait for each answer; steps sent together run in no set order. Every started minute of the session costs credits; it ends when closed or 3 minutes after the last call in the browser.

   from to

9. cotlet_browser_hoverRead only

   Point at the page

   Rests the pointer on an element of the current page (or a point of the screenshot) in the user's BookingKoala Cloud Browser, as a person does to open a hover menu, a tooltip or a card's preview. Read after it for what opened. Run browser steps one at a time and wait for each answer; steps sent together run in no set order. Every started minute of the session costs credits; it ends when closed or 3 minutes after the last call in the browser.

   element x y

10. cotlet_browser_navigateRead only

    Go to a page

    Opens a public http or https address in the user's BookingKoala Cloud Browser and returns the URL and title it ended on. Only BookingKoala pages open. Run browser steps one at a time and wait for each answer; steps sent together run in no set order. Every started minute of the session costs credits; it ends when closed or 3 minutes after the last call in the browser.

    url

11. cotlet_browser_openRead only

    Open the browser

    Wakes the user's BookingKoala Cloud Browser, a real Chrome hosted on Cotlet and signed in to BookingKoala as the user. Use it for what the BookingKoala tools do not cover. Opens `url` when given and returns the page's URL and title. The user watches every step live. Before the first step in an app, Cotlet's app guide says which browser to use and how to work in the app. Run browser steps one at a time and wait for each answer; steps sent together run in no set order. Every started minute of the session costs credits; it ends when closed or 3 minutes after the last call in the browser.

    url

12. cotlet_browser_pressChanges data

    Press a key

    Presses a key on the current page in the user's BookingKoala Cloud Browser, on the element that has focus: Tab to the next field, Enter to send, Escape to close a dialog or pop-up, arrows to move through a suggestion list or a slider, or one character (a site's shortcut). Returns the URL and title after it, and says when nothing changed. Enter on account pages and characters into password fields are refused. Run browser steps one at a time and wait for each answer; steps sent together run in no set order. Every started minute of the session costs credits; it ends when closed or 3 minutes after the last call in the browser.

    key repeat

13. cotlet_browser_readRead only

    Read the page

    Returns the current page of the user's BookingKoala Cloud Browser: its readable text, up to 20,000 characters, and a numbered list of its links, buttons, fields, options and toggles, also inside frames. Open dialogs and cookie banners come first: they cover the page, so close or answer them first. Field values, cookies and storage are never returned. On a page longer than that, both start near where it is scrolled to; `element` reads only the part inside that element (a dialog, a form, a list). Run browser steps one at a time and wait for each answer; steps sent together run in no set order. Every started minute of the session costs credits; it ends when closed or 3 minutes after the last call in the browser.

    element

14. cotlet_browser_screenshotRead only

    See the page

    Returns a JPEG image of the visible part of the current page in the user's BookingKoala Cloud Browser, with its URL and title: boards, canvases and layouts that the page text does not show. Run browser steps one at a time and wait for each answer; steps sent together run in no set order. Every started minute of the session costs credits; it ends when closed or 3 minutes after the last call in the browser.

15. cotlet_browser_scrollRead only

    Scroll the page

    Scrolls the current page in the user's BookingKoala Cloud Browser with the mouse wheel, as a person does: down or up by `screens` viewport heights (default 0.8), to the top or the bottom, or until element `element` is in view. Content that loads on scroll appears, and the next read lists it. Returns the URL, title and scroll position (at_top, at_bottom). Run browser steps one at a time and wait for each answer; steps sent together run in no set order. Every started minute of the session costs credits; it ends when closed or 3 minutes after the last call in the browser.

    direction screens element inside

16. cotlet_browser_selectChanges data

    Choose from a list

    Chooses an option of a drop-down list on the current page in the user's BookingKoala Cloud Browser, by the list's number in the element list and the option's label as read lists it (or its value). Returns the URL and title after it. Card fields and account pages are refused. Run browser steps one at a time and wait for each answer; steps sent together run in no set order. Every started minute of the session costs credits; it ends when closed or 3 minutes after the last call in the browser.

    element option

17. cotlet_browser_typeChanges data

    Type on the page

    Types text into a field of the current page in the user's BookingKoala Cloud Browser, by the field's number in the page's element list, and with `submit` presses Enter. Returns the URL and title after it. Password, card and one-time code fields and sign-in pages are refused: the user fills those in themselves. Run browser steps one at a time and wait for each answer; steps sent together run in no set order. Every started minute of the session costs credits; it ends when closed or 3 minutes after the last call in the browser.

    element text submit slowly

18. cotlet_browser_uploadChanges data

    Upload a file

    Puts files into a file field of the current page in the user's BookingKoala Cloud Browser, or into the file picker that an upload button opens, by its number in the element list. A file is given as {"url": "https://..."} for a file online or {"file_id": "..."} for one uploaded to Cotlet first; up to 10 files, 20 MB each. Returns the URL and title after it. Run browser steps one at a time and wait for each answer; steps sent together run in no set order. Every started minute of the session costs credits; it ends when closed or 3 minutes after the last call in the browser.

    element files

19. cotlet_browser_waitRead only

    Wait for the page

    Waits until `text` shows on the current page in the user's BookingKoala Cloud Browser (at most `seconds`, default 5, up to 20), or just `seconds` without text: for results, prices or a page that load slowly. Says whether the text appeared. Run browser steps one at a time and wait for each answer; steps sent together run in no set order. Every started minute of the session costs credits; it ends when closed or 3 minutes after the last call in the browser.

    text seconds

20. cotlet_get_callRead only

    Cotlet: check a call

    Status of an earlier Cotlet call, by its call_id: pending (waits for the owner's approval in the Cotlet console), approved, running, success, rejected, expired, blocked or failed. For a call that answered with status pending or running.

    call_id

21. cotlet_report_issue

    Cotlet: report a bug or a missing feature

    Sends a report straight to the Cotlet team: a tool that failed or returned wrong data, an error you could not get past, or a tool, field or app the task needed and Cotlet lacks. The report carries the error text and call_id when there is one, never passwords or tokens. Needs the user's Cotlet API key or sign-in.

    kind title description app tool call_id client

22. cotlet_request_apps

    Cotlet: request access to apps

    Requests access to apps for the user's workspace, as Request access in the console: every app is granted at once. An app with dedicated tools gets them after the user signs in to it in their Cloud Browser; any other works now in the user's Web browser with cotlet_app_guide, and the Cotlet team builds its dedicated tools on demand. Takes app slugs as listed at https://cotlet.dev/api/v1/apps. Free. Needs the user's Cotlet API key or sign-in.

    apps use_case

23. cotlet_upload_file

    Cotlet: upload a file for a tool

    Returns a one-time upload_url and a file_id for a local file (an image for a post, an attachment). The file is sent to upload_url with an HTTP PUT; an argument that takes a file accepts {"file_id": "..."}. Up to 25 MB, the URL works once. Free. Needs the user's Cotlet API key or sign-in.

    name content_type

24. cotlet_whoamiRead only

    Cotlet: who am I

    The Cotlet account this connection acts as: email, workspace, access status, the API key or OAuth client in use with its scope, the apps the workspace may call and its credit balance. Free. Needs the user's Cotlet API key or sign-in.

25. create_bookingChanges data

    Create booking

    Start a new booking as a copy of an existing one: same customer, service and price. Copies the booking as Duplicate in its sidebar does. The copy is saved as a draft (list_drafts) with the same customer, address, service, extras and price; open form_url to pick the date and book it. Nobody is told until it is booked.

    from_booking_id

26. create_customerChanges data

    Create customer

    New customer in the store. BookingKoala emails them an invitation to set a password. Adds a customer as Add Customer in the admin does, with an optional address that becomes their default service address. BookingKoala emails the customer at once to set a password for the store's booking page, so use their real address. An email already in the store is refused. Returns the new customer as get_customer does. Waits for the owner's approval.

    apt city email phone state gender address country zipcode last_name first_name sms_notifications

27. dashboardRead only

    Dashboard

    Store totals for a date range: revenue, provider pay, bookings, ratings, referrals. Returns the figures of the admin Dashboard for the dates given (this month by default): revenue paid and pending, split into bookings, custom invoices and separate charges; what providers earned and what is still unpaid; booking counts, unassigned and cancelled included; ratings and referrals. Amounts are in the store's currency.

    end_date start_date

28. get_bookingRead only

    Get booking

    One booking with its price breakdown, provider pay, notes and service. Reads a booking by id: date and arrival window, customer, address, assigned providers, the service parameters and extras, notes, the price breakdown (service total, discounts, tax, tip, final amount) and what the providers are paid for it.

    booking_id

29. get_customerRead only

    Get customer

    One customer: contact details, addresses, booking counts and bookings not charged yet. Returns the customer's profile as their page in the admin shows it: name, email, phone, saved addresses (address_id is what a booking or invoice for this customer uses), counts of upcoming and cash bookings, the bookings not charged yet (past ones included), gift cards received and the referral summary. Times of day are in the store's time zone.

    customer_id

30. get_providerRead only

    Get provider

    One provider or team: contact, category, team members, reviews and payment logs. Returns the provider's profile as their page in the admin shows it: contact details, IC or W2 category, priority, scheduling permissions, the team's members and lead (for a team) or the teams it belongs to, customer reviews and the newest payment logs (what the store paid the provider). Payment logs come as BookingKoala records them.

    provider_id payment_logs_limit

31. list_bookingsRead only

    List bookings

    Bookings of the store: upcoming, unassigned, completed, charge pending or declined. Lists bookings as the Bookings page shows them, newest schedule dates first within the filter, with the customer, address, assigned providers, total and whether it is charged. Filter by status, date range, a search on the customer, or one customer or provider. Cancelled bookings are not listed. Page with next_cursor.

    limit cursor search status end_date start_date customer_id provider_id

32. list_chargesRead only

    List charges

    Charged bookings with their payments and refunds, as the Charges page lists them. Returns bookings that were charged, newest first, each with its payments: the booking charge, extras, tips, fees and refunds, with amount, tax, refunded amount and card. Filter by booking day and search by customer. BookingKoala gives no total: next_cursor is set while a full page comes back. booking_id and payment_log_id go to refund_charge. Empty until the store charges through a connected payment processor or marks bookings paid in cash.

    limit cursor search end_date start_date

33. list_customersRead only

    List customers

    Customers of the store, with email and phone; search by name, email or phone. Returns the store's customers as the Customers page lists them, newest first, active or deactivated. BookingKoala gives no total: next_cursor is set while a full page comes back. Use customer_id in get_customer.

    limit cursor search status

34. list_draftsRead only

    List drafts

    Draft bookings and quotes saved in the store, not yet booked. Lists the drafts and quotes on the Drafts page: customer, date when set, total and whether it is a quote. create_booking leaves a draft here. Page with next_cursor.

    limit cursor search

35. list_invoicesRead only

    List invoices

    Invoices of the store or of one customer, with payment status, total and amount due. Returns invoices as the Invoices page lists them, newest first: number, customer, booking or custom type, payment status (paid, unpaid, partially_paid, void, uncollectible), total, paid, amount due, issue and due dates. Filter by customer, payment status and issue dates (default: two years back to a year ahead), or search by number, email, name or phone. BookingKoala gives no total: next_cursor is set while a full page comes back. invoice_id goes to resend_invoice.

    limit cursor search end_date pay_status start_date customer_id

36. list_providersRead only

    List providers

    Providers (cleaners, technicians) and teams of the store, in priority order. Returns the store's service providers as the Providers page lists them, single providers and teams together; type team returns teams only. A team lists its members' provider ids, a provider the teams it belongs to and leads. BookingKoala gives no total: next_cursor is set while a full page comes back. Use provider_id in get_provider and when assigning a booking.

    type limit cursor search status

37. refund_chargeChanges data

    Refund a charge

    Refund a paid booking charge, extra, tip or fee to the customer's card, in full or in part. Refunds one payment from list_charges (payment_log_id and its booking_id) through the store's payment processor, as the Refund popup of the Charges page does. amount includes tax and defaults to what is not refunded yet; less than that is a partial refund. Cancellation and reschedule fees are refunded only in full. The customer is not emailed unless notify_customer is true. Refused before you confirm when the store has no payment processor, the payment is not paid or the amount is too large. A booking paid partly with a gift card or referral credit is refunded in the panel. Money goes back to the customer and cannot be taken back. By default you confirm each call; you can switch that off for this tool. Waits for the owner's approval.

    amount reason booking_id payment_log_id notify_customer

38. reschedule_bookingChanges data

    Reschedule booking

    Postpone a visit of a recurring booking to the date of a later visit in its schedule. Works like Postpone in the booking's sidebar: the visit moves to one of the schedule's later visit dates, keeping its arrival time and price, and the booking comes back as get_booking shows it. A date outside the schedule fails with the list of allowed dates. One-time bookings cannot be postponed. Nobody is told unless notify is true. A store that charges a reschedule fee refuses the move here: charge it in the panel. Waits for the owner's approval.

    date notify booking_id

39. resend_invoiceChanges data

    Resend an invoice

    Send an invoice to its customer again by email, text or both. Sends an existing invoice from list_invoices to its customer again, as the invoice's Resend button does: by email (default) and, with sms true, a text with the invoice link. The invoice's CC and billing addresses get the email too. attach_pdf defaults to the invoice's own setting. The invoice itself does not change. The customer gets it at once. BookingKoala refuses some resends with a warning, for example a void invoice; the error carries its message. By default you confirm each call; you can switch that off for this tool. Waits for the owner's approval.

    sms email attach_pdf invoice_id

40. send_quoteChanges data

    Send a quote

    Email a saved quote to the customer with a link to book it. Sends a quote from list_drafts as the Send quote popup does: saves the recipient and expiry date on the quote, then emails the store's Send quote template (or your subject and message) with the quote's booking link. email defaults to the quote's customer; expires_on to the saved date, else a month ahead. Only drafts saved as quotes can be sent; a plain draft is refused before you confirm. The customer gets the email at once. By default you confirm each call; you can switch that off for this tool. Waits for the owner's approval.

    email message subject draft_id expires_on