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

# Read

> wiseguard_list_aliases, wiseguard_get_alias and wiseguard_list_recently_deleted: look up your aliases.

All three tools are [free](/guides/credits#what-each-tool-costs).

## The alias object

Most tools return an alias with these fields.

| Field | Type | Description |
| - | - | - |
| `id` | string | The alias ID. |
| `address` | string | The full alias address, like `maple.river.stone@wiseguard.app`. |
| `label` | string | What the alias is for, like `Netflix`. |
| `state` | string | `active` or `paused`. |
| `site_domain` | string or null | The website the alias is for, like `netflix.com`. |
| `created_at` | string | When the alias was created (ISO 8601). |
| `last_received_at` | string or null | When the alias last got mail (ISO 8601). `null` if never. |
| `forwarding` | boolean | Whether mail to this alias is forwarded to you. |

## wiseguard\_list\_aliases

Lists your aliases, newest first, 10 per page. Deleted aliases aren't included.

<Badge color="green" shape="pill">Read-only</Badge> **Scope:** `aliases:read`

### Input

| Name | Type | Required | Description |
| - | - | - | - |
| `query` | string | No | 1 to 80 characters. Matches the label or the part before the `@`. |
| `state` | string | No | `active` or `paused`. |
| `page` | integer | No | Page number, from 1. Defaults to 1. |
| `limit` | integer | No | Aliases per page, 1 to 10. Defaults to 10. |

### Output

| Field | Type | Description |
| - | - | - |
| `aliases` | array | A list of [alias objects](#the-alias-object). |
| `page` | integer | The page you got. |
| `has_more` | boolean | `true` if there are more. Ask for `page` + 1 to see them. |

### Errors

This tool has no errors of its own. Sign-in errors apply, see [Troubleshooting](/guides/troubleshooting).

### Example prompt

```text wrap theme={null}
Which of my aliases are paused?
```

## wiseguard\_get\_alias

Gets one of your aliases by its ID or its full address. Deleted aliases aren't found.

<Badge color="green" shape="pill">Read-only</Badge> **Scope:** `aliases:read`

### Input

Pass exactly one of `alias_id` or `address`.

| Name | Type | Required | Description |
| - | - | - | - |
| `alias_id` | string | One of | The alias ID (a UUID). |
| `address` | string | One of | The full alias address, up to 320 characters, like `word.word.word@wiseguard.app`. |

### Output

One [alias object](#the-alias-object).

### Errors

```text wrap theme={null}
No alias with that ID or address on this account.
```

If the agent passes both fields or neither, the input is rejected. The error includes:

```text wrap theme={null}
Pass exactly one of alias_id or address
```

### Example prompt

```text wrap theme={null}
What is maple.river.stone@wiseguard.app for?
```

## wiseguard\_list\_recently\_deleted

Lists your deleted aliases that you can still restore, soonest deadline first, 10 per page.

<Badge color="green" shape="pill">Read-only</Badge> **Scope:** `aliases:read`

### Input

| Name | Type | Required | Description |
| - | - | - | - |
| `page` | integer | No | Page number, from 1. Defaults to 1. |
| `limit` | integer | No | Aliases per page, 1 to 10. Defaults to 10. |

### Output

| Field | Type | Description |
| - | - | - |
| `aliases` | array | A list of [deleted alias objects](#the-deleted-alias-object). |
| `page` | integer | The page you got. |
| `has_more` | boolean | `true` if there are more. Ask for `page` + 1 to see them. |

### The deleted alias object

| Field | Type | Description |
| - | - | - |
| `id` | string | The alias ID. |
| `address` | string | The full alias address. |
| `label` | string | What the alias was for. |
| `site_domain` | string or null | The website the alias was for. |
| `deleted_at` | string | When it was deleted (ISO 8601). |
| `restorable_until` | string | The restore deadline (ISO 8601). After this, the address is retired forever. |

### Errors

This tool has no errors of its own. Sign-in errors apply, see [Troubleshooting](/guides/troubleshooting).

### Example prompt

```text wrap theme={null}
What have I deleted recently?
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.