Skip to main content

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.
API access is disabled by default. To get started, contact JobTicket+ support at [email protected] to request that API access is enabled for your company account. Once enabled, you can manage your API keys and webhooks from the Developer Portal.

Base URLs

EnvironmentBase URL
Staginghttps://v1-api-staging.ticket-plus.app
Productionhttps://v1-api.ticket-plus.app
Always develop and test against staging before switching to production.

Authentication

All endpoints use HTTP Basic Auth — Base64-encode your username:password and pass it in the Authorization header.
Authorization: Basic <base64(username:password)>
Invalid or missing credentials return 401 Unauthorized. Manage your API keys in the Developer Portal.

Key Concepts

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.
Pass sortField and sortOrder (asc / desc) on any list endpoint. Allowed sort fields vary per endpoint — see the individual endpoint reference.

Rate Limiting

100 requests per minute per API credential (60-second rolling window). Exceeding the limit returns 429 Too Many Requests and blocks your credentials for 5 minutes.
Prefer paginated list calls (up to 100 results per page) over many single-record fetches to stay within limits.

Error Codes

CodeMeaning
200Success
204Success, no body
400Malformed request — fix before retrying
401Invalid or missing credentials
403Valid credentials but insufficient permissions
404Resource not found — check the id in the path
409Conflict with current resource state
422Business-logic validation failed — response body has field-level details
429Rate limit exceeded — wait for retry-after seconds
500Server error — contact [email protected]
502 / 503 / 504Gateway/upstream issues — retry with exponential back-off

Support

For integration questions or credential requests, contact your JobTicket+ account manager or email [email protected].