> 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/groups/group-list.md).

# Groups

{% 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/groups/group-list.md).
{% endhint %}

The site's task groups, with search, filters, each group's red, amber and green task counts, and a "+" button to create one; the apps also show who is on call.

![Groups](https://3653879137-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVVGa79QbcEkJ7n8srxe%2Fuploads%2Fgit-blob-b4774056527d1ed47e9372bee26d407ee4832be2%2Fgroup-list.png?alt=media)

* **Where:** web `/fix/groups`, the "GROUPS" tab of [Fix](https://docs.snapfix.com/how-the-apps-work/screens/tasks/fix.md); iOS and Android: Fix > "GROUPS" (the default tab)
* **Who:** any signed-in user with a site selected. Each user sees the groups they belong to in the site; a multi-site user with a multi-site selected sees every group of the site ([`GET /v1/app/businesses`](https://docs.snapfix.com/engineering-reference/api/groups.md#get-v1appbusinesses)). The "+" button follows a different rule on each platform ([Platform differences](#platform-differences)).
* **Feature:** [Groups](https://docs.snapfix.com/product/features/groups/groups.md)

A group opens its task list, [Group tasks](https://docs.snapfix.com/how-the-apps-work/screens/tasks/group-tasks.md). The row's button opens [Group settings](https://docs.snapfix.com/how-the-apps-work/screens/groups/group-settings.md) or [Group purpose](https://docs.snapfix.com/how-the-apps-work/screens/groups/group-purpose.md).

## Getting here

* **Web:** the Fix page opens the tab last used on this site, and "GROUPS" when none was stored. The tab label is "GROUPS" with the count, such as "(18)"; during a search it shows the matches and the total, such as "(2 / 18)".
* **iOS and Android:** the Fix tab opens on "GROUPS". The site name in the top bar opens the [Site switcher](https://docs.snapfix.com/how-the-apps-work/screens/groups/site-switcher.md).
* **From a link:** `/groups` links do nothing on iOS, which parses them and drops them, and Android's link filters for them are commented out.

## Layout

### Web

1. **Top row.** A view switch (grid or list), the filter button, the search field "Search Groups", and the "+" button when the user may create groups.
2. **Groups.** One card (grid) or row (list) per group: the image, the name and the address (both translated when the site translates content), three counts for red, amber and green tasks ("99999+" above that), a bell, and a three-dot button. A badge on the image shows how many tasks changed since the user last opened the group ("99+" above 99).
3. **Archived groups** show greyed out and have no bell.
4. **Scrolling** loads the next page. A page holds at least 35 groups, more when the window fits more.
5. **Empty:** an image and "Manage your Groups in a Snap!"; for users who may create groups also "To add a group, click on the" with a plus icon and "button.". The icon opens the create dialog.

### iOS and Android

1. **Top bar:** the profile photo (opens the side menu), the site name (opens the [Site switcher](https://docs.snapfix.com/how-the-apps-work/screens/groups/site-switcher.md)), and the "+" menu.
2. **Search and filter:** a search toggle and a filter for "Active groups" or "Archived groups".
3. **On-call banner:** the site's on-call users; tapping them opens the on-call list. What being on call changes is open \[[ASK-36](https://github.com/snapfix/docs/blob/main/ASK.md#ask-36-what-does-being-on-call-change)].
4. **Rows:** each group's image, name and address, its red, amber and green counts, a new-activity badge, a bell, and a button that opens settings or the purpose screen. Archived groups are greyed out with no bell. iOS also has a header with an add-group and an add-user button ([Platform differences](#platform-differences)).

## Inputs

| Field  | Type                                 | Required | Default                           | Rules and messages                                                                                                                                                                                                                                                                                                 |
| ------ | ------------------------------------ | -------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Search | Text                                 | No       | Web: the last search on this site | Web: "Search Groups". The list reloads one second after the user stops typing, and "Clear search" reloads the full list. The server matches the group's name and address ([`search`](https://docs.snapfix.com/engineering-reference/api/groups.md#get-v1appbusinesses)). The apps filter the groups on the device. |
| Filter | "Active groups" or "Archived groups" | No       | "Active groups"                   | Web: a "Filters" drawer with the two switches, "Clear Filters" and "Apply"; the choice is one or the other and is sent as `archived` 0 or 1. The apps show the same two choices.                                                                                                                                   |
| View   | Grid or list                         | No       | Grid                              | Web only. The view, the search and the filter are kept in the browser per site.                                                                                                                                                                                                                                    |

## Actions

| Action                 | Who                                                                                                                          | What happens                                                                                                                                                                                                                                                                                                                                                                                   | API                                                                                                                                                                                                                                                                                                                                                                                      |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Open the list          | Anyone                                                                                                                       | Web: loads the site's groups a page at a time with their task counts, then asks for the new-activity count of each group on the page. Counting loads every task of the listed groups. The apps show the groups stored on the device.                                                                                                                                                           | [`GET /v1/app/businesses`](https://docs.snapfix.com/engineering-reference/api/groups.md#get-v1appbusinesses), then [`POST /v1/app/businesses/get-updates`](https://docs.snapfix.com/engineering-reference/api/groups.md#post-v1appbusinessesget-updates)                                                                                                                                 |
| Open a group           | Anyone                                                                                                                       | Opens the group's task list (web `/group/:id/tasks`). An archived group does not open. On the web, a multi-site user who isn't an admin of the group first gets the dialog to register as its admin. In the apps, a group whose data is still loading shows "Your %1$s group data is still loading. If you have a good internet connection the group will be loaded soon."                     | -                                                                                                                                                                                                                                                                                                                                                                                        |
| Three-dot button (web) | Anyone                                                                                                                       | Opens [Group settings](https://docs.snapfix.com/how-the-apps-work/screens/groups/group-settings.md) for admins and users with "Group Settings Access" (`perBusSettingsScreenAccess`), also on an archived group; everyone else gets the [Group purpose](https://docs.snapfix.com/how-the-apps-work/screens/groups/group-purpose.md) dialog.                                                    | -                                                                                                                                                                                                                                                                                                                                                                                        |
| Row button (apps)      | Anyone                                                                                                                       | iOS: settings for admins and users with "Group Settings Access" who are not read-only, the purpose screen for everyone else. Android: settings for admins only; everyone else, including holders of "Group Settings Access", gets the purpose screen.                                                                                                                                          | -                                                                                                                                                                                                                                                                                                                                                                                        |
| Mute                   | Members, active groups                                                                                                       | Web: the bell asks "Mute this Group?" ("Cancel" and "Mute") and then shows a muted bell. iOS and Android ask the same question in a sheet. Android first asks the user to turn on notifications when they are off ("Notification Settings": "Please turn on Notifications in your Snapfix profile."). Muting stops the group's update notifications for this user; it does not hide the group. | Web: `PUT /v1/app/notification/{group}/mute` ([Notifications API](https://docs.snapfix.com/engineering-reference/api/notifications.md)). iOS and Android change `notifMute` in their synced copy of the membership, as for Unmute                                                                                                                                                        |
| Unmute                 | Members                                                                                                                      | One tap on the muted bell, with no question.                                                                                                                                                                                                                                                                                                                                                   | Web: `PUT /v1/app/notification/{group}/unmute` ([Notifications API](https://docs.snapfix.com/engineering-reference/api/notifications.md)). iOS and Android change `notifMute` in their synced copy of the membership (ios @ aa31967ac8, `SnapFix/BusinessListingVC.swift:2691-2702`; android @ 86068bfeea, `app/src/main/java/gmail/com/snapfixapp/room/dao/UserBusinessDao.kt:186-194`) |
| "+"                    | See [Platform differences](#platform-differences)                                                                            | Web: opens [Create a new group](https://docs.snapfix.com/how-the-apps-work/screens/groups/create-group.md). Android: opens the "+" menu (see [Dialogs and sheets](#dialogs-and-sheets)). iOS: the top bar "+" opens a menu with "Create a new group"; the header's add-group button opens the create screen.                                                                                   | -                                                                                                                                                                                                                                                                                                                                                                                        |
| Add users to a group   | iOS: the header's add-user button, under the same rule as its add-group button. Android: the "+" menu, when any group exists | Opens [Add users to a group](https://docs.snapfix.com/how-the-apps-work/screens/groups/add-users.md).                                                                                                                                                                                                                                                                                          | -                                                                                                                                                                                                                                                                                                                                                                                        |
| Pull to refresh        | Anyone (apps)                                                                                                                | Reads the user's data from the server again and redraws the list. Without a connection the apps say so (iOS: "You must be connected to the Internet to carry out this task. Please connect and try again."); a failed read on Android shows "Something went wrong. Please try again."                                                                                                          | [`?action=read_data_v2`](https://docs.snapfix.com/engineering-reference/api/tasks.md#post-actionread_data_v2)                                                                                                                                                                                                                                                                            |
| Scroll to the end      | Anyone (web)                                                                                                                 | Loads the next page while there are more.                                                                                                                                                                                                                                                                                                                                                      | [`GET /v1/app/businesses`](https://docs.snapfix.com/engineering-reference/api/groups.md#get-v1appbusinesses) with `offset`                                                                                                                                                                                                                                                               |

## States

* **Loading:** web shows skeleton cards while the first page loads, and a spinner at the end while the next page loads. The apps show the device's copy at once.
* **Empty:** web shows the empty text in [Layout](#layout); a search that matches nothing shows the same text. The apps show no rows, and the "+" menu offers only what the user may do.
* **Error:** web shows the server's message in an alert ("Internal server error" when there is none), an empty list, and the tab count "(undefined)". The apps keep the device's copy.
* **No permission:** without the right to create groups there is no "+" (web) or no "Create a new group" item (apps). Without settings access the row button opens the purpose dialog instead of settings.
* **Archived:** archived groups are left out of the active list and shown by the "Archived groups" filter. They open only into settings, for users with settings access.
* **Offline (mobile):** the list comes from the device's copy; the bell, counts and badges update when the device syncs.

## Dialogs and sheets

* **Mute this Group?** Web: "By muting this group you will no longer receive notifications of update." and "Unmute anytime by clicking the button again.", with "Cancel" and "Mute". Android: "By muting this group you will no longer receive notifications of updates." and "Unmute anytime by tapping the button again.", with "Mute" and "Cancel".
* **Filters** (web drawer; apps filter sheet): "Active groups" and "Archived groups".
* **"+" menu (Android):** "Create a new task" and "Add users to a group" when any group exists, "Create a new group" when the user may create groups, and "Spread the word", which opens the system share sheet with an invitation to Snapfix (subject "Invitation to Snapfix"); nothing is sent to the server.
* **On call (apps):** the list of the site's on-call users, from the banner. The web shows on-call users in the [Site switcher](https://docs.snapfix.com/how-the-apps-work/screens/groups/site-switcher.md) instead.
* **Create a new Group** ([Create a new group](https://docs.snapfix.com/how-the-apps-work/screens/groups/create-group.md)) and **Group Details** ([Group purpose](https://docs.snapfix.com/how-the-apps-work/screens/groups/group-purpose.md)).
* **Duplicate Group** (web): opened from the group's task list menu ([Group tasks](https://docs.snapfix.com/how-the-apps-work/screens/tasks/group-tasks.md)), not from this page. It says "You have chosen to duplicate the group: {name}", asks "Please provide a name for the new group:" ("New group name", required: "Group name is required") and offers "Copy all task chat items", on by default. "Create" refuses the same name with "The new group name cannot be the same as the original group name." The copy is made in the same site and may come from a group the user can't see. It calls [`POST /v1/app/businesses/copy`](https://docs.snapfix.com/engineering-reference/api/groups.md#post-v1appbusinessescopy). The apps copy a group through [`?action=check_duplicate_business`](https://docs.snapfix.com/engineering-reference/api/groups.md#post-actioncheck_duplicate_business) and [`?action=duplicate_business`](https://docs.snapfix.com/engineering-reference/api/groups.md#post-actionduplicate_business) from the group's task menu; the iOS long press on a group row does nothing.

## Platform differences

* **Layout:** web has a grid and a list view; the apps have a list.
* **Who sees "+":** the web uses the server's "Create New Group" right for the site (`createPermission`). iOS's top bar menu uses the same site right, but its header add-group button shows for site admins and admins of any group in the site. Android's groups "+" menu offers "Create a new group" to site admins and admins of any group in the site, while the Fix tab's "+" menu uses the site right. The apps save new groups without any server check of that right.
* **Who opens settings:** web and iOS open settings for admins and "Group Settings Access" holders; Android only for admins.
* **New activity:** web counts from the server; the apps' badges stay at 0 because of a server bug.
* **On call:** the apps show a banner on this page; the web shows on-call users in the site switcher.
* **Title of the create screen:** web and iOS say "Create a new Group", Android "Create a New Group" or "Create a new group".


---

# 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/groups/group-list.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.
