Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Alle Events abfragen

GET https://api.campflow.de/events

Fragt alle Events ab, die in campflow angelegt sind. Du kannst dies z.B. nutzen, um auf deiner Website eine Übersicht über alle Events anzuzeigen, Anmeldeformulare programmatisch einzubetten oder in ein anderes System zu integrieren.

Query Parameter
Key Typ Beschreibung
archived Boolean (optional) Bei true werden nur archivierte Events zurückgegeben, bei false nur nicht-archivierte. Wird der Parameter nicht übergeben, werden alle Events zurückgegeben.
GET https://api.campflow.de/events?archived=false
Status Codes / Troubleshooting
Status Code Hinweis
200 OK Erfolgreich
und weitere  
Response (Beispiel)
  • id enthält die Event-ID, welche als list_container_id beim Zugriff auf die Teilnehmendenliste verwendet werden sollte.
  • list_id enthält eine veraltete ID, die nur noch zum Zwecke der Rückwärtskompatibilität enthalten ist.
  • title enthält den Titel des Events.
  • published gibt an, ob das Event derzeit Anmeldungen annimmt.
  • start_date und end_date enthalten den Zeitraum des Events. Dabei handelt es sich nicht um den Anmeldezeitraum.
  • max_persons enthält die maximale Teilnehmendenzahl des Events. Bei unbeschränkter Anzahl ist diese null.
  • archived gibt an, ob das Event oder der zugehörige Ordner derzeit archiviert ist.
  • url enthält den Link zum Anmeldeformular.
  • embed_snippet enthält einen HTML-String mit einem Script-Tag, um das Anmeldeformular einzubetten.
  • collection ist null, falls das Event keinem Ordner angehört. Andernfalls wird ein Objekt mit der ID id und dem Namen name des Ordners zurückgegeben.
  • Es erfolgt keine Pagination, alle Events werden in einem Request zurückgegeben.
{
  "data": [
    {
      "id": "evt_4NtIABPura5xVh9NzJs0",
      "list_id": "lst_TLDgPkcqXQpDSuDw7YVw",
      "title": "Kostenloser Workshop",
      "published": false,
      "start_date": "2024-07-08",
      "end_date": "2024-07-08",
      "max_persons": null,
      "archived": true,
      "url": "https://on.campflow.de/jugend-musterstadt-ev/kostenloser-workshop",
      "embed_snippet": "<script src=\"https://embed.campflow.de\" data-slug=\"jugend-musterstadt-ev/kostenloser-workshop\"></script>",
      "collection": null
    },
    {
      "id": "evt_Ztpg2DxyDiveTy1N5iwQ",
      "list_id": "lst_YHpM8HSkFOBECnAs7STy",
      "title": "Ferienfreizeit in den Bergen",
      "published": true,
      "start_date": "2024-11-04",
      "end_date": "2024-11-14",
      "max_persons": 100,
      "archived": false,
      "url": "https://on.campflow.de/jugend-musterstadt-ev/ferienfreizeit-in-den-bergen",
      "embed_snippet": "<script src=\"https://embed.campflow.de\" data-slug=\"jugend-musterstadt-ev/ferienfreizeit-in-den-bergen\"></script>",
      "collection": {
        "id": "evc_N6dYiVA6zgsI59Bsc5tR",
        "name": "Ferienfreizeiten"
      }
    }
  ]
}