TableCheck

TableCheck is a restaurant booking and guest-experience platform (founded 2011, headquartered in Tokyo, Japan) used by thousands of restaurants across 35+ countries to consolidate reservations, availability, guest CRM, memberships, and POS integration into one system. TableCheck exposes a production JSON/REST API, partitioned into components - Availability, Web Booking, Booking, CRM, POS, and Site Controller - under https://api.tablecheck.com/api. Access is partner-gated, and a per-environment secret_key is issued by the TableCheck API team on approval, while some components (notably the direct Booking API) are available only by special arrangement. Each component publishes an OpenAPI 3.0 description.

6 APIs 0 Features
RestaurantReservationsBookingHospitalityAvailabilityGuest CRMPoint of SaleJapan

APIs

TableCheck Availability API

Obtain near real-time table availability for online reservation booking. Search availability across all shops for a party size and datetime, fetch a shop's availability timetabl...

TableCheck Web Booking API

Read-only API to query reservations that diner users booked via the TableCheck website. List reservations with created_at, updated_at, and start_at range filters, and fetch a sp...

TableCheck Booking API

Book reservations directly into TableCheck's inventory backend. Create, read, update, and cancel reservations; manage blockages and reservation flags; and list shops. Available ...

TableCheck CRM API

Obtain full customer, reservation, membership, and related guest data for restaurant operators. Manage customers (list, create, amend, delete, bulk search/export), memberships a...

TableCheck POS API

Connect Point-of-Sale systems to restaurants on the TableCheck platform. List shops, manage POS journals per shop (create, read, update, delete, void), read and update reservati...

TableCheck Site Controller API

Site-controller component for reading shop inventory across the platform. List shops (filtered by IDs, slugs, or franchise IDs) and fetch a specific shop, for channel-manager an...

Collections

TableCheck API

OPEN

Pricing Plans

Tablecheck Plans Pricing

2 plans

PLANS

Rate Limits

Tablecheck Rate Limits

2 limits

RATE LIMITS

FinOps

Tablecheck Finops

FINOPS

Resources

🔗
DomainSecurity
DomainSecurity
🔑
Authentication
Authentication
👥
GitHubOrganization
GitHubOrganization
🔗
LinkedIn
LinkedIn
🔗
Website
Website
🔗
Documentation
Documentation
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps
📰
Blog
Blog

Sources

Raw ↑ 
opencollection: 1.0.0
info:
  name: TableCheck API
  version: '1.0'
request:
  auth:
    type: apikey
    apikey:
      key: Authorization
      value: '{{secret_key}}'
      in: header
items:
- info:
    name: Availability
    type: folder
  items:
  - info:
      name: Search for availability across all shops
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/availability/v1/shops
    docs: Search for availability across all shops
  - info:
      name: Fetch info of a specific shop. Does not include availability.
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/availability/v1/shops/:shop_id
      params:
      - name: shop_id
        value: ''
        type: path
    docs: Fetch info of a specific shop. Does not include availability.
  - info:
      name: Fetch availability timetable of a specific shop.
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/availability/v1/timetable/:shop_id
      params:
      - name: shop_id
        value: ''
        type: path
    docs: Fetch availability timetable of a specific shop.
  - info:
      name: Fetch availability calendar of a specific shop.
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/availability/v1/calendar/:shop_id
      params:
      - name: shop_id
        value: ''
        type: path
    docs: Fetch availability calendar of a specific shop.
  - info:
      name: Fetch availability tables of a specific shop.
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/availability/v1/availability_tables/:shop_id
      params:
      - name: shop_id
        value: ''
        type: path
    docs: Fetch availability tables of a specific shop.
- info:
    name: Web Booking
    type: folder
  items:
  - info:
      name: List all Reservations
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/web_booking/v1/reservations
    docs: List all Reservations
  - info:
      name: Fetch a specific Reservation
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/web_booking/v1/reservations/:reservation_id_or_ref
      params:
      - name: reservation_id_or_ref
        value: ''
        type: path
    docs: Fetch a specific Reservation
- info:
    name: Booking
    type: folder
  items:
  - info:
      name: Create Blockage
      type: http
    http:
      method: POST
      url: https://api.tablecheck.com/api/booking/v1/blockages
      body:
        type: json
        data: '{}'
    docs: Create Blockage
  - info:
      name: Fetch a specific Blockage
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/booking/v1/blockages/:blockage_id
      params:
      - name: blockage_id
        value: ''
        type: path
    docs: Fetch a specific Blockage
  - info:
      name: Update Blockage
      type: http
    http:
      method: PUT
      url: https://api.tablecheck.com/api/booking/v1/blockages/:blockage_id
      params:
      - name: blockage_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update Blockage
  - info:
      name: Delete Blockage
      type: http
    http:
      method: DELETE
      url: https://api.tablecheck.com/api/booking/v1/blockages/:blockage_id
      params:
      - name: blockage_id
        value: ''
        type: path
    docs: Delete Blockage
  - info:
      name: List all Reservations
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/booking/v1/reservations
    docs: List all Reservations
  - info:
      name: Create Reservation
      type: http
    http:
      method: POST
      url: https://api.tablecheck.com/api/booking/v1/reservations
      body:
        type: json
        data: '{}'
    docs: Create Reservation
  - info:
      name: Fetch a specific Reservation
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/booking/v1/reservations/:reservation_id_or_ref
      params:
      - name: reservation_id_or_ref
        value: ''
        type: path
    docs: Fetch a specific Reservation
  - info:
      name: Update Reservation
      type: http
    http:
      method: PUT
      url: https://api.tablecheck.com/api/booking/v1/reservations/:reservation_id_or_ref
      params:
      - name: reservation_id_or_ref
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update Reservation
  - info:
      name: Cancel Reservation
      type: http
    http:
      method: PUT
      url: https://api.tablecheck.com/api/booking/v1/reservations/:reservation_id_or_ref/cancel
      params:
      - name: reservation_id_or_ref
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Cancel Reservation
  - info:
      name: List all Reservation Flags
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/booking/v1/reservation_flags
    docs: List all Reservation Flags
  - info:
      name: Fetch a specific Reservation Flag
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/booking/v1/reservation_flags/:reservation_flag_id
      params:
      - name: reservation_flag_id
        value: ''
        type: path
    docs: Fetch a specific Reservation Flag
  - info:
      name: List all shops
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/booking/v1/shops
    docs: List all shops
  - info:
      name: Fetch a specific shop
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/booking/v1/shops/:shop_id
      params:
      - name: shop_id
        value: ''
        type: path
    docs: Fetch a specific shop
- info:
    name: CRM
    type: folder
  items:
  - info:
      name: List all Reservations
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/crm/v1/reservations
    docs: List all Reservations
  - info:
      name: Create Reservation
      type: http
    http:
      method: POST
      url: https://api.tablecheck.com/api/crm/v1/reservations
      body:
        type: json
        data: '{}'
    docs: Create Reservation
  - info:
      name: Fetch a specific Reservation
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/crm/v1/reservations/:reservation_id
      params:
      - name: reservation_id
        value: ''
        type: path
    docs: Fetch a specific Reservation
  - info:
      name: Update Reservation
      type: http
    http:
      method: PUT
      url: https://api.tablecheck.com/api/crm/v1/reservations/:reservation_id
      params:
      - name: reservation_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update Reservation
  - info:
      name: List all Reservation Flags
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/crm/v1/reservation_flags
    docs: List all Reservation Flags
  - info:
      name: Fetch a specific Reservation Flag
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/crm/v1/reservation_flags/:reservation_flag_id
      params:
      - name: reservation_flag_id
        value: ''
        type: path
    docs: Fetch a specific Reservation Flag
  - info:
      name: List all Memberships
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/crm/v1/memberships
    docs: List all Memberships
  - info:
      name: Create Membership
      type: http
    http:
      method: POST
      url: https://api.tablecheck.com/api/crm/v1/memberships
      body:
        type: json
        data: '{}'
    docs: Create Membership
  - info:
      name: Fetch a specific Membership
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/crm/v1/memberships/:membership_id
      params:
      - name: membership_id
        value: ''
        type: path
    docs: Fetch a specific Membership
  - info:
      name: Update Membership
      type: http
    http:
      method: PUT
      url: https://api.tablecheck.com/api/crm/v1/memberships/:membership_id
      params:
      - name: membership_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update Membership
  - info:
      name: Destroy the membership
      type: http
    http:
      method: DELETE
      url: https://api.tablecheck.com/api/crm/v1/memberships/:membership_id
      params:
      - name: membership_id
        value: ''
        type: path
    docs: Destroy the membership
  - info:
      name: List all Membership Programs
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/crm/v1/membership_programs
    docs: List all Membership Programs
  - info:
      name: Fetch a specific Membership Program
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/crm/v1/membership_programs/:membership_program_id
      params:
      - name: membership_program_id
        value: ''
        type: path
    docs: Fetch a specific Membership Program
  - info:
      name: List all Customers
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/crm/v1/customers
    docs: List all Customers
  - info:
      name: Create a new customer
      type: http
    http:
      method: POST
      url: https://api.tablecheck.com/api/crm/v1/customers
      body:
        type: json
        data: '{}'
    docs: Create a new customer
  - info:
      name: Fetch a specific Customer
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/crm/v1/customers/:customer_id
      params:
      - name: customer_id
        value: ''
        type: path
    docs: Fetch a specific Customer
  - info:
      name: Amend the Customer
      type: http
    http:
      method: PUT
      url: https://api.tablecheck.com/api/crm/v1/customers/:customer_id
      params:
      - name: customer_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Amend the Customer
  - info:
      name: Destroy the customer
      type: http
    http:
      method: DELETE
      url: https://api.tablecheck.com/api/crm/v1/customers/:customer_id
      params:
      - name: customer_id
        value: ''
        type: path
    docs: Destroy the customer
  - info:
      name: Search and bulk export customers
      type: http
    http:
      method: POST
      url: https://api.tablecheck.com/api/crm/v1/customer_search
      body:
        type: json
        data: '{}'
    docs: Search and bulk export customers
  - info:
      name: List all Shops
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/crm/v1/shops
    docs: List all Shops
  - info:
      name: Fetch a specific Shop
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/crm/v1/shops/:shop_id
      params:
      - name: shop_id
        value: ''
        type: path
    docs: Fetch a specific Shop
  - info:
      name: List all Franchises
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/crm/v1/franchises
    docs: List all Franchises
  - info:
      name: Fetch a specific Franchise
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/crm/v1/franchises/:franchise_id
      params:
      - name: franchise_id
        value: ''
        type: path
    docs: Fetch a specific Franchise
- info:
    name: POS
    type: folder
  items:
  - info:
      name: List of all available shops
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/pos/v1/shops
    docs: List of all available shops
  - info:
      name: Get Shop information
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/pos/v1/shops/:id
      params:
      - name: id
        value: ''
        type: path
    docs: Get Shop information
  - info:
      name: List all PosJournals
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/pos/v1/shops/:shop_id/pos_journals
      params:
      - name: shop_id
        value: ''
        type: path
    docs: List all PosJournals
  - info:
      name: Create PosJournal
      type: http
    http:
      method: POST
      url: https://api.tablecheck.com/api/pos/v1/shops/:shop_id/pos_journals
      params:
      - name: shop_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Create PosJournal
  - info:
      name: Get PosJournal information
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/pos/v1/shops/:shop_id/pos_journals/:pos_journal_id
      params:
      - name: shop_id
        value: ''
        type: path
      - name: pos_journal_id
        value: ''
        type: path
    docs: Get PosJournal information
  - info:
      name: Update PosJournal
      type: http
    http:
      method: PUT
      url: https://api.tablecheck.com/api/pos/v1/shops/:shop_id/pos_journals/:pos_journal_id
      params:
      - name: shop_id
        value: ''
        type: path
      - name: pos_journal_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update PosJournal
  - info:
      name: Delete PosJournal
      type: http
    http:
      method: DELETE
      url: https://api.tablecheck.com/api/pos/v1/shops/:shop_id/pos_journals/:pos_journal_id
      params:
      - name: shop_id
        value: ''
        type: path
      - name: pos_journal_id
        value: ''
        type: path
    docs: Delete PosJournal
  - info:
      name: Void PosJournal (Check Void)
      type: http
    http:
      method: POST
      url: https://api.tablecheck.com/api/pos/v1/shops/:shop_id/pos_journals/void
      params:
      - name: shop_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Void PosJournal (Check Void)
  - info:
      name: List all Reservations
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/pos/v1/shops/:shop_id/reservations
      params:
      - name: shop_id
        value: ''
        type: path
    docs: List all Reservations
  - info:
      name: Get Reservation information
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/pos/v1/shops/:shop_id/reservations/:reservation_id
      params:
      - name: shop_id
        value: ''
        type: path
      - name: reservation_id
        value: ''
        type: path
    docs: Get Reservation information
  - info:
      name: Update Reservation
      type: http
    http:
      method: PUT
      url: https://api.tablecheck.com/api/pos/v1/shops/:shop_id/reservations/:reservation_id
      params:
      - name: shop_id
        value: ''
        type: path
      - name: reservation_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update Reservation
  - info:
      name: List all Tables
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/pos/v1/shops/:shop_id/tables
      params:
      - name: shop_id
        value: ''
        type: path
    docs: List all Tables
  - info:
      name: Get Table Status
      type: http
    http:
      method: POST
      url: https://api.tablecheck.com/api/pos/v1/shops/:shop_id/table_status/show
      params:
      - name: shop_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Get Table Status
  - info:
      name: Update Table Status
      type: http
    http:
      method: PUT
      url: https://api.tablecheck.com/api/pos/v1/shops/:shop_id/table_status/update
      params:
      - name: shop_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: Update Table Status
- info:
    name: Site Controller
    type: folder
  items:
  - info:
      name: List all Shops
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/site/v1/shops
    docs: List all Shops
  - info:
      name: Fetch a specific shop
      type: http
    http:
      method: GET
      url: https://api.tablecheck.com/api/site/v1/shops/:shop_id
      params:
      - name: shop_id
        value: ''
        type: path
    docs: Fetch a specific shop