Skip to main content
All JobTicket B2B API endpoints (except Health Check) require authentication using HTTP Basic Auth with API key credentials issued from the Developer Portal.

​
Getting your credentials

Credentials are issued per API key in the Developer Portal. Each key has a username and password and a specific set of permissions that controls which endpoints it can access.

Production Portal

Manage production API keys

Staging Portal

Manage staging API keys

​
How to authenticate

Combine your username and password with a colon, Base64-encode the result, and pass it in the Authorization header on every request.

​
Example

The -u flag in curl handles the Base64 encoding automatically. In other HTTP clients, encode username:password with Base64 yourself and set the header manually:

​
Permissions

Each API key is granted one or more permissions in the Developer Portal. The table below lists every permission and the endpoints it unlocks.
The Trigger HR Sync endpoint requires all four permissions — view-employees, add-employees, update-employees, and remove-employees — to be granted on the same API key.

​
Servers

Use the staging server with staging credentials when building and testing your integration. Staging and production credentials are separate — they are not interchangeable.