Skip to content

Commit 5ee8ba5

Browse files
edit event endpoint pages
1 parent 5384310 commit 5ee8ba5

File tree

2 files changed

+30
-30
lines changed

2 files changed

+30
-30
lines changed

docs/api/admin/create-event.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The following are examples of payload sent to the API:
6767
"space_id": null,
6868
"external_id": "9876",
6969
"participation_info": "Bring your own blanket and snacks.",
70-
"occation_type_id": 2,
70+
"occasion_type_id": 2,
7171
"languages": ["en", "de"],
7272
"min_age": 12,
7373
"max_age": 99,

docs/api/public/get/events.md

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

5757

5858
### Accessibility Flags (bitmask)

0 commit comments

Comments
 (0)