---
title: "List your aliases."
method: GET
path: "/v1/addresses"
tags: ["Addresses"]
---

# List your aliases.

`GET /v1/addresses`

## Request

- Base URL: `https://api.inboxy.net`
- URL: `https://api.inboxy.net/v1/addresses`
- Auth: HTTP bearer

## Query parameters

- `include_retired` boolean

## Response `200`

Aliases.

- object
  - `addresses` Address[]
    - `id` string, uuid, required
    - `local_part` string, required
    - `full_address` string, email, required
    - `label` string, nullable
    - `status` 'active' | 'retired', required
    - `kind` 'standard' | 'agent': `agent` aliases draw from the separate agent allowance.
    - `created_at` integer, required
    - `retired_at` integer, nullable
    - `total` integer: Total messages ever received at this alias (list-view only).
    - `unread` integer: Unread messages currently on this alias (list-view only).

---

[API](https://skmtc.dev/inboxy/apis/inboxy-api.md) · [All operations](https://skmtc.dev/inboxy/apis/inboxy-api/llms.txt) · [OpenAPI document](https://skmtc.dev/inboxy/apis/inboxy-api/revisions/25155a8dec0f?raw)