Booksy MCP server for AI agents

Let Claude, ChatGPT or your own agent read and act on Booksy: 23 typed functions through one MCP server. No Booksy API key needed.

Functions
23
Sign-in
For account actions
Works with
MCP, HTTP, Node, Python

Connect

Just Booksy

An MCP server for Booksy alone, with one tool per function. Paste it into Claude, ChatGPT, Cursor or any MCP client as a remote server.

https://api.bowmark.ai/mcp/site/booksy
Every site

One MCP server for Booksy and every other site Bowmark covers. Your agent looks up what it needs and calls it.

https://api.bowmark.ai/mcp
Set it up in your client

Both need a Bowmark API key. The quickstart gets you one and a first result in a few minutes. Functions that need a login use the person's own account: how sign-in works.

Functions

Open a function to see its arguments, what it returns and how to call it.

Read 17
  • getAvailabilityReturns the open appointment times for one service at one business over a date range, optionally with a chosen staff member: per day, the bookable…

    Arguments

    NameTypeRequired
    businessnumber | stringYes
    serviceVariantIdnumber
    A service variant id from getBusiness.
    Yes
    startDatestring
    "YYYY-MM-DD".
    Yes
    endDatestring
    "YYYY-MM-DD", default startDate.
    No
    staffIdnumber
    A staff member id from getBusiness, default any ("autoassign").
    No
    countrystringNo

    Returns booksyAvailability

    interface booksyAvailability {
      business: number;
      serviceVariantId: number;
      staffId: number;
      days: { date: string | null; times: string[] }[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/getAvailability

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.getAvailability({
      business: 110442,
      serviceVariantId: 4546809,
      startDate: { $daysFromNow: 1 }
    });
  • getBookingQuotePrices an appointment before booking it: the service, start and end time, the staff member assigned, the total, any deposit or prepayment the…

    Arguments

    NameTypeRequired
    businessnumber | stringYes
    serviceVariantIdnumber
    A service variant id from getBusiness.
    Yes
    startTimestring
    A start time from getAvailability's days[].times, "YYYY-MM-DDTHH:MM".
    Yes
    staffIdnumberNo
    countrystringNo

    Returns booksyBookingQuote

    interface booksyBookingQuote {
      business: number;
      serviceVariantId: number;
      serviceName: string | null;
      startTime: string | null;
      endTime: string | null;
      currency: string | null;
      total: number | null;
      /** What this booking would charge now; $0 for a pay-at-business appointment. */
      payableNow: number | null;
      /** The card hold forfeit on a late cancellation or no-show, if the business takes one. */
      cancellationFee: number | null;
      prepayment: number | null;
      /** Always null, a dry run creates nothing. */
      appointmentUid: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/getBookingQuote

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.getBookingQuote({
      business: 1,
      serviceVariantId: 1,
      startTime: "<startTime>"
    });
  • getBusinessReturns one business from its id or its booksy.com page URL: name, description, address and coordinates, opening hours and exceptions, staff, the…

    Arguments

    NameTypeRequired
    businessnumber | string
    A Booksy business id (110442) or its booksy.com page URL.
    Yes
    countrystringNo

    Returns booksyBusiness

    interface booksyServiceSummary {
      id: number;
      name: string | null;
      price: string | null;
      durationMinutes: number | null;
    }
    
    interface booksyBusinessCard {
      /** Pass back as `business`. */
      id: number;
      name: string | null;
      url: string | null;
    
      checkout: booksyCheckout | null;
      primaryCategoryId: number | null;
      address: string | null;
      city: string | null;
      latitude: number | null;
      longitude: number | null;
      rating: number | null;
      reviewsCount: number | null;
      imageUrl: string | null;
      promoted: boolean;
      acceptsBooksyPay: boolean;
      services: booksyServiceSummary[];
    }
    
    interface booksyVariant {
      /** The service variant id getAvailability and getBookingQuote take. */
      id: number;
      label: string | null;
      durationMinutes: number | null;
      price: number | null;
      priceText: string | null;
      deposit: number | null;
      prepayment: number | null;
      staff: { id: number; name: string | null }[];
    }
    
    interface booksyBusiness extends booksyBusinessCard {
      description: string | null;
      website: string | null;
      instagram: string | null;
      facebook: string | null;
      openingHours: { day: string; open: string | null; close: string | null }[];
      openingHoursNote: string | null;
      staff: { id: number; name: string | null; description: string | null; photoUrl: string | null }[];
      serviceCategories: {
        name: string | null;
        services: { id: number; name: string | null; description: string | null; treatment: string | null; bookableOnline: boolean; variants: booksyVariant[] }[];
      }[];
      bookingPolicy: string | null;
      depositPolicy: string | null;
      waitlistEnabled: boolean;
      amenities: string[];
      parking: string | null;
      wheelchairAccess: string | null;
    }
    
    interface booksyCheckout {
      status: "ready_to_checkout" | "needs_login" | "unavailable";
      /** Always https, on the studio's own site. */
      url: string;
      /** ready_to_checkout only: carries_items opens this very slot, product_page opens the studio's schedule. */
      urlKind?: "carries_items" | "signed_in_cart" | "product_page";
      /** unavailable only: out_of_stock (class full, no waitlist) or not_available_for_dates (cancelled). */
      reason?: string;
      detail?: string;
      account: { site: string; hint: string; signedInAs?: string; signInUrl?: string };
      summary: {
        items: { title: string; variant: string | null; quantity: number; unitPrice: string | null; lineTotal: string | null; url?: string; id?: string }[];
        total: string | null;
        currency: string;
        /** ISO start/end of the class or slot, with the studio's UTC offset when the site gives one. */
        dates?: { start: string; end?: string };
      } | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/getBusiness

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.getBusiness({ business: 110442 });
  • getBusinessContactReturns a business's contact email, which Booksy shows only to a signed-in customer.

    Arguments

    NameTypeRequired
    businessnumber | string
    A business id, or its booksy.com page URL.
    Yes
    countrystringNo

    Returns booksyBusinessContact

    interface booksyBusinessContact {
      business: number;
      /** Null when the business shows no email. */
      email: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/getBusinessContact

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.getBusinessContact({ business: 110442 });
  • getBusinessNetworkNames the Booksy network a business belongs to (a chain or curated group) and lists its member businesses' ids, so a caller can read each with…

    Arguments

    NameTypeRequired
    businessnumber | stringYes
    countrystringNo

    Returns booksyBusinessNetwork

    interface booksyBusinessNetwork {
      business: number;
      country: string;
      network: { name: string | null; slug: string; businessIds: number[] } | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/getBusinessNetwork

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.getBusinessNetwork({ business: 8122, country: "pl" });
  • getBusinessPhotosLists a business's portfolio and venue photos, and the photos customers attached to reviews.

    Arguments

    NameTypeRequired
    businessnumber | stringYes
    pagenumber
    1-based, applies to the main gallery only -- review photos are always returned in full.
    No
    limitnumber
    1-50, default 20.
    No
    countrystringNo

    Returns booksyBusinessPhotos

    interface booksyPhoto {
      id: number;
      url: string | null;
      /** The site's own album, e.g. "biz_photo", "portfolio", "message_blast_photo". */
      category: string | null;
      isCoverPhoto: boolean;
      width: number | null;
      height: number | null;
    }
    
    interface booksyReviewPhoto {
      id: number;
      url: string | null;
      reviewId: number | null;
      reviewText: string | null;
    }
    
    interface booksyBusinessPhotos {
      business: number;
      page: number;
      total: number | null;
      photos: booksyPhoto[];
      reviewPhotosTotal: number | null;
      reviewPhotos: booksyReviewPhoto[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/getBusinessPhotos

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.getBusinessPhotos({ business: 110442, limit: 5 });
  • getBusinessReviewsLists a business's customer reviews, newest first: rating, text, date, the service and staff member reviewed, reply from the business and photos.

    Arguments

    NameTypeRequired
    businessnumber | stringYes
    pagenumber
    1-based.
    No
    limitnumber
    1-50, default 10.
    No
    countrystringNo

    Returns booksyBusinessReviews

    interface booksyReview {
      id: number;
      rating: number | null;
      text: string | null;
      createdAt: string | null;
      appointmentDate: string | null;
      verified: boolean;
      services: { id: number; name: string | null }[];
      staff: { id: number; name: string | null }[];
      reviewerFirstName: string | null;
      /** The business's own reply, if any. */
      reply: string | null;
      photos: unknown[];
    }
    
    interface booksyBusinessReviews {
      business: number;
      page: number;
      total: number | null;
      averageRating: number | null;
      reviews: booksyReview[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/getBusinessReviews

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.getBusinessReviews({ business: 110442, limit: 5 });
  • getMyAppointmentReturns one of the signed-in caller's appointments in full: service, time, staff, price paid or due, cancellation deadline and status.

    Arguments

    NameTypeRequired
    appointmentUidstring | number
    An appointmentUid from listMyBookings.
    Yes
    countrystringNo

    Returns booksyMyAppointment

    interface booksyMyAppointment {
      /** The id getMyAppointment and cancelAppointment take; null on a dry run. */
      appointmentUid: string | null;
      /** accepted, cancelled, finished, no_show, pending_payment, awaiting_confirmation, rejected, or Booksy's own code. */
      status: string | null;
      statusCode: string | null;
      startTime: string | null;
      endTime: string | null;
      currency: string | null;
      total: number | null;
      payableNow: number | null;
      cancellationFee: number | null;
      prepayment: number | null;
      business: { id: number | null; name: string | null; address: string | null } | null;
      services: { serviceId: number | null; serviceName: string | null; serviceVariantId: number | null; startTime: string | null; endTime: string | null; staffId: number | null; staffName: string | null }[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/getMyAppointment

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.getMyAppointment({ appointmentUid: 1 });
  • getMyProfileReturns the signed-in caller's Booksy profile: name, email, phone, photo and notification settings.

    Arguments

    NameTypeRequired
    countrystringNo

    Returns booksyMyProfile

    interface booksyMyProfile {
      id: number | null;
      firstName: string | null;
      lastName: string | null;
      email: string | null;
      phone: string | null;
      birthday: string | null;
      gender: string | null;
      address: { line1: string | null; line2: string | null; apartment: string | null; city: string | null; zipcode: string | null };
      photo: string | null;
      language: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/getMyProfile

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.getMyProfile({});
  • getSearchSuggestionsTurns what a caller typed ("skin fade", "gel nails", a business name) into Booksy's own search suggestions -- treatments and businesses with the ids…

    Arguments

    NameTypeRequired
    textstring
    What a caller is typing, e.g. "skin fade".
    Yes
    countrystringNo

    Returns booksyGetSearchSuggestionsResult

    interface booksySuggestion {
      type: string | null;
      label: string | null;
      /** A treatment or category id (searchBusinesses' treatmentId/categoryId), or a business id. */
      id: number | null;
      slug: string | null;
      /** Present only on a treatment suggestion. */
      treatmentType: string | null;
      /** Present only on a business suggestion; pass to getBusiness as `business`. */
      businessUrl: string | null;
    }
    
    interface booksyGetSearchSuggestionsResult {
      text: string;
      suggestions: booksySuggestion[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/getSearchSuggestions

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.getSearchSuggestions({ text: "fade" });
  • listCategoriesLists Booksy's top-level business categories (Hair, Barber, Nails, Skin Care...), the ids searchBusinesses' categoryId filters by.

    Arguments

    NameTypeRequired
    countrystringNo

    Returns booksyListCategoriesResult

    interface booksyCategory {
      /** The id searchBusinesses' categoryId takes. */
      id: number;
      name: string | null;
      iconUrl: string | null;
    }
    
    interface booksyListCategoriesResult {
      country: string;
      categories: booksyCategory[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/listCategories

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.listCategories({});
  • listFavoritesLists the businesses the signed-in caller has saved as favourites.

    Arguments

    NameTypeRequired
    pagenumberNo
    limitnumber
    1-50, default 20.
    No
    countrystringNo

    Returns booksyFavorites

    interface booksyServiceSummary {
      id: number;
      name: string | null;
      price: string | null;
      durationMinutes: number | null;
    }
    
    interface booksyBusinessCard {
      /** Pass back as `business`. */
      id: number;
      name: string | null;
      url: string | null;
    
      checkout: booksyCheckout | null;
      primaryCategoryId: number | null;
      address: string | null;
      city: string | null;
      latitude: number | null;
      longitude: number | null;
      rating: number | null;
      reviewsCount: number | null;
      imageUrl: string | null;
      promoted: boolean;
      acceptsBooksyPay: boolean;
      services: booksyServiceSummary[];
    }
    
    interface booksyCheckout {
      status: "ready_to_checkout" | "needs_login" | "unavailable";
      /** Always https, on the studio's own site. */
      url: string;
      /** ready_to_checkout only: carries_items opens this very slot, product_page opens the studio's schedule. */
      urlKind?: "carries_items" | "signed_in_cart" | "product_page";
      /** unavailable only: out_of_stock (class full, no waitlist) or not_available_for_dates (cancelled). */
      reason?: string;
      detail?: string;
      account: { site: string; hint: string; signedInAs?: string; signInUrl?: string };
      summary: {
        items: { title: string; variant: string | null; quantity: number; unitPrice: string | null; lineTotal: string | null; url?: string; id?: string }[];
        total: string | null;
        currency: string;
        /** ISO start/end of the class or slot, with the studio's UTC offset when the site gives one. */
        dates?: { start: string; end?: string };
      } | null;
      warnings: string[];
    }
    
    interface booksyFavorites {
      page: number;
      total: number | null;
      businesses: booksyBusinessCard[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/listFavorites

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.listFavorites({});
  • listGiftCardOffersLists the gift cards and vouchers a business sells online: name, value, price, validity and the services each covers.

    Arguments

    NameTypeRequired
    businessnumber | stringYes
    countrystringNo

    Returns booksyGiftCardOffers

    interface booksyGiftCardOffer {
      id: number;
      name: string | null;
      value: number | null;
      price: number | null;
      validUntil: string | null;
      description: string | null;
      services: { id: number; name: string | null }[];
    }
    
    interface booksyGiftCardOffers {
      business: number;
      total: number | null;
      offers: booksyGiftCardOffer[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/listGiftCardOffers

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.listGiftCardOffers({ business: 110442 });
  • listMyBookingsLists the signed-in caller's upcoming and past Booksy appointments: business, service, time, staff, status and the appointment id the other account…

    Arguments

    NameTypeRequired
    state"upcoming" | "past"
    "upcoming" or "past"; omit for both.
    No
    pagenumberNo
    limitnumber
    1-50, default 20.
    No
    countrystringNo

    Returns booksyMyBookings

    interface booksyMyAppointment {
      /** The id getMyAppointment and cancelAppointment take; null on a dry run. */
      appointmentUid: string | null;
      /** accepted, cancelled, finished, no_show, pending_payment, awaiting_confirmation, rejected, or Booksy's own code. */
      status: string | null;
      statusCode: string | null;
      startTime: string | null;
      endTime: string | null;
      currency: string | null;
      total: number | null;
      payableNow: number | null;
      cancellationFee: number | null;
      prepayment: number | null;
      business: { id: number | null; name: string | null; address: string | null } | null;
      services: { serviceId: number | null; serviceName: string | null; serviceVariantId: number | null; startTime: string | null; endTime: string | null; staffId: number | null; staffName: string | null }[];
    }
    
    interface booksyMyBookings {
      page: number;
      total: number | null;
      bookings: booksyMyAppointment[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/listMyBookings

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.listMyBookings({});
  • listMyGiftCardsLists the gift cards and vouchers the signed-in caller holds, with balance and validity.

    Arguments

    NameTypeRequired
    pagenumberNo
    countrystringNo

    Returns booksyMyGiftCards

    interface booksyMyGiftCard {
      id: number | null;
      name: string | null;
      code: string | null;
      status: string | null;
      price: number | null;
      value: number | null;
      /** What is left to spend. */
      balance: number | null;
      validTill: string | null;
      business: { id: number | null; name: string | null; address: string | null } | null;
      services: { serviceVariantId: number | null; name: string | null }[];
    }
    
    interface booksyMyGiftCards {
      page: number;
      total: number | null;
      hasMore: boolean;
      giftCards: booksyMyGiftCard[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/listMyGiftCards

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.listMyGiftCards({});
  • resolveLocationResolves a place a caller names ("Brooklyn", a street address) into the Booksy region id and coordinates searchBusinesses takes, with street…

    Arguments

    NameTypeRequired
    querystring
    A city, neighbourhood or street address, e.g. "Brooklyn".
    Yes
    countrystring
    Booksy country subdomain, default "us".
    No

    Returns booksyLocation

    interface booksyLocation {
      query: string;
      country: string;
      matched: boolean;
      formattedAddress: string | null;
      latitude: number | null;
      longitude: number | null;
      type: string | null;
      /** `region.id` is the `locationId` searchBusinesses takes. */
      region: { id: number; name: string | null; fullName: string | null; slug: string | null; type: string | null } | null;
      /** Street and place completions for a partial query. */
      suggestions: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/resolveLocation

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.resolveLocation({ query: "Brooklyn" });
  • searchBusinessesSearches Booksy's marketplace for businesses (barbers, salons, spas, nail, massage, tattoo...) by free text, category or treatment, near a place or…

    Arguments

    NameTypeRequired
    querystring
    Free text: a treatment, a business name.
    No
    categoryIdnumber
    Booksy category id, e.g. 6 = Barber.
    No
    treatmentIdnumberNo
    locationIdnumber
    Region id from resolveLocation.
    No
    latitudenumberNo
    longitudenumberNo
    openNowbooleanNo
    hasOnlineServicesbooleanNo
    pagenumber
    1-based.
    No
    limitnumber
    1-50, default 20.
    No
    countrystringNo

    Returns booksyBusinessPage

    interface booksyServiceSummary {
      id: number;
      name: string | null;
      price: string | null;
      durationMinutes: number | null;
    }
    
    interface booksyBusinessCard {
      /** Pass back as `business`. */
      id: number;
      name: string | null;
      url: string | null;
    
      checkout: booksyCheckout | null;
      primaryCategoryId: number | null;
      address: string | null;
      city: string | null;
      latitude: number | null;
      longitude: number | null;
      rating: number | null;
      reviewsCount: number | null;
      imageUrl: string | null;
      promoted: boolean;
      acceptsBooksyPay: boolean;
      services: booksyServiceSummary[];
    }
    
    interface booksyBusinessPage {
      country: string;
      page: number;
      total: number | null;
      location: { id: number; name: string | null; type: string | null } | null;
      businesses: booksyBusinessCard[];
    }
    
    interface booksyCheckout {
      status: "ready_to_checkout" | "needs_login" | "unavailable";
      /** Always https, on the studio's own site. */
      url: string;
      /** ready_to_checkout only: carries_items opens this very slot, product_page opens the studio's schedule. */
      urlKind?: "carries_items" | "signed_in_cart" | "product_page";
      /** unavailable only: out_of_stock (class full, no waitlist) or not_available_for_dates (cancelled). */
      reason?: string;
      detail?: string;
      account: { site: string; hint: string; signedInAs?: string; signInUrl?: string };
      summary: {
        items: { title: string; variant: string | null; quantity: number; unitPrice: string | null; lineTotal: string | null; url?: string; id?: string }[];
        total: string | null;
        currency: string;
        /** ISO start/end of the class or slot, with the studio's UTC offset when the site gives one. */
        dates?: { start: string; end?: string };
      } | null;
      warnings: string[];
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/searchBusinesses

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.searchBusinesses({ categoryId: 6, locationId: 29902, limit: 5 });
Act 6
  • addFavoriteSaves a business to the signed-in caller's favourites.

    Arguments

    NameTypeRequired
    businessnumber | string
    A business id, or its booksy.com page URL.
    Yes
    countrystringNo

    Returns booksyFavoriteResult

    interface booksyFavoriteResult {
      business: number;
      /** True after addFavorite, false after removeFavorite. */
      favorite: boolean;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/addFavorite

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.addFavorite({ business: 1 });
  • bookAppointmentBooks an appointment for the signed-in caller: a service variant at a start time, with a chosen staff member or anyone, plus a note to the business.

    Arguments

    NameTypeRequired
    businessnumber | stringYes
    serviceVariantIdnumber
    A variant id from getBusiness.
    Yes
    startTimestring
    "YYYY-MM-DDTHH:MM", a time from getAvailability.
    Yes
    staffIdnumber
    A staff member id from getBusiness; omit for anyone.
    No
    notestring
    A note to the business.
    No
    countrystringNo

    Returns booksyBookedAppointment

    interface booksyMyAppointment {
      /** The id getMyAppointment and cancelAppointment take; null on a dry run. */
      appointmentUid: string | null;
      /** accepted, cancelled, finished, no_show, pending_payment, awaiting_confirmation, rejected, or Booksy's own code. */
      status: string | null;
      statusCode: string | null;
      startTime: string | null;
      endTime: string | null;
      currency: string | null;
      total: number | null;
      payableNow: number | null;
      cancellationFee: number | null;
      prepayment: number | null;
      business: { id: number | null; name: string | null; address: string | null } | null;
      services: { serviceId: number | null; serviceName: string | null; serviceVariantId: number | null; startTime: string | null; endTime: string | null; staffId: number | null; staffName: string | null }[];
    }
    
    interface booksyBookedAppointment extends booksyMyAppointment {
      /** True when the appointment exists and nothing is owed up front. */
      booked: boolean;
      /** True when a deposit or prepayment is due, Bowmark never pays it; finish on booksy.com. */
      paymentRequired: boolean;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/bookAppointment

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.bookAppointment({
      business: 1,
      serviceVariantId: 1,
      startTime: "<startTime>"
    });
  • cancelAppointmentCancels one of the signed-in caller's appointments, reporting any cancellation fee the business's policy applies.

    Arguments

    NameTypeRequired
    appointmentUidstring | number
    An appointmentUid from listMyBookings.
    Yes
    countrystringNo

    Returns booksyCancelledAppointment

    interface booksyMyAppointment {
      /** The id getMyAppointment and cancelAppointment take; null on a dry run. */
      appointmentUid: string | null;
      /** accepted, cancelled, finished, no_show, pending_payment, awaiting_confirmation, rejected, or Booksy's own code. */
      status: string | null;
      statusCode: string | null;
      startTime: string | null;
      endTime: string | null;
      currency: string | null;
      total: number | null;
      payableNow: number | null;
      cancellationFee: number | null;
      prepayment: number | null;
      business: { id: number | null; name: string | null; address: string | null } | null;
      services: { serviceId: number | null; serviceName: string | null; serviceVariantId: number | null; startTime: string | null; endTime: string | null; staffId: number | null; staffName: string | null }[];
    }
    
    interface booksyCancelledAppointment extends booksyMyAppointment {
      cancelled: boolean;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/cancelAppointment

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.cancelAppointment({ appointmentUid: "<appointmentUid>" });
  • removeFavoriteRemoves a business from the signed-in caller's favourites.

    Arguments

    NameTypeRequired
    businessnumber | string
    A business id, or its booksy.com page URL.
    Yes
    countrystringNo

    Returns booksyFavoriteResult

    interface booksyFavoriteResult {
      business: number;
      /** True after addFavorite, false after removeFavorite. */
      favorite: boolean;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/removeFavorite

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.removeFavorite({ business: 1 });
  • updateMyProfileUpdates the signed-in caller's Booksy profile: name, birthday, gender or address.

    Arguments

    NameTypeRequired
    firstNamestringNo
    lastNamestringNo
    birthdaystring
    "YYYY-MM-DD".
    No
    genderstringNo
    addressLine1stringNo
    apartmentNumberstringNo
    citystringNo
    zipcodestringNo
    countrystringNo

    Returns booksyMyProfile

    interface booksyMyProfile {
      id: number | null;
      firstName: string | null;
      lastName: string | null;
      email: string | null;
      phone: string | null;
      birthday: string | null;
      gender: string | null;
      address: { line1: string | null; line2: string | null; apartment: string | null; city: string | null; zipcode: string | null };
      photo: string | null;
      language: string | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/updateMyProfile

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.updateMyProfile({});
  • writeReviewPosts the signed-in caller's 1-5 star rating and review of a business, optionally tied to an appointment.

    Arguments

    NameTypeRequired
    businessnumber | stringYes
    ratingnumber
    1-5 stars.
    Yes
    textstringYes
    titlestringNo
    appointmentUidstring | number
    The appointment being reviewed, from listMyBookings.
    No
    countrystringNo

    Returns booksyMyReview

    interface booksyMyReview {
      reviewId: number | null;
      rating: number | null;
      title: string | null;
      text: string | null;
      created: string | null;
      updated: string | null;
      business: { id: number | null; name: string | null } | null;
    }

    HTTP endpoint

    POST https://api.bowmark.ai/v1/sites/booksy/writeReview

    Call it

    import { bowmark } from "@bowmark/web";
    
    const result = await bowmark.providers.booksy.writeReview({ business: 1, rating: 1, text: "<text>" });

Use it from code