/
Directory v1

Directory v1

This API is Live and ready to use in production.

The Directory API is used to retrieve a listing of restaurants on the TableCheck platform, including photos and descriptions.

Target audience

The Directory API is recommended for use by:

  • Restaurant listing websites

  • Travel and experience booking websites

  • Concierge services

If you would like to implement reservation booking, we recommend to use the Availability API instead.

The Directory API is not intended for use by Point-of-Sale, CRM, or IPTV vendors. These use cases have special APIs which allow you to fetch a dedicated shop list.

Endpoint

The Directory API is read-only. Both development and production should connect to the Live API endpoint.

https://api.tablecheck.com/api/directory/v1/...

Interactive API console

https://api.tablecheck.com/api/directory/v1/docs

Refer to Using the API Console for help.

Rate Limits

Using TableCheck content

The Directory API includes content which is the property of TableCheck and/or its participating merchants. You may re-use this content on your site without direct attribution provided that:

  1. You are redirecting users to the TableCheck booking page to make reservations; and

  2. You do not claim ownership of this content; and

  3. TableCheck has not revoked your privilege to use its content

How to Implement

Browsing the shop list

🔗 API Console

The API refers to restaurants as "shops". The /shops endpoint will return all restaurants listed on TableCheck in a paginated format. The response can return a detailed set of attributes including addresses, descriptions, and photos as they appear in the TableCheck system.

GET /shops?page=0

You may also use query parameters, for example geolocation parameters (see API console for full documentation).

GET /shops?geo_latitude=35.6895&geo_longitude=139.6917&geo_distance=10000



The directory/v1/shops endpoint can be used interchangeably with the availability/v1/shops endpoint. The latter can return the same results but also includes booking availability.

Fetching the list of cuisines

🔗 API Console

You may fetch the list of cuisine keys to use when querying shops, as well as their translations, at the following endpoint:

GET /cuisines

Next Steps

Use the Availability API to search shops which have available seating in real-time.

 

For further inquiries and assistance, please contact api@tablecheck.com



 

Related content