Overview Get comprehensive information about a specific endpoint including its configuration, delivery statistics, recent deliveries, associated email addresses, and catch-all domain configurations.
GET https://inbound.new/api/v2/endpoints/{id} Authentication Bearer token for API authentication. Format: Bearer YOUR_API_KEY
Path Parameters The unique identifier of the endpoint to retrieve.
Response { "id" : "ep_abc123" , "name" : "Production Webhook" , "type" : "webhook" , "config" : { "url" : "https://api.example.com/webhook" , "timeout" : 30 , "retryAttempts" : 3 , "headers" : { "X-Custom-Header" : "value" } }, "isActive" : true , "description" : "Main webhook for production alerts" , "userId" : "user_123" , "createdAt" : "2024-01-15T10:30:00Z" , "updatedAt" : "2024-01-15T10:30:00Z" , "groupEmails" : null , "deliveryStats" : { "total" : 145 , "successful" : 142 , "failed" : 3 , "lastDelivery" : "2024-01-15T14:30:00Z" }, "recentDeliveries" : [ { "id" : "del_xyz789" , "emailId" : "email_456" , "deliveryType" : "webhook" , "status" : "success" , "attempts" : 1 , "lastAttemptAt" : "2024-01-15T14:30:00Z" , "createdAt" : "2024-01-15T14:30:00Z" , "responseData" : { "responseCode" : 200 , "responseBody" : "OK" , "deliveryTime" : 250 , "url" : "https://api.example.com/webhook" } } ], "associatedEmails" : [ { "id" : "addr_123" , "address" : "alerts@example.com" , "isActive" : true , "createdAt" : "2024-01-15T10:30:00Z" } ], "catchAllDomains" : [ { "id" : "dom_456" , "domain" : "example.com" , "status" : "ses_verified" } ] } Response Fields Unique identifier for the endpoint.
User-friendly name for the endpoint.
Type of endpoint: webhook, email, or email_group.
Configuration object specific to the endpoint type.
Whether the endpoint is active and will receive emails.
Description of the endpoint.
ID of the user who owns this endpoint.
ISO 8601 timestamp when the endpoint was created.
ISO 8601 timestamp when the endpoint was last updated.
Array of email addresses (only for email_group type endpoints).
Statistics about email deliveries to this endpoint. Total number of delivery attempts.
Number of successful deliveries.
Number of failed deliveries.
ISO 8601 timestamp of the last delivery attempt.
Array of the 10 most recent delivery attempts. Unique identifier for the delivery.
ID of the email that was delivered.
Type of delivery: webhook or email_forward.
Delivery status: success, failed, or pending.
Number of delivery attempts made.
ISO 8601 timestamp of the last delivery attempt.
ISO 8601 timestamp when the delivery was created.
Additional response data from the delivery attempt.
Array of email addresses that route to this endpoint. Show Email Address Properties
Unique identifier for the email address.
Whether the email address is active.
ISO 8601 timestamp when the email address was created.
Array of domains that use this endpoint for catch-all routing. Unique identifier for the domain.
Domain verification status.
Examples Get Webhook Endpoint import { InboundEmailClient } from '@inboundemail/sdk' const inbound = new InboundEmailClient ( process . env . INBOUND_API_KEY ! ) const { data : endpoint , error } = await inbound . endpoint . get ( 'ep_abc123' ) if ( error ) { console . error ( 'Error fetching endpoint:' , error ) } else { console . log ( `Endpoint: ${ endpoint . name } ( ${ endpoint . type } )` ) console . log ( `Deliveries: ${ endpoint . deliveryStats . total } total, ${ endpoint . deliveryStats . successful } successful` ) }
Get Email Group Endpoint import { InboundEmailClient } from '@inboundemail/sdk' const inbound = new InboundEmailClient ( process . env . INBOUND_API_KEY ! ) const { data : endpoint , error } = await inbound . endpoint . get ( 'ep_def456' ) if ( error ) { console . error ( 'Error fetching endpoint:' , error ) } else { console . log ( `Email Group: ${ endpoint . name } ` ) console . log ( `Recipients: ${ endpoint . groupEmails ?. join ( ', ' ) } ` ) }
Error Responses
{ "error" : "Unauthorized" } Missing or invalid authentication credentials.
{ "error" : "Endpoint not found" } The specified endpoint does not exist or you don’t have access to it.
500 Internal Server Error
{ "error" : "Internal server error" } An unexpected error occurred. Please try again or contact support. Understanding the Response Webhook Endpoint Email Forward Email Group For webhook endpoints, the config object contains:
url - The webhook destination URLtimeout - Request timeout in seconds (default: 30)retryAttempts - Number of retry attempts (default: 3)headers - Custom headers to include in requestssecret - Webhook secret for signature verification Delivery Statistics The deliveryStats object provides insights into how the endpoint is performing:
Success Rate successful / total * 100 gives you the success percentage
Recent Activity lastDelivery shows when the endpoint was last used
Recent Deliveries The recentDeliveries array shows the 10 most recent delivery attempts, including:
Success/failure status
Response data (for webhooks)
Delivery timing information
Number of attempts made
This information is useful for debugging delivery issues or monitoring endpoint performance.
✅ Documentation Verified - This endpoint documentation has been verified against the actual API implementation in /api/v2/endpoints/[id]/route.ts. All response fields, types, and behavior match the implementation.
1.0 - ✅ 
