Skip to main content
GET
/
api
/
e2
/
email-addresses
JavaScript
import Inbound from 'inboundemail';

const client = new Inbound({
  apiKey: process.env['INBOUND_API_KEY'], // This is the default and can be omitted
});

const emailAddresses = await client.emailAddresses.list();

console.log(emailAddresses.data);
{
  "data": [
    {
      "id": "<string>",
      "address": "<string>",
      "domainId": "<string>",
      "webhookId": "<string>",
      "endpointId": "<string>",
      "isActive": true,
      "isReceiptRuleConfigured": true,
      "receiptRuleName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "userId": "<string>",
      "domain": {
        "id": "<string>",
        "name": "<string>",
        "status": "<string>"
      },
      "routing": {
        "type": "webhook",
        "id": "<string>",
        "name": "<string>",
        "isActive": true,
        "config": "<unknown>"
      }
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123,
    "hasMore": true
  }
}

Authorizations

Authorization
string
header
required

Your Inbound API key. Include it in the Authorization header as: Bearer

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
domainId
string
isActive
enum<string>
Available options:
true,
false
isReceiptRuleConfigured
enum<string>
Available options:
true,
false

Response

Response for status 200

data
object[]
required
pagination
object
required