Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Companies

Get suspensions for this company

Get existing suspension records for this company. A company may have multiple suspension records if they have suspended their Gusto account more than once.

📘 To check if company is already suspended

To determine if a company is currently suspended, use the is_suspended and company_status fields in the Get a company endpoint.

scope: company_suspensions:read

get/v1/companies/{company_uuid}/suspensions

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 response

uuidstring

Unique identifier for this suspension.

company_uuidstring

Unique identifier for the company which is suspended.

effective_datestring

Date that the suspension took effect.

leaving_forstring nullable

Which competitor the company is joining instead. Only required if reason is 'switching_provider'.

reasonstring

Explanation for why the company's account was suspended.

reconcile_tax_method'pay_taxes' | 'refund_taxes'

How Gusto will handle taxes already collected.

file_quarterly_formsboolean

Should Gusto file quarterly tax forms on behalf of the company? The correct answer can depend on why the company is suspending their account, and how taxes are being reconciled.

file_yearly_formsboolean

Should Gusto file yearly tax forms on behalf of the company? The correct answer can depend on why the company is suspending their account, and how taxes are being reconciled.

commentsstring nullable

User-supplied comments describing why they are suspending their account.