API Reference

Employers

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Retrieve Payroll Access Setup

employers.retrieve_payroll_access_setup(employer_id) -> EmployerRetrievePayrollAccessSetupResponse { data }

GET/v1/employers/{employer_id}/payroll-access-setup

Return whether the employer has submitted payroll access setup.

ParametersExpand Collapse

employer_id: String

Unique employer identifier (empr_*)

ReturnsExpand Collapse

class EmployerRetrievePayrollAccessSetupResponse { data }

Response containing a single payroll access setup status resource.

data: { completed, submitted_at}

completed: bool

submitted_at: Time

formatdate-time

Retrieve Payroll Access Setup

Ruby

HTTP

TypeScript

Python

Ruby

require "vitable_connect"

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

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

puts(response)

200 example

{
  "data": {
    "completed": true,
    "submitted_at": "2019-12-27T18:11:19.117Z"
  }
}

Returns Examples

200 example

{
  "data": {
    "completed": true,
    "submitted_at": "2019-12-27T18:11:19.117Z"
  }
}