v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Salary Estimates

Get a salary estimate

Retrieve a salary estimate by its UUID. Returns the estimated salary calculation along with all occupation details, revenue, and location information.

scope: salary_estimates:read

get/v1/salary_estimates/{uuid}

Path parameters

uuidstring required

The UUID of the salary estimate

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

uuidstring required

The UUID of the salary estimate.

employee_uuidstring nullable required

The UUID of the employee this salary estimate is for.

employee_job_uuidstring nullable

The UUID of the employee job this salary estimate is associated with (once accepted).

annual_net_revenuestring nullable required

The annual net revenue of the business used for salary calculations.

zip_codestring nullable required

The ZIP code used for location-based salary calculations.

resultinteger nullable

The calculated reasonable salary estimate in cents. Null if not yet calculated.

accepted_atstring date-time nullable

The timestamp when this salary estimate was accepted and finalized.

created_atstring date-time required

The timestamp when this salary estimate was created.

updated_atstring date-time required

The timestamp when this salary estimate was last updated.