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

# 列出 Notification Endpoints

<Warning>
  此頁面由 AI 自動翻譯。API 技術規格以英文呈現為標準。如有任何疑問，請參閱[英文版本](/api-reference/notification/list-notification-endpoints)。
</Warning>

列出您的帳戶已註冊、用於接收 webhook 通知的 HTTPS 端點。每筆結果都包含 `apiNotificationId`（呼叫[刪除 Notification Endpoint](/zh-Hant/api-reference/notification/delete-notification-endpoint) 時使用）以及已儲存的端點 URL。

尚未註冊任何端點的帳戶會收到空清單，而非錯誤。

<Note>
  這裡只會列出您透過本 API 註冊的端點。由 Return Helper 代為設定的端點不會顯示於此，也無法在此刪除——如需異動請聯絡 [support@returnhelper.com](mailto:support@returnhelper.com)。
</Note>

<h2 id="related">
  相關
</h2>

* [新增 Notification Endpoint](/zh-Hant/api-reference/notification/add-notification-endpoint)
* [Webhooks](/zh-Hant/webhooks) — 事件清單、Payload 與簽章驗證。


## OpenAPI

````yaml get /api/Notification/GetAll
openapi: 3.1.0
info:
  title: Return Helper API
  description: API documentation for Return Helper — covering User and Public endpoints.
  version: 1.0.0
servers:
  - url: https://api.returnshelper.com/uat/user
    description: Sandbox — User API
  - url: https://api.returnshelper.com/uat/public
    description: Sandbox — Public API
  - url: https://api.returnhelpercentre.com/v1/user
    description: Production — User API
  - url: https://api.returnhelpercentre.com/v1/public
    description: Production — Public API
  - url: https://api.returnhelperchina.com/user
    description: Production — User API (China)
security:
  - ApiKey: []
    ApiToken: []
paths:
  /api/Notification/GetAll:
    get:
      tags:
        - Notification
      summary: List notification endpoints
      operationId: ReturnUserApi_NotificationGetAll
      responses:
        '200':
          description: >-
            Success — `data` lists the notification endpoints registered by the
            account through this API. Empty when none are registered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneralList_NotificationEndpointReply'
        '401':
          description: >-
            Authentication failed. Returned when the `x-rr-apikey` or
            `x-rr-apitoken` header is missing or invalid. The body uses the
            standard `ApiResponse` envelope with `meta.error.message` describing
            the auth failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
      security:
        - ApiKey: []
          ApiToken: []
      servers:
        - url: https://api.returnshelper.com/uat/user
          description: Sandbox — User API
components:
  schemas:
    GeneralList_NotificationEndpointReply:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/NotificationEndpointReply'
          description: >-
            Notification endpoints registered by the account through this API.
            Empty when none are registered.
    ApiResponse:
      type: object
      description: >-
        Universal response envelope. Successful responses include the business
        payload as additional top-level fields alongside `correlationId` and
        `meta`. Failed responses (auth errors, validation errors) only populate
        `correlationId` and `meta`, with `meta.errorCode` and `meta.error`
        describing the failure.
      properties:
        correlationId:
          type:
            - string
            - 'null'
          description: >-
            Unique correlation ID for tracing the request through Return Helper
            systems.
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
    NotificationEndpointReply:
      type: object
      properties:
        apiNotificationId:
          type: integer
          format: int64
          description: >-
            Identifier of the registered notification endpoint. Pass this to
            /api/Notification/Delete.
          examples:
            - 1234
        endpoint:
          type:
            - string
            - 'null'
          description: The normalized endpoint URL as stored by Return Helper.
          examples:
            - https://acme.example/hooks/returnhelper
    ApiResponseMeta:
      type: object
      description: >-
        Application-level metadata for every API response. Inspect `status` and
        `errorCode` to detect soft-error responses (validation failures arrive
        as HTTP 200 with `meta.status: 400`).
      properties:
        status:
          type: integer
          description: >-
            Application-level status code. For successful operations this
            mirrors the HTTP status (e.g. 200). For validation failures it
            reports the logical status (e.g. 400) even though the wire HTTP
            status is 200.
        data:
          type: object
          additionalProperties:
            type: string
          description: Reserved free-form metadata key/value pairs. Usually empty.
        errorCode:
          type:
            - string
            - 'null'
          description: >-
            Machine-readable error code (e.g. `VALIDATION_FAILED`). Non-null
            only when the operation failed.
        error:
          type: object
          additionalProperties: true
          description: >-
            Field-level or message-level error detail keyed by request property
            name. Empty object on success.
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-rr-apikey
      description: Your API key
    ApiToken:
      type: apiKey
      in: header
      name: x-rr-apitoken
      description: Your API token — keep this private

````