curl --request GET \
--url "https://v1-api.ticket-plus.app/hr-integrations/7" \
--header "Authorization: Basic <base64(clientId:clientSecret)>"
import requests, base64
credentials = base64.b64encode(b"<clientId>:<clientSecret>").decode()
res = requests.get(
"https://v1-api.ticket-plus.app/hr-integrations/7",
headers={"Authorization": f"Basic {credentials}"},
)
print(res.json())
const credentials = Buffer.from("<clientId>:<clientSecret>").toString("base64");
const res = await fetch("https://v1-api.ticket-plus.app/hr-integrations/7", {
headers: { Authorization: `Basic ${credentials}` },
});
console.log(await res.json());
{
"data": {
"id": 7,
"name": "BambooHR",
"type": "hr-integration",
"status": "active",
"initialConnectionStatus": "completed",
"lastSyncId": "sync_abc123",
"lastSynced": "2024-05-10T08:00:00Z",
"lastSyncStatus": "succeeded",
"canTriggerSync": true,
"resource": "hr-integration",
"_links": {
"self": { "href": "https://v1-api.ticket-plus.app/hr-integrations/7", "type": "application/json" }
}
}
}
HR Integrations
Get HR Integration
Retrieve full details for a single HR integration by its ID.
GET
/
hr-integrations
/
{id}
curl --request GET \
--url "https://v1-api.ticket-plus.app/hr-integrations/7" \
--header "Authorization: Basic <base64(clientId:clientSecret)>"
import requests, base64
credentials = base64.b64encode(b"<clientId>:<clientSecret>").decode()
res = requests.get(
"https://v1-api.ticket-plus.app/hr-integrations/7",
headers={"Authorization": f"Basic {credentials}"},
)
print(res.json())
const credentials = Buffer.from("<clientId>:<clientSecret>").toString("base64");
const res = await fetch("https://v1-api.ticket-plus.app/hr-integrations/7", {
headers: { Authorization: `Basic ${credentials}` },
});
console.log(await res.json());
{
"data": {
"id": 7,
"name": "BambooHR",
"type": "hr-integration",
"status": "active",
"initialConnectionStatus": "completed",
"lastSyncId": "sync_abc123",
"lastSynced": "2024-05-10T08:00:00Z",
"lastSyncStatus": "succeeded",
"canTriggerSync": true,
"resource": "hr-integration",
"_links": {
"self": { "href": "https://v1-api.ticket-plus.app/hr-integrations/7", "type": "application/json" }
}
}
}
Returns the complete record for one HR integration — connection status, last sync details, and whether a manual sync can be triggered.
curl --request GET \
--url "https://v1-api.ticket-plus.app/hr-integrations/7" \
--header "Authorization: Basic <base64(clientId:clientSecret)>"
import requests, base64
credentials = base64.b64encode(b"<clientId>:<clientSecret>").decode()
res = requests.get(
"https://v1-api.ticket-plus.app/hr-integrations/7",
headers={"Authorization": f"Basic {credentials}"},
)
print(res.json())
const credentials = Buffer.from("<clientId>:<clientSecret>").toString("base64");
const res = await fetch("https://v1-api.ticket-plus.app/hr-integrations/7", {
headers: { Authorization: `Basic ${credentials}` },
});
console.log(await res.json());
{
"data": {
"id": 7,
"name": "BambooHR",
"type": "hr-integration",
"status": "active",
"initialConnectionStatus": "completed",
"lastSyncId": "sync_abc123",
"lastSynced": "2024-05-10T08:00:00Z",
"lastSyncStatus": "succeeded",
"canTriggerSync": true,
"resource": "hr-integration",
"_links": {
"self": { "href": "https://v1-api.ticket-plus.app/hr-integrations/7", "type": "application/json" }
}
}
}
Path Parameters
The unique numeric ID of the HR integration to retrieve.
Response
Show properties
Show properties
Unique integration identifier.
Display name of the integration, e.g.
"BambooHR".Integration type. Allowed values: -
hr-integration — syncs from a
third-party HR system. - api-integration — you push employee data
directly via the sync API.Connection health. Allowed values: -
active — connected and working
normally. - invalid — credentials have expired or been revoked;
re-authentication required. - inactive — integration has been disabled.Onboarding progress. Allowed values: -
incomplete — setup has not been
completed. - final-sync-pending — setup done; awaiting first full sync.completed— fully set up and initial sync done.
ID of the most recent sync operation.
null if no sync has run yet.ISO 8601 timestamp of the last completed sync.
null if no sync has run.Outcome of the last sync.
null if no sync has run. Allowed values: -
succeeded — all records synced successfully. - partially-failed — some
records failed; job still completed. - failed — entire sync job failed.authentication-failed— sync failed due to invalid credentials.
true if a manual sync can be triggered via Trigger HR
Sync. Only true when status is
active and setup is complete.Resource type label. Always
"hr-integration".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 retrieve.
Response
200 - application/json
The requested HR integration's full record.
Show child attributes
Show child attributes
⌘I

