For AI agents: visit https://docs.onsched.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
API-First Online Booking | OnSchedHomeBook an Intro CallStartup Program
HomeDocumentationAPI EndpointsChangelog
HomeBook an Intro CallStartup ProgramLog InAPI-First Online Booking | OnSched
API Endpoints
Log In
HomeDocumentationAPI EndpointsChangelog

Welcome

  • OnSched API 3.0.0
  • Authentication

Onsched API

  • Appointment
    • Book a held appointmentput
    • Cancel an appointmentput
    • Confirm an appointmentput
    • Create an appointmentpost
    • Delete an appointment (holds only)del
    • Get appointment by IDget
    • Update an appointmentput
    • List appointmentsget
    • Get appointment custom fieldsget
    • Filter appointments (DEPRECATED)get
    • Hold an appointment slotpost
    • Reschedule an appointmentput
    • Reserve an appointment slot (no auto-expiry)post
    • Validate appointment resource changespost
    • List appointment audit eventsget
  • Auth
    • Generate a new refresh tokenpost
    • /v3/auth/tokenpost
    • Issue OAuth2 client credentials access tokenpost
  • Availability
    • Get availabilityget
  • ClientId
    • Delete a client IDdel
    • List all client IDs for the companyget
    • Get the primary client ID for the companyget
    • Generate and set a new client IDpost
  • Company
    • Adjust user roles for a companyput
    • Create a companypost
    • Delete a companydel
    • Get company by IDget
    • Update a companyput
    • List companies for the authenticated userget
    • Remove users from a companyput
    • Rotate company API keyput
    • Rotate OAuth client secretput
    • Set users for a companypost
  • Customer
    • Create a customerpost
    • Delete a customerdel
    • Get customer by IDget
    • Update a customerput
    • List customersget
  • Domain
    • Delete a company domaindel
    • List company domainsget
    • Set company domainspost
  • EmailTemplate
    • List email templatesget
    • Set an email templatepost
  • ExternalCalendar
    • Create an external calendar for a resourcepost
    • List external calendars for a resourceget
    • Create bulk unavailability from external calendarspost
    • Delete an external calendardel
    • Get an external calendar by IDget
    • Update an external calendarput
    • List available provider calendars for a resourceget
    • Regenerate external calendar auth URLput
    • Select calendars for read/write syncpost
    • External calendar OAuth callbackget
  • Geography
    • Get geography dataget
  • System
    • API health checkget
  • Holiday
    • List holidays for the Company/Locationget
    • Set holidays for the Company/Locationpost
  • Location
    • Add resource/service associations to a locationput
    • Bulk create locationspost
    • Create a locationpost
    • Set weekly availability for a locationpost
    • Get weekly availability for a locationget
    • Delete a locationdel
    • Get a locationget
    • Update a locationput
    • List locationsget
    • Remove resource/service associations from a locationput
    • Replace resource/service associations for a locationpost
  • Mapping
    • Resolve V1 legacy IDs to V3 IDsget
  • Public Routes
    • Book a held appointment (public)put
    • Confirm an appointment (public)put
    • Create an appointment (public)post
    • Get appointment by ID (public)get
    • List appointments (public)get
    • Get availability (public)get
    • Get location by ID (public)get
    • List locations (public)get
    • Get resource by ID (public)get
    • List resources (public)get
    • Get service by ID (public)get
    • List services (public)get
    • Hold an appointment slot (public)post
    • Reserve an appointment slot (public)post
  • RecurringBlocks
    • Create a recurring blockpost
    • Delete recurring blocksdel
    • List recurring blocksget
    • Delete a recurring blockdel
    • Get a recurring blockget
    • Update a recurring blockput
  • Resource
    • Add location/service associations to a resourceput
    • Bulk create resourcespost
    • Create a resourcepost
    • Set weekly availability for a resourcepost
    • Get weekly availability for a resourceget
    • Delete a resourcedel
    • Get a resourceget
    • Update a resourceput
    • List resourcesget
    • Remove location/service associations from a resourceput
    • Replace location/service associations for a resourcepost
  • Service
    • Add location/resource associations to a serviceput
    • Bulk create servicespost
    • Create a servicepost
    • Set weekly availability for a servicepost
    • Get weekly availability for a serviceget
    • Delete a servicedel
    • Get a serviceget
    • Update a serviceput
    • List servicesget
    • Remove location/resource associations from a serviceput
    • Replace location/resource associations for a servicepost
  • SingleAllocation
    • Create a single allocationpost
    • List single allocationsget
    • Delete a single allocationdel
    • Get a single allocationget
    • Update a single allocationput
    • Replace multiple single allocationspost
  • Tickets
    • Add a ticket notepost
    • Create a ticketpost
    • List ticketsget
    • Create a ticket messagepost
    • List ticket messagesget
    • Delete a ticketdel
    • Get a ticketget
    • Update a ticketput
  • Timezone
    • List timezonesget
  • Unavailability
    • Create an unavailability blockpost
    • List unavailability (calendar view)get
    • List unavailability blocksget
    • Unavailability calendar view (deprecated alias)get
    • Replace unavailability blockspost
    • Delete an out-of-office unavailability blockdel
  • User
    • Get current userget
    • Update a userput
  • Migration
    • Sync all v1 companies and entities for the authenticated userpost
    • List v1 companies available to sync for the authenticated userget
  • Webhook
    • Create a webhookpost
    • List webhooksget
    • Set webhookspost
  • WeeklyAllocation
    • Create weekly availabilitypost
    • List weekly allocationsget
    • Delete a weekly allocationdel
    • Get a weekly allocationget
    • Replace weekly allocationspost

Public Endpoints

  • Security
  • Recommended Usage

Security

Updated 10 months ago


Replace weekly allocations
Recommended Usage
Did this page help you?

Updated 10 months ago


Replace weekly allocations
Recommended Usage
Did this page help you?