curl --request POST \
--url "https://v1-api.ticket-plus.app/hr-integrations/7/sync" \
--header "Authorization: Basic <base64(clientId:clientSecret)>" \
--header "Content-Type: application/json" \
--data '{
"syncId": "sync-2024-05-14-001",
"employees": [
{
"firstName": "Anna",
"lastName": "Müller",
"email": "anna.mueller@example.com",
"profileImage": null,
"dateOfBirth": "1990-04-15",
"hrId": "emp_HR_001",
"startDate": "2022-03-01",
"terminationDate": null,
"autoSyncEmployee": null,
"absences": []
}
]
}'
import requests, base64
credentials = base64.b64encode(b"<clientId>:<clientSecret>").decode()
res = requests.post(
"https://v1-api.ticket-plus.app/hr-integrations/7/sync",
headers={
"Authorization": f"Basic {credentials}",
"Content-Type": "application/json",
},
json={
"syncId": "sync-2024-05-14-001",
"employees": [
{
"firstName": "Anna",
"lastName": "Müller",
"email": "anna.mueller@example.com",
"profileImage": None,
"dateOfBirth": "1990-04-15",
"hrId": "emp_HR_001",
"startDate": "2022-03-01",
"terminationDate": None,
"autoSyncEmployee": None,
"absences": [],
}
],
},
)
print(res.status_code) # 204
const credentials = Buffer.from("<clientId>:<clientSecret>").toString("base64");
const res = await fetch(
"https://v1-api.ticket-plus.app/hr-integrations/7/sync",
{
method: "POST",
headers: {
Authorization: `Basic ${credentials}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
syncId: "sync-2024-05-14-001",
employees: [
{
firstName: "Anna",
lastName: "Müller",
email: "anna.mueller@example.com",
profileImage: null,
dateOfBirth: "1990-04-15",
hrId: "emp_HR_001",
startDate: "2022-03-01",
terminationDate: null,
autoSyncEmployee: null,
absences: [],
},
],
}),
},
);
console.log(res.status); // 204
(empty body)
HR Integrations
Trigger HR Sync
Push the current employee roster from your HR system to JobTicket.
POST
/
hr-integrations
/
{id}
/
sync
curl --request POST \
--url "https://v1-api.ticket-plus.app/hr-integrations/7/sync" \
--header "Authorization: Basic <base64(clientId:clientSecret)>" \
--header "Content-Type: application/json" \
--data '{
"syncId": "sync-2024-05-14-001",
"employees": [
{
"firstName": "Anna",
"lastName": "Müller",
"email": "anna.mueller@example.com",
"profileImage": null,
"dateOfBirth": "1990-04-15",
"hrId": "emp_HR_001",
"startDate": "2022-03-01",
"terminationDate": null,
"autoSyncEmployee": null,
"absences": []
}
]
}'
import requests, base64
credentials = base64.b64encode(b"<clientId>:<clientSecret>").decode()
res = requests.post(
"https://v1-api.ticket-plus.app/hr-integrations/7/sync",
headers={
"Authorization": f"Basic {credentials}",
"Content-Type": "application/json",
},
json={
"syncId": "sync-2024-05-14-001",
"employees": [
{
"firstName": "Anna",
"lastName": "Müller",
"email": "anna.mueller@example.com",
"profileImage": None,
"dateOfBirth": "1990-04-15",
"hrId": "emp_HR_001",
"startDate": "2022-03-01",
"terminationDate": None,
"autoSyncEmployee": None,
"absences": [],
}
],
},
)
print(res.status_code) # 204
const credentials = Buffer.from("<clientId>:<clientSecret>").toString("base64");
const res = await fetch(
"https://v1-api.ticket-plus.app/hr-integrations/7/sync",
{
method: "POST",
headers: {
Authorization: `Basic ${credentials}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
syncId: "sync-2024-05-14-001",
employees: [
{
firstName: "Anna",
lastName: "Müller",
email: "anna.mueller@example.com",
profileImage: null,
dateOfBirth: "1990-04-15",
hrId: "emp_HR_001",
startDate: "2022-03-01",
terminationDate: null,
autoSyncEmployee: null,
absences: [],
},
],
}),
},
);
console.log(res.status); // 204
(empty body)
Submits your complete current employee roster to JobTicket. The API performs a full reconciliation — adding new employees, updating changed records, and offboarding employees no longer in the list.
This endpoint is only available for HR integrations of type API Integration. Attempting to trigger a sync on an integration of any other type will return a
422 Unprocessable Entity error.curl --request POST \
--url "https://v1-api.ticket-plus.app/hr-integrations/7/sync" \
--header "Authorization: Basic <base64(clientId:clientSecret)>" \
--header "Content-Type: application/json" \
--data '{
"syncId": "sync-2024-05-14-001",
"employees": [
{
"firstName": "Anna",
"lastName": "Müller",
"email": "anna.mueller@example.com",
"profileImage": null,
"dateOfBirth": "1990-04-15",
"hrId": "emp_HR_001",
"startDate": "2022-03-01",
"terminationDate": null,
"autoSyncEmployee": null,
"absences": []
}
]
}'
import requests, base64
credentials = base64.b64encode(b"<clientId>:<clientSecret>").decode()
res = requests.post(
"https://v1-api.ticket-plus.app/hr-integrations/7/sync",
headers={
"Authorization": f"Basic {credentials}",
"Content-Type": "application/json",
},
json={
"syncId": "sync-2024-05-14-001",
"employees": [
{
"firstName": "Anna",
"lastName": "Müller",
"email": "anna.mueller@example.com",
"profileImage": None,
"dateOfBirth": "1990-04-15",
"hrId": "emp_HR_001",
"startDate": "2022-03-01",
"terminationDate": None,
"autoSyncEmployee": None,
"absences": [],
}
],
},
)
print(res.status_code) # 204
const credentials = Buffer.from("<clientId>:<clientSecret>").toString("base64");
const res = await fetch(
"https://v1-api.ticket-plus.app/hr-integrations/7/sync",
{
method: "POST",
headers: {
Authorization: `Basic ${credentials}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
syncId: "sync-2024-05-14-001",
employees: [
{
firstName: "Anna",
lastName: "Müller",
email: "anna.mueller@example.com",
profileImage: null,
dateOfBirth: "1990-04-15",
hrId: "emp_HR_001",
startDate: "2022-03-01",
terminationDate: null,
autoSyncEmployee: null,
absences: [],
},
],
}),
},
);
console.log(res.status); // 204
(empty body)
This is a full-roster replace operation. Any employee omitted from the
employees array will be offboarded in JobTicket. Always include every
currently active employee in the payload.Path Parameters
number
required
The unique numeric ID of the HR integration to sync against. Must refer to an integration of type API Integration. Obtain this from
List HR Integrations.
Body
string
required
A unique identifier for this sync operation. Used for idempotency and audit
logging. Use a UUID or timestamp-based string. Re-submitting with the same
syncId is safe — duplicate submissions will be deduplicated.object[]
required
The complete current employee roster from your HR system. Must contain at least one employee. Employees absent from this list will be offboarded in JobTicket.
Show employee object
Show employee object
string
required
Employee’s first name.
string
required
Employee’s last name.
string
required
Employee’s work email address. Used to match against existing JobTicket accounts.
string | null
required
URL to the employee’s profile photo. Pass
null if not available.string
required
Date of birth in
YYYY-MM-DD format.string
required
The employee’s unique identifier in your HR system. Used to match records across syncs — must be stable and never reused for a different person.
string
required
Employment start date in
YYYY-MM-DD format.string | null
required
Termination date in
YYYY-MM-DD format. Set this when the employee is leaving the company or has been deleted from your HR system. Pass null if the employee is still active.boolean | null
required
Controls whether this employee is automatically included in future scheduled syncs. This field is only relevant if you have configured a custom field in your HR system to manage employee subscription eligibility — in that case, pass
true or false based on the custom field value. If you are not using a custom field to control subscriptions, this field is not applicable and should be set to null.object[]
required
Current absences for this employee. Pass an empty array
[] if there are none.Show absence object
Show absence object
string
required
The unique ID of the absence type as it exists in your HR system. This is an opaque identifier — pass the raw ID your HR system assigns to the absence type, without mapping or transforming it.
string
required
Unique identifier for this specific absence record in your HR system.
string
required
Absence start date in
YYYY-MM-DD format.string
required
Absence end date in
YYYY-MM-DD format.boolean
required
Set to
true if the absence has been approved. Set to false if the absence has been rejected or deleted from your HR system.Response
null
204 No Content — The sync has been accepted and will process in the
background. The response body is empty.Authorizations
HTTP Basic Auth using your API key credentials. Use the username and password issued from the Developer Portal. Encode them as Base64(username:password) and pass in the Authorization: Basic <token> header.
Path Parameters
The unique numeric ID of the HR integration to sync against.
Body
application/json
A unique identifier for this sync operation. Used for idempotency and audit logging. Use a UUID or timestamp-based string.
The complete current employee roster from your HR system. Must contain at least one employee. Employees absent from this list will be offboarded in JobTicket.
Minimum array length:
1Show child attributes
Show child attributes
Response
204 - application/json
Sync accepted and will process in the background. The response body is empty.
Empty body on success.