API Basics

A read-only HTTP API for department vendors and partners. Each endpoint returns data scoped to one department — the department is resolved from the API key, so a vendor working with multiple departments needs one key per department.

• Base URL: https://api.stationwise.com
• Auth: X-API-Key header (issued per department by Stationwise staff — contact your Stationwise rep)
• Content type: JSON (camelCase keys)
• Rate limit: 5 requests / minute / API key (returns 429 Too Many Requests when exceeded)

Authentication

Every request must include the header:

X-API-Key: <api-key-provided>

The key is shown once at creation time and cannot be recovered after — store it securely.

Keys can be revoked (one-way; cannot be undone) or given an expiry date. A revoked or expired key returns 401 Unauthorized.

A request without a valid key returns 401 Unauthorized.

Endpoints

• Department API — the department's name and battalions.
• Shift Schedule API — position assignments for a given date.

For the error response shapes and status codes shared by both endpoints, see Error Handling.

Versioning & change policy

This API is currently unversioned. Backward-incompatible changes will be announced in advance to API key holders via email. Adding new optional fields to response objects is not a breaking change.