> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getray.info/llms.txt
> Use this file to discover all available pages before exploring further.

# Pets

> The Pets screen lists the pets registered to the organization's users and lets an admin add a pet for a user, edit its species, breed, color, gender, name, date of birth, microchip number and photo, and attach documents such as vaccination records. Found under Directory → Pets in the RAY admin portal.

## Summary

The **Pets** screen in the RAY admin portal is the register of pets owned by the organization's
users, for example the dogs and cats living in a residential community. Each pet belongs to one user
(the **Pet Owner**) and has a species, breed and color, plus an optional name, gender, date of
birth, microchip number, photo and documents. A user's pets are also listed in the **Pets** tab of
the user's detail page.

## Where to find the Pets screen

* Menu: **Directory → Pets** (Arabic: **الدليل ← الحيوانات الأليفة**)
* Clicking a pet opens the pet's detail page.
* **Export** is in the **⋮** (more) menu at the top of the Pets list.

## Who can access the Pets screen

The Pets menu entry is shown only to users with an **Admin** role that includes the pets feature.
See [Roles and permissions](/getting-started/roles-and-permissions).

## Pets list columns

| Column        | Meaning                                                                                                   |
| ------------- | --------------------------------------------------------------------------------------------------------- |
| **Species**   | **Dog**, **Cat**, **Bird**, **Fish**, **Turtle**, **Rodent** or **Rabbit**.                               |
| **Pet Owner** | The user who owns the pet, with photo, email and phone. **Deleted User** when the owner no longer exists. |
| **Breed**     | Breed of the pet.                                                                                         |
| **Color**     | Color of the pet.                                                                                         |
| **Gender**    | **Male** or **Female**.                                                                                   |
| **Pet Name**  | Name of the pet.                                                                                          |

The list can be filtered by **Pet Owner**, **Pet Name**, **Species**, **Breed**, **Gender**,
**Color**, **Date of Birth** (a date range) and **Microchip Number**.

## Pet fields

| Field                | Required | Meaning and rules                                                                        |
| -------------------- | -------- | ---------------------------------------------------------------------------------------- |
| **Pet Owner**        | Yes      | The user the pet belongs to. Chosen when the pet is added; cannot be changed afterwards. |
| **Species**          | Yes      | **Dog**, **Cat**, **Bird**, **Fish**, **Turtle**, **Rodent** or **Rabbit**.              |
| **Breed**            | Yes      | Breed.                                                                                   |
| **Color**            | Yes      | Color.                                                                                   |
| **Gender**           | No       | **Male** or **Female**. Set on the pet detail page.                                      |
| **Pet Name**         | No       | Name of the pet. Set on the pet detail page.                                             |
| **Date of Birth**    | No       | Date only. Set on the pet detail page.                                                   |
| **Microchip Number** | No       | Identification chip number. Set on the pet detail page.                                  |
| Photo                | No       | One photo. Added on the pet detail page.                                                 |
| **Documents**        | No       | Files such as vaccination or registration certificates. Added on the pet detail page.    |

## How to add a pet

1. Open **Directory → Pets**.
2. Click **Add**.
3. Choose the **Pet Owner**.
4. Choose the **Species** and enter the **Breed** and **Color**.
5. Click **Save**.

The portal opens the new pet's detail page, where the name, gender, date of birth, microchip number,
photo and documents can be added.

## How to edit a pet

1. Open **Directory → Pets** and click the pet.
2. Change the **Species**, **Breed**, **Color**, **Gender**, **Pet Name**, **Date of Birth** or
   **Microchip Number** directly on the pet detail page, or add, replace or remove the photo.
3. Save the change.

## Pet detail page

The pet detail page is titled with the species and owner, for example "Dog - Omar Haddad". It shows
the pet fields, the photo, **Created at** and **Last Modified at**, and a **Documents** tab.

## How to add documents to a pet

1. Open the pet from **Directory → Pets**.
2. In the **Documents** tab, upload one or more files.

Accepted files are images (JPG, JPEG, PNG, GIF, WEBP), PDF, video (MP4, MOV, WEBM, M4V, 3GP), audio
(MP3, WAV, OGG, M4A), Word, Excel, PowerPoint, CSV and TXT. A document can be deleted from the same
tab.

## Common questions about Pets

### Why can't I see the Pets menu?

The Pets menu is hidden when none of your roles is an Admin role with the pets feature. Ask an
administrator with access to **Administration → Roles & Permissions** to add that feature to your
role.

### How do I find all pets of one resident?

Filter the Pets list by **Pet Owner**, or open the user under **Directory → Users** and open the
**Pets** tab.

### Where do I record a pet's vaccination certificate?

Upload it in the **Documents** tab of the pet's detail page.

### Can I change the owner of a pet?

No. The **Pet Owner** is read-only after the pet is added. Add the pet again for the new owner.

### Why does a pet show "Deleted User" as the owner?

The owner's user account was deleted. The pet stays in the list.

## Related pages

* [Users](/directory/users): the owners of pets.
* [User detail tabs](/directory/user-detail-tabs): a user's **Pets** tab.
* [Vehicles](/directory/vehicles): the vehicle register, which works the same way.