Skip to main content
GET
/
api
/
e2
/
endpoints
/
{id}
JavaScript
import Inbound from 'inboundemail';

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

const endpoint = await client.endpoints.retrieve('id');

console.log(endpoint.id);
{
  "id": "<string>",
  "name": "<string>",
  "type": "webhook",
  "config": "<unknown>",
  "isActive": true,
  "description": "<string>",
  "userId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "groupEmails": [
    "<string>"
  ],
  "deliveryStats": {
    "total": 123,
    "successful": 123,
    "failed": 123,
    "lastDelivery": "<string>"
  },
  "recentDeliveries": [
    {
      "id": "<string>",
      "emailId": "<string>",
      "deliveryType": "<string>",
      "status": "<string>",
      "attempts": 123,
      "lastAttemptAt": "<string>",
      "responseData": "<unknown>",
      "createdAt": "<string>"
    }
  ],
  "associatedEmails": [
    {
      "id": "<string>",
      "address": "<string>",
      "isActive": true,
      "createdAt": "<string>"
    }
  ],
  "catchAllDomains": [
    {
      "id": "<string>",
      "domain": "<string>",
      "status": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Response

Response for status 200

id
string
required
name
string
required
type
enum<string>
required
Available options:
webhook,
email,
email_group
config
any
required
isActive
boolean
required
description
string · null · null
required
userId
string
required
createdAt
string · null · null
required
updatedAt
string · null · null
required
groupEmails
string[] · null · null
required
deliveryStats
object
required
recentDeliveries
object[]
required
associatedEmails
object[]
required
catchAllDomains
object[]
required