Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Employees

Get employee payment details for a company

Fetches payment details for employees in a given company. Results are paginated.

Use the employee_uuid query parameter to filter for a single employee. Use the payroll_uuid query parameter to filter for employees on a specific payroll. Providing both employee_uuid and payroll_uuid will result in a 422 error. An empty array is returned if the company has no employees or if no employees match the filter criteria.

The encrypted_account_number in the splits array is only visible if the employee_payment_methods:read:account_number scope is present.

scope: employee_payment_methods:read

get/v1/companies/{company_id}/employees/payment_details

Path parameters

company_idstring required

The UUID of the company

Query parameters

employee_uuidstring

The UUID of a specific employee to fetch payment details for.

payroll_uuidstring

The UUID of a specific payroll to fetch payment details for employees on that payroll.

pageinteger

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

perinteger

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

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

A list of employee payment details.

employee_uuidstring

The UUID of the employee.

first_namestring

The legal first name of the employee.

last_namestring

The last name of the employee.

payment_method'Direct Deposit' | 'Check'

The type of payment method.

split_by'Amount' | 'Percentage' nullable

How the payment is split. This field is applicable when payment_method is "Direct Deposit". If split_by is Percentage, then the split amounts must add up to exactly 100. If split_by is Amount, the last split amount must be null to capture the remainder.