Quickstart

This guide takes you from receiving an API key to retrieving a location your integration can access.

1. Store your API key

Your Chataigne contact provides a key beginning with ch_org_. Store it in a secret manager or an environment variable on your server.

export CHATAIGNE_API_KEY="ch_org_..."

Never expose a Chataigne API key in browser or mobile code, logs, screenshots, or source control. If a key is exposed, ask your Chataigne contact to rotate it.

2. List your locations

Send the key in the x-api-key header. GET /v1/locations returns every location in the key’s scope that it has permission to read.

curl https://server.chataigne.ai/v1/locations \
  -H "x-api-key: $CHATAIGNE_API_KEY"

const response = await fetch('https://server.chataigne.ai/v1/locations', {
  headers: { 'x-api-key': process.env.CHATAIGNE_API_KEY },
});

const body = await response.json();
if (!response.ok) {
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data);

import os
import requests

response = requests.get(
    "https://server.chataigne.ai/v1/locations",
    headers={"x-api-key": os.environ["CHATAIGNE_API_KEY"]},
)
body = response.json()
response.raise_for_status()

print(body["data"])

3. Read the list response

List endpoints return a list object. The data array contains the resources available on the current page.

{
  "object": "list",
  "data": [
    {
      "id": "loc_r8v4n2c6tz",
      "object": "location",
      "organization_id": "busorg_k3m9x2p7qw",
      "name": "Café de la Gare",
      "currency": "EUR",
      "country": "FR",
      "timezone": "Europe/Paris",
      "default_language": "fr",
      "address": {
        "line1": "12 rue de la Gare",
        "postal_code": "75010",
        "city": "Paris",
        "country": "FR"
      },
      "created_at": "2026-01-14T09:30:00Z",
      "updated_at": "2026-05-02T16:45:12Z"
    }
  ],
  "has_more": false,
  "url": "/v1/locations"
}

If the key is scoped to a business organization, data can contain several locations. If it is scoped to one location, data contains that location. See Organizations and locations for the full access model.

4. Retrieve one location

Copy a location id from the list and place it in the URL:

curl https://server.chataigne.ai/v1/locations/loc_r8v4n2c6tz \
  -H "x-api-key: $CHATAIGNE_API_KEY"

The response is the complete location resource. Keep the returned ID: you will use it in location settings and analytics endpoints.

Troubleshooting

Status	Meaning	What to check
`401`	The request could not be authenticated.	Confirm that `x-api-key` is present and the key is current.
`403`	The key cannot perform this action.	Confirm the key’s scope and that it has `location.read`.
`404`	The resource is unavailable to this key.	Confirm the location ID and the key’s scope.

Every response includes an X-Request-Id header. Log it and include it when contacting Chataigne support.

1. Store your API key

2. List your locations

3. Read the list response

4. Retrieve one location

Troubleshooting

Next steps

Find all your resources

Manage a location

​1. Store your API key

​2. List your locations

​3. Read the list response

​4. Retrieve one location

​Troubleshooting

​Next steps

Find all your resources

Manage a location

1. Store your API key

2. List your locations

3. Read the list response

4. Retrieve one location

Troubleshooting

Next steps