> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/how-the-apps-work/screens/help/login-help.md).

# Help with logging in

{% hint style="info" %}
Draft, written by an agent and not yet checked by a person ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). Platforms: web, iOS and Android. [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/screens/help/login-help.md).
{% endhint %}

People who cannot sign in search answers to common questions and reach the contact form.

![Help with logging in](https://3653879137-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVVGa79QbcEkJ7n8srxe%2Fuploads%2Fgit-blob-6fdbfe6c204608bfffed4f6f83514cfb1bbad13a%2Flogin-help.png?alt=media)

* **Where:**
  * Web: `/auth/help-hub-faq`, from "Having trouble loggin in? HelpHub." below the form on [Sign in](https://docs.snapfix.com/how-the-apps-work/screens/account/sign-in.md) (not in the mini sign-in dialog), on [Forgot password](https://docs.snapfix.com/how-the-apps-work/screens/account/forgot-password.md) and its code step, and on the set-password page ([Reset your password](https://docs.snapfix.com/how-the-apps-work/screens/account/reset-password.md), [Accept invitation](https://docs.snapfix.com/how-the-apps-work/screens/account/accept-invitation.md)) (web\_app\_v2 @ 0989b8e685, `src/app/pages/auth/sign-in/sign-in.component.html:16-25`, `src/app/pages/auth/forgot-password/forgot-password.component.html:122-124`, `src/app/pages/auth/forgot-password/otp/otp.component.html:98-101`, `src/app/pages/auth/set-password/set-password.component.html:92-95`).
  * iOS: "Having trouble logging in? HelpHub." on Sign in, Forgot password, [Forgot password code](https://docs.snapfix.com/how-the-apps-work/screens/account/forgot-password-code.md), Reset your password, Accept invitation and the steps of [Sign up by QR invitation](https://docs.snapfix.com/how-the-apps-work/screens/account/qr-sign-up.md). The link opens the [FAQ](https://docs.snapfix.com/how-the-apps-work/screens/help/faq.md) screen (ios @ aa31967ac8, `Extensions/Extension+All+components.swift:2415-2440`, `SnapFix/Forgot Password/ForgotPasswordView.swift:463-492`, `SnapFix/Forgot Password/SendOTPView.swift:143`, `SnapFix/Localization/en.lproj/Localizable.strings:2076-2077`).
  * Android: "Having a trouble loggin in? HelpHub." on Sign in, Forgot password and Forgot password code, and "Having a trouble signing up? HelpHub." on Accept invitation, Reset your password and the Sign up by QR invitation steps (android @ 86068bfeea, `app/src/main/res/values/strings.xml:2760-2761`, `:2772`, `app/src/main/java/gmail/com/snapfixapp/activity/LoginActivity.kt:253`, `app/src/main/java/gmail/com/snapfixapp/fragment/RegistrationProfileNewFragment.java:547-549`).
* **Who:** signed-out users. On the web the `/auth` routes send a signed-in user to `/fix` (`src/app/services/auth/auth-guard/auth-signin/auth-signin.guard.ts:13-16`). The iOS screen is the FAQ screen: a signed-in user who reaches it gets the FAQ's signed-in title and list, without the "GET IN TOUCH" footer (`SnapFix/FaqVC.swift:86-92`, `:122-125`). The Android screen always loads the signed-out list.
* **Feature:** [Help Hub](https://docs.snapfix.com/product/features/help/help-hub.md)

The list is the same FAQ that signed-in users get, loaded with the shared guest login. In production it is the server's built-in FAQ file: all three live passes on 2026-11-14 saw its articles, and none of them is about signing in ([Help API](https://docs.snapfix.com/engineering-reference/api/help.md#get-v1guesthelp-hubcategory)). With the HubSpot source the answers would arrive in a shape no platform reads.

## Layout

### Web

1. **Header.** A back arrow with the tooltip "Back", and the HelpHub logo.
2. **Title.** "Help with Logging in".
3. **Description.** "Find answers to common questions and get help accessing your account quickly."
4. **Search.** A field with the placeholder "Search for help topics" and, once it has text, a clear button.
5. **List.** The articles as an accordion: each title opens to its description and content paragraphs.
6. **Button.** "Get In Touch" (the string "GET IN TOUCH" in title case), with an envelope icon (web\_app\_v2 @ 0989b8e685, `src/app/pages/auth/help-hub-faq/help-hub-faq.component.html:13-89`).

### iOS

The [FAQ](https://docs.snapfix.com/how-the-apps-work/screens/help/faq.md) screen in its signed-out mode: a back button with no title, the title "Help with Logging In", the intro "Find answers to common questions and get help accessing your account quickly.", the FAQ's search and list, and a "GET IN TOUCH" footer (ios @ aa31967ac8, `SnapFix/FaqVC.swift:80-92`).

### Android

A toolbar with a back arrow and the HelpHub logo; the title "Help with Logging In" and the same description; the search box "Search for help topics"; the list; and a "GET IN TOUCH" button (the string "Get in touch", shown in capitals), which shows the [Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md) form on the same screen (android @ 86068bfeea, `app/src/main/java/gmail/com/snapfixapp/activity/LoginHelpHubActivity.kt:57-75`, `app/src/main/res/layout/activity_login_help_hub.xml:24-53`).

## Inputs

| Field                    | Type | Required | Default | Rules and messages                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ------------------------ | ---- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "Search for help topics" | Text | No       | Empty   | Filters the loaded list; no request. Matches the title, the description or a content line, ignoring case. Web: trims the text and filters one second after a key is released; text that arrives without a key release, such as a paste from the menu or autofill, filters nothing until the next key (`src/app/components/search/search.component.html:13`, `src/app/components/search/search.component.ts:30`, `:56-75`, `help-hub-faq.component.ts:90-104`). iOS and Android: as on the [FAQ](https://docs.snapfix.com/how-the-apps-work/screens/help/faq.md#inputs). |

## Actions

| Action         | Who              | What happens                                                                                                                                                                                                                                                                                                                                                                 | API                                                                                                                                                        |
| -------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Open the page  | Signed-out users | Loads the articles of category `faq`, once.                                                                                                                                                                                                                                                                                                                                  | [`GET /v1/guest/help-hub/{category}`](https://docs.snapfix.com/engineering-reference/api/help.md#get-v1guesthelp-hubcategory), with the shared guest login |
| Search         | Signed-out users | Filters the list.                                                                                                                                                                                                                                                                                                                                                            | None                                                                                                                                                       |
| Tap an article | Signed-out users | Shows or hides its answer.                                                                                                                                                                                                                                                                                                                                                   | None                                                                                                                                                       |
| "Get In Touch" | Signed-out users | Web: logs the analytics event `get_in_touch` and opens [Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md) at `/auth/get-in-touch`. iOS: opens [Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md). Android: shows the form on this screen and hides the button (`LoginHelpHubActivity.kt:202-207`). | None                                                                                                                                                       |
| Back           | Signed-out users | Web: goes to the previous page. Coming back from Get in touch, it goes to the page before Get in touch; going back to the set-password page, it restores the saved link details (`help-hub-faq.component.ts:50-88`). iOS: closes the screen. Android: from the form, back to the list; from the list, leaves the screen (`LoginHelpHubActivity.kt:175-181`, `:213-224`).     | None                                                                                                                                                       |

## States

* **Loading:** web: a loading animation in place of the search and the list. iOS: a "Refreshing..." overlay. Android: the logo animation.
* **Empty:** web: "No results found. Try a different search term." and "No FAQ data available at the moment." together, also after a search with no match. iOS and Android: no text.
* **Error:** web: the shared alert shows the API's message, or "Internal server error", and the two empty texts stay (`src/app/services/http/http.service.ts:243-251`). A refused guest login shows no alert: the web signs the visitor out and opens the sign-in page. iOS: an alert with the API's message, or "Something went wrong. Please try again.". Android: no message; the list stays empty.
* **No permission:** none.
* **Offline (mobile):** iOS shows "No Connection" with "You must be connected to the Internet to carry out this task. Please connect and try again." and loads nothing. Android shows the same message without a title, and the screen keeps only its toolbar and "GET IN TOUCH": no title, no list, and nothing reloads when the connection returns (`LoginHelpHubActivity.kt:57-75`).

## Dialogs and sheets

None. The form is [Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md).

## Platform differences

| Topic                       | Web                            | iOS                          | Android                                                         |
| --------------------------- | ------------------------------ | ---------------------------- | --------------------------------------------------------------- |
| Screen                      | `/auth/help-hub-faq`           | The FAQ screen, signed out   | Its own screen                                                  |
| Title                       | "Help with Logging in"         | "Help with Logging In"       | "Help with Logging In"                                          |
| Link on the sign-in screens | "Having trouble loggin in?"    | "Having trouble logging in?" | "Having a trouble loggin in?" or "Having a trouble signing up?" |
| Get in touch                | Its own page                   | Its own screen               | On this screen                                                  |
| Search                      | One second after a key release | As typed, trimmed            | As typed                                                        |
| Empty or failed list        | Two texts                      | No text; an alert on failure | No text                                                         |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snapfix.com/how-the-apps-work/screens/help/login-help.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
