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

# List All Registered Webhook Endpoints

> List all webhook endpoints for the authenticated application, with optional filtering by status and subscribed event types.

Use this endpoint to retrieve a paginated list of the webhook endpoints registered to your application. Filter by `status` to narrow the list to `enabled`, `disabled`, or `errored` endpoints, and by `subscribedEvents` to find endpoints carrying a given subscription. Signing secrets are never included.

<Note>
  The `subscribedEvents` filter matches **literally** against each endpoint's subscription list rather than expanding wildcards. Filtering by `transfer.*` returns endpoints that subscribed with the `transfer.*` wildcard itself, not endpoints subscribed to `transfer.succeeded`. To find every endpoint that would receive one event, pass both forms: `subscribedEvents=transfer.succeeded,transfer.*,*`.
</Note>


## OpenAPI

````yaml openapi/spherepay.yaml GET /v2/webhook-endpoints
openapi: 3.0.0
info:
  contact: {}
  description: The Sphere REST API for payments, transfers, and accounts.
  title: Sphere API
  version: '2'
servers:
  - description: Production
    url: https://api.spherepay.co
security:
  - bearer: []
tags: []
paths:
  /v2/webhook-endpoints:
    get:
      summary: List Webhook Endpoints V2
      description: >-
        List all webhook endpoints for the authenticated application, with
        optional filtering by status and subscribed event types.
      operationId: getV2WebhookEndpoints
      parameters:
        - in: query
          name: ''
          required: true
          schema:
            properties:
              limit:
                default: '10'
                description: 'Number of items per page (default: 10)'
                example: 10
                type: string
              page:
                default: '1'
                description: 'Page number of the list (default: 1)'
                example: 1
                type: string
              status:
                description: Filter endpoints by state.
                enum:
                  - enabled
                  - errored
                  - disabled
                  - deleted
                example: enabled
                type: string
                x-enumNames:
                  - ENABLED
                  - ERRORED
                  - DISABLED
                  - DELETED
              subscribedEvents:
                description: >-
                  Comma-separated list of event types. Returns endpoints
                  subscribed to at least one of them.
                example: payment.succeeded,payment.failed
                type: string
            required:
              - page
              - limit
            type: object
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    description: Array of webhook endpoint presentations
                    items:
                      properties:
                        apiVersion:
                          description: >-
                            API version date string this endpoint was configured
                            with, or null if not set.
                          example: '2026-04-01'
                          nullable: true
                          type: string
                        createdAt:
                          description: ISO 8601 timestamp when the endpoint was created.
                          example: '2026-01-01T00:00:00.000Z'
                          type: string
                        description:
                          description: >-
                            Human-readable description of this webhook endpoint,
                            or null if not set.
                          example: Production payment events handler
                          nullable: true
                          type: string
                        id:
                          description: The unique identifier of the webhook endpoint.
                          example: webhook_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6
                          type: string
                        metadata:
                          description: >-
                            Arbitrary key-value metadata attached to this
                            endpoint, or null if not set.
                          example:
                            environment: prod
                            team: payments
                          nullable: true
                        status:
                          description: The current state of this endpoint.
                          enum:
                            - enabled
                            - errored
                            - disabled
                            - deleted
                          example: enabled
                          type: string
                          x-enumNames:
                            - ENABLED
                            - ERRORED
                            - DISABLED
                            - DELETED
                        subscribedEvents:
                          description: List of event types this endpoint receives.
                          example:
                            - customer.created
                            - transfer.succeeded
                          items:
                            enum:
                              - '*'
                              - customer.*
                              - transfer.*
                              - document.*
                              - service.*
                              - customer.created
                              - customer.pending
                              - customer.approved
                              - customer.rejected
                              - transfer.created
                              - transfer.pendingFunding
                              - transfer.pendingReview
                              - transfer.fundsReceived
                              - transfer.processing
                              - transfer.succeeded
                              - transfer.returned
                              - transfer.pendingRefundInformation
                              - transfer.failed
                              - transfer.canceled
                              - transfer.refunded
                              - transfer.unexpectedError
                              - transfer.failedPrecondition
                              - transfer.expired
                              - transfer.unfunded
                              - document.pending
                              - document.processing
                              - document.verified
                              - document.rejected
                              - service.pending
                              - service.processing
                              - service.succeeded
                              - service.failed
                              - service.cancelled
                            type: string
                            x-enumNames:
                              - ALL
                              - ALL_CUSTOMER
                              - ALL_TRANSFER
                              - ALL_DOCUMENT
                              - ALL_SERVICE
                              - CREATE_CUSTOMER
                              - PENDING_CUSTOMER
                              - APPROVE_CUSTOMER
                              - REJECT_CUSTOMER
                              - CREATE_TRANSFER
                              - PENDING_FUNDING_TRANSFER
                              - PENDING_REVIEW_TRANSFER
                              - FUNDS_RECEIVED_TRANSFER
                              - PROCESSING_TRANSFER
                              - SUCCESSFUL_TRANSFER
                              - RETURNED_TRANSFER
                              - PENDING_REFUND_INFORMATION_TRANSFER
                              - FAILED_TRANSFER
                              - CANCELLED_TRANSFER
                              - REFUNDED_TRANSFER
                              - UNEXPECTED_ERROR_TRANSFER
                              - FAILED_PRECONDITION_TRANSFER
                              - EXPIRED_TRANSFER
                              - UNFUNDED_TRANSFER
                              - PENDING_DOCUMENT
                              - PROCESSING_DOCUMENT
                              - VERIFIED_DOCUMENT
                              - REJECTED_DOCUMENT
                              - PENDING_SERVICE
                              - PROCESSING_SERVICE
                              - SUCCESSFUL_SERVICE
                              - FAILED_SERVICE
                              - CANCELLED_SERVICE
                          type: array
                        updatedAt:
                          description: >-
                            ISO 8601 timestamp when the endpoint was last
                            updated.
                          example: '2026-01-01T00:00:00.000Z'
                          type: string
                        url:
                          description: The HTTPS URL events are delivered to.
                          example: https://example.com/webhooks/sphere
                          type: string
                      required:
                        - id
                        - url
                        - subscribedEvents
                        - status
                        - apiVersion
                        - description
                        - metadata
                        - createdAt
                        - updatedAt
                      type: object
                    type: array
                  hasNext:
                    description: Whether there is a next page
                    example: false
                    type: boolean
                  hasPrevious:
                    description: Whether there is a previous page
                    example: false
                    type: boolean
                  limit:
                    description: Number of items per page
                    example: 10
                    exclusiveMaximum: false
                    exclusiveMinimum: false
                    maximum: 100
                    minimum: 1
                    type: number
                  page:
                    description: Current page number
                    example: 1
                    type: number
                  total:
                    description: Total number of items
                    example: 1
                    type: number
                  totalPages:
                    description: Total number of pages
                    example: 1
                    type: number
                required:
                  - page
                  - limit
                  - total
                  - totalPages
                  - hasNext
                  - hasPrevious
                  - data
                type: object
          description: A paginated list of webhook endpoints.
        '400':
          content:
            application/json:
              examples:
                Bad Request:
                  summary: Bad Request
                  value:
                    code: address/invalid
                    correlationId: 28c61e885c6e5eaa78c1a2183a9b883c
                    detail: Invalid request parameters
                    status: 400
              schema:
                $ref: '#/components/schemas/ProblemDetailsDto'
          description: Bad Request
        '404':
          content:
            application/json:
              examples:
                Not Found:
                  summary: Not Found
                  value:
                    code: resource/not-found
                    correlationId: 28c61e885c6e5eaa78c1a2183a9b883c
                    detail: Resource not found
                    status: 404
              schema:
                $ref: '#/components/schemas/ProblemDetailsDto'
          description: Not Found
        '422':
          content:
            application/json:
              examples:
                Validation Error:
                  summary: Validation Error
                  value:
                    code: validation/failed
                    correlationId: 28c61e885c6e5eaa78c1a2183a9b883c
                    detail: Validation failed
                    errors:
                      - detail: Invalid email format
                        pointer: /email
                      - detail: Name is required
                        pointer: /name
                    status: 422
              schema:
                $ref: '#/components/schemas/ProblemDetailsDto'
          description: Unprocessable Entity - Validation Error
components:
  schemas:
    ProblemDetailsDto:
      properties:
        code:
          type: string
        correlationId:
          type: string
        detail:
          type: string
        errors:
          items:
            properties:
              detail:
                type: string
              header:
                type: string
              parameter:
                type: string
              pointer:
                type: string
            required:
              - detail
            type: object
          type: array
        status:
          type: integer
        title:
          type: string
      required:
        - status
        - detail
      type: object
  securitySchemes:
    bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````