Skip to main content
The Chataigne API lets you connect restaurant operations to your own systems. Use it to discover the restaurants your integration can access, keep location information and ordering settings up to date, and retrieve analytics.
Base URL
The API uses resource-oriented URLs under /v1, JSON request and response bodies, standard HTTP methods, and conventional status codes. Every request must use HTTPS and include a Chataigne API key in the x-api-key header.

Make your first request

Authenticate and retrieve the locations available to your integration.

Understand your access

Learn how key scope and permissions work together.

Organizations and locations

Understand the two resources at the center of the API.

Find your resources

Discover the organization and locations your key can access.

​
Resource model

A business organization represents a restaurant group or business. It can contain one or more locations, where each location represents an individual restaurant. Some integrations receive a business-organization-scoped key and can access the organization and its locations. Others receive a location-scoped key and can access only one location. Standalone locations may not belong to a business organization.
Scope determines which resources a key can reach. Permissions determine which actions it can perform on those resources. Both must allow a request.

​
What you can do

  • Discover your business organization and locations.
  • Update an organization’s display name or a location’s profile.
  • Configure order behavior, opening hours, delivery, order acceptance, and AI clerk instructions.
  • Schedule exceptional closures.
  • Retrieve location or organization analytics.
Responses identify resources with opaque string IDs such as loc_…. Store and reuse the IDs returned by the API; do not derive meaning from their format.
  1. Complete the Quickstart to retrieve your first location.
  2. Read API keys and permissions to understand your access boundary.
  3. Use Find your resources to obtain the IDs your integration needs.
  4. Continue to Location Management or Analytics for task-specific guides.