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

# Asset registers

{% 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/assets/registers.md).
{% endhint %}

The site's asset registers (the web page is titled "Assets"): people open a register to see its assets, create a register, or open a register's settings.

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

* **Where:** web `/assets` (side menu "Assets"); iOS: Plan > "Asset Registers"; Android: Plan > "Asset registers"; side menu "Assets" on both apps.
* **Who:** any signed-in user can open the page. The web lists the registers the [list endpoint](https://docs.snapfix.com/engineering-reference/api/assets.md#get-v1appasset-regs) returns: the ones the user belongs to, or, in a multi-site view, every register of the site except those the user was removed from \[[ASK-100](https://github.com/snapfix/docs/blob/main/ASK.md#ask-100-should-a-multi-site-member-see-every-asset-register-and-asset-of-the-multi-sites-sites)]. The apps list the registers the user belongs to on the selected site, from the device copy. The "+" rule differs per platform \[[ASK-104](https://github.com/snapfix/docs/blob/main/ASK.md#ask-104-who-may-create-an-asset-register)].
* **Feature:** [Asset registers](https://docs.snapfix.com/product/features/assets/asset-registers.md)

An asset register is a group whose type is `asset`, so the web page is the group list in asset mode ([Groups](https://docs.snapfix.com/how-the-apps-work/screens/groups/group-list.md)). Opening a register shows [Asset list](https://docs.snapfix.com/how-the-apps-work/screens/assets/asset-list.md); its settings are [Asset register settings](https://docs.snapfix.com/how-the-apps-work/screens/assets/register-settings.md).

## Layout

**Web**, top to bottom:

1. The title "Assets". With a multi-site selected, a sites dropdown sits beside it, and the list shows registers of more than one site.
2. A row of controls: the grid or list switch, the filter button (tooltip "Filter"), the search box "Search Asset Registers", and a "+" when the user may create registers.
3. The registers, as cards (grid) or rows (list). Each shows the register's image (or a box icon), its name, its description on a second line, and the red, amber and green asset counts, each with the asset status icon (counts above 99999 show "99999+"). Each has a three-dot button and a bell. An archived register gets an inactive style and no bell.
4. The placeholder when the list is empty (see [States](#states)).

**iOS:** the Plan tab bar with "Asset Registers (n)" selected, a header "Asset Registers (n)" ("(shown/total)" while searching) with a "+" for users who may create, a search icon that turns into the field "Search asset registers", a filter button, a scan button, and the register rows (name, description, red, amber and green counts, a badge of new activity, a settings button and a mute button). A trial banner shows on trial sites.

**Android:** the Plan chips ("Planned Tasks", "Asset registers", "Comply", "Housekeeping"), the title "Asset registers (n)", a search icon that opens "Search asset registers", a filter button, the "+" menu button, a floating scan button, and the register rows with counts and badges.

## Inputs

| Field      | Type                             | Required | Default                                         | Rules and messages                                                                                                                                                                                                                                                                     |
| ---------- | -------------------------------- | -------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Search     | Text                             | No       | Web: the last search for this site; apps: empty | Web: "Search Asset Registers". The list reloads from the server one second after the last key press; the server matches the name or description in any letter case. iOS and Android: "Search asset registers"; filters the device copy as you type.                                    |
| Filter     | Two switches (web), sheet (apps) | No       | Active registers                                | Web: the "Filters" drawer with "Active Assets Registers" and "Archived Assets Registers", "Clear Filters" and "Apply". One is on at a time; a choice reloads the list with `archived` 0 or 1. iOS and Android: the group filter sheet, active or archived, applied to the device copy. |
| View (web) | Grid or list                     | No       | The last choice for this site                   | Stored per site on the device. The apps show a list only.                                                                                                                                                                                                                              |

## Actions

| Action                 | Who                                                                                                                                                                        | What happens                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | API                                                                                                                                                                                           |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Open a register        | Anyone who sees it                                                                                                                                                         | Opens [Asset list](https://docs.snapfix.com/how-the-apps-work/screens/assets/asset-list.md). An archived register does not open on the web (its settings still do) or on iOS. In a multi-site view, a user who is not an admin of the register gets a dialog first. On the apps, a register whose data is not on the device yet shows "Your %@ group data is still loading. If you have a good internet connection the group will be loaded soon." with the register name; iOS turns "group" into "asset register", Android does not. | Web: the asset list loads [`GET /v1/app/asset-regs/{uuid}`](https://docs.snapfix.com/engineering-reference/api/assets.md#get-v1appasset-regsuuid); apps: none                                 |
| Search                 | Anyone                                                                                                                                                                     | Reloads (web) or filters (apps) the list, see [Inputs](#inputs).                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | Web: [`GET /v1/app/asset-regs`](https://docs.snapfix.com/engineering-reference/api/assets.md#get-v1appasset-regs) with `search`                                                               |
| Filter                 | Anyone                                                                                                                                                                     | Shows active or archived registers.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Web: [`GET /v1/app/asset-regs`](https://docs.snapfix.com/engineering-reference/api/assets.md#get-v1appasset-regs) with `archived`                                                             |
| Load more (web)        | Anyone                                                                                                                                                                     | Scrolling to the end loads the next page; a loader sits at the bottom meanwhile.                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [`GET /v1/app/asset-regs`](https://docs.snapfix.com/engineering-reference/api/assets.md#get-v1appasset-regs) with `offset` and `limit`                                                        |
| Refresh counts (web)   | Anyone                                                                                                                                                                     | After each page loads, the page asks for the new activity of the registers shown and merges it in.                                                                                                                                                                                                                                                                                                                                                                                                                                    | [`POST /v1/app/businesses/get-updates`](https://docs.snapfix.com/engineering-reference/api/groups.md#post-v1appbusinessesget-updates)                                                         |
| "+" (web)              | Users the list answer allows (`createPermission`)                                                                                                                          | Opens the [create dialog](#create-a-new-asset-register-web).                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | None                                                                                                                                                                                          |
| "+" (iOS)              | Admins of an asset register or of a task group, and account admins \[[ASK-104](https://github.com/snapfix/docs/blob/main/ASK.md#ask-104-who-may-create-an-asset-register)] | The header "+" opens [Create a new asset register](https://docs.snapfix.com/how-the-apps-work/screens/assets/create-register.md). The app's top "+" menu in asset mode also has the create item.                                                                                                                                                                                                                                                                                                                                      | None                                                                                                                                                                                          |
| "+" menu (Android)     | Anyone                                                                                                                                                                     | Opens the [plus menu](#plus-menu-android).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | None                                                                                                                                                                                          |
| Three-dot button (web) | Anyone who sees the card                                                                                                                                                   | With the group permission `perBusSettingsScreenAccess`: opens [Asset register settings](https://docs.snapfix.com/how-the-apps-work/screens/assets/register-settings.md) at once. Without it: opens the "Asset Register Details" dialog.                                                                                                                                                                                                                                                                                               | Settings page or dialog: [`GET /v1/app/asset-regs/{uuid}`](https://docs.snapfix.com/engineering-reference/api/assets.md#get-v1appasset-regsuuid)                                              |
| Settings button (apps) | iOS: admins and users with the settings permission, while active in the register. Android: admins only                                                                     | Opens [Asset register settings](https://docs.snapfix.com/how-the-apps-work/screens/assets/register-settings.md). Everyone else gets the register's purpose page.                                                                                                                                                                                                                                                                                                                                                                      | None                                                                                                                                                                                          |
| Mute or unmute         | Anyone                                                                                                                                                                     | The bell asks "Mute this Asset Register?" and then mutes the register's notifications for this user. Unmuting happens at once, with no dialog. The apps mute from the row's mute button.                                                                                                                                                                                                                                                                                                                                              | Web: `PUT /v1/app/notification/{businessUuid}/mute` or `/unmute` ([Notifications API](https://docs.snapfix.com/engineering-reference/api/notifications.md)); apps: the membership row, synced |
| Scan (apps)            | Anyone                                                                                                                                                                     | The scan button opens the [Code scanner](https://docs.snapfix.com/how-the-apps-work/screens/assets/code-scanner.md) to find an asset by its code.                                                                                                                                                                                                                                                                                                                                                                                     | None                                                                                                                                                                                          |
| Pull to refresh (apps) | Anyone                                                                                                                                                                     | Syncs the device copy, reloads the list and asks for the counts of new activity. iOS refuses offline with its "update offline" message.                                                                                                                                                                                                                                                                                                                                                                                               | Sync; counts: [`read_business_jobs_new_updates`](https://docs.snapfix.com/engineering-reference/api/tasks.md#post-actionread_business_jobs_new_updates), which always answers 0               |

After a register is created on iOS, the list shows a banner "New asset register created :" with the name in bold for three seconds.

## States

* **Loading:** web: a skeleton of cards or rows. iOS and Android: the device copy shows at once; pull to refresh shows the spinner.
* **Empty:** web: "Manage your Assets in a Snap!" and, only when the user may create registers, "To add an asset register, click on the + button." with the "+" in the sentence. Android: "To add an asset register, tap the XXXX button." with a tappable "+" image in place of "XXXX". iOS: its empty view.
* **Assets off (apps):** when the site's plan has no asset feature (`asset_enabled`), the apps show a "Learn more" card instead of the list; it opens snapfix.com/asset-management in the browser. The web has no such check on this page \[[ASK-23](https://github.com/snapfix/docs/blob/main/ASK.md#ask-23-should-plan-limits-be-enforced-on-the-web-and-the-server)].
* **Error:** web: a failed list request leaves the list empty, so the placeholder shows, with no message.
* **No permission:** no "+" without the create right; the three-dot button opens the details dialog instead of settings.
* **Archived:** the inactive style, no bell, and no opening (web and iOS).
* **Offline (mobile):** the apps list and filter the device copy and can create registers offline ([Create a new asset register](https://docs.snapfix.com/how-the-apps-work/screens/assets/create-register.md)). The web needs a connection.

## Dialogs and sheets

### Create a new Asset Register (web)

The title "Create a new Asset Register", the field "Asset Register \*" with the hint "Asset register name has to be unique", "Cancel" and "Create Asset Register".

* The field stops at 100 characters. The button is off while the name is empty or only spaces, so "Please enter an asset register name" and "Your input exceeds the maximum allowed length of 100 characters" are not reached by typing.
* On "Create Asset Register", a name that matches a register already loaded on the page (ignoring case and outer spaces) opens the alert "Asset Register name already exists" with 'An asset register with this name already exists for the site "{site}". You cannot create a second asset register with the same name.' and "OK"; the site's name goes into the dialog as HTML. The dialog stays open and nothing is sent. Registers not loaded yet are not checked; the server refuses a taken name ([`POST /v1/app/asset-regs`](https://docs.snapfix.com/engineering-reference/api/assets.md#post-v1appasset-regs)).
* Otherwise the register is created, the dialog closes after 1.5 seconds, and the new register's asset list opens.

The apps use a screen instead: [Create a new asset register](https://docs.snapfix.com/how-the-apps-work/screens/assets/create-register.md).

### Asset Register Details (web)

For users without the settings permission. The title "Asset Register Details", the register's image and name, the site, "Purpose", "Instructions", the status definitions for red, amber and green, and the register's admins.

### Mute this Asset Register? (web)

"By muting this asset register you will no longer receive notifications of update." and the hint "You can unmute at any time by clicking the button again.", with "Cancel" and "Mute". The language file at the commit has "Unmute anytime by clicking the button again." for the hint; the live page showed the longer text.

### Plus menu (Android)

The sheet from the header's "+": "Create a new Asset" and "Add users to an asset register" (only when the user belongs to a register on the site; the second follows different rules on iOS and Android), "Create a new asset register" (only when the user may create registers: the site's create flag on the device, or account admin), "Tell your team", "Scan Asset QR or Barcode" and "Scan Asset Smart Tag".

## Platform differences

| Topic                             | Web                           | iOS                                                                                                                                                               | Android                                                                  |
| --------------------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| Source of the list                | The server, paged             | The device copy                                                                                                                                                   | The device copy                                                          |
| Who sees "+"                      | The list answer's create flag | Admins of an asset register or task group, account admins \[[ASK-104](https://github.com/snapfix/docs/blob/main/ASK.md#ask-104-who-may-create-an-asset-register)] | "+" always; the create item by the device's create flag or account admin |
| Settings from the row             | Settings permission           | Admin or settings permission                                                                                                                                      | Admin only                                                               |
| Archived register                 | Does not open                 | Does not open                                                                                                                                                     | Opens                                                                    |
| Scan                              | No                            | Scan button                                                                                                                                                       | Floating scan button and the "+" menu                                    |
| Assets off                        | No check                      | "Learn more"                                                                                                                                                      | "Learn more"                                                             |
| Tapping Plan while Assets is open | Not applicable                | Stays                                                                                                                                                             | Switches to another Plan page                                            |


---

# 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/assets/registers.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.
