Skip to content

Get an employer's HRIS connection

GET/v1/employers/{employer_id}/hris

Returns the employer’s HRIS connection — provider, status, last sync, and synced row count — or null when the employer has no integration. The caller must be authorized for the employer; an unknown or unauthorized employer returns 404.

Path ParametersExpand Collapse
employer_id: string

Unique employer identifier (empr_*)

ReturnsExpand Collapse
data: { hris }
hris: { last_sync_on, provider, provider_label, 2 more }

HRIS connection details, or null when the employer has no integration.

last_sync_on: string

When the last sync completed, or null when none has.

formatdate-time
provider: string

Id of the HRIS/payroll provider the employer is connected to (e.g. paylocity).

provider_label: string

Display name of that provider (e.g. Paylocity).

status: string

Connection status reported by the integration.

synced_row_count: number

Rows in the latest completed sync, or null when none has.

Get an employer's HRIS connection

curl https://api.vitablehealth.com/v1/employers/$EMPLOYER_ID/hris \
    -H "Authorization: Bearer $VITABLE_CONNECT_API_KEY"
{
  "data": {
    "hris": {
      "provider": "paychex_flex",
      "provider_label": "Paychex Flex",
      "status": "connected",
      "last_sync_on": "2026-05-01T00:00:00Z",
      "synced_row_count": 84
    }
  }
}
Returns Examples
{
  "data": {
    "hris": {
      "provider": "paychex_flex",
      "provider_label": "Paychex Flex",
      "status": "connected",
      "last_sync_on": "2026-05-01T00:00:00Z",
      "synced_row_count": 84
    }
  }
}