---
title: "Get Configurations"
description: "Use GET /configs to list configurations visible to the caller. The operation is Config.findAll."
canonical: https://docs.ordering.co/api-reference/guides/get-configs/
---

# Get Configurations

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

Use `GET /configs` to list configurations visible to the caller. The operation is `Config.findAll`.

## Default list response

Without `mode`, the operation returns `result` as an array. `dictionary` is not a runtime default.

```json
{
  "error": false,
  "result": [
    {
      "id": 1,
      "key": "example_setting",
      "value": "example",
      "public": true,
      "hidden": false
    }
  ]
}
```

## Dictionary mode

Set `mode=dictionary` to return an object indexed by configuration `key` instead of an array:

```text
GET /configs?mode=dictionary
```

```json
{
  "error": false,
  "result": {
    "example_setting": {
      "id": 1,
      "key": "example_setting",
      "value": "example",
      "public": true,
      "hidden": false
    }
  }
}
```

Dictionary mode excludes v2-only configurations and omits `description` from model-backed entries. `mode=dashboard` is not an alias for dictionary mode.

## Visibility and access

Callers without administrator or server access may see only configurations where `public=true` and `hidden=false`, subject to plugin and business-manager exceptions. Requests may use an API key or bearer token; do not assume anonymous access is enabled.

Protected configurations can return `PROTECT` instead of their stored value. Never use documentation examples to expose or infer protected values.

## Legacy SDK example

```javascript
const list = await ordering.configs().get()
const dictionary = await ordering.configs().asDictionary().get()
```

SDK helper names and arguments may differ by version.

## OpenAPI reference

**Operation:** `GET /configs`

**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                          |
| 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/configs/GET/configs)