---
title: "Check the app embed status"
description: "Whether STOQ's app embed is on in the published theme. status is enabled, disabled, or unknown when the theme could not be read. enabled is true or false, and null when status is unknown, because then whether the embed i"
url: https://docs.stoqapp.com/v2-reference/account-setup/check-the-app-embed-status/
api: "API v2 reference"
method: GET
path: "/account/setup"
---

# Check the app embed status

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

Whether STOQ's app embed is on in the published theme. status is enabled, disabled, or unknown when the theme could not be read. enabled is true or false, and null when status is unknown, because then whether the embed is on is not known. theme_editor_url, the theme editor link that turns the embed on, is there whenever enabled is not true. The embed adds the Preorder and Notify me buttons to the storefront.

**Note:** Each call reads the published theme's settings from Shopify, so it reflects the embed as saved in the theme editor. Read only: the API can't turn the embed on. Send the merchant to `theme_editor_url`, which opens the editor with the embed switched on; it only takes effect once they press Save. Status is `unknown` when the shop hasn't granted theme access or the theme couldn't be read.

## Returns

- `app_embed` (object)
  - `enabled` (boolean, nullable): e.g. `false`
  - `status` (string): e.g. `disabled`
  - `theme_editor_url` (string): e.g. `https://admin.shopify.com/store/stride-supply/themes/curr…`

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

## 200

Success: example response shown.

```json
{
  "app_embed": {
    "enabled": false,
    "status": "disabled",
    "theme_editor_url": "https://admin.shopify.com/store/stride-supply/themes/current/editor?context=apps&template=product&activateAppId=00000000-0000-4000-8000-000000000000/main"
  }
}
```

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

