Stagewerk API

The Stagewerk API gives an organiser's own systems read access to the data on its public event pages: events, classes, the entry list, the itinerary, bulletins and published results. It is read-only. Everything is JSON over HTTPS under /api/v1.

The examples use two shell variables. STAGEWERK_URL is the address of the Stagewerk site you sign in to, for example https://your-stagewerk-host, and STAGEWERK_KEY is your API key.

Get an API key

Keys belong to an organiser, not to a person. The organiser's owner opens API keys in the console (/t/{organiser}/api-keys), gives the key a name that says what uses it, and creates it. The key is shown once, in a box at the top of the page. Copy it into your secret store straight away: Stagewerk keeps only a hash and cannot show it again. Create one key per integration so you can revoke one without touching the others. The page lists each key with the time it was last used, and Revoke stops a key working immediately.

A key can read that organiser's data and nothing else. It cannot read another organiser, and it cannot change anything.

Authenticate

Send the key as a bearer token on every request.

curl -H "Authorization: Bearer $STAGEWERK_KEY" -H "Accept: application/json" "$STAGEWERK_URL/api/v1/events"

A missing, wrong or revoked key gets 401. Always send Accept: application/json.

Pagination

List endpoints that can grow (events, entries, bulletins) use cursor pagination. A response looks like this:

{
    "data": [ ... ],
    "links": { "first": null, "last": null, "prev": null, "next": "https://.../api/v1/events?cursor=eyJ..." },
    "meta": { "path": "https://.../api/v1/events", "per_page": 50, "next_cursor": "eyJ...", "prev_cursor": null }
}

Ask for a page size with limit (1 to 100, default 50). To get the next page, request links.next, or repeat the request with cursor set to meta.next_cursor. When meta.next_cursor is null you have everything. Treat cursors as opaque strings. Lists that are always short (classes, itinerary) are returned whole.

Sparse fields

Add fields with a comma-separated list of keys to receive only those keys in each object, for example fields=competition_number,driver_name. An unknown key returns 422 and the message lists the keys that exist. The keys of every object are listed in the reference below.

Rate limits

Each key may make 120 requests a minute. Every response carries X-RateLimit-Limit and X-RateLimit-Remaining. Over the limit you get 429 with a Retry-After header holding the seconds to wait. Back off for that long, then continue.

Errors

Errors are JSON with a message. Validation errors (422) also have an errors object keyed by parameter.

Worked example: an entry list

This builds an entry-list page for one event: find the event, read its classes, then read every entry.

1. List the organiser's events and pick one by its slug.

   curl -s -H "Authorization: Bearer $STAGEWERK_KEY" -H "Accept: application/json" \
     "$STAGEWERK_URL/api/v1/events?fields=name,slug,starts_on,status"
   

   { "data": [ { "name": "Club Rallysprint", "slug": "club-rallysprint", "starts_on": "2027-03-14", "status": "entries_open" } ], "links": { ... }, "meta": { ... } }
   

2. Read the classes, to show group headings (code and name match class_code and class_name on each entry).

   curl -s -H "Authorization: Bearer $STAGEWERK_KEY" -H "Accept: application/json" \
     "$STAGEWERK_URL/api/v1/events/club-rallysprint/classes?fields=code,name,sort_order"
   

3. Read the entry list, 100 at a time.

   curl -s -H "Authorization: Bearer $STAGEWERK_KEY" -H "Accept: application/json" \
     "$STAGEWERK_URL/api/v1/events/club-rallysprint/entries?limit=100&fields=competition_number,class_name,driver_name,co_driver_name,vehicle_description"
   

   {
       "data": [
           {
               "competition_number": 7,
               "class_name": "Club Sprint",
               "driver_name": "A. Driver",
               "co_driver_name": null,
               "vehicle_description": "2004 Subaru Impreza"
           }
       ],
       "links": {
           "first": null,
           "last": null,
           "prev": null,
           "next": "https://.../entries?limit=100&cursor=eyJ..."
       },
       "meta": {
           "path": "https://.../entries",
           "per_page": 100,
           "next_cursor": "eyJ...",
           "prev_cursor": null
       }
   }
   

4. While meta.next_cursor is not null, request the same URL with &cursor=<next_cursor> and append data.

The entry list holds the entries that have a place in the event. It shows names, class, vehicle and state. It never includes email addresses, phone numbers, licence numbers or dates of birth.

TypeScript types

resources/js/api/v1.d.ts in the Stagewerk repository holds TypeScript types generated from the OpenAPI document. Generate your own from /developers/openapi.json with npx openapi-typescript.

Reference

The sections below are generated from the same OpenAPI 3.1 document you can download at /developers/openapi.json.

Changelog

• 8 November 2026: /api/v1/events/{event}/entries now returns 404 until the organiser publishes the entry list on the Widgets page. Publish the list there, then the endpoint returns it.