Getting Started

Welcome to the TablelistPro Developer Docs. This guide will help you make your first request.

Terminology: In the API, table reservations are admission groups with type TABLE. Other reservation-related types (guest list, tally, ticket) use the same Admission Groups endpoints where applicable.

Guides in this project

Guide	Description
Getting Started (this page)	Base URL and API keys.
Rate Limits	Throttling for the public and partners APIs.
Webhooks	Real-time event notifications.
POS	Bulk sync table spend / closed state from a POS.

Use the API Reference in ReadMe for full endpoint and schema details (generated from OpenAPI).

Base URL

Production:

https://api.tablelist.com/2025-03

Development (when applicable):

https://api-dev.tablelist.com/2025-03

Authentication

All requests to the TablelistPro API must be authenticated using an API key.

Generating an API Key

You can create and manage your API keys in the TablelistPro web app:

Navigate to: Organization → API Keys

Sending Authenticated Requests

Include your API key in the x-tl-api-key header for every request.

Example:

curl https://api.tablelist.com/2025-03/ping -H "x-tl-api-key:{api-key}"

Replace {api-key} with your organization API key. The same header is documented on endpoints in the API Reference (generated from the OpenAPI spec).

Key safety

Do not commit API keys to source control.
Rotate keys from Organization → API Keys if a key is exposed.

Next steps

Read Rate Limits for how throttling works (20 requests per second per API key) and 429 behavior.
Use GET /ping to verify your key (see API Reference).
Read Webhooks for real-time event notifications.
For POS integrations, read POS.