Introduction

Integrate your HR systems with the JobTicket+ JobTicket platform

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 [e-mail] 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

Environment	Base URL
Staging	http://v1-api-staging.ticket-plus.app
Production	http://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

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

Pass sortField and sortOrder (asc / desc) on any list endpoint. Allowed sort fields vary per endpoint — see the individual endpoint reference.

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 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

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 [e-mail]
502 / 503 / 504	Gateway/upstream issues — retry with exponential back-off

---

Support

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