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

# Account

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

The list of every site, called an account here and a business in the help texts. Staff create and edit sites, and open each site's graph, users, Guestline settings and email service.

* **Where:** admin app `/account`; menu "Account"
* **Who:** anyone signed in to the admin app ([Access](https://docs.snapfix.com/how-the-apps-work/screens/staff.md#access)). The list call and the dialogs' calls check no staff flag on the server, so any signed-in user can list, change or delete sites.
* **Feature:** [Customer administration](https://docs.snapfix.com/product/features/staff/customer-admin.md)

## Layout

From top to bottom:

1. **Title row.** "Account"; on the left a round "+" button with the text "Create a new Account"; on the right the text "Add/Remove columns" and a round menu button.
2. **Warnings.** A banner, shown only while a warning count is above zero, with one button per warning above zero: the count (999 and more show as "999+") and the name. The warnings are "Accounts missing email key", "Accounts missing account email key admin", "Accounts missing first invoice date", "Accounts missing account administrator", "Accounts missing renewal date" and "Accounts passed renewal date". The counts come from the page's first load and are not refreshed.
3. **Notice.** "When you create a new account using this web admin tool, an Account Superadmin user is NOT automatically created. Before sending a payment link to this account/customer, you need to add an Account Superadmin user." Nothing else enforces this \[[ASK-212](https://github.com/snapfix/docs/blob/main/ASK.md#ask-212-what-is-an-account-superadmin-and-should-a-payment-link-wait-until-the-site-has-one)].
4. **Table.** Paged on the server: 10 rows by default (10, 20, 50 or 100), with a quick jump box.
5. **Help block.** Five lines, each beside an icon: the business owns the groups and pays for Snapfix, and the Edit icon changes its basic information; the Metrics icon shows usage data; the administrator is the contact who pays, and one must be set before payment details; the email icon sets up the optional, usually paid, email feature; and every column can be filtered from its heading.

| Column                                    | Shown at first              | Shows                                                                                                                                                                                     |
| ----------------------------------------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "Tenant ID"                               | Yes                         | The site's row ID                                                                                                                                                                         |
| "UUID"                                    | No                          | The site's ID                                                                                                                                                                             |
| "Name"                                    | Yes                         | The name, with a search box and a sort, both on the server                                                                                                                                |
| "Address"                                 | Yes                         | The address                                                                                                                                                                               |
| "Job Count", "User Count", "Group Count"  | Yes                         | Counts. The "User Count" cells follow the "Job Count" checkbox of the columns menu, so hiding Job Count hides both                                                                        |
| "First Invoice Date", "Next Renewal Date" | No                          | Dates as `MM/dd/YYYY`                                                                                                                                                                     |
| "Customer Type"                           | Yes                         | The stored type with underscores made spaces and each word capitalised, such as "Paying Customer" or "Investor Probono"; `0` shows as "Uncategorised". A one-choice filter in the heading |
| "Action"                                  | Always, pinned to the right | A round "⋯" button with the [row menu](#row-menu), and a button with the tooltip "Business Groups"                                                                                        |

Name, Address and Customer Type are highlighted for paying customers and for deleted sites. The columns menu ("Show Columns") lists every column except "Action".

## Inputs

| Field                | Type                                                                                           | Required | Default               | Rules and messages                                                                                     |
| -------------------- | ---------------------------------------------------------------------------------------------- | -------- | --------------------- | ------------------------------------------------------------------------------------------------------ |
| Name search          | Text, in the column's search box ("Search name", "Search", "Reset")                            | No       | Empty                 | Searches site names on the server and goes back to the first page. Sorting and paging keep the search. |
| Customer Type filter | One choice: "Customer", "Sales Trial", "Churn", "Test", "Investor / Pro Bono", "Uncategorised" | No       | None                  | Filters on the server.                                                                                 |
| Warning              | A button in the banner                                                                         | No       | None                  | One at a time; pressing the active one again clears it.                                                |
| Columns              | Checkboxes, under "Show Columns"                                                               | No       | As in the table above | Applies at once.                                                                                       |

## Actions

| Action            | Who              | What happens                                                                                                                                                                                                                       | API                                                                                            |
| ----------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| Load the list     | Anyone signed in | Loads one page of sites with the current sort, search, customer type and warning, on opening and on every change.                                                                                                                  | [`GET /v4/parents`](https://docs.snapfix.com/engineering-reference/api/staff.md#get-v4parents) |
| Press a warning   | Anyone signed in | Filters the list to the live paying sites with that gap, staying on the current page, so from a later page the table can come back empty. When the gap no longer matches any site, the filter is dropped and every site is listed. | [`GET /v4/parents`](https://docs.snapfix.com/engineering-reference/api/staff.md#get-v4parents) |
| "+"               | Anyone signed in | Opens [Add Account](#add-account-and-edit-account).                                                                                                                                                                                | None                                                                                           |
| "Business Groups" | Anyone signed in | Opens [Groups](https://docs.snapfix.com/how-the-apps-work/screens/staff/groups.md) with the site's name in the address; that page selects the first site whose name matches, not this site by ID.                                  | None                                                                                           |
| Row menu items    | Anyone signed in | Open the dialogs below for the row's site.                                                                                                                                                                                         | See [Dialogs and sheets](#dialogs-and-sheets)                                                  |

## States

* **Loading:** the table shows its spinner during each list request.
* **Empty:** no rows.
* **Error:** the list call shows no message. An answer that is not a success empties the table; a failed request keeps the old rows.
* **No permission:** none in the app.

## Dialogs and sheets

### Row menu

The "⋯" button's menu: "Edit", "View Graphs", "Business User(s)", "Guestline Detail" and "Email Service".

### Add Account and Edit Account

Opened by "+" (Add Account) or by "Edit" (Edit Account). In edit mode, help text at the top says the name and address can be edited here, that the customer type matters for analytics and reporting, and that deleting is for a business created in error; for older businesses the type should change instead, "from 'Paying Customer' to 'Other' for example", names the form does not use.

| Field                                                                              | Type                                    | Required      | Default                                      | Rules and messages                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ---------------------------------------------------------------------------------- | --------------------------------------- | ------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name                                                                               | Text                                    | Yes           | The site's name; empty when adding           | "Please input Account name." Not checked for duplicates \[[ASK-125](https://github.com/snapfix/docs/blob/main/ASK.md#ask-125-must-site-names-be-unique)].                                                                                                                                                                                                                                                                                                                                                                       |
| Address                                                                            | Text                                    | Yes           | The site's address; empty when adding        | "Please input Account Address."                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| State, Postal Code, City                                                           | Text                                    | No            | Empty                                        | Add only.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Country                                                                            | Select with search, "Select a Country"  | Yes, add only | Empty                                        | "Please Select Account Country." Sorted by name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Timezone Name                                                                      | Select with search, "Select a Timezone" | Yes           | The site's time zone; empty when adding      | "Please Select Timezone Name."                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Select Customer Type                                                               | Radio buttons                           | Yes           | The site's type; "Uncategorised" when adding | "Please choose Account Customer Type." "Customer: A customer who has paid for the service", "Sales Trial: A customer in the sales process who has not yet been invoiced", "Churn: A customer who has not renewed", "Test: An internal test account", "Investor / Pro Bono: An investor or other non-customer who is using the system for free", "Uncategorised: Other". In edit mode, "Existing Customer Type:" with the stored type shows above them when the type is not one of these, and also for every uncategorised site. |
| Customer Type Change Date, Customer First Invoice Date, Customer Next Renewal Date | Dates                                   | No            | The saved dates                              | Edit only.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Delete                                                                             | Checkbox, in the footer                 | No            | Off                                          | Edit only, for a site that is not deleted. Ticking it asks "Deleting a account is usually carried out by the customer." and "Are you sure it's safe to delete this account?" with "Delete"; the box ticks only after "Delete". Clicking a ticked box unticks it.                                                                                                                                                                                                                                                                |

When the dialog opens from a HubSpot deal ([Hubspot deals](https://docs.snapfix.com/how-the-apps-work/screens/staff/hubspot-deals.md)), its name, address, state, postal code, city and country come from the deal. The country is the first in the sorted list whose name equals or contains the deal's text, read as a pattern.

| Action   | Who              | What happens                                                                                                                                                                                                                                                                | API                                                                                                                                                                                                     |
| -------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Open     | Anyone signed in | Loads the time zones and the countries.                                                                                                                                                                                                                                     | [`GET ?action=read_parent_timezones`](https://docs.snapfix.com/engineering-reference/api/reference.md), [`GET ?action=countries_list`](https://docs.snapfix.com/engineering-reference/api/reference.md) |
| "Add"    | Anyone signed in | Creates the site with the name, address, time zone, customer type, state, city, postal code and country. On success "Success" shows, the dialog closes and the list reloads; a refusal shows the server's message and the dialog stays. Disabled while the form is invalid. | [`POST /v1/admin/parents`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-v1adminparents)                                                                                             |
| "Save"   | Anyone signed in | Saves the site's listed fields with the new name, address, time zone, customer type and dates, and the deleted flag from the checkbox. On success "Success" shows, the dialog closes and the list reloads. Disabled while the form is invalid.                              | [`POST ?action=admin_modify_parent`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionadmin_modify_parent)                                                                        |
| "Cancel" | Anyone signed in | Closes without saving. Disabled while saving.                                                                                                                                                                                                                               | None                                                                                                                                                                                                    |

While it saves, the button spins and the dialog cannot be closed. A deleted site opens read-only: its fields and dates cannot change, "Delete" and "Save" are hidden, and only "Cancel" is left.

### View Graphs

No title and no buttons; the chart's title is the site's name. "Graph For" offers "10 Days" (the default), "30 Days", "60 Days" and "90 Days", and a change reloads the chart. The chart has two lines, "Previous Sales Data" (dashed) and "Sales Data", with the legend hidden and the vertical axis from 0. Despite the labels, both count the task chat messages created each day in the site's groups: "Sales Data" over the chosen period and "Previous Sales Data" over the same number of days just before it ([`kpi_job_chats_created_day`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionkpi_job_chats_created_day)). A spinner covers the chart while it loads; a failed load shows the server's message and leaves the chart empty.

### Business User(s)

Titled "Business User(s)", with the text: "Ideally each business should have one or more admin. If a business becomes a paying customer then it's mandatory that at least one admin is assigned to the business. … An admin must be a pre-existing Snapfix user."

Two lists side by side, "Admin User(s)" and "Normal User(s)". Each row shows the first and last name, the username and the mobile number; a row with none of these is not shown. Each list has a search box, "Search admin user(s)" or "Search normal user(s)", that matches the name, the username or the mobile number.

| Field        | Type              | Required | Default | Rules and messages                                                                                                      |
| ------------ | ----------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------- |
| Arrow button | Button, per row   | No       | —       | Moves the user to the other list. Disabled for a deleted user, and for the last live admin.                             |
| Delete       | Checkbox, per row | No       | Off     | Marks the membership deleted on save. A deleted user shows "Deleted" and no checkbox. Disabled for the last live admin. |

The site always keeps one live admin: the last one cannot be moved or marked deleted.

| Action   | Who              | What happens                                                                                                                                       | API                                                                                                                                                                                                                              |
| -------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Open     | Anyone signed in | Loads the site's users and its admins together, and leaves the admins out of the users list. The admin list call checks no staff flag and no site. | [`POST ?action=read_users`](https://docs.snapfix.com/engineering-reference/api/users.md), [`POST ?action=admin_list_parent_user`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionadmin_list_parent_user) |
| "Save"   | Anyone signed in | Sends each changed user with its role and deleted flag. Enabled only after a change. On success "Success" shows and the dialog closes.             | [`POST ?action=admin_save_parent_user`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionadmin_save_parent_user)                                                                                           |
| "Cancel" | Anyone signed in | Closes. Disabled while loading or saving.                                                                                                          | None                                                                                                                                                                                                                             |

A spinner covers the dialog while it loads or saves. A failed load leaves the lists empty and shows no message; a failed save shows the server's message and the dialog stays.

### Guestline Detail

Titled "Guestline Snapfix Intergation Details". It stores the site's Guestline login and tests it before saving.

| Field            | Type                         | Required | Default         | Rules and messages                                                                                                                                              |
| ---------------- | ---------------------------- | -------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Site ID          | Text                         | Yes      | The saved value | "Please input Site ID"                                                                                                                                          |
| Interface ID     | Text                         | Yes      | The saved value | "Please input Interface ID". The login test sends it as a number, so text becomes null.                                                                         |
| Operator Code    | Text                         | Yes      | The saved value | "Please input Operator Code"                                                                                                                                    |
| Select Admin     | Select of the site's users   | Yes      | The saved admin | "Please select Admin". The site's users that are not deleted, as "Name - username"; users without a name are left out.                                          |
| Password         | Password, with an eye button | Yes      | Empty           | "Please input Password". The saved password is never shown, so it is typed on every save. The Guestline service can turn stored passwords back into plain text. |
| Confirm Password | Password, with an eye button | Yes      | Empty           | "Please input Confirm Password", or "Password and Confirm Password does not match".                                                                             |

| Action   | Who              | What happens                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             | API                                                                                                                                                                                                                                                                               |
| -------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Open     | Anyone signed in | Fills in everything but the passwords. A failed load shows nothing and leaves the fields empty.                                                                                                                                                                                                                                                                                                                                                                                                                          | [`POST ?action=admin_read_gl_parent`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionadmin_read_gl_parent)                                                                                                                                                |
| "Save"   | Anyone signed in | Signs in to Guestline with the four values. With a session in the answer, saves the settings, the password included, then "Success" shows and the dialog closes. Without one, it stops: a message shows only when Guestline sends an error description. A test that fails at the HTTP level leaves "Save" spinning and the close button off, though "Cancel" still works. The save fails when the site's current Guestline admin is missing or deleted, even with a new admin picked. These actions check no staff flag. | [`POST ?action=admin_guestline_login`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionadmin_guestline_login), then [`POST ?action=admin_modify_gl_parent`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionadmin_modify_gl_parent) |
| "Cancel" | Anyone signed in | Closes. Disabled while the details load.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | None                                                                                                                                                                                                                                                                              |

### Task Creation Email Service

Titled "Task Creation Email Service". The text explains that a business can have an email code, usually as a paid extra, that lets people without Snapfix create tasks by email; that the Email Key should be unique, short and readable, such as the business's web address; and that the Email User Admin, an existing Snapfix user, becomes the admin of every group or task the service creates. A note says a group name with spaces takes underscores in the address, as `Fire_Safety@<key>.snapfix.email`. Its examples use a real-looking business name.

| Field            | Type                                                   | Required | Default                            | Rules and messages                                                                                                                                                    |
| ---------------- | ------------------------------------------------------ | -------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Email Key        | Text, between the fixed texts "@" and ".snapfix.email" | Yes      | The saved key                      | "Please input Email Key". The form does not check that the key is unique; the server refuses a key another site has with "email\_key exists", and that message shows. |
| Email User Admin | Select of the site's users                             | Yes      | Empty, even when an admin is saved | "Please select Email User Admin". The same list as Select Admin above.                                                                                                |

| Action   | Who              | What happens                                                                                                                                                                                                | API                                                                                                                              |
| -------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| "Save"   | Anyone signed in | Saves the site's listed fields with the new key and admin. On success "Success" shows, the dialog closes and the list reloads. An admin ID the server cannot find gives an HTTP 500 instead of its message. | [`POST ?action=admin_modify_parent`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionadmin_modify_parent) |
| "Cancel" | Anyone signed in | Closes. Disabled while saving.                                                                                                                                                                              | None                                                                                                                             |


---

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