---
title: "List Custom Fields"
method: GET
path: "/custom_fields"
tags: ["Custom Fields"]
---

# List Custom Fields

`GET /custom_fields`

## Request

- Base URL: `https://secure.fleetio.com/api`
- URL: `https://secure.fleetio.com/api/custom_fields`
- Auth: API key in header `Authorization` and API key in header `Account-Token`
- TypeScript: <https://skmtc.dev/fleetio/apis/fleetio-developer-api/docs/custom_fields/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of custom fields defined for your account.

For details, please see [our guide on Custom Fields](/docs/overview/custom-fields).

## Query parameters

- `start_cursor` string
- `per_page` integer
- `filter` object
  - `custom_field_type` EqFilter
    - `eq` string, required
  - `created_at` union
    - object
      - `lt` string, required
    - object
      - `lte` string, required
    - object
      - `gt` string, required
    - object
      - `gte` string, required
  - `updated_at` union
    - object
      - `lt` string, required
    - object
      - `lte` string, required
    - object
      - `gt` string, required
    - object
      - `gte` string, required
- `sort` object
  - `id` 'asc' | 'desc'
  - `created_at` 'asc' | 'desc'
  - `updated_at` 'asc' | 'desc'

## Response `200`

OK

- object
  - `start_cursor` string, nullable: The current start cursor of the records returned.
  - `next_cursor` string, nullable: The next cursor to retrieve the next page of records.
  - `per_page` integer: The maximum number of records returned.
  - `estimated_remaining_count` integer: The number of remaining records including the returned records, up to a maximum of 500.
  - `filtered_by` union[]: The filters applied to the returned record set.
    - union
      - object
        - `custom_field_type` EqFilter
          - `eq` string, required
      - object
        - `created_at` union
          - object
            - `lt` string, required
          - object
            - `lte` string, required
          - object
            - `gt` string, required
          - object
            - `gte` string, required
      - object
        - `updated_at` union
          - object
            - `lt` string, required
          - object
            - `lte` string, required
          - object
            - `gt` string, required
          - object
            - `gte` string, required
  - `sorted_by` union[]: The sorts applied to the returned record set.
    - union
      - object
        - `updated_at` 'asc' | 'desc'
      - object
        - `created_at` 'asc' | 'desc'
      - object
        - `id` 'asc' | 'desc'
  - `records` CustomField[]
    - `id` integer
    - `created_at` string, date-time: The date and time at which this record was created.
    - `updated_at` string, date-time: The date and time at which this record was most recently updated.
    - `account_id` integer: The ID of the `Account` that this Custom Field belongs to.
    - `association_type` string, nullable: Used when `data_type` is `association` and `custom_field_type` is `custom_object_template` determines to which kind of record the Custom Field belongs to.
    - `custom_object_key` string, nullable: When `custom_field_type` is `custom_object_template` it determines to which key of the Custom Records it belongs to.
    - `primary_association` boolean, required: Whether this Custom Field is the primary association for its Custom Object.
    - `property_category` string, nullable: The property category that this Custom Field belongs to.
    - `custom_field_type` string, required
    - `data_type` 'checkbox' | 'currency' | 'date' | 'dropdown' | 'number' | 'text', required
    - `description` string, required
    - `key` string, required
    - `label` string, required
    - `required` boolean, required
    - `values` string[], nullable, required
    - `position` number, nullable, required
    - `can_update` boolean, required: Whether the user viewing this Custom Field can update it.
    - `is_calculated` boolean, required: Whether the value of this Custom Field is calculated from a formula instead of being entered by a user. Calculated Custom Fields always have a `data_type` of `number` or `currency`.
    - `calculated_custom_field_config` CalculatedCustomFieldConfig: The formula configuration for a Custom Field whose value is calculated rather than entered by a user. Only present on a Custom Field whose `is_calculated` is `true`.
      - `id` integer
      - `created_at` string, date-time: The date and time at which this record was created.
      - `updated_at` string, date-time: The date and time at which this record was most recently updated.
      - `account_id` integer, required: The ID of the `Account` that this configuration belongs to.
      - `custom_field_id` integer, required: The ID of the `Custom Field` whose value this configuration calculates.
      - `format` 'number' | 'percentage', required: How the calculated value is formatted.
      - `formula` string, required: The expression evaluated to produce the Custom Field's value. Variables in the expression refer to the `key` of another Custom Field on the same Custom Object.
      - `variables` string[], required: The keys of the Custom Fields referenced by `formula`.

## Other responses

- `400`: The format or parameters of the request was invalid
- `401`: Request could not be authenticated
- `500`: Something unexpected happened

## Changes

- **2026-11-06** `49558d744bd7`: 2 warning, 7 info
  - added the new `currency` enum value to the `records/items/data_type` response property for the response status `200`
  - added the new `number` enum value to the `records/items/data_type` response property for the response status `200`
  - for the `query` request parameter `per_page`, the min was decreased from `2.00` to `1.00`
  - added the optional property `records/items/association_type` to the response with the `200` status
  - …5 more

[Operation history](https://skmtc.dev/fleetio/apis/fleetio-developer-api/changes/custom_fields/get.md)

---

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