---
title: "List custom fields"
method: GET
path: "/v1/businesses/{client_id}/custom-fields"
tags: ["Custom Fields"]
---

# List custom fields

`GET /v1/businesses/{client_id}/custom-fields`

Returns a paginated list of custom fields for the given business.

## Path parameters

- `client_id` integer, required

## Query parameters

- `offset` integer
- `limit` integer

## Response `200`

OK

- CustomFieldListResponse
  - `count` integer — Total number of custom fields.
  - `next` string, nullable — Pagination cursor for the next page.
  - `previous` string, nullable — Pagination cursor for the previous page.
  - `results` CustomField[]
    - `id` string, uuid — The unique identifier for this custom field.
    - `name` string — The display name of the custom field.
    - `field_type` 'LIST' | 'FREE_TEXT' — The type of the custom field.
    - `budget_setting` 'NONE' | 'SOME' | 'ALL_CURRENT_AND_NEW' — Controls which budgets this custom field is assigned to.
    - `is_manager_only` boolean — Whether this custom field is visible only to managers. Cannot be changed after creation.
    - `created_by` 'MANUAL' | 'PUBLIC_API' | 'XERO' | 'MYOB' | 'QUICKBOOKS' | 'NETSUITE' | 'BUSINESS_CENTRAL' — The source that created this custom field.
    - `created` string, date-time — The date and time when this custom field was created.
    - `updated` string, date-time — The date and time when this custom field was last updated.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/letsweel/apis/weel-openapi.md) · [All operations](https://skmtc.net/letsweel/apis/weel-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/letsweel/weel-openapi/revisions/55da5fa350fb/schema)