---
title: "Get a settings section"
description: "One settings section: label, description, settings (the output of the read actions behind it, keyed by block, e.g. settings.widget is GET /back_in_stock/settings/widget), columns (field path => model column) and raw (fie"
url: https://docs.stoqapp.com/v2-reference/account-settings/get-a-settings-section/
api: "API v2 reference"
method: GET
path: "/account/settings/{section_id}"
---

# Get a settings section

`GET https://app.stoqapp.com/api/v2/external/account/settings/{section_id}`

One settings section: label, description, `settings` (the output of the read actions behind it, keyed by block, e.g. settings.widget is [`GET /back_in_stock/settings/widget`](https://docs.stoqapp.com/v2-reference/back-in-stock-settings/get-widget-settings/)), `columns` (field path =&gt; model column) and `raw` (field path =&gt; stored value). Sections: delivery_settings, signup_widget, notification_channels, notification_templates, preorder_notifications, preorder_pages, preorder_storefront_text, integrations, languages.

**Note:** Read only: change a field with the PATCH of the block it comes from. Blocks that don't apply are left out (delivery_settings has `locations` only while a location filter is on). A block whose read fails is listed under `unavailable` with its error; the rest still return. Template sections are read in the alert language, given as `settings.locale`. `labels` names each field as the dashboard shows it. An unknown `section_id` fails with 422 `validation_failed`.

## Path parameters

- `section_id` (string, required): The settings section, as the dashboard's Settings page names it. One of: `delivery_settings`, `signup_widget`, `notification_channels`, `notification_templates`, `preorder_notifications`, `preorder_pages`, `preorder_storefront_text`, `integrations`, `languages`.

## Returns

The [settings object](https://docs.stoqapp.com/v2-reference/account-settings/).

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/account/settings/{section_id}" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: example response shown.

```json
{
  "label": "Languages",
  "description": "Dashboard language, alert language and multi-language support.",
  "settings": {
    "languages": {
      "default_locale": "en",
      "app_locale": "en",
      "multi_language_enabled": true,
      "product_translations_enabled": true
    }
  },
  "columns": {
    "languages.default_locale": "default_locale",
    "languages.app_locale": "app_locale",
    "languages.multi_language_enabled": "multi_language_enabled",
    "languages.product_translations_enabled": "product_translations_enabled"
  },
  "raw": {
    "languages.default_locale": "en",
    "languages.app_locale": "en",
    "languages.multi_language_enabled": true,
    "languages.product_translations_enabled": true
  },
  "labels": {
    "languages.multi_language_enabled": {
      "label": "Multi-language support",
      "label_id": "settings.multi_language_support",
      "menu_path": [
        "Back in stock alerts"
      ],
      "group": "Multi-language"
    },
    "languages.product_translations_enabled": {
      "label": "Use translations",
      "label_id": "settings.product_translations_support",
      "menu_path": [
        "Back in stock alerts"
      ],
      "group": "Multi-language",
      "shown_when": {
        "column": "multi_language_enabled",
        "label": "Multi-language support",
        "label_id": "settings.multi_language_support",
        "equals": true,
        "state": "on",
        "path": "languages.multi_language_enabled"
      },
      "effect": "Use translated product and variant titles based on the customer's language in all notifications.",
      "shown_now": 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
    }
  ]
}
```

## 404

The resource does not exist for this shop, or the action path is not registered.

```json
{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "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
    }
  ]
}
```

