---
title: "List Checkout Fields"
description: "Use GET /checkoutfields to list configured checkout fields. The operation is CheckoutField.findAll."
canonical: https://docs.ordering.co/api-reference/guides/get-checkoutfields/
---

# List Checkout Fields

> **API operation:** [Open the endpoint in Scalar](https://docs.ordering.co/api-reference/#tag/checkoutfields/GET/checkoutfields)

Use `GET /checkoutfields` to list configured checkout fields. The operation is `CheckoutField.findAll`.

The operation exposes this read without authentication. With `mode=dictionary`, the response is keyed by each field's `code` instead of returning an array; each value includes `name`, `type`, `required`, and `enabled`.

See [Checkout fields model](https://docs.ordering.co/api-reference/guides/checkoutfields-model/).

## OpenAPI reference

**Operation:** `GET /checkoutfields`

**Query parameters**

| Name      | Type   | Required | Description                                                                                                                                              |
| --------- | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `params`  | string | No       | Comma-separated list of fields. It is intersected with the model’s $fillable; an empty or invalid list returns all fields.                               |
| `orderBy` | string | No       | Field to sort by, with `-` prefixed for descending order. Multiple fields can be chained with commas.                                                    |
| `where`   | string | No       | JSON filter over the fields the model declares as filterable. Valid fields for each resource are exposed in its `x-ordering-whereable` schema extension. |
| `mode`    | string | No       | —                                                                                                                                                        |

**Responses**

| Code | Description                               |
| ---- | ----------------------------------------- |
| 200  | OK (Envelope)                             |
| 400  | Bad Request (ErrorResponse)               |
| 401  | Unauthorized (ProjectAccessErrorResponse) |
| 404  | Not Found                                 |
| 429  | Too Many Requests (ErrorResponse)         |
| 500  | Internal Server Error (ErrorResponse)     |
| 503  | Service Unavailable (ErrorResponse)       |

[Open this operation in the API reference](https://docs.ordering.co/api-reference/#tag/checkoutfields/GET/checkoutfields)