Get an inbox

GEThttps://myagentmail.com/v1/inboxes/{id}

Returns the inbox detail including IMAP/SMTP credentials and the full address list.

Path parameters

id

required

string

Inbox UUID

Responses

200application/jsonOK

`id` string	format: 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	format: uuid
`addresses` object[]
`address` string
`isPrimary` boolean
`imapPassword` string	Only returned on creation and GET /inboxes/{id}. Stored plaintext so IMAP clients can log in.
`imap` object
`host` string
`port` integer
`tls` boolean
`username` string
`password` string
`smtp` object
`host` string
`port` integer
`starttls` boolean
`username` string
`password` string
`createdAt` string	format: date-time

404application/jsonResource not found

`error` required string
`code` string

Authentication

Send your API key in the X-API-Key header (or Authorization: Bearer <key>). Any prefix accepted by this endpoint — tk_, wk_, ak_, or sa_ — is documented in the key prefix table.

Request

import { MyAgentMail } from "myagentmail";

const client = new MyAgentMail({ apiKey: process.env.MYAGENTMAIL_API_KEY! });

// GET /v1/inboxes/{id}
const result = await client.request("get", "/v1/inboxes/{id}", { params: { id: "00000000-0000-0000-0000-000000000000" } });

Example response · 200

{
  "id": "00000000-0000-0000-0000-000000000000",
  "email": "[email protected]",
  "canonicalEmail": "[email protected]",
  "username": "string",
  "domain": "string",
  "displayName": "string",
  "workspaceId": "00000000-0000-0000-0000-000000000000",
  "addresses": [
    {
      "address": "[email protected]",
      "isPrimary": false
    }
  ],
  "imapPassword": "string",
  "imap": {
    "host": "imap.myagentmail.com",
    "port": 993,
    "tls": false,
    "username": "string",
    "password": "string"
  },
  "smtp": {
    "host": "smtp.myagentmail.com",
    "port": 587,
    "starttls": false,
    "username": "string",
    "password": "string"
  },
  "createdAt": "2026-05-01T08:11:44.705Z"
}