---
title: "Get the custom fields of a company"
method: GET
path: "/v1/companies/{company_id}/custom_fields"
tags: ["Companies"]
---

# Get the custom fields of a company

`GET /v1/companies/{company_id}/custom_fields`

## Request

- Base URL: `https://api.gusto-demo.com`
- URL: `https://api.gusto-demo.com/v1/companies/{company_id}/custom_fields`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/gusto/apis/gusto-api/docs/v1/companies/:company_id/custom_fields/get.ts> (a function with typed inputs; its response is checked against the schema)

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`

## Path parameters

- `company_id` string, required

## Query parameters

- `page` integer
- `per` integer

## Headers

- `X-Gusto-API-Version` '2026-06-15'

## Response `200`

successful

- CompanyCustomFieldList
  - `custom_fields` CompanyCustomField[]
    - `uuid` string, required: UUID of the company custom field
    - `name` string, required: Name of the company custom field
    - `type` 'text' | 'currency' | 'number' | 'date' | 'radio', required: Input type for the custom field.
    - `description` string, nullable: Description of the company custom field
    - `selection_options` string[], nullable: An array of options for fields of type radio. Otherwise, null.

## Other responses

- `404`: Not Found The requested resource does not exist. Make sure the provided UUID is valid.

---

[API](https://skmtc.dev/gusto/apis/gusto-api.md) - [All operations](https://skmtc.dev/gusto/apis/gusto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gusto/apis/gusto-api/revisions/f98575fa2a5e?raw)