---
title: "Retrieve a template"
description: "Read one back-in-stock notification's email and SMS copy. key is \"signup_thank_you\" (sent right after a customer signs up), \"restock_alert\" (sent when the product restocks) or \"reminder\" (the follow-up). ?locale= picks t"
url: https://docs.stoqapp.com/v2-reference/back-in-stock-templates/retrieve-a-template/
api: "API v2 reference"
method: GET
path: "/back_in_stock/templates/{key}"
---

# Retrieve a template

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

Read one back-in-stock notification's email and SMS copy. key is "signup_thank_you" (sent right after a customer signs up), "restock_alert" (sent when the product restocks) or "reminder" (the follow-up). ?locale= picks the language of the copy (omit it for the shop default); the response names it in `locale`. Whether it sends, and when, is [`GET /back_in_stock/notification_settings`](https://docs.stoqapp.com/v2-reference/back-in-stock-notification-settings/list-notification-settings/).

## Path parameters

- `key` (string, required)

## Query parameters

- `locale` (string)

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

## Examples

### Retrieve a template

```sh
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/templates/{key}" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

### Retrieve a template filtered by locale

```sh
curl "https://app.stoqapp.com/api/v2/external/back_in_stock/templates/{key}?locale=fr" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

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