Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Payrolls

Get all payroll blockers for a company

Returns a list of reasons that prevent the company from running payrolls. See the Payroll Blockers guide for a complete list of reasons. The list is empty if there are no payroll blockers.

scope: payrolls:run

get/v1/companies/{company_uuid}/payrolls/blockers

Path parameters

company_uuidstring required

The UUID of the company

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Response

Successful

key'company_ownership_required' | 'contractor_only_company' | 'eftps_in_error' | 'geocode_error' | 'geocode_needed' | 'invalid_signatory' | 'missing_addresses' | 'missing_bank_info' | 'missing_bank_verification' | 'missing_employee_setup' | 'missing_federal_tax_setup' | 'missing_forms' | 'missing_industry_selection' | 'missing_pay_schedule' | 'missing_signatory' | 'missing_state_tax_setup' | 'needs_approval' | 'needs_onboarding' | 'pay_schedule_setup_not_complete' | 'pending_information_request' | 'pending_payroll_review' | 'pending_recovery_case' | 'soft_suspended' | 'suspended' required

A unique identifier for the payroll blocker reason. For a complete list of blockers and their meanings, see the Payroll Blockers guide.

messagestring required

A human-readable message describing the payroll blocker and what action is needed to resolve it.

Example response

[
  {
    "key": "needs_approval",
    "message": "Company needs to be approved to run payroll."
  }
]