API documentatie

Overzicht

Met de Inzetrooster REST API kun je diensten tonen op je eigen website of integreren in je eigen applicatie. Je kunt diensten opvragen met dezelfde filters die beschikbaar zijn op de pagina Alle diensten.

De API geeft JSON terug en gebruikt tokengebaseerde authenticatie. Elk verzoek moet je API-token meesturen in de request header. Tokens zijn alleen beschikbaar voor premium accounts en kunnen hier gevonden worden.

Alle actieve groepen worden teruggegeven, inclusief privé-groepen. Zorg er daarom voor dat je API-token alleen gedeeld wordt met vertrouwde partijen.

Authenticatie

Elk verzoek moet een Authorization-header bevatten met een Bearer-token:

Authorization: Bearer <jouw-api-token>

Verzoeken zonder geldig token krijgen een 401 Unauthorized-melding terug:

{"error": "Invalid or expired API token"}

Neem contact op met Inzetrooster support om een API-token aan te vragen.

Diensten eindpunt

GET /:account/api/v1/shifts

Geeft een gepagineerde lijst van diensten terug voor jouw account. Zonder filters worden de diensten van de komende 12 maanden teruggegeven.

Filterparameters

Alle filterparameters zijn optioneel en kunnen vrij gecombineerd worden. Gebruik komma's voor meerdere waarden, bijv. group_ids=5,2.

Parameter

Type

Omschrijving

group_ids

integers (komma-gescheiden)

Filter op één of meerdere groep-ID's.

months

integers (komma-gescheiden)

Filter op maandnummer (1 = januari … 12 = december).

years

integers (komma-gescheiden)

Filter op jaar, bijv. 2026.

weeks

integers (komma-gescheiden)

Filter op ISO-weeknummer (1–53).

days

integers (komma-gescheiden)

Filter op dag van de week (1 = zondag, 2 = maandag … 7 = zaterdag).

location_ids

integers (komma-gescheiden)

Filter op één of meerdere locatie-ID's.

day

datum (YYYY-MM-DD)

Diensten voor één specifieke datum.

date_from

datum (YYYY-MM-DD)

Diensten vanaf (en met) deze datum. Combineer met date_to voor een periode, ook als deze een jaargrens overschrijdt. Kan ook los gebruikt worden voor een open einde.

date_to

datum (YYYY-MM-DD)

Diensten tot (en met) deze datum. Kan ook los gebruikt worden voor een open begin.

published

boolean

Standaard worden alleen gepubliceerde diensten teruggegeven. Gebruik published=false om ook nog niet gepubliceerde diensten op te halen.

months en years worden per jaar gecombineerd en kunnen dus geen periode over een jaargrens teruggeven (bijv. december 2026 t/m januari 2027). Gebruik hiervoor date_from en date_to.

weeks gebruikt het ISO-weeknummer en werkt correct over een jaargrens heen (bijv. week 53 geeft alleen de dagen terug die daadwerkelijk bij die ISO-week horen, ook als sommige daarvan in januari van het volgende jaar vallen). Wordt weeks of days gebruikt zonder years, dan worden alle jaren doorzocht maar alleen vanaf vandaag (geen diensten uit het verleden); voeg years toe om ook oudere voorkomens mee te nemen.

Sorteervolgorde

De resultaten worden gesorteerd op basis van de sorteervolgorde die is ingesteld in de accountinstellingen. De standaard volgorde is op datum en tijd. Wanneer sorteren op groep is ingesteld, worden de resultaten gesorteerd op datum, groepnaam en vervolgens tijd.

Paginaparameters

Parameter

Standaard

Omschrijving

page

1

Paginanummer.

per_page

500

Resultaten per pagina. Maximum is 500.

Antwoordformaat

Het antwoord is JSON met een shifts-array en een meta-object voor paginering.

{
  "shifts": [
    {
      "id": 123,
      "date": "2026-05-01",
      "start_time": "09:00",
      "end_time": "17:00",
      "end_date": "2026-05-01",
      "group": {
        "id": 5,
        "name": "Ochtendploeg"
      },
      "location": {
        "name": "Grote zaal",
        "address": "Kerkstraat 1, Amsterdam"
      },
      "person": {
        "name": "Jan de Vries"
      },
      "publish_date": "2026-04-01",
      "remarks": "Neem je badge mee",
      "starred": false,
      "cancelled": false,
      "noshow": false
    }
  ],
  "meta": {
    "total": 42,
    "page": 1,
    "per_page": 500,
    "total_pages": 1
  }
}

Veldnamen

Veld

Omschrijving

id

Uniek dienst-ID.

date

Startdatum van de dienst (YYYY-MM-DD).

start_time / end_time

Begin- en eindtijd (HH:MM, 24-uurs notatie).

end_date

Einddatum van de dienst. Gelijk aan date bij ééndagsdiensten.

group

De groep waar deze dienst bij hoort (id + naam).

location

Locatienaam en adres. null als er geen locatie is ingesteld.

person

Naam van de ingeschreven persoon. null als de dienst open is.

publish_date

Datum vanaf wanneer de dienst zichtbaar is voor gebruikers (YYYY-MM-DD).

remarks

Optionele opmerking bij de dienst.

starred

true als de dienst gemarkeerd (starred) is.

cancelled

true als de dienst is geannuleerd.

noshow

true als de ingeschreven persoon niet is komen opdagen.

Voorbeelden

Alle komende diensten (standaard)

curl -H "Authorization: Bearer <token>" \
  "https://inzetrooster.nl/jouwaccount/api/v1/shifts"

Diensten voor een specifieke maand en jaar

curl -H "Authorization: Bearer <token>" \
  "https://inzetrooster.nl/jouwaccount/api/v1/shifts?months=5&years=2026"

Diensten van een specifieke groep

curl -H "Authorization: Bearer <token>" \
  "https://inzetrooster.nl/jouwaccount/api/v1/shifts?group_ids=5"

Diensten van meerdere groepen

curl -H "Authorization: Bearer <token>" \
  "https://inzetrooster.nl/jouwaccount/api/v1/shifts?group_ids=5,2"

Diensten op één specifieke datum

curl -H "Authorization: Bearer <token>" \
  "https://inzetrooster.nl/jouwaccount/api/v1/shifts?day=2026-05-01"

Diensten in een periode over een jaargrens heen

curl -H "Authorization: Bearer <token>" \
  "https://inzetrooster.nl/jouwaccount/api/v1/shifts?date_from=2026-12-01&date_to=2027-01-31"

Door meerdere pagina's bladeren

curl -H "Authorization: Bearer <token>" \
  "https://inzetrooster.nl/jouwaccount/api/v1/shifts?years=2026&page=2&per_page=50"

JavaScript (fetch)

fetch('/jouwaccount/api/v1/shifts?months=5&years=2026', {
  headers: { 'Authorization': 'Bearer <token>' }
})
.then(r => r.json())
.then(data => console.log(data.shifts));

Foutmeldingen

HTTP-status

Betekenis

200 OK

Verzoek geslaagd.

400 Bad Request

Ongeldige waarde voor date_from of date_to (verwacht formaat: YYYY-MM-DD).

401 Unauthorized

Ontbrekend, ongeldig of verlopen API-token.

404 Not Found

Account niet gevonden.

Rooster maken

Uitleg gebruikers

Uitleg beheerders

Overige