> ## Documentation Index
> Fetch the complete documentation index at: https://inbound.new/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List all endpoints

> Get paginated list of endpoints for authenticated user with optional filtering by type, active status, sort order, and search by name



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/inbound/openapi.documented.yml get /api/e2/endpoints
openapi: 3.1.0
info:
  title: Inbound Email API
  description: >+

    # Inbound API


    The Inbound API allows you to manage email infrastructure programmatically -
    domains, email addresses, webhooks, and more.


    ## Authentication


    All API requests require a Bearer token in the Authorization header:


    ```bash

    curl -H "Authorization: Bearer YOUR_API_KEY" \
      https://inbound.new/api/e2/domains
    ```


    ## Base URL


    ```

    https://inbound.new/api/e2

    ```


    ## Quick Start


    1. **Create a domain** - Register your domain with Inbound

    2. **Configure DNS** - Add the provided DNS records to your domain

    3. **Create an email address** - Set up addresses to receive emails

    4. **Create an endpoint** - Configure where emails are delivered (webhook,
    forwarding, etc.)

  version: 2.0.0
servers:
  - url: https://inbound.new
    description: Production API server
security:
  - bearerAuth: []
tags:
  - name: Webhooks
    description: Webhooks sent by Inbound to your configured endpoints when events occur.
  - name: Emails
    description: >-
      Send, list, and manage emails. Supports immediate sending, scheduling,
      replies, and retry functionality.
  - name: Mail
    description: >-
      Inbox and thread views for received emails. Filter by domain, address, or
      search.
  - name: Domains
    description: >-
      Manage domains for sending and receiving emails. Domains must be verified
      via DNS before use.
  - name: Endpoints
    description: >-
      Configure where incoming emails are delivered - webhooks, email
      forwarding, or custom handlers.
  - name: Email Addresses
    description: Create and manage email addresses on your verified domains.
  - name: Attachments
    description: Download email attachments using authenticated requests.
paths:
  /api/e2/endpoints:
    get:
      tags:
        - Endpoints
      summary: List all endpoints
      description: >-
        Get paginated list of endpoints for authenticated user with optional
        filtering by type, active status, sort order, and search by name
      operationId: getApiE2Endpoints
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            minimum: 1
            maximum: 100
            default: 50
            anyOf:
              - format: integer
                default: 0
                type: string
              - minimum: 1
                maximum: 100
                default: 50
                type: integer
        - name: offset
          in: query
          required: false
          schema:
            minimum: 0
            default: 0
            anyOf:
              - format: integer
                default: 0
                type: string
              - minimum: 0
                default: 0
                type: integer
        - name: type
          in: query
          required: false
          schema:
            enum:
              - webhook
              - email
              - email_group
            type: string
        - name: active
          in: query
          required: false
          schema:
            enum:
              - 'true'
              - 'false'
            type: string
        - name: sortBy
          in: query
          required: false
          schema:
            enum:
              - newest
              - oldest
            type: string
        - name: search
          in: query
          required: false
          schema:
            maxLength: 100
            type: string
      responses:
        '200':
          description: Response for status 200
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        type:
                          enum:
                            - webhook
                            - email
                            - email_group
                          type: string
                        config:
                          x-stainless-any: true
                        isActive:
                          type: boolean
                        description:
                          nullable: true
                          anyOf:
                            - type: string
                            - type: 'null'
                        userId:
                          type: string
                        createdAt:
                          type: string
                        updatedAt:
                          type: string
                        groupEmails:
                          nullable: true
                          anyOf:
                            - type: array
                              items:
                                type: string
                            - type: 'null'
                        deliveryStats:
                          type: object
                          properties:
                            total:
                              type: number
                            successful:
                              type: number
                            failed:
                              type: number
                            lastDelivery:
                              nullable: true
                              anyOf:
                                - type: string
                                - type: 'null'
                          required:
                            - total
                            - successful
                            - failed
                            - lastDelivery
                      required:
                        - id
                        - name
                        - type
                        - config
                        - isActive
                        - description
                        - userId
                        - createdAt
                        - updatedAt
                        - groupEmails
                        - deliveryStats
                  pagination:
                    type: object
                    properties:
                      limit:
                        type: number
                      offset:
                        type: number
                      total:
                        type: number
                      hasMore:
                        type: boolean
                    required:
                      - limit
                      - offset
                      - total
                      - hasMore
                required:
                  - data
                  - pagination
        '401':
          description: Response for status 401
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: number
                required:
                  - error
                  - message
                  - statusCode
        '500':
          description: Response for status 500
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: number
                required:
                  - error
                  - message
                  - statusCode
      x-codeSamples:
        - lang: JavaScript
          source: |-
            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);
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Your Inbound API key. Include it in the Authorization header as: Bearer
        <your-api-key>

````