Get an employer's HRIS connection

employers.retrieve_hris() -> EmployerRetrieveHRISResponse

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

employer_id: str

Unique employer identifier (empr_*)

ReturnsExpand Collapse

class EmployerRetrieveHRISResponse: …

Response containing a single employer hris resource.

data: Data

hris: Optional[DataHRIS]

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

last_sync_on: Optional[datetime]

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

formatdate-time

provider: str

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

provider_label: str

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

status: str

Connection status reported by the integration.

synced_row_count: Optional[int]

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

Get an employer's HRIS connection

import os
from vitable_connect import VitableConnect

client = VitableConnect(
    api_key=os.environ.get("VITABLE_CONNECT_API_KEY"),  # This is the default and can be omitted
)
response = client.employers.retrieve_hris(
    "empr_abc123def456",
)
print(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
    }
  }
}