GET
/
api
/
v2
/
email-addresses
curl -X GET 'https://inbound.new/api/v2/email-addresses' \
  -H 'Authorization: Bearer YOUR_API_KEY'
{
  "data": [
    {
      "id": "email_addr_123",
      "address": "hello@example.com",
      "domainId": "dom_abc123",
      "webhookId": null,
      "endpointId": "end_xyz789",
      "isActive": true,
      "isReceiptRuleConfigured": true,
      "receiptRuleName": "example.com-individual-rule",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "userId": "user_123",
      "domain": {
        "id": "dom_abc123",
        "name": "example.com",
        "status": "verified"
      },
      "routing": {
        "type": "endpoint",
        "id": "end_xyz789",
        "name": "Main Endpoint",
        "config": {
          "type": "webhook",
          "url": "https://api.yourapp.com/webhooks/email"
        },
        "isActive": true
      }
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "hasMore": false
  }
}

Overview

This endpoint retrieves a paginated list of all email addresses associated with the authenticated user. It supports filtering by domain, active status, and SES configuration status.

Authentication

Authorization
string
required
Bearer token for API authentication. Format: Bearer YOUR_API_KEY

Parameters

limit
integer
default:"50"
Maximum number of email addresses to return. Range: 1-100.
offset
integer
default:"0"
Number of email addresses to skip for pagination. Must be non-negative.
domainId
string
Filter email addresses by domain ID.
isActive
string
Filter email addresses by active status. Valid values: true, false.
isReceiptRuleConfigured
string
Filter email addresses by SES receipt rule configuration status. Valid values: true, false.

Response

data
array
required
Array of email address objects with detailed information.
pagination
object
required
Pagination information for the result set.

Examples

Basic Request

curl -X GET 'https://inbound.new/api/v2/email-addresses' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Filtered Request

curl -X GET 'https://inbound.new/api/v2/email-addresses?domainId=dom_abc123&isActive=true&limit=10' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response Example

{
  "data": [
    {
      "id": "email_addr_123",
      "address": "hello@example.com",
      "domainId": "dom_abc123",
      "webhookId": null,
      "endpointId": "end_xyz789",
      "isActive": true,
      "isReceiptRuleConfigured": true,
      "receiptRuleName": "example.com-individual-rule",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "userId": "user_123",
      "domain": {
        "id": "dom_abc123",
        "name": "example.com",
        "status": "verified"
      },
      "routing": {
        "type": "endpoint",
        "id": "end_xyz789",
        "name": "Main Endpoint",
        "config": {
          "type": "webhook",
          "url": "https://api.yourapp.com/webhooks/email"
        },
        "isActive": true
      }
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "hasMore": false
  }
}

Error Responses

{
  "error": "Limit must be between 1 and 100"
}

Notes

  • Email addresses must be associated with a verified domain to receive emails
  • The routing field shows how emails are forwarded (webhook, endpoint, or none)
  • Only active email addresses with configured receipt rules can receive emails
  • Email addresses inherit the domain’s verification status for email receiving capability
  • The isReceiptRuleConfigured field indicates if AWS SES is properly configured for this address