Skip to main content

Introduction

OpenAgenda provides a REST API for reading and editing event content programmatically.

Data from published agendas is available under an open license. Exports are available in several formats: PDF, spreadsheet, ICS, text.

Although the API is free to use, it requires authentication for both read and write operations. This constraint allows us to more effectively combat abusive usage.

To learn more about authentication, go here

Main Entities​

Agendas​

OpenAgenda allows you to manage event content within agendas. These agendas are administered by a community of moderators or administrators who decide on the input form configuration, the contribution workflow to be followed by contributors with whom they can communicate via a messaging system specific to the agenda. Agendas can be discovered via the following route:

https://api.openagenda.com/v2/agendas

An agenda's configuration can be viewed via the following route:

https://api.openagenda.com/v2/agendas/{agendaUID}

Go here for more details.

Events​

An agenda's events can be viewed, edited, published, and searched via the following group of routes:

https://api.openagenda.com/v2/agendas/{uid}/events

Go here for more details.

Locations​

An agenda's locations can be viewed, edited, and deleted via the following group of routes:

https://api.openagenda.com/v2/agendas/{uid}/locations

Go here for more details.

Getting Started​

To start using the OpenAgenda API:

  1. Create an account if you don't have one
  2. Retrieve your API key from your settings
  3. Check the Authentication section to learn how to use your key
  4. Explore the Agendas section to see how to view and edit agendas
  5. Explore the Events section to see how to view and edit events published on agendas