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

# List All Webhook Subscriptions Registered for Your Tenant

> GET /v1/webhook-subscriptions — Returns a paginated list of webhook subscriptions for your tenant. Filter by name, URL, or active status.

This endpoint returns all webhook subscriptions registered under your tenant, with support for filtering by name, URL, or active status. Results are paginated; use the `page` and `limit` query parameters to traverse large result sets. The `secret` field is never included in list responses — retrieve it only during subscription creation.

## Endpoint

```
GET /v1/webhook-subscriptions
```

**Required scope:** `webhooks.read`

## Request Headers

| Header | Required | Description |
| - | - | - |
| `Authorization` | Yes | `Bearer {access_token}` |

## Query Parameters

**page** `integer`

The page number to retrieve, starting at `1`. Defaults to `1`.

**limit** `integer`

Number of subscriptions to return per page. Defaults to `20`. Maximum is `100`.

**name** `string`

Filter results to subscriptions whose `name` contains this string (case-insensitive).

**url** `string`

Filter results to subscriptions whose `url` contains this string.

**isActive** `boolean`

When `true`, return only active subscriptions. When `false`, return only inactive subscriptions. Omit to return all.

## Response — 200 OK

**data** `array`

Array of webhook subscription objects. Each object contains the fields below. The `secret` is **never** included.

**Subscription object fields**

**id** `string`

UUID of the webhook subscription.

**name** `string`

Friendly name for the subscription.

**url** `string`

The HTTPS endpoint that receives event payloads.

**eventTypes** `array`

List of subscribed event type strings. Empty array means all events.

**isActive** `boolean`

Whether the subscription is currently active.

**createdAt** `string`

ISO 8601 creation timestamp.

**updatedAt** `string`

ISO 8601 last-updated timestamp.

**page** `integer`

The current page number.

**limit** `integer`

The number of records per page used for this response.

**total** `integer`

Total number of subscriptions matching the applied filters.

## Examples

### List all subscriptions

```bash theme={null}
curl --request GET \
  --url 'https://api.diameterpay.com/v1/webhook-subscriptions' \
  --header 'Authorization: Bearer {access_token}'
```

### Filter to active subscriptions on page 2

```bash theme={null}
curl --request GET \
  --url 'https://api.diameterpay.com/v1/webhook-subscriptions?isActive=true&page=2&limit=10' \
  --header 'Authorization: Bearer {access_token}'
```

### Filter by name

```bash theme={null}
curl --request GET \
  --url 'https://api.diameterpay.com/v1/webhook-subscriptions?name=Payment' \
  --header 'Authorization: Bearer {access_token}'
```

### Response

```json theme={null}
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Payment Notifications",
      "url": "https://hooks.yourapp.com/diameter/payments",
      "eventTypes": [
        "PAYMENT_WIRE_OUTBOUND_COMPLETED",
        "PAYMENT_WIRE_OUTBOUND_FAILED",
        "PAYMENT_WIRE_INBOUND_POSTED"
      ],
      "isActive": true,
      "createdAt": "2024-06-01T12:00:00.000Z",
      "updatedAt": "2024-06-01T12:00:00.000Z"
    },
    {
      "id": "7cb94e72-8821-4673-c4ed-3d074g77bgb7",
      "name": "Account Lifecycle Events",
      "url": "https://hooks.yourapp.com/diameter/accounts",
      "eventTypes": [
        "ACCOUNT_CREATED",
        "ACCOUNT_UPDATED"
      ],
      "isActive": true,
      "createdAt": "2024-06-02T09:15:00.000Z",
      "updatedAt": "2024-06-02T09:15:00.000Z"
    }
  ],
  "page": 1,
  "limit": 20,
  "total": 2
}
```


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