Skip to content

Commit a08ebd4

Browse files
update get events endpoint country codes
1 parent b0c0575 commit a08ebd4

File tree

1 file changed

+29
-28
lines changed

1 file changed

+29
-28
lines changed

docs/api/public/get/events.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
---
44

5-
# Endpoint
5+
# Endpoints
66

77
<span class="func-signature">GET /api/events/{optional query parameters}</ul>
88

@@ -22,35 +22,36 @@ Returns a summary of events grouped by venue, including the number of event date
2222

2323
### Query Parameters (Filters)
2424

25-
| Filter | Type | Allowed Values / Examples | Notes |
26-
|--------|------|--------------------------|-------|
27-
| `past` | boolean | `true`, `false` | Include past events if `true`. Defaults to future events only. |
25+
| Filter | Type | Allowed Values / Examples | Notes |
26+
|--------|------|----------------------------------|-------|
27+
| `past` | boolean | `true`, `false` | Include past events if `true`. Defaults to future events only. |
2828
| `start` | date string | `YYYY-MM-DD`, e.g., `2026-01-01` | Event start date ≥ this value. |
2929
| `end` | date string | `YYYY-MM-DD`, e.g., `2026-12-31` | Event end date ≤ this value. |
30-
| `last_event_start_at` | timestamp | `YYYY-MM-DDTHH:MM:SSZ` | Pagination: only events after this datetime. |
31-
| `last_event_date_id` | int | `131762` | Pagination: only events after this event_date_id. |
32-
| `time` | string / range | `18:00-21:00` | Filter by start time. |
33-
| `search` | string | `"Lesung"` | Full-text search in title/description. |
34-
| `events` | comma-separated ints | `123,456,789` | Filter by event IDs. |
35-
| `venues` | comma-separated ints | `10,20` | Filter by venue IDs. |
36-
| `spaces` | comma-separated ints | `5,6` | Filter by space IDs. |
37-
| `space_types` | comma-separated ints | `1,2` | Filter by space type IDs. |
38-
| `organizations` | comma-separated ints | `42,43` | Filter by organization IDs. |
39-
| `countries` | comma-separated ISO codes | `DE,DK` | Filter events by venue country. |
40-
| `postal_code` | string | `"24118"` | Filter by postal code. |
41-
| `title` | string | `"Autumn Festival"` | Partial match in event title. |
42-
| `city` | string | `"Berlin"` | Match venue city. |
43-
| `event_types` | JSON array | `[[1,5],[2,null]]` | `[type_id, genre_id]`. Use `null` for genre if not filtered. |
44-
| `tags` | comma-separated strings | `"music,festival,autumn"` | Filter events containing tags. |
45-
| `accessibility` | int (bitmask) | `1`, `2`, `4`, ... | Space accessibility flags. Combine with bitwise OR. |
46-
| `visitor_infos` | int (bitmask) | `1`, `2`, `4`, ... | Visitor info flags. Combine with bitwise OR. |
47-
| `age` | int or range | `12`, `12-99` | Filter events suitable for this age or range. |
48-
| `lon` | float | `13.404954` | Longitude for radius filtering. |
49-
| `lat` | float | `52.520008` | Latitude for radius filtering. |
50-
| `radius` | int (km) | `10` | Radius around lon/lat. |
51-
| `offset` | int | `0`, `50` | Pagination offset. |
52-
| `limit` | int | `10`, `50` | Pagination limit. |
53-
| `language` | string | `"de"`, `"en"` | Filter events by language. |
30+
| `last_event_start_at` | timestamp | `YYYY-MM-DDTHH:MM:SSZ` | Pagination: only events after this datetime. |
31+
| `last_event_date_id` | int | `131762` | Pagination: only events after this event_date_id. |
32+
| `time` | string / range | `18:00-21:00` | Filter by start time. |
33+
| `search` | string | `"Lesung"` | Full-text search in title/description. |
34+
| `events` | comma-separated ints | `123,456,789` | Filter by event IDs. |
35+
| `venues` | comma-separated ints | `10,20` | Filter by venue IDs. |
36+
| `spaces` | comma-separated ints | `5,6` | Filter by space IDs. |
37+
| `space_types` | comma-separated ints | `1,2` | Filter by space type IDs. |
38+
| `organizations` | comma-separated ints | `42,43` | Filter by organization IDs. |
39+
| `countries` | comma-separated ISO codes | `DEU,DKNK` | Filter events by venue country. |
40+
| `postal_code` | string | `"24118"` | Filter by postal code. |
41+
| `title` | string | `"Autumn Festival"` | Partial match in event title. |
42+
| `city` | string | `"Berlin"` | Match venue city. |
43+
| `event_types` | JSON array | `[[1,5],[2,null]]` | `[type_id, genre_id]`. Use `null` for genre if not filtered. |
44+
| `tags` | comma-separated strings | `"music,festival,autumn"` | Filter events containing tags. |
45+
| `accessibility` | int (bitmask) | `1`, `2`, `4`, ... | Space accessibility flags. Combine with bitwise OR. |
46+
| `visitor_infos` | int (bitmask) | `1`, `2`, `4`, ... | Visitor info flags. Combine with bitwise OR. |
47+
| `age` | int or range | `12`, `12-99` | Filter events suitable for this age or range. |
48+
| `lon` | float | `13.404954` | Longitude for radius filtering. |
49+
| `lat` | float | `52.520008` | Latitude for radius filtering. |
50+
| `radius` | int (km) | `10` | Radius around lon/lat. |
51+
| `offset` | int | `0`, `50` | Pagination offset. |
52+
| `limit` | int | `10`, `50` | Pagination limit. |
53+
| `language` | string | `"de"`, `"en"` | Filter events by language. |
54+
5455

5556
### Accessibility Flags (bitmask)
5657

0 commit comments

Comments
 (0)