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

# List endpoints

> **Permission:** `webhooks:read`



## OpenAPI

````yaml /api-reference/openapi/user-api.yaml get /webhooks
openapi: 3.0.3
info:
  title: PapelShip Store API
  version: 1.0.0
  description: >-
    Manage your PapelShip store from your own systems: create orders, sync
    products and stock, ship physical orders, answer support tickets and react
    to events.


    Every request needs your API key in `x-api-key` and your store ID in
    `x-store-hash`. Amounts are integers in minor units (`2999` = 29.99). Dates
    are ISO 8601 in UTC.
  contact:
    name: PapelShip Support
    email: support@papelship.com
    url: https://papelship.com
servers:
  - url: https://app.papelship.com/api/v1
    description: Production
security:
  - ApiKey: []
    StoreHash: []
tags:
  - name: Account
    description: Your key, store and payment methods.
  - name: Orders
    description: Create orders, take manual payments, cancel, refund and read deliveries.
  - name: Products
    description: Products and their settings.
  - name: Variants & stock
    description: Variants, physical stock and license keys.
  - name: Product content
    description: Media, SEO, payment methods, files and stock alerts.
  - name: Categories
    description: Organise products.
  - name: Groups
    description: Collections of products.
  - name: Coupons
    description: Discount codes.
  - name: Customers
    description: Buyers and their history.
  - name: Blocklist
    description: Emails and IPs that can't place orders.
  - name: Reviews
    description: Customer reviews.
  - name: Support
    description: Support tickets.
  - name: Subscriptions
    description: Recurring products and auto-renewals.
  - name: Fulfillment
    description: Ship physical orders.
  - name: Returns
    description: Return requests.
  - name: Shipping settings
    description: Zones, rates and locations.
  - name: Webhooks
    description: Endpoints, deliveries and event types.
  - name: Affiliates
    description: Partner programme.
  - name: Analytics
    description: Sales summary.
paths:
  /webhooks:
    get:
      tags:
        - Webhooks
      summary: List endpoints
      description: '**Permission:** `webhooks:read`'
      operationId: listWebhooks
      parameters:
        - in: query
          name: limit
          schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 100
          description: Items per page (1–100).
        - in: query
          name: offset
          schema:
            type: integer
            default: 0
            minimum: 0
          description: Number of items to skip.
      responses:
        '200':
          description: A page of results
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  webhooks:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookEndpoint'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
                  limit_per_store:
                    type: integer
                    example: 16
                required:
                  - success
components:
  schemas:
    WebhookEndpoint:
      type: object
      properties:
        id:
          type: string
          example: we_8Kd2LmQ9
        object:
          type: string
          example: webhook_endpoint
        url:
          type: string
          example: https://example.com/webhooks/papelship
        description:
          type: string
          nullable: true
        events:
          type: array
          description: Event types, or `*` for all.
          example:
            - order.completed
            - order.refunded
          items:
            type: string
        enabled:
          type: boolean
        disabled_reason:
          type: string
          nullable: true
        failure_streak:
          type: integer
        secret_hint:
          type: string
          example: whsec_…a1b2
        last_success_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-10-04T12:00:00.000Z'
        last_failure_at:
          type: string
          format: date-time
          nullable: true
          example: '2026-10-04T12:00:00.000Z'
        created_at:
          type: string
          format: date-time
          example: '2026-10-04T12:00:00.000Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-10-04T12:00:00.000Z'
        stats_7d:
          type: object
          properties:
            total:
              type: integer
            succeeded:
              type: integer
            failed:
              type: integer
    Pagination:
      type: object
      properties:
        total:
          type: integer
          description: Total number of matching records.
          example: 128
        limit:
          type: integer
          example: 25
        offset:
          type: integer
          example: 0
        has_more:
          type: boolean
          description: '`true` when another page exists.'
          example: true
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your Store API key (`pk_live_...`). Create it in **Developers › API
        keys**.
    StoreHash:
      type: apiKey
      in: header
      name: x-store-hash
      description: >-
        The ID of the store the request is for. Shown in **Developers › API
        keys**.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.