> 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/staff.md).

# Staff screens

{% 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)). [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/screens/staff/README.md).
{% endhint %}

The staff admin app (webadmin\_angular), a web app for Snapfix staff only. Staff use it for sites (called "Account" on screen), groups and their members, onboarding, billing setup, usage dashboards, support logs, marketing popups, QR forms and surveys. Its calls are in the [Staff API](https://docs.snapfix.com/engineering-reference/api/staff.md), apart from a few that live in the [Groups](https://docs.snapfix.com/engineering-reference/api/groups.md), [Users](https://docs.snapfix.com/engineering-reference/api/users.md), [Planner](https://docs.snapfix.com/engineering-reference/api/planner.md), [Reference](https://docs.snapfix.com/engineering-reference/api/reference.md) and [Billing](https://docs.snapfix.com/engineering-reference/api/billing.md) docs. These docs describe webadmin\_angular @ db972390b8, written from code only, with no screenshots. Resyncs no longer update them.

## Access

* Every page but `/login` needs a session: the route guard checks only that the browser holds an access token, a refresh token and a user, and sends anyone else to [Log in](https://docs.snapfix.com/how-the-apps-work/screens/staff/sign-in.md).
* The sign-in uses the customers' sign-in and turns away a user without the staff flag (`fSnapfixWebAdminUser`) with "The username or password is invalid.", in the browser only.
* On the server, the Laravel `/v1/admin` routes check the staff flag. Most php-apis actions and every apipy route the pages call check no staff flag at all, so any signed-in Snapfix user could make those calls ([php-apis actions](https://docs.snapfix.com/engineering-reference/api/staff.md#php-apis-actions)). Each screen says what its calls check.
* The "Credit Card Payment", "Stripe Payment" and "Paywall" pages also need a username on a list built into the app, and a token that names the user's own ID; anyone else goes to Home. Their menu items, and "Survey", stay hidden for everyone else, though the Survey route has no check (webadmin\_angular @ db972390b8, `src/app/services/payment/payment.service.ts:180-193`, `src/app/app.component.ts:246-258`).
* A call answered with 401 makes the app refresh the token once. If the refresh is refused with 401, the session is removed and the app goes to `/login`.

## Menu and frame

The menu, shown once signed in, has seven groups:

| Group | Items                                                                                                   |
| ----- | ------------------------------------------------------------------------------------------------------- |
| H     | "Home"                                                                                                  |
| A     | "Account", "Organization Mapping", "Groups", "Group Users", "Users", "Task Move"                        |
| P     | "Credit Card Payment", "Stripe Payment", "Paywall" (all three for listed staff only), "Hubspot Deals"   |
| S     | "Support Logs", "Onboard"                                                                               |
| O     | "Analytics", "Account Dashboard", "Security Dashboard", "Guestline"                                     |
| C     | "CS Dashboard", "Marketing Popup", "QR Management", "Survey" (listed staff only), "SMS/E-mail Delivery" |
| L     | "Log Out", which clears the session and goes to `/login`                                                |

"Guestline" opens `/guestline`, documented in the integrations area: [Guestline](https://docs.snapfix.com/how-the-apps-work/screens/integrations/guestline.md). Outside production builds, every page shows the banner "This is TEST Environment."; the footer reads "Snapfix v" with the app's version and the year.

Most list calls switch off the app's error message, so a failed list looks like an empty one. Saves usually show "Success", or the server's message when they fail.

## Account picker

Many pages pick a site with the same control, placeholder "Type to search account":

* It loads the sites 50 at a time, and the next 50 when the list is scrolled to the end ([`GET /v4/parents`](https://docs.snapfix.com/engineering-reference/api/staff.md#get-v4parents)). It shows "Loading Data..." while loading.
* Typing searches site names, one second after the last key.
* Deleted sites are listed, marked, and can be picked \[[ASK-223](https://github.com/snapfix/docs/blob/main/ASK.md#ask-223-should-deleted-accounts-be-selectable-for-card-payments-and-support-logs)].
* Unless a page says otherwise, the first site of the list is picked when it loads. A page that gets a site's name in its address searches for it and picks the first match, which may be another site with a similar name.
* Clearing it reloads the list but tells the page nothing, so the page keeps working with the previous site.
* A failed load leaves it empty, with no message.

## Screens

| Screen                                                                                                | Platforms | Where                                                                           |
| ----------------------------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------------- |
| [Log in](https://docs.snapfix.com/how-the-apps-work/screens/staff/sign-in.md)                         | web       | admin app `/login`                                                              |
| [Home](https://docs.snapfix.com/how-the-apps-work/screens/staff/home.md)                              | web       | admin app `/home`; menu "Home"                                                  |
| [Account](https://docs.snapfix.com/how-the-apps-work/screens/staff/accounts.md)                       | web       | admin app `/account`; menu "Account"                                            |
| [Organization mapping](https://docs.snapfix.com/how-the-apps-work/screens/staff/org-mapping.md)       | web       | admin app `/organization-mapping`; menu "Organization Mapping"                  |
| [Groups](https://docs.snapfix.com/how-the-apps-work/screens/staff/groups.md)                          | web       | admin app `/groups`; menu "Groups"                                              |
| [Group users](https://docs.snapfix.com/how-the-apps-work/screens/staff/group-users.md)                | web       | admin app `/group-users`; menu "Group Users"                                    |
| [Users](https://docs.snapfix.com/how-the-apps-work/screens/staff/users.md)                            | web       | admin app `/users`; menu "Users"                                                |
| [Task move](https://docs.snapfix.com/how-the-apps-work/screens/staff/task-move.md)                    | web       | admin app `/task-move`; menu "Task Move"                                        |
| [Onboard account](https://docs.snapfix.com/how-the-apps-work/screens/staff/onboard.md)                | web       | admin app `/onboard`; menu "Onboard"                                            |
| [Credit card payment](https://docs.snapfix.com/how-the-apps-work/screens/staff/card-payment.md)       | web       | admin app `/credit-card-payment`; menu "Credit Card Payment", listed staff only |
| [Stripe payment](https://docs.snapfix.com/how-the-apps-work/screens/staff/stripe-payment.md)          | web       | admin app `/stripe-payment`; menu "Stripe Payment", listed staff only           |
| [Paywall](https://docs.snapfix.com/how-the-apps-work/screens/staff/paywall.md)                        | web       | admin app `/paywall`; menu "Paywall", listed staff only                         |
| [Hubspot deals](https://docs.snapfix.com/how-the-apps-work/screens/staff/hubspot-deals.md)            | web       | admin app `/hubspot-deals`; menu "Hubspot Deals"                                |
| [Support logs](https://docs.snapfix.com/how-the-apps-work/screens/staff/support-logs.md)              | web       | admin app `/support-logs`; menu "Support Logs"                                  |
| [SMS/E-mail delivery](https://docs.snapfix.com/how-the-apps-work/screens/staff/sms-email-delivery.md) | web       | admin app `/sms-email-delivery`; menu "SMS/E-mail Delivery"                     |
| [Analytics](https://docs.snapfix.com/how-the-apps-work/screens/staff/analytics.md)                    | web       | admin app `/analytics`; menu "Analytics"                                        |
| [Account dashboard](https://docs.snapfix.com/how-the-apps-work/screens/staff/account-dashboard.md)    | web       | admin app `/account-dashboard`; menu "Account Dashboard"                        |
| [Security dashboard](https://docs.snapfix.com/how-the-apps-work/screens/staff/security-dashboard.md)  | web       | admin app `/security-dashboard`; menu "Security Dashboard"                      |
| [CS dashboard](https://docs.snapfix.com/how-the-apps-work/screens/staff/cs-dashboard.md)              | web       | admin app `/cs-dashboard`; menu "CS Dashboard"                                  |
| [Marketing popup](https://docs.snapfix.com/how-the-apps-work/screens/staff/marketing-popups.md)       | web       | admin app `/marketing-popup`; menu "Marketing Popup"                            |
| [Survey](https://docs.snapfix.com/how-the-apps-work/screens/staff/surveys.md)                         | web       | admin app `/survey`; menu "Survey", listed staff only                           |
| [QR management](https://docs.snapfix.com/how-the-apps-work/screens/staff/qr-management.md)            | web       | admin app `/qr-management`; menu "QR Management"                                |


---

# 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/staff.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.
