Lists

List and retrieve lists

A group of customers the venue sends to.

The list object

The same for every key, live or test: there is no test copy of it.

idstringrequired

A list id, lst_ and 22 characters.

object"list"required

namestringrequired

slugstringrequired

descriptionstringrequirednullable

kindstringrequirednullable

manual, or a list kept by a rule.

created_atstringrequired

A UTC instant, ISO 8601, e.g. 2026-10-08T03:00:00.000Z.

updated_atstringrequired

A UTC instant, ISO 8601, e.g. 2026-10-08T03:00:00.000Z.

The list object

{
  "id": "lst_0TMXp8QPR6yGvKuV2GZQ10",
  "object": "list",
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "kind": "<string>",
  "created_at": "2026-10-08T03:00:00.000Z",
  "updated_at": "2026-10-08T03:00:00.000Z"
}

List lists

GEThttps://api.hatcel.com/lists

Any key

Every list the key can see, newest first, a page at a time.

Query parameters

limitinteger

How many to return, 1 to 100. Defaults to 25.

starting_afterstring

The next_cursor of the page before. Omit it for the first page.

updated_sincestring

Only rows changed at or after this instant, ISO 8601 with an offset.

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

200 response

{
  "object": "list",
  "data": [
    {
      "id": "lst_0TMXp8QPR6yGvKuV2GZQ10",
      "object": "list",
      "name": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "kind": "<string>",
      "created_at": "2026-10-08T03:00:00.000Z",
      "updated_at": "2026-10-08T03:00:00.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJ0IjoiMjAyNi0xMC0wOFQwMzowMDowMC4wMDBaIiwiaSI6IjBmOGZhZDViIn0"
}

Retrieve a list

GEThttps://api.hatcel.com/lists/{id}

Any key

One list by its id, with its version in the ETag header. Another object's id, or one this key cannot see, is a 404.

Path parameters

idstringrequired

The list's id, lst_ and 22 characters.

curl "https://api.hatcel.com/lists/lst_0TMXp8QPR6yGvKuV2GZQ10" \
  -H "Authorization: Bearer $HATCEL_API_KEY" \
  -H "Hatcel-Version: 2026-10-08"

200 response

{
  "id": "lst_0TMXp8QPR6yGvKuV2GZQ10",
  "object": "list",
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "kind": "<string>",
  "created_at": "2026-10-08T03:00:00.000Z",
  "updated_at": "2026-10-08T03:00:00.000Z"
}

Tags Bookings