> 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-purpose.md).

# Group purpose

{% 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-purpose.md).
{% endhint %}

Shows what a group is for: its purpose, its instructions, what its red, amber and green statuses mean, and who its admins are; the apps also link to the group's settings.

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

* **Where:** web: the group's image or name in a task list header, or the three-dot button on a group card for a user without settings access (dialog "Group Details"); iOS and Android: the row button on the groups list for users who don't get settings ([Groups](https://docs.snapfix.com/how-the-apps-work/screens/groups/group-list.md)), and the group's menus (screen "Group Purpose" on Android)
* **Who:** anyone who can see the group, read-only members included. The apps' settings icon shows for admins and users with "Group Settings Access" whose membership isn't read-only.
* **Feature:** [Groups](https://docs.snapfix.com/product/features/groups/groups.md)

## Layout

### Web

A dialog at least 670 px wide, titled "Group Details" ("Asset Register Details" for an asset register).

1. **Header:** the group's image and name, and the site's name.
2. **Left:** "Purpose", "Instructions" and "Status definitions", one line per colour with the group's name for it. The purpose and instructions are shown as formatted text; markup in them runs in the page. Any member who isn't read-only can set them through the API.
3. **Right:** "Group Admins" ("Asset Register Admins"): the members whose role is Admin and whose membership isn't read-only, sorted by name, each with a picture or initials and the name. When the site shows contact data, each admin also shows a username, or else the mobile number with its country code. The group's data sent to the dialog holds every member's contact fields either way \[[ASK-72](https://github.com/snapfix/docs/blob/main/ASK.md#ask-72-should-every-member-get-the-other-members-and-invitees-contact-details)].

### iOS and Android

The screen shows the purpose and the instructions ("-" when empty), the three status definitions, the admins ("Group admins", or "Group admin" for one) and the settings icon. Android fills an empty status definition with "New tasks", "Tasks in progress" or "Completed tasks". The admins' contact data shows when the site shows contact data (Android: the username, else the mobile number, else the staff username).

## Inputs

None. The screen only shows data.

## Actions

| Action               | Who                                                             | What happens                                                                                         | API                                                                                                                     |
| -------------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| Open (web)           | Anyone who can see the group                                    | Loads the group with its members.                                                                    | [`GET /v1/app/businesses/{uuid}`](https://docs.snapfix.com/engineering-reference/api/groups.md#get-v1appbusinessesuuid) |
| Open (apps)          | Same                                                            | Reads the group from the device's copy.                                                              | -                                                                                                                       |
| Settings icon (apps) | Admins and "Group Settings Access" holders who aren't read-only | Opens [Group settings](https://docs.snapfix.com/how-the-apps-work/screens/groups/group-settings.md). | -                                                                                                                       |
| Close                | Anyone                                                          | Closes the dialog or goes back.                                                                      | -                                                                                                                       |

## States

* **Loading:** web shows a skeleton until the group arrives.
* **Empty:** web shows nothing under "Purpose" or "Instructions" when they are empty; the apps show "-".
* **Error:** web closes the dialog when the group doesn't load, and the server's message shows in an alert. Android shows "Something went wrong. Please try again." and closes when the group isn't on the device.
* **No permission:** no settings icon; the rest is the same for everyone.
* **Offline (mobile):** the apps show the last synced text.

## Platform differences

* **Shape:** web opens a dialog; the apps open a screen.
* **Settings:** only the apps have a settings icon here. The web opens settings from the group card or the task list header.
* **Empty texts:** web leaves them blank; the apps show "-", and Android shows the default status names.
* **Fresh data:** web loads the group when the dialog opens; the apps show what the last sync stored.
* **Heading:** "Group Admins" on the web, "Group admins" on Android.


---

# 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-purpose.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.
