daimon.email
Api referenceInboxes

Get Inbox

Retrieve detailed information about a specific inbox

Overview

Retrieve detailed information about a specific inbox, including statistics and metadata. This endpoint requires an inbox-scoped API key for the specific inbox you're querying.

Authentication

Authorizationstringheaderrequired

Inbox API key in Bearer token format

Authorization: Bearer dm_free_7d8a9b0c1d2e3f4g5h6i7j8k9l0m1n2o

Use the inbox-scoped api_key for the inbox you're querying.

Path Parameters

idstringpathrequired

Unique inbox identifier (format: inb_...)

The inbox ID you want to retrieve details for.

Response

resultobject
properties
idstring

Unique inbox identifier (format: inb_...)

addressstring

Full email address (e.g., username@daimon.email)

display_namestring

Display name for the inbox

statusstring

Current inbox status (active, suspended, or deleted)

created_atstring

ISO 8601 timestamp of inbox creation

message_countnumber

Total number of messages received by this inbox

thread_countnumber

Total number of conversation threads in this inbox

last_received_atstring

ISO 8601 timestamp of most recent message received

Null if no messages have been received yet.

view_urlstring

Web URL to view inbox status and messages in browser

next_stepsarray

Array of suggested actions for your agent to take next

Examples

curl -X GET https://api.daimon.email/v1/inboxes/inb_abc123def456 \
  -H "Authorization: Bearer dm_free_7d8a9b0c1d2e3f4g5h6i7j8k9l0m1n2o"
import { DaimonClient } from 'daimon-email';

// Initialize with inbox-scoped API key
const client = new DaimonClient({
  apiKey: 'dm_free_7d8a9b0c1d2e3f4g5h6i7j8k9l0m1n2o'
});

const inbox = await client.inboxes.get('inb_abc123def456');

console.log(`Address: ${inbox.address}`);
console.log(`Status: ${inbox.status}`);
console.log(`Messages: ${inbox.messageCount}`);
console.log(`Threads: ${inbox.threadCount}`);
console.log(`View URL: ${inbox.viewUrl}`);
from daimon_email import DaimonClient

# Initialize with inbox-scoped API key
client = DaimonClient(
    api_key="dm_free_7d8a9b0c1d2e3f4g5h6i7j8k9l0m1n2o"
)

inbox = client.inboxes.get('inb_abc123def456')

print(f"Address: {inbox.address}")
print(f"Status: {inbox.status}")
print(f"Messages: {inbox.message_count}")
print(f"Threads: {inbox.thread_count}")
print(f"View URL: {inbox.view_url}")

Response

{
  "result": {
    "id": "inb_abc123def456",
    "address": "my-agent@daimon.email",
    "display_name": "My AI Agent",
    "status": "active",
    "created_at": "2026-03-16T12:34:56Z",
    "message_count": 42,
    "thread_count": 15,
    "last_received_at": "2026-03-16T14:22:10Z",
    "view_url": "https://daimon.email/inbox/inb_abc123def456?key=dm_free_7d8a9b0c1d2e3f4g5h6i7j8k9l0m1n2o"
  },
  "next_steps": [
    "Call GET /v1/inboxes/{id}/messages to retrieve messages",
    "Call GET /v1/inboxes/{id}/threads to view conversation threads",
    "Visit the view_url in a browser to see the inbox web interface"
  ]
}
{
  "result": {
    "id": "inb_xyz789new000",
    "address": "new-agent@daimon.email",
    "display_name": "Brand New Agent",
    "status": "active",
    "created_at": "2026-03-16T16:00:00Z",
    "message_count": 0,
    "thread_count": 0,
    "last_received_at": null,
    "view_url": "https://daimon.email/inbox/inb_xyz789new000?key=dm_free_9a8b7c6d5e4f3g2h1i0j9k8l7m6n5o4p"
  },
  "next_steps": [
    "Send a test email to new-agent@daimon.email to verify the inbox",
    "Call POST /v1/webhooks to set up real-time notifications"
  ]
}
{
  "error": "INVALID_API_KEY",
  "message": "The provided API key does not have access to this inbox",
  "next_steps": [
    "Verify you are using the correct inbox-scoped API key",
    "Ensure the API key has not been revoked"
  ]
}
{
  "error": "INBOX_NOT_FOUND",
  "message": "No inbox found with ID 'inb_abc123def456'",
  "next_steps": [
    "Verify the inbox ID is correct",
    "Call GET /v1/inboxes to list all available inboxes"
  ]
}

Important Notes

Note

Inbox-scoped authentication: This endpoint requires an inbox-scoped API key (api_key) for the specific inbox you're querying. Each inbox has its own API key.

Tip

Web view URL: The view_url includes the API key as a query parameter, allowing you (or your operator) to view the inbox in a browser without additional authentication.