Skip to content

Commit b0c0575

Browse files
update get events endpoint
1 parent 15d3448 commit b0c0575

File tree

1 file changed

+10
-40
lines changed

1 file changed

+10
-40
lines changed

docs/api/public/get/events.md

Lines changed: 10 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -8,46 +8,16 @@
88

99
Retrieve all upcoming events. Optional query parameters can be used to filter results, for example by date, type, or location.
1010

11-
## Query Parameters
12-
13-
| Parameter | Type | Description |
14-
|------------------------|----------|-------------|
15-
| `lang` | string | Language code to filter event content (e.g., `en`, `de`). |
16-
| `past` | boolean | If present, include past events. |
17-
| `start` | string | Start date filter (`YYYY-MM-DD`). |
18-
| `end` | string | End date filter (`YYYY-MM-DD`). |
19-
| `time` | string | Filter by event time (`HH:MM` or time range). |
20-
| `search` | string | Search term for event title, description, or keywords. |
21-
| `events` | string | Comma-separated list of event IDs to include. |
22-
| `venues` | string | Comma-separated list of venue IDs. |
23-
| `spaces` | string | Comma-separated list of space IDs. |
24-
| `organizers` | string | Comma-separated list of organizer IDs. |
25-
| `countries` | string | Comma-separated list of country codes (ISO 3166-1 alpha-2). |
26-
| `postal_code` | string | Filter by postal code. |
27-
| `lon` | number | Longitude for geospatial filtering. |
28-
| `lat` | number | Latitude for geospatial filtering. |
29-
| `radius` | number | Radius in meters for location-based filtering. |
30-
| `space_types` | string | Comma-separated list of space type IDs. |
31-
| `title` | string | Filter events by title. |
32-
| `city` | string | Filter events by city. |
33-
| `accessibility` | string | Comma-separated list of accessibility features (e.g., wheelchair). |
34-
| `visitor_infos` | string | Comma-separated list of visitor info filters (e.g., age restrictions). |
35-
| `age` | string | Filter by minimum or exact age. |
36-
| `limit` | integer | Limit the number of results returned. |
37-
| `offset` | integer | Offset for pagination. |
38-
39-
40-
**URL:** `/api/events`
41-
**Method:** GET
42-
**Description:** Returns a list of events with optional filtering, pagination, and expanded fields.
43-
44-
**URL:** `/api/event-type-summary`
45-
**Method:** GET
46-
**Description:** Returns a summary of events grouped by event type, including the number of event dates for each type. Filters can be applied as query parameters.
47-
48-
**URL:** `/api/event-venue-summary`
49-
**Method:** GET
50-
**Description:** Returns a summary of events grouped by venue, including the number of event dates per venue. Filters can be applied as query parameters.
11+
12+
<span class="func-signature">GET /api/event-type-summary/{optional query parameters}</ul>
13+
14+
Returns a summary of events grouped by event type, including the number of event dates for each type. Filters can be applied as query parameters.
15+
16+
17+
<span class="func-signature">GET /api/event-venue-summary/{optional query parameters}</ul>
18+
19+
Returns a summary of events grouped by venue, including the number of event dates per venue. Filters can be applied as query parameters.
20+
5121

5222

5323
### Query Parameters (Filters)

0 commit comments

Comments
 (0)