---
title: "Get a template's translations"
description: "Read every translation of one back-in-stock notification's copy: the translatable field paths (as GET /back_in_stock/templates/:key names them), each one's default-language text, and the text per locale. key is \"signup_t"
url: https://docs.stoqapp.com/v2-reference/back-in-stock-templates/get-a-templates-translations/
api: "API v2 reference"
method: GET
path: "/back_in_stock/templates/{key}/translations"
---

# Get a template's translations

`GET https://app.stoqapp.com/api/v2/external/back_in_stock/templates/{key}/translations`

Read every translation of one back-in-stock notification's copy: the translatable field paths (as [`GET /back_in_stock/templates/:key`](https://docs.stoqapp.com/v2-reference/back-in-stock-templates/get-a-template/) names them), each one's default-language text, and the text per locale. key is &quot;signup_thank_you&quot;, &quot;restock_alert&quot; or &quot;reminder&quot;.

**Note:** Write a translation with [`PATCH /back_in_stock/templates/:key`](https://docs.stoqapp.com/v2-reference/back-in-stock-templates/update-a-template/) and a body `locale`.

## Path parameters

- `key` (string, required): Which notification's template: signup_thank_you, restock_alert or reminder. One of: `signup_thank_you`, `restock_alert`, `reminder`.

## Returns

- `key` (string): e.g. `string`
- `default_locale` (string): e.g. `string`
- `locales` (array of strings)
- `published_locales` (array of strings)
- `fields` (array of strings)
- `source_values` (object)
  - `email.subject` (string): e.g. `string`
  - `email.preheader` (null)
  - `email.heading` (string): e.g. `string`
  - `email.body` (string): e.g. `string`
  - `email.footer` (string): e.g. `string`
  - `email.button.text` (string): e.g. `string`
  - `email.html.template` (null)
  - `email.reviews.title` (string): e.g. `string`
  - `email.unsubscribe_text` (string): e.g. `string`
  - `email.consent_text` (string): e.g. `string`
  - `sms.body` (string): e.g. `string`
- `translations` (object)
  - `fr` (object)
    - `email.subject` (string): e.g. `string`
    - `sms.body` (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/back_in_stock/templates/{key}/translations" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "key": "string",
  "default_locale": "string",
  "locales": [
    "string"
  ],
  "published_locales": [
    "string"
  ],
  "fields": [
    "string"
  ],
  "source_values": {
    "email.subject": "string",
    "email.preheader": null,
    "email.heading": "string",
    "email.body": "string",
    "email.footer": "string",
    "email.button.text": "string",
    "email.html.template": null,
    "email.reviews.title": "string",
    "email.unsubscribe_text": "string",
    "email.consent_text": "string",
    "sms.body": "string"
  },
  "translations": {
    "fr": {
      "email.subject": "string",
      "sms.body": "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
    }
  ]
}
```

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

