Get HR Integration

Retrieve full details for a single HR integration by its ID.

GET /hr-integrations/{id}

cURL

curl --request GET \
  --url "https://v1-api.ticket-plus.app/hr-integrations/7" \
  --header "Authorization: Basic <base64(clientId:clientSecret)>"

200

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

curl --request GET \
  --url "https://v1-api.ticket-plus.app/hr-integrations/7" \
  --header "Authorization: Basic <base64(clientId:clientSecret)>"

200

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

id · integer · required

The unique numeric ID of the HR integration to retrieve.

Response

data · object · required

Show properties

id · integer · required

Unique integration identifier.

name · string · required

Display name of the integration, e.g. "BambooHR".

type · string · required

Integration type. Allowed values: - hr-integration — syncs from a third-party HR system. - api-integration — you push employee data directly via the sync API.

status · string · required

Connection health. Allowed values: - active — connected and working normally. - invalid — credentials have expired or been revoked; re-authentication required. - inactive — integration has been disabled.

initialConnectionStatus · string · required

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.

lastSyncId · string | null

ID of the most recent sync operation. null if no sync has run yet.

lastSynced · string | null

ISO 8601 timestamp of the last completed sync. null if no sync has run.

lastSyncStatus · string | null

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.

canTriggerSync · boolean · required

true if a manual sync can be triggered via Push HR Sync. Only true when status is active and setup is complete.

resource · string · required

Resource type label. Always "hr-integration".

_links · object · required

HAL hypermedia links.

Show properties

self · object · required

Link to this integration resource.

Show properties

href · string · required

URL of this integration.

type · string · required

Media type.

Authorizations

Authorization · string · header · required

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

id · integer · required

The unique numeric ID of the HR integration to retrieve.

Response

200 - application/json

The requested HR integration's full record.

data · object

Show child attributes