Quickstart
This guide will get you all set up and ready to use the Ferienpass API. We'll cover how to make your first API request and where to go next to find all the information you need.
Base URL
Every municipality using Ferienpass has its own dedicated instance with its own base URL. The API is always available under the /api/ path of the respective domain:
https://{tenant-domain}/api/
Replace {tenant-domain} with the actual domain of your Ferienpass instance, for example ferienpass-musterstadt.de.
Public access vs. authenticated access
The API can be used without authentication to retrieve publicly visible offers — the same offers that are shown on the Ferienpass website. No API token is needed for this.
If you are a host organization and need to access your own offers regardless of their publication status, you need to authenticate with a Personal Access Token. See the authentication guide for details.
Making your first API request
The following example fetches the list of all currently published offers. No authentication is required.
curl https://ferienpass-musterstadt.de/api/offers
Filtering offers
You can filter offers by date, edition, fee, and more using query parameters:
Filter by edition alias
curl "https://ferienpass-musterstadt.de/api/offers?edition.alias=sommerferienprogramm-2024"
Filter by date range
curl "https://ferienpass-musterstadt.de/api/offers?dates.begin%5Bafter%5D=2024-07-01&dates.begin%5Bbefore%5D=2024-07-31"