API docs by Redocly

Verbandspartner API (2.2.1)

Download OpenAPI specification:

The Verbandspartner API allows you to access events from the platform. You can use this API to search for events, filter events by various criteria, and get detailed information about individual events.

/api/v1/events

Authorizations:
ApiKeyAuth
query Parameters
period
string or null
Enum: "past" "upcoming" "next_month" "all"

Filter events by period: past shows events that have already ended, upcoming shows events that have not yet started, next_month shows events that start in the next month from now, all shows all events

search
string or null

Search for events by name, description, or tags

tags
Array of strings or null

Comma separated list of tags to filter events by

scope
string or null
Enum: "public" "private"

Filter events by scope: public shows only public events, private shows only private events

status
string or null
Enum: "draft" "published" "canceled" "completed" "all"

Filter events by status: draft shows only draft events, published shows only published events, canceled shows only canceled events, completed shows only completed events

sortKey
string or null
Enum: "startAt" "name" "category"
sortOrder
string or null
Enum: "asc" "desc"
page
integer or null <int32>
size
integer or null <int32>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}