Documentation Index
Fetch the complete documentation index at: https://allridegmbh.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The JobTicket B2B API lets employers and HR platforms manage employee transit subscriptions programmatically — retrieve employee records, manage documents, trigger HR syncs, and receive real-time events via webhooks.Developer Portal
Manage API keys and webhook endpoints
Webhooks
Receive real-time subscription change events
Base URLs
| Environment | Base URL |
|---|---|
| Staging | http://v1-api-staging.ticket-plus.app |
| Production | http://v1-api.ticket-plus.app |
Authentication
All endpoints use HTTP Basic Auth — Base64-encode yourusername:password and pass it in the Authorization header.
401 Unauthorized. Manage your API keys in the Developer Portal.
Key Concepts
Pagination
Pagination
All list endpoints use page-based pagination via
page (default 1) and
perPage (default 10, max 100) query parameters. Responses wrap results
in a data envelope with page, perPage, totalPages, and total fields.Sorting
Sorting
Pass
sortField and sortOrder (asc / desc) on any list endpoint.
Allowed sort fields vary per endpoint — see the individual endpoint reference.HAL Links (_links)
HAL Links (_links)
Every resource includes a
_links object with pre-built href + type pairs
for related resources (e.g. self, employeeDocuments). Use these instead of
constructing URLs manually.Rate Limiting
100 requests per minute per API credential (60-second rolling window). Exceeding the limit returns429 Too Many Requests and blocks your credentials for 5 minutes.
Error Codes
| Code | Meaning |
|---|---|
200 | Success |
204 | Success, no body |
400 | Malformed request — fix before retrying |
401 | Invalid or missing credentials |
403 | Valid credentials but insufficient permissions |
404 | Resource not found — check the id in the path |
409 | Conflict with current resource state |
422 | Business-logic validation failed — response body has field-level details |
429 | Rate limit exceeded — wait for retry-after seconds |
500 | Server error — contact [email protected] |
502 / 503 / 504 | Gateway/upstream issues — retry with exponential back-off |