Quickstart

Make a key and send your first request

Five minutes from nothing to your venues coming back as JSON.

1. Make a key

In Hatcel, open Settings > Developers and create an API key.
Name it after what will use it, such as Reporting dashboard.
For a first try, choose Test and Read only. Both are fixed once the key is made.
Copy the key. It is shown once and never again.

2. Keep it out of your code

Put the key in an environment variable. Every sample in these docs reads HATCEL_API_KEY.

Terminal

export HATCEL_API_KEY=hat_test_...

3. Send your first request

List the workspace's venues. Pick your language; the choice follows you round the docs.

curl "https://api.hatcel.com/venues?limit=25" \
  -H "Authorization: Bearer $HATCEL_API_KEY" \
  -H "Hatcel-Version: 2026-10-08"

4. Read the answer

Every list comes back in the same envelope: the rows in data, and whether there are more.

200

{
  "object": "list",
  "data": [
    {
      "id": "ven_0TMXp8QPR6yGvKuV2GZQ10",
      "object": "venue",
      "name": "<string>",
      "slug": "<string>",
      "booking_code": "<string>",
      "timezone": "Australia/Sydney",
      "currency": "aud",
      "address": {
        "line1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "phone": "<string>",
      "email": "alex@example.com",
      "active": true,
      "created_at": "2026-10-08T03:00:00.000Z",
      "updated_at": "2026-10-08T03:00:00.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJ0IjoiMjAyNi0xMC0wOFQwMzowMDowMC4wMDBaIiwiaSI6IjBmOGZhZDViIn0"
}

From here, page through a list, look up a customer by email in the Customers reference, or handle errors.

Introduction Authentication