---
title: "Help Guide"
method: GET
path: "/api/field-app/help/guides/{slug}"
tags: ["fieldApp"]
---

# Help Guide

`GET /api/field-app/help/guides/{slug}`

## Request

- Base URL: `https://api.electricair.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.electricair.io/api/field-app/help/guides/{slug}`
- Auth: none declared

## Path parameters

- `slug` string, required

## Response `200`

OK

- GuideSchema
  - `slug` string, required
  - `title` string, required
  - `subtitle` string, required
  - `signed_in` boolean, required
  - `steps` GuideStepSchema[], required
    - `number` integer, required
    - `title` string, required
    - `warning` string, required
    - `slides` GuideSlideSchema[], required
      - `kind` string, required
      - `file` string
      - `url` string, nullable
      - `caption` string
    - `hearts` integer, required
    - `hearted` boolean, required
    - `comments` integer, nullable

---

[API](https://skmtc.dev/electricair/apis/electric-air-autoquote-api.md) - [All operations](https://skmtc.dev/electricair/apis/electric-air-autoquote-api/llms.txt) - [OpenAPI document](https://skmtc.dev/electricair/apis/electric-air-autoquote-api/revisions/a13d832a5676?raw)