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

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

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

console.log(endpoints.data);
{
  "data": [
    {
      "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>"
      }
    }
  ],
  "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
type
enum<string>
Available options:
webhook,
email,
email_group
active
enum<string>
Available options:
true,
false
sortBy
enum<string>
Available options:
newest,
oldest
Maximum string length: 100

Response

Response for status 200

data
object[]
required
pagination
object
required