v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Companies

Get the custom fields of a company

Returns a list of the custom fields of the company. Useful when you need to know the schema of custom fields for an entire company.

scope: companies:read

get/v1/companies/{company_id}/custom_fields

Path parameters

company_idstring required

The UUID of the company

Query parameters

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

successful