---
title: "Retrieve the setup guide"
description: "The setup guide on the dashboard's Home page, for back_in_stock and preorders: whether the merchant chose that product on the welcome page (chosen), each step in order with done, steps_done, next_step (null once the guid"
url: https://docs.stoqapp.com/v2-reference/account-setup-guide/retrieve-the-setup-guide/
api: "API v2 reference"
method: GET
path: "/account/setup_guide"
---

# Retrieve the setup guide

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

The setup guide on the dashboard's Home page, for back_in_stock and preorders: whether the merchant chose that product on the welcome page (chosen), each step in order with done, steps_done, next_step (null once the guide is complete) and completed_at (set when every step is done or the guide was skipped). Back in stock: app_embed, design_widget, first_signup, first_alert_sent, with first_signup_id while the guide is open. Preorders: app_embed, first_offer, first_product, first_order.

**Note:** Same steps and rules as the Home page guide. Reading it marks a guide complete once all its steps are done, as the dashboard does. The app embed itself (status and the theme editor link) is [`GET /account/setup`](https://docs.stoqapp.com/v2-reference/account-setup/retrieve-the-setup/). Home shows a guide only when chosen and not completed more than a day ago (shown_on_home); a completed guide leaves Home by itself, so it needs no skip. Dismiss on Home is remembered by that browser only, so it is not here. If the merchant still sees a guide that shown_on_home says is hidden, ask what the card says and where it shows; never guess a cause such as a cache, and never name a card title or button this read does not give.

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_guide" \
  -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
    }
  ]
}
```

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