> 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/console/my-sites.md).

# My sites

{% 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/console/my-sites.md).
{% endhint %}

The Multi-Site Console's first tab: the multi-site's sites with their red, amber and green task counts, a way to open each site, and the multi-site's own name, description and image; adding or deleting a site only points to Customer Success.

![My sites](https://3653879137-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVVGa79QbcEkJ7n8srxe%2Fuploads%2Fgit-blob-82325440be8882eec32351769bbf00e35a902433%2Fmy-sites.png?alt=media)

* **Where:** web `/multi-site/my_sites` (Multi-Site Console, tab "My Sites"). The console opens here from the side menu "Multi-Site Console" or from the "Site Console" button on the multi-site in the site switcher; `/multi-site` and any unknown `/multi-site/...` address also land here.
* **Who:** anyone with a multi-site selected in the site switcher (`authMultisiteGuard`); without one the console goes to `/fix`. Every multi-site user gets the whole page, and the server checks only membership of the multi-site, so any of them can edit it \[[ASK-123](https://github.com/snapfix/docs/blob/main/ASK.md#ask-123-who-may-manage-a-multi-site-and-change-its-members-site-roles)].
* **Feature:** [Multi-Site Console](https://docs.snapfix.com/product/features/console/multi-site-console.md)

## Layout

1. **Console header.** "Multi-Site Console" and the tabs "My Sites", "Site Details", "Users" and "Checklists" ([Site details (multi-site)](https://docs.snapfix.com/how-the-apps-work/screens/console/multi-site-details.md), [Users (multi-site)](https://docs.snapfix.com/how-the-apps-work/screens/console/multi-site-users.md), [Checklists](https://docs.snapfix.com/how-the-apps-work/screens/console/checklists.md)).
2. **Left half.** A search field "Search Sites" and a "+" button (title "Add Site"). Below, one card per site: image, name, description, and three counters for red, amber and green tasks. A count of 100,000 or more shows "99999+".
3. **Right half.** The multi-site's image, the label "MULTI-SITE", its name and description, and the buttons "Edit" and "Delete Site".
4. **Welcome popup.** Once per browser session: "Welcome to your Multi-Site Console!", the multi-site's image and name, "Here you can manage your Sites and compare their progress.", "Please contact <support@snapfix.com> for assistance, and we also welcome your feedback." and "Ok".

## Inputs

| Field               | Type  | Required | Default             | Rules and messages                                                                                                                                             |
| ------------------- | ----- | -------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "Search Sites"      | Text  | No       | Empty               | Filters the loaded cards by name, ignoring case, shortly after typing stops. Sends no request.                                                                 |
| Edit: image         | Image | No       | Current image       | Chosen in the upload dialog with a crop, and uploaded at once.                                                                                                 |
| Edit: "Name \*"     | Text  | Yes      | Current name        | Placeholder "Enter name". Up to 100 characters. Empty: "Enter name". Longer: "Your input exceeds the maximum allowed length of 100 characters". Saved trimmed. |
| Edit: "Description" | Text  | No       | Current description | Placeholder "Enter description". Up to 255 characters. Saved trimmed.                                                                                          |

## Actions

| Action         | Who              | What happens                                                                                                                                                                                                                                                                                                                                                                                                                        | API                                                                                                                          |
| -------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| Load the sites | Multi-site users | Loads the multi-site's sites with their task counts and the caller's role.                                                                                                                                                                                                                                                                                                                                                          | [`GET /v1/app/multiSites/{uuid}`](https://docs.snapfix.com/engineering-reference/api/console.md#get-v1appmultisitesuuid)     |
| Search         | Multi-site users | Filters the cards.                                                                                                                                                                                                                                                                                                                                                                                                                  | None                                                                                                                         |
| Open a site    | Multi-site users | A card click makes that site the stored current site and opens `/fix`, while the multi-site stays selected, so the top-left name and the site menu still show the multi-site \[[ASK-137](https://github.com/snapfix/docs/blob/main/ASK.md#ask-137-after-a-site-card-is-opened-on-my-sites-should-the-site-menu-show-that-site)]. The stored site then reports its tag and checklist permissions as off until the site list reloads. | None                                                                                                                         |
| Edit           | Multi-site users | Opens "Edit Multi-site Console". "Save", enabled only when the form is valid and something changed, sends the name, description and image, then updates the header and the stored multi-site.                                                                                                                                                                                                                                       | [`PUT /multisite/{multisiteUUID}`](https://docs.snapfix.com/engineering-reference/api/console.md#put-multisitemultisiteuuid) |
| Add Site       | Multi-site users | Opens "Add Site". "Ok" opens the Customer Success ticket page in a new tab; nothing is added here.                                                                                                                                                                                                                                                                                                                                  | None                                                                                                                         |
| Delete Site    | Multi-site users | Opens "Delete Site". "Ok" opens the same page; nothing is deleted here.                                                                                                                                                                                                                                                                                                                                                             | None                                                                                                                         |

The Customer Success links and both "Ok" buttons go to a support page that returns 404.

## States

* **Loading:** a spinner in the list while the sites load.
* **Empty:** a search with no match shows "No sites found" and "Try a different search term or clear the filter.". A multi-site with no sites shows a blank list.
* **Error:** a failed load is written to the browser console and the list stays empty.
* **No permission:** none inside the page; without a selected multi-site the console goes to `/fix`.

## Dialogs and sheets

* **Edit Multi-site Console:** the image with an edit button, "Name \*" and "Description", with "Cancel" and "Save" ([Inputs](#inputs)).
* **Add Site:** "Please contact **Customer Success** to add a Site to your Organization.", where "Customer Success" is a link to the support ticket page; "Cancel" and "Ok", and a close icon.
* **Delete Site:** "Due to data retention regulations and other security and privacy considerations, please contact **Customer Success** to remove a Site from your Organization.", with the same link and buttons.
* **Welcome popup:** see [Layout](#layout); "Ok" marks it as shown for the session.

## Platform differences

Web only. The apps have no multi-site console; their site switcher lists the sites one at a time.


---

# 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/console/my-sites.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.
