---
title: "List Webhook Subscriptions"
method: GET
path: "/api/v1/webhook-subscriptions"
tags: ["Webhook Subscriptions"]
---

# List Webhook Subscriptions

`GET /api/v1/webhook-subscriptions`

List all webhook subscriptions with pagination and filtering options

## Query parameters

- `perPage` integer
- `page` integer
- `entityId` string

## Response `200`

Webhook subscriptions listed successfully

- object
  - `data` WebhookSubscriptionResponse[]
    - `id` string — Unique identifier for the webhook subscription
    - `type` 'webhookSubscription' — Type of the resource
    - `attributes` object
      - `url` string, uri — HTTPS URL that will receive webhook events
      - `secretKey` string — Secret key used to sign webhook payloads
      - `enabled` boolean — Whether the webhook subscription is active
      - `scopeType` 'organisation' | 'entity' — Scope type for the webhook subscription
      - `scopeName` string — Name of the scope
      - `subscribedEvents` string[] — List of events subscribed to
  - `meta` IndexMeta
    - `totalCount` integer — Total count of records returned
    - `resultsPerPage` integer — Number of records returned per page. Set using the perPage query parameter.
    - `currentPage` integer — Index of current page
    - `totalPages` integer — Total pages returned
  - `links` IndexLinks
    - `first` string, nullable — Path to first page, null if currentPage is first page
    - `prev` string, nullable — Path to prev page, null if currentPage is first page
    - `next` string, nullable — Path to next page, null if currentPage is last page
    - `last` string, nullable — Path to last page, null if currentPage is last page

## Other responses

- `401` — Unauthorized - Invalid API key

---

[API](https://skmtc.dev/passentry/apis/passentry-api.md) · [All operations](https://skmtc.dev/passentry/apis/passentry-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/passentry/passentry-api/revisions/3b24e067f9d9/schema)
