list_aliases
List or search aliases with filters for activity, pinned status, labels, domains, recipients, and pagination to find and manage specific email aliases.
Instructions
List or search aliases. Results are paginated; the response includes meta with totals and page counts.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_aliases"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (1-based) | |
| sort | No | Field to sort by | |
| active | No | Only active (true) or inactive (false) aliases | |
| pinned | No | Only pinned (true) or unpinned (false) aliases | |
| search | No | Search alias email addresses and descriptions | |
| deleted | No | 'with' to include deleted aliases, 'only' for just deleted ones. Default excludes them. | |
| include | No | Also return each alias's recipients or labels (the API allows only one per request) | |
| label_id | No | Only aliases with this label id | |
| domain_id | No | Only aliases on this custom domain id | |
| page_size | No | Results per page (1-100) | |
| descending | No | Sort descending | |
| username_id | No | Only aliases on this username id | |
| recipient_id | No | Only aliases forwarding to this recipient id |