---
title: "Get storefront translations"
description: "Read every translation override on the shop's notify-me button, signup form, and preorder button/modal text, plus the full enumeration of translatable field paths, each field's default-locale source text, and every local"
url: https://docs.stoqapp.com/v2-reference/account-translations/get-storefront-translations/
api: "API v2 reference"
method: GET
path: "/account/translations"
---

# Get storefront translations

`GET https://app.stoqapp.com/api/v2/external/account/translations`

Read every translation override on the shop's notify-me button, signup form, and preorder button/modal text, plus the full enumeration of translatable field paths, each field's default-locale source text, and every locale the shop has actually published.

**Note:** Read only. To write a translation, pass `locale` to [`PATCH /back_in_stock/settings/widget`](https://docs.stoqapp.com/v2-reference/back-in-stock-settings/update-widget-settings/) (Notify me button, signup form, opt-in email) or [`PATCH /preorders/settings/storefront_text`](https://docs.stoqapp.com/v2-reference/preorders-settings/update-storefront-text/) (preorder button and modal). `translations` holds only the fields with an override, by locale, and is `{}` when there are none. `published_locales` always includes the alert language and can lag a change in Shopify by a few minutes.

## Returns

- `default_locale` (string): e.g. `string`
- `locales` (array of strings)
- `published_locales` (array of strings)
- `fields` (array of strings)
- `source_values` (object)
  - `notify_button.text` (string): e.g. `string`
  - `notify_button.resubscribe_text` (string): e.g. `string`
  - `notify_button.email_button_text` (null)
  - `preorder_button.out_of_stock_text` (string): e.g. `string`
  - `preorder_button.add_to_cart_text` (string): e.g. `string`
  - `preorder_button.modal_continue_text` (string): e.g. `string`
  - `preorder_button.modal_cancel_text` (string): e.g. `string`
  - `signup_form.header` (string): e.g. `string`
  - `signup_form.description` (string): e.g. `string`
  - `signup_form.customer_name_placeholder` (string): e.g. `string`
  - `signup_form.customer_name_error` (string): e.g. `string`
  - `signup_form.email_label` (string): e.g. `string`
  - `signup_form.email_placeholder` (string): e.g. `string`
  - `signup_form.error` (string): e.g. `string`
  - `signup_form.phone_label` (string): e.g. `string`
  - `signup_form.phone_placeholder` (string): e.g. `string`
  - `signup_form.phone_error` (string): e.g. `string`
  - `signup_form.quantity_label` (string): e.g. `string`
  - `signup_form.promotion_consent_label` (string): e.g. `string`
  - `signup_form.terms` (string): e.g. `string`
  - `signup_form.success` (string): e.g. `string`
  - `signup_form.button_text` (string): e.g. `string`
  - `signup_form.empty_error` (string): e.g. `string`
  - `signup_form.duplicate_error` (string): e.g. `string`
  - `signup_form.did_you_mean_error` (string): e.g. `string`
  - `signup_form.mixed_cart_error` (string): e.g. `string`
  - `signup_form.error_heading` (string): e.g. `string`
  - `optin.email_subject` (string): e.g. `string`
  - `optin.email_body` (string): e.g. `string`
  - `optin.success_text` (string): e.g. `string`
  - `review_trigger.text` (null)
- `translations` (object)
  - `fr` (object)
    - `notify_button.text` (string): e.g. `string`
  - `en` (object)
    - `notify_button.text` (string): e.g. `string`

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/translations" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "default_locale": "string",
  "locales": [
    "string"
  ],
  "published_locales": [
    "string"
  ],
  "fields": [
    "string"
  ],
  "source_values": {
    "notify_button.text": "string",
    "notify_button.resubscribe_text": "string",
    "notify_button.email_button_text": null,
    "preorder_button.out_of_stock_text": "string",
    "preorder_button.add_to_cart_text": "string",
    "preorder_button.modal_continue_text": "string",
    "preorder_button.modal_cancel_text": "string",
    "signup_form.header": "string",
    "signup_form.description": "string",
    "signup_form.customer_name_placeholder": "string",
    "signup_form.customer_name_error": "string",
    "signup_form.email_label": "string",
    "signup_form.email_placeholder": "string",
    "signup_form.error": "string",
    "signup_form.phone_label": "string",
    "signup_form.phone_placeholder": "string",
    "signup_form.phone_error": "string",
    "signup_form.quantity_label": "string",
    "signup_form.promotion_consent_label": "string",
    "signup_form.terms": "string",
    "signup_form.success": "string",
    "signup_form.button_text": "string",
    "signup_form.empty_error": "string",
    "signup_form.duplicate_error": "string",
    "signup_form.did_you_mean_error": "string",
    "signup_form.mixed_cart_error": "string",
    "signup_form.error_heading": "string",
    "optin.email_subject": "string",
    "optin.email_body": "string",
    "optin.success_text": "string",
    "review_trigger.text": null
  },
  "translations": {
    "fr": {
      "notify_button.text": "string"
    },
    "en": {
      "notify_button.text": "string"
    }
  }
}
```

## 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
    }
  ]
}
```

