---
title: "List request custom fields, optionally scoped to a category"
method: GET
path: "/custom-fields"
tags: ["Custom fields"]
---

# List request custom fields, optionally scoped to a category

`GET /custom-fields`

## Request

- Base URL: `https://helpspot.example.com/api/v2`
- URL: `https://helpspot.example.com/api/v2/custom-fields`
- Auth: one of:
  - HTTP bearer
  - HTTP basic

## Query parameters

- `category_id` integer

## Response `200`

Unpaginated lookup collection. See this resource group for field definitions.

- object
  - `data` CustomFieldResource[], required
    - `id` integer
    - `name` string, nullable
    - `type` string, nullable
    - `required` boolean
    - `always_visible` boolean
    - `position` integer
    - `max_length` integer
    - `decimal_places` integer
    - `pattern` string, nullable
    - `options` CustomFieldOption[]
      - `value` string, required
      - `label` string, required
      - `children` CustomFieldOption[], required
    - `public` boolean

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `405`: Method Not Allowed
- `406`: Not Acceptable
- `413`: Content Too Large
- `422`: Validation error
- `429`: Too Many Requests
- `500`: Internal Server Error
- `503`: Service Unavailable

---

[API](https://skmtc.dev/helpspot/apis/helpspot-api-v2.md) · [All operations](https://skmtc.dev/helpspot/apis/helpspot-api-v2/llms.txt) · [OpenAPI document](https://skmtc.dev/helpspot/apis/helpspot-api-v2/revisions/794dac0002c0?raw)