Get an employer's HRIS connection

employers.retrieve_hris(employer_id) -> 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

employer_id: String

Unique employer identifier (empr_*)

ReturnsExpand Collapse

class EmployerRetrieveHRISResponse { data }

Response containing a single employer hris resource.

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: Time

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: Integer

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

Get an employer's HRIS connection

require "vitable_connect"

vitable_connect = VitableConnect::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

response = vitable_connect.employers.retrieve_hris("empr_abc123def456")

puts(response)

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