Get a single payroll

get

https://api.gusto-demo.com/v1/companies/{company_id}/payrolls/{payroll_id}

Returns a payroll. If payroll is calculated or processed, will return employee_compensations and totals. Results are paginated, with a maximum page size of 100 employee_compensations.

Notes:

Hour and dollar amounts are returned as string representations of numeric decimals.
Hours are represented to the thousands place; dollar amounts are represented to the cent.
Every eligible compensation is returned for each employee. If no data has yet be inserted for a given field, it defaults to “0.00” (for fixed amounts) or “0.000” (for hours ).
When include parameter with benefits value is passed, employee_benefits:read scope is required to return benefits
- Benefits containing PHI are only visible with the employee_benefits:read:phi scope

scope: payrolls:read

Path Params

company_id

string

required

The UUID of the company

payroll_id

string

required

The UUID of the payroll

Query Params

include

array of strings

Include the requested attribute in the response, for multiple attributes comma separate the values, i.e. ?include=benefits,deductions,taxes

include

page

integer

The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.

per

integer

Number of objects per page. For majority of endpoints will default to 25

sort_by

string

enum

Field to sort employee compensations by

Allowed:

Headers

X-Gusto-API-Version

string

enum

Defaults to 2026-02-01

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

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful

404Not Found