Apptoto Availability API

openapi: 3.2.0
info:
  title: api-settings Availability API
  version: '1.0'
servers:
- url: https://api.apptoto.com
security:
- sec0: []
- sec1: []
tags:
- name: Availability
paths:
  /v1/availability:
    get:
      summary: /v1/availability
      description: This endpoint allows you to fetch times that are available to book appointments on your apptoto booking pages.
      operationId: v1availability
      parameters:
      - name: begin
        in: query
        description: (Required)  The beginning of the date range to fetch availability for.
        schema:
          type: string
          format: date
      - name: end
        in: query
        description: (Required) The ending of the date range to fetch availability for.
        schema:
          type: string
          format: date
      - name: booking_page
        in: query
        description: (Required) The booking page id or subdomain.  E.g if your booking page is hosted at https://bookwithme.apptoto.com/ then you would pass "bookwithme" for the booking_page parameter.
        schema:
          type: string
      - name: appointment_type
        in: query
        description: If your booking page has multiple appointment types, then you must pass in the appointment_type token that you want availability for.
        schema:
          type: string
      - name: expanded
        in: query
        description: If expanded is false, then an array of available times will be returned.  If expanded is true, then an array of objects will be returned.  Each object will have the time, whether or not it's available, and a link to use to book the time.
        schema:
          type: boolean
          default: false
      - name: include_links
        in: query
        description: If include_links is set to true, then the return value will include a link for each available time that clients can use to book that time.  Note that if expanded is set to true, then the default for this parameter is true.
        schema:
          type: boolean
          default: false
      deprecated: false
      security:
      - sec0: []
      - sec1:
        - bookings:read
      tags:
      - Availability
components:
  securitySchemes:
    sec0:
      type: http
      scheme: basic
    sec1:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://www.apptoto.com/oauth/authorize
          tokenUrl: https://api.apptoto.com/oauth/token
          refreshUrl: https://api.apptoto.com/oauth/token
          scopes:
            calendars:read: View calendars
            address_books:read: View address books
            contacts:read: View contacts
            contacts:write: Create, update, and delete contacts
            events:read: View calendar events
            events:write: Create, update, and delete events; mark event statuses
            bookings:read: View booking page availability and existing bookings
            bookings:write: Create bookings on booking pages
            imports:read: Check the status of imports
            imports:write: Upload imports (CSV / ICS / XML) that bulk-create data
            lists:read: View opt-in and opt-out lists
            lists:write: Modify opt-in and opt-out lists
            messaging:read: View conversations and message history
            messaging:send: Send SMS or email messages on the user's behalf
            webhooks:read: View webhooks
            webhooks:write: Create, update, and delete webhooks that send account activity to other services
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://apidocs.apptoto.com/reference
  harvested: '2026-10-28'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://apidocs.apptoto.com/reference/import-upload.md
  - https://apidocs.apptoto.com/reference/v1address_books.md
  - https://apidocs.apptoto.com/reference/v1availability.md
  - https://apidocs.apptoto.com/reference/v1book_now-1.md
  - https://apidocs.apptoto.com/reference/v1booking_pages.md
  - https://apidocs.apptoto.com/reference/v1bookings.md
  - https://apidocs.apptoto.com/reference/v1calendars-1.md
  - https://apidocs.apptoto.com/reference/v1contact.md
  - https://apidocs.apptoto.com/reference/v1contacts-1.md
  - https://apidocs.apptoto.com/reference/v1contacts-2.md
  - https://apidocs.apptoto.com/reference/v1contacts-3.md
  - https://apidocs.apptoto.com/reference/v1contacts.md
  - https://apidocs.apptoto.com/reference/v1contactstag.md
  - https://apidocs.apptoto.com/reference/v1conversation_messages.md
  - https://apidocs.apptoto.com/reference/v1conversation_reply.md
  - https://apidocs.apptoto.com/reference/v1conversation_templates.md
  - https://apidocs.apptoto.com/reference/v1conversations.md
  - https://apidocs.apptoto.com/reference/v1event.md
  - https://apidocs.apptoto.com/reference/v1eventmark.md
  - https://apidocs.apptoto.com/reference/v1events-1.md
  - https://apidocs.apptoto.com/reference/v1events-2.md
  - https://apidocs.apptoto.com/reference/v1events-3.md
  - https://apidocs.apptoto.com/reference/v1events.md
  - https://apidocs.apptoto.com/reference/v1eventtag.md
  - https://apidocs.apptoto.com/reference/v1import.md
  - https://apidocs.apptoto.com/reference/v1lists-1.md
  - https://apidocs.apptoto.com/reference/v1lists-2.md
  - https://apidocs.apptoto.com/reference/v1lists-3.md
  - https://apidocs.apptoto.com/reference/v1lists.md
  - https://apidocs.apptoto.com/reference/v1participantmark.md
  - https://apidocs.apptoto.com/reference/v1participants-1.md
  - https://apidocs.apptoto.com/reference/v1participants-2.md
  - https://apidocs.apptoto.com/reference/v1participants-3.md
  - https://apidocs.apptoto.com/reference/v1participants.md
  - https://apidocs.apptoto.com/reference/v1participants_auto_messages-1.md
  - https://apidocs.apptoto.com/reference/v1participants_auto_messages.md
  - https://apidocs.apptoto.com/reference/v1participanttag.md
  - https://apidocs.apptoto.com/reference/v1start_conversation.md
  - https://apidocs.apptoto.com/reference/v1userinfo.md
  - https://apidocs.apptoto.com/reference/v1webhooks-1.md
  - https://apidocs.apptoto.com/reference/v1webhooks-2.md
  - https://apidocs.apptoto.com/reference/v1webhooks-3.md
  - https://apidocs.apptoto.com/reference/v1webhooks.md
  merge:
    pages: 43
    deduped: 84
    conflicts_kept_first: 0