GET /events

Scope

Din API nøgle skal have scopet read.events for at bruge denne API.

Hent events

Få en liste af dine events. Du vil kun få events der hører til den bruger API nøglen også hører til.

Resultat

Hvis request'en er godkendt får du et JSON object tilbage. I objektet er der en liste af events, antallet af events i resultatet og en URL til næste side givet de samme search params.

{
  events: Event[]; // Liste af events.
  count: number; // Antal af `events` i dette resultat.
  next: string; // URL til næste side, givet de samme search params.
}

Search params

Når du laver en GET request til /events kan du sætte nogle search params/query på, for at specificere resultatet. De er alle valgfrie.

from. En dato i et ISO format.
- Få kun de begivenheder der starter efter den givne dato.
to. En dato i et ISO format.
- Få kun de begivenheder der slutter op til den givne dato.
createdAfter. En dato i et ISO format.
- Få kun de begivenheder der er oprettet efter denne dato.
updatedAfter. En dato i et ISO format.
- Få kun de begivenheder der er opdateret efter denne dato. En opdatering er når en bruger har ændret en begivenheds detaljer/information.
createdBefore. En dato i et ISO format.
- Få kun de begivenheder der er oprettet før denne dato.
updatedBefore. En dato i et ISO format.
- Få kun de begivenheder der er opdateret før denne dato. En opdatering er når en bruger har ændret en begivenheds detaljer/information.
visibility. "public" | "unlisted" | "private".
- Få kun de begivenheder der har den givet synlighed. Hvis ingen visibility er givet, bliver alle begivenheder sendt.
tags. En liste af tag ID'er.
- Få kun de begivenheder der har et eller flere af de givet tags.
- Husk at lave listen om til en string, f.eks.: '["tag1","tag2"]'.
excludeTags. "true" | "false".
- Bliver kun brugt hvis tags er givet. I stedet for at få begivenheder med de givet tags, så bliver de begivenheder med de givet tags sorteret fra.
venueId. ID til en venue.
- Få kun de begivenheder der er hører sammen med den givet venue.
limit. Et heltal.
- Få maks. det antal af begivenheder som er givet. Hvis et limit ikke er givet bliver det sat til 10.
orderBy. "title" | "participants" | "date.start" | "date.end".
- Vælg hvordan begivenhederne skal sorteres. Efter titlen, antal deltagere, start dato eller slut dato. Hvis orderBy ikke er sat bliver begivenhederne sorteret efter deres ID.
orderByDirection. "asc" | "desc".
- Bliver kun brugt hvis orderBy er givet. Vælg hvilken retning begivenhederne skal sorteret. Hvis orderByDirection ikke er givet bliver den sat til "asc".
startAfter. Et event ID.
- Givet de øvrige indstillinger, kan vi vælge at vi ikke vil starte fra det første event, men derimod et event længere inde i listen. Det kan være brugbart for pagination.
select. En liste af fields.
- Vælge kun at få bestemte data fields i resultatet. Dette kan hjælpe med at få dataen hurtigere, da der ikke skal sendes ligeså meget.