---
title: "Get page settings"
description: "The Preorder pages settings (Preorders > Settings > Pages): whether the Preorder button shows on the home, collection and search pages, and whether collection pages show the preorder badge when any variant is a preorder."
url: https://docs.stoqapp.com/v2-reference/preorders-settings/get-page-settings/
api: "API v2 reference"
method: GET
path: "/preorders/settings/pages"
---

# Get page settings

`GET https://app.stoqapp.com/api/v2/external/preorders/settings/pages`

The Preorder pages settings (Preorders &gt; Settings &gt; Pages): whether the Preorder button shows on the home, collection and search pages, and whether collection pages show the preorder badge when any variant is a preorder. Shop-wide, not per offer. Product pages always show the button. The locations and markets these pages count stock at are [`GET /account/markets`](https://docs.stoqapp.com/v2-reference/account-markets/get-market-settings/); the page's CSS selectors are [`GET /preorders/settings/developer`](https://docs.stoqapp.com/v2-reference/preorders-settings/get-developer-settings/).

**Note:** Change them with [`PATCH /preorders/settings/pages`](https://docs.stoqapp.com/v2-reference/preorders-settings/update-page-settings/). All are off on a new shop. show_badge_if_any_variant_is_preorder applies to every product list with the Preorder button on, not only collections, and shows a badge only for offers that have their badge turned on.

## Returns

- `home` (object)
  - `enabled` (boolean): e.g. `true`
- `collection` (object)
  - `enabled` (boolean): e.g. `true`
  - `show_badge_if_any_variant_is_preorder` (boolean): e.g. `true`
- `search` (object)
  - `enabled` (boolean): e.g. `true`

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/settings/pages" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "home": {
    "enabled": true
  },
  "collection": {
    "enabled": true,
    "show_badge_if_any_variant_is_preorder": true
  },
  "search": {
    "enabled": true
  }
}
```

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

