Get an employer's HRIS connection

client.employers.retrieveHRIS(, ?): EmployerRetrieveHRISResponse { data }

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.

ParametersExpand Collapse

employerID: string

Unique employer identifier (empr_*)

ReturnsExpand Collapse

EmployerRetrieveHRISResponse { data }

Response containing a single employer hris resource.

data: Data { hris }

hris: HRIS | null

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

last_sync_on: string | null

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 | null

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

Get an employer's HRIS connection

import VitableConnect from '@vitable-inc/vitable-connect';

const client = new VitableConnect({
  apiKey: process.env['VITABLE_CONNECT_API_KEY'], // This is the default and can be omitted
});

const response = await client.employers.retrieveHRIS('empr_abc123def456');

console.log(response.data);

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