Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TableCheck customers API

The customers API from TableCheck — 3 operation(s) for customers.

TableCheck customers API is one of 14 APIs that TableCheck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include customers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 28 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://api.tablecheck.com/api/availability/v1/.

6 operations 3 paths 28 schemas 1 DELETE2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.tablecheck.com/api/availability/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

TableCheck customers API declares 1 security scheme for authenticating requests. An API key is passed in the header as AUTHORIZATION (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

customers 6
GET
/customers
List all Customers
listCustomers 10 params → 200default
POST
/customers
Create a new customer
createCustomer body → 200default
GET
/customers/{customer_id}
Fetch a specific Customer
showCustomerById 3 params → 200default
PUT
/customers/{customer_id}
Amend the Customer
amendCustomer 1 param body → 200default
DELETE
/customers/{customer_id}
Destroy the customer
deleteCustomerById 1 param → 200default
POST
/customer_search
Search and bulk export customers
customerSearch body → 200default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are CustomerSearchParams (119 properties), Customer (45 properties), CustomerCreateParams (42 properties), CustomerUpdateParams (41 properties). Each schema is shown below with its type and property counts.

MembershipEmbed
object
8 properties
ImageEmbed
object
8 properties
Emails
array
[PII] A list of Email objects.
ElasticCustomer
object
25 properties
PaginationData
object
2 properties
Error
object
1 property 1 required
ElasticMembership
object
4 properties
ImageEmbedDestroy
object
2 properties
CustomersListResponse
object
2 properties
Social
object
5 properties 1 required
ImageDimensions
object
3 properties
ImageVariants
object
4 properties
Email
object
5 properties 1 required
PhoneNumbersList
array
[PII] A list of phone numbers as strings.
CustomerSearchParams
object
119 properties
CustomerCreateParams
object
42 properties 1 required
EmailAddressesList
array
[PII] Email addresses as an array of strings.
Address
object
10 properties
Event
object
8 properties
ElasticPaginationData
object
2 properties
CustomerUpdateParams
object
41 properties 1 required
CustomerSearchResponse
object
2 properties
Phones
array
[PII] A list of Phone objects.
CustomerShopMemo
array
A shop-specific customer memo.
CustomerShowResponse
object
1 property
Customer
object
45 properties
Phone
object
5 properties 1 required
ImageEmbedCreate
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tablecheck-customers-api-openapi.yml Raw ↑

Other APIs TableCheck publishes across the network.

TableCheck availability API
TableCheck blockages API
TableCheck calendar API
TableCheck franchises API
TableCheck membership_programs API
TableCheck memberships API
TableCheck pos_journals API
TableCheck reservation_flags API
TableCheck reservations API
TableCheck shops API
TableCheck table_status API
TableCheck tables API