---
title: "List inboxes"
method: GET
path: "/v1/inboxes"
tags: ["Inboxes"]
---

# List inboxes

`GET /v1/inboxes`

## Request

- Base URL: `https://anjal.app`
- URL: `https://anjal.app/v1/inboxes`
- Auth: API key in header `X-API-Key`

## Query parameters

- `workspace` string, uuid

## Response `200`

OK

- object
  - `inboxes` Inbox[]
    - `id` string, uuid
    - `email` string: Current primary outbound address — may be a custom-domain alias.
    - `canonicalEmail` string: Stable identity used for IMAP/SMTP auth. Never changes after creation.
    - `username` string
    - `domain` string
    - `displayName` string
    - `workspaceId` string, uuid
    - `addresses` InboxAddress[]
      - `address` string
      - `isPrimary` boolean
    - `imapPassword` string: Only returned on creation and GET /inboxes/{id}. Stored plaintext so IMAP clients can log in.
    - `imap` ImapCreds
      - `host` string
      - `port` integer
      - `tls` boolean
      - `username` string
      - `password` string
    - `smtp` SmtpCreds
      - `host` string
      - `port` integer
      - `starttls` boolean
      - `username` string
      - `password` string
    - `createdAt` string, date-time

---

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