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. 
Authorization: Basic Base64(username:password)

​
Example

curl https://v1-api.ticket-plus.app/employees \
  -u "your_username:your_password"
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: 
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

​
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.
PermissionDescriptionEndpoints
view-employeesRead employee records and their documents.List Employees, Get Employee, List Employee Documents, List All Documents, Get Document, Download Document
view-hr-integrationsRead HR integration records and sync status.List HR Integrations, Get HR Integration
view-billingRead billing items — the charges on your company’s invoices, including per-employee ticket charges, pricing, and billing periods. Use the ticket charges to build payroll data.List Billing Items, Get Billing Item, Export Billing Items
add-employeesCreate new employee records during a sync.Trigger HR Sync
update-employeesUpdate existing employee records during a sync.Trigger HR Sync
remove-employeesOffboard employees no longer in the roster during a sync.Trigger HR Sync
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

EnvironmentBase URL
Productionhttps://v1-api.ticket-plus.app
Staginghttps://v1-api-staging.ticket-plus.app
Use the staging server with staging credentials when building and testing your integration. Staging and production credentials are separate — they are not interchangeable.