FavCRM Service Booking API

The Service Booking API from FavCRM — 10 operation(s) for service booking.

GitHub OpenAPI

Operations 10

GET /v6/customer-portal/services List bookable services #
GET /v6/customer-portal/services/{id} Get service detail #
GET /v6/customer-portal/services/{id}/staff List service staff #
GET /v6/customer-portal/services/{id}/resources List service resources #
GET /v6/customer-portal/services/{id}/slots List available slots #
POST /v6/customer-portal/bookings/guest Create a guest booking #
GET /v6/customer-portal/bookings List authenticated customer bookings #
GET /v6/customer-portal/bookings/{id} Get authenticated customer booking detail #
POST /v6/customer-portal/bookings/{id}/cancel Cancel authenticated customer booking #
POST /v6/customer-portal/bookings/{id}/reschedule Reschedule authenticated customer booking #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/favcrm-io:favcrm-io-service-booking-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

favcrm-io-service-booking-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: FavCRM Public SDK Service Booking API
  version: 0.2.0
  summary: Customer-facing v6 APIs for public FavCRM integrations.
  description: 'Curated public SDK contract for building storefront, booking, member,

    content, event, commerce, offer, and survey integrations. Provider

    callbacks, generated platform docs, MCP/OAuth discovery, health checks, and

    internal developer routes are intentionally excluded.'
servers:
- url: https://api.favcrm.io
  description: Production v6 API domain
- url: https://api.favoredapp.co
  description: Legacy production domain that can proxy v6 routes
- url: http://localhost:18778
  description: Local development gateway
tags:
- name: Service Booking
paths:
  /v6/customer-portal/services:
    get:
      tags:
      - Service Booking
      summary: List bookable services
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      - $ref: '#/components/parameters/SearchQuery'
      - $ref: '#/components/parameters/PageQuery'
      - $ref: '#/components/parameters/LimitQuery'
      responses:
        '200':
          $ref: '#/components/responses/ListSuccess'
      operationId: getV6CustomerPortalServices
      x-operation-id-source: derived
  /v6/customer-portal/services/{id}:
    get:
      tags:
      - Service Booking
      summary: Get service detail
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      - $ref: '#/components/parameters/IdPath'
      responses:
        '200':
          $ref: '#/components/responses/Success'
        '404':
          $ref: '#/components/responses/Error'
      operationId: getV6CustomerPortalServicesById
      x-operation-id-source: derived
  /v6/customer-portal/services/{id}/staff:
    get:
      tags:
      - Service Booking
      summary: List service staff
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      - $ref: '#/components/parameters/IdPath'
      responses:
        '200':
          $ref: '#/components/responses/ListSuccess'
      operationId: getV6CustomerPortalServicesByIdStaff
      x-operation-id-source: derived
  /v6/customer-portal/services/{id}/resources:
    get:
      tags:
      - Service Booking
      summary: List service resources
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      - $ref: '#/components/parameters/IdPath'
      responses:
        '200':
          $ref: '#/components/responses/ListSuccess'
      operationId: getV6CustomerPortalServicesByIdResources
      x-operation-id-source: derived
  /v6/customer-portal/services/{id}/slots:
    get:
      tags:
      - Service Booking
      summary: List available slots
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      - $ref: '#/components/parameters/IdPath'
      - name: date
        in: query
        schema:
          type: string
          format: date
      - name: staffId
        in: query
        schema:
          type: string
      - name: resourceId
        in: query
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/Success'
      operationId: getV6CustomerPortalServicesByIdSlots
      x-operation-id-source: derived
  /v6/customer-portal/bookings/guest:
    post:
      tags:
      - Service Booking
      summary: Create a guest booking
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GuestBookingRequest'
      responses:
        '200':
          $ref: '#/components/responses/Success'
        '400':
          $ref: '#/components/responses/Error'
      operationId: postV6CustomerPortalBookingsGuest
      x-operation-id-source: derived
  /v6/customer-portal/bookings:
    get:
      tags:
      - Service Booking
      summary: List authenticated customer bookings
      security:
      - customerBearer: []
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      responses:
        '200':
          $ref: '#/components/responses/ListSuccess'
      operationId: getV6CustomerPortalBookings
      x-operation-id-source: derived
  /v6/customer-portal/bookings/{id}:
    get:
      tags:
      - Service Booking
      summary: Get authenticated customer booking detail
      security:
      - customerBearer: []
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      - $ref: '#/components/parameters/IdPath'
      responses:
        '200':
          $ref: '#/components/responses/Success'
      operationId: getV6CustomerPortalBookingsById
      x-operation-id-source: derived
  /v6/customer-portal/bookings/{id}/cancel:
    post:
      tags:
      - Service Booking
      summary: Cancel authenticated customer booking
      security:
      - customerBearer: []
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      - $ref: '#/components/parameters/IdPath'
      responses:
        '200':
          $ref: '#/components/responses/Success'
      operationId: postV6CustomerPortalBookingsByIdCancel
      x-operation-id-source: derived
  /v6/customer-portal/bookings/{id}/reschedule:
    post:
      tags:
      - Service Booking
      summary: Reschedule authenticated customer booking
      security:
      - customerBearer: []
      parameters:
      - $ref: '#/components/parameters/CompanyIdHeader'
      - $ref: '#/components/parameters/IdPath'
      responses:
        '200':
          $ref: '#/components/responses/Success'
      operationId: postV6CustomerPortalBookingsByIdReschedule
      x-operation-id-source: derived
components:
  parameters:
    SearchQuery:
      name: search
      in: query
      required: false
      schema:
        type: string
    LimitQuery:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    CompanyIdHeader:
      name: X-Company-Id
      in: header
      required: false
      schema:
        type: string
      description: Tenant id. May be omitted when tenant context is resolved by storefront domain.
    IdPath:
      name: id
      in: path
      required: true
      schema:
        type: string
    PageQuery:
      name: page
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        default: 1
  responses:
    ListSuccess:
      description: Standard list success response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ListResponse'
    Success:
      description: Standard success response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SuccessResponse'
    Error:
      description: Standard error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    GuestBookingRequest:
      type: object
      required:
      - serviceId
      - occurrenceStart
      - occurrenceEnd
      - customerName
      - customerPhone
      properties:
        serviceId:
          type: string
        occurrenceStart:
          type: string
          format: date-time
        occurrenceEnd:
          type: string
          format: date-time
        customerName:
          type: string
        customerPhone:
          type: string
        customerEmail:
          type: string
          format: email
        staffId:
          type: string
        resourceId:
          type: string
    ListResponse:
      type: object
      required:
      - success
      - data
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          properties:
            items:
              type: array
              items:
                type: object
                additionalProperties: true
            pagination:
              type: object
              additionalProperties: true
          additionalProperties: true
    SuccessResponse:
      type: object
      required:
      - success
      - data
      properties:
        success:
          type: boolean
          const: true
        data:
          type: object
          additionalProperties: true
    ErrorResponse:
      type: object
      required:
      - success
      - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
              additionalProperties: true
  securitySchemes:
    customerBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT