Sweep

Sweep scheduling (public) API

The scheduling (public) API from Sweep — 8 operation(s) for scheduling (public).

GitHub OpenAPI

Operations 9

POST /scheduling/webhook/{formId} #
GET /scheduling/booking/{token} #
GET /scheduling/availability/{token} #
POST /scheduling/book/{token} #
POST /scheduling/reschedule/{token} #
GET /scheduling/google/callback #
GET /scheduling/zoom/callback #

Documentation

📖
APIReference
https://api.sweep.io/api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/authentication/sweep-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/openapi/sweep-scheduling-public-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/conventions/sweep-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/data-model/sweep-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/errors/sweep-problem-types.yml

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/sweep-scheduling-public-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

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

OpenAPI Specification

sweep-scheduling-public-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sweep scheduling (public) API
  description: This is a publicly available Sweep API.
  version: '0.1'
  contact: {}
servers:
- url: https://api.sweep.io
  description: Sweep production API — the host this document was harvested from (GET /api-json); /health responds here
tags:
- name: scheduling (public)
paths:
  /scheduling/webhook/{formId}:
    post:
      operationId: SchedulingPublicUnauthenticatedController_webhook
      parameters:
      - name: formId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LeadSubmissionDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - scheduling (public)
  /scheduling/booking/{token}:
    get:
      operationId: SchedulingPublicUnauthenticatedController_getBookingDetails
      parameters:
      - name: token
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - scheduling (public)
  /scheduling/availability/{token}:
    get:
      operationId: SchedulingPublicUnauthenticatedController_getAvailability
      parameters:
      - name: token
        required: true
        in: path
        schema:
          type: string
      - name: startDate
        required: true
        in: query
        schema:
          type: string
      - name: days
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      tags:
      - scheduling (public)
  /scheduling/book/{token}:
    post:
      operationId: SchedulingPublicUnauthenticatedController_book
      parameters:
      - name: token
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BookSlotDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - scheduling (public)
  /scheduling/reschedule/{token}:
    post:
      operationId: SchedulingPublicUnauthenticatedController_reschedule
      parameters:
      - name: token
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BookSlotDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - scheduling (public)
  /scheduling/book-link/{linkId}:
    get:
      operationId: SchedulingPublicUnauthenticatedController_resolveBookingLink
      parameters:
      - name: linkId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - scheduling (public)
    post:
      operationId: SchedulingPublicUnauthenticatedController_submitBookingLink
      parameters:
      - name: linkId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LeadSubmissionDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - scheduling (public)
  /scheduling/google/callback:
    get:
      operationId: SchedulingPublicUnauthenticatedController_googleCallback
      parameters:
      - name: code
        required: true
        in: query
        schema:
          type: string
      - name: state
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - scheduling (public)
  /scheduling/zoom/callback:
    get:
      operationId: SchedulingPublicUnauthenticatedController_zoomCallback
      parameters:
      - name: code
        required: true
        in: query
        schema:
          type: string
      - name: state
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
      tags:
      - scheduling (public)
components:
  schemas:
    LeadSubmissionDto:
      type: object
      properties:
        lead:
          type: object
      required:
      - lead
    BookSlotDto:
      type: object
      properties:
        startTime:
          type: string
        timezone:
          type: string
      required:
      - startTime
      - timezone
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http