Note

The v3.0 API documentation is a work in progress and subject to change. If you are developing an application and have additional questions, or find any errors, please contact us for assistance.

Welcome to the Checkfront Developer API

The Checkfront API allows developers to expand and build on the Checkfront Booking Platform. The API makes it easy to create web, desktop & mobile applications that directly integrate and interact with your Checkfront account.

This API is built around open standards and secure technologies to streamline development and maintain the integrity of your data.

The documentation is divided into the following sections:

• Overview
• Developer Guide
• Reference

Overview

• Getting Started
  • Prerequisites
  • Where to Start
  • Sample Code
  • Finding Help
  • Rate Limits
  • The Public API
  • Terms of Service
• Connecting to the API
  • Setting Up Your Application
    • Choosing Your Workflow
    • Obtaining API Credentials
  • Authenticating with Token Pairs
  • Authenticating with OAuth2
    • Logging in with a Staff Account
    • Using and Maintaining OAuth2 Tokens
    • OAuth2 Reference
• Request Formatting
• Response Formatting

Developer Guide

• The Developer Console
• Setting Up The SDK
  • With Token Authentication
  • With OAuth2 Authentication
  • Making Calls to the API
• How To…
  • List Items
  • Add Items to a Booking Session
  • Alter Items in the Session
  • Create a New Booking
• Frequently Asked Questions
  • Understanding Errors

Reference

• Webhooks
  • Booking Modified & Booking Status Change
  • Item Calendar Edit
  • Item Event/Discount Edit
  • Item Update
  • New Payment/Refund
• API 3.0 Endpoints
  • account
  • booking
  • booking/[booking_id]
  • booking/create
  • booking/form
  • booking/index
  • booking/notes
  • booking/session
  • category
  • company
  • customer
  • event
  • item
  • help
  • ping