Get benefits for a company

get https://api.gusto-demo.com/v1/companies/{company_id}/company_benefits

Company benefits represent the benefits that a company is offering to employees. This ties together a particular supported benefit with the company-specific information for the offering of that benefit.

Note that company benefits can be deactivated only when no employees are enrolled.

Benefits containing PHI are only visible to applications with the company_benefits:read:phi scope.

scope: company_benefits:read

Responses

Response body

array of objects

object

version

string

The current version of the object. See the versioning guide for information on how to use this field.

uuid

string

required

The UUID of the company benefit.

benefit_type

number

The type of the benefit to which the company benefit belongs.

active

boolean

Defaults to true

Whether this benefit is active for employee participation. Company benefits may only be deactivated if no employees are actively participating.

description

string

length ≥ 1

The description of the company benefit.For example, a company may offer multiple benefits with an ID of 1 (for Medical Insurance). The description would show something more specific like “Kaiser Permanente” or “Blue Cross/ Blue Shield”.

deletable

boolean

Whether this company benefit can be deleted. Deletable will be set to true if the benefit has not been used in payroll, has no employee benefits associated, and the benefit is not owned by Gusto or a Partner

supports_percentage_amounts

boolean

Whether employee deductions and company contributions can be set as percentages of payroll for an individual employee. This is determined by the type of benefit and is not configurable by the company.

responsible_for_employer_taxes

boolean

Whether the employer is subject to pay employer taxes when an employee is on leave. Only applicable to third party sick pay benefits.

responsible_for_employee_w2

boolean

Whether the employer is subject to file W-2 forms for an employee on leave. Only applicable to third party sick pay benefits.

404

Not Found

The requested resource does not exist. Make sure the provided ID/UUID is valid.

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.gusto-demo.com/v1/companies/company_id/company_benefits \
3
     --header 'accept: application/json'


xxxxxxxxxx
14
 
1
[
2
  {
3
    "uuid": "d2cec746-caee-464a-bcaf-00d93f7049c9",
4
    "version": "98jr3289h3298hr9329gf9egskt3kagri32qqgiqe3872",
5
    "company_uuid": "528cc543-8a41-497e-b479-23a4c5ec77ac",
6
    "benefit_type": 1,
7
    "active": true,
8
    "description": "Kaiser Permanente",
9
    "deletable": true,
10
    "supports_percentage_amounts": true,
11
    "responsible_for_employer_taxes": false,
12
    "responsible_for_employee_w2": false
13
  }
14
]

200Example response