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
}
}Get paginated list of endpoints for authenticated user with optional filtering by type, active status, sort order, and search by name
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
}
}Your Inbound API key. Include it in the Authorization header as: Bearer
1 <= x <= 100x >= 0webhook, email, email_group true, false newest, oldest 100Was this page helpful?