# List webhook endpoints

> The webhook_endpoints.list operation: GET /api/v1/webhook_endpoints in the REST API and the webhook_endpoints_list tool in the MCP server.

Lists the brand's webhook endpoints in the request's mode, newest first. Filter with `enabled` (`true` or
`false`) to find endpoints that were disabled, by you or after failing for 3 days.

Paginate with `limit` (1–100, default 10) and `starting_after` (the `next_cursor` of the previous page).

## At a glance

- **REST:** `GET /api/v1/webhook_endpoints`
- **MCP tool:** `webhook_endpoints_list`
- **Operation ID:** `webhook_endpoints.list`
- **Scope:** Brand
- **Permission:** `webhooks:read`
- **Risk tier:** `read`
- **Dry run:** Not supported
- **Idempotency:** Not needed (read only)
- **Modes:** Test and live
- **Pagination:** `limit` (at most 100) and `starting_after`
- **Authentication:** API key with the `webhooks:read` scope
- **Since:** M4

## Request

### Query parameters

| Field            | Type               | Required | Description                                            |
| ---------------- | ------------------ | -------- | ------------------------------------------------------ |
| `enabled`        | string             | No       | Only enabled (`true`) or disabled (`false`) endpoints. |
| `limit`          | integer (1 to 100) | No       |                                                        |
| `starting_after` | `we_…` ID          | No       |                                                        |

## Response

`200 OK` with a JSON object, a page of the list (newest first):

| Field                            | Type                               | Description |
| -------------------------------- | ---------------------------------- | ----------- |
| `object`                         | `"list"`                           |             |
| `data`                           | array of object                    |             |
| `data[].id`                      | `we_…` ID                          |             |
| `data[].object`                  | `"webhook_endpoint"`               |             |
| `data[].brandId`                 | `brd_…` ID                         |             |
| `data[].livemode`                | boolean                            |             |
| `data[].url`                     | string                             |             |
| `data[].description`             | string or null                     |             |
| `data[].events`                  | array of string                    |             |
| `data[].enabled`                 | boolean                            |             |
| `data[].disabledReason`          | one of `manual`, `failing` or null |             |
| `data[].disabledAt`              | date-time or null                  |             |
| `data[].failingSince`            | date-time or null                  |             |
| `data[].secretRotatedAt`         | date-time or null                  |             |
| `data[].previousSecretExpiresAt` | date-time or null                  |             |
| `data[].metadata`                | object                             |             |
| `data[].createdAt`               | date-time                          |             |
| `data[].updatedAt`               | date-time                          |             |
| `has_more`                       | boolean                            |             |
| `next_cursor`                    | `we_…` ID or null                  |             |

## Examples

### The brand's endpoints

```http
GET /api/v1/webhook_endpoints
Authorization: Bearer or_test_…
```

Response (`200`):

```json
{
  "object": "list",
  "data": [
    {
      "id": "we_01m4tx5nj8emwbyf7y9vcf47z0",
      "object": "webhook_endpoint",
      "brandId": "brd_01m4tx5nj8emwbyf7y9vcf47x4",
      "livemode": false,
      "url": "https://example.com/webhooks/ownrecord",
      "description": "Order fulfilment",
      "events": ["customer.created", "checkout.session.completed"],
      "enabled": true,
      "disabledReason": null,
      "disabledAt": null,
      "failingSince": null,
      "secretRotatedAt": null,
      "previousSecretExpiresAt": null,
      "metadata": {},
      "createdAt": "2026-10-13T12:00:00.000Z",
      "updatedAt": "2026-10-13T12:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}
```

### Endpoints that were disabled

```http
GET /api/v1/webhook_endpoints?enabled=false
Authorization: Bearer or_test_…
```

Response (`200`):

```json
{
  "object": "list",
  "data": [
    {
      "id": "we_01m4tx5nj8emwbyf7y9vcf47z1",
      "object": "webhook_endpoint",
      "brandId": "brd_01m4tx5nj8emwbyf7y9vcf47x4",
      "livemode": false,
      "url": "https://example.com/webhooks/ownrecord",
      "description": "Order fulfilment",
      "events": ["customer.created", "checkout.session.completed"],
      "enabled": false,
      "disabledReason": "failing",
      "disabledAt": "2026-10-14T09:30:00.000Z",
      "failingSince": "2026-10-11T09:30:00.000Z",
      "secretRotatedAt": null,
      "previousSecretExpiresAt": null,
      "metadata": {},
      "createdAt": "2026-10-13T12:00:00.000Z",
      "updatedAt": "2026-10-14T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}
```

## Errors

| Code                                                                                   | HTTP status | When                                       | What to do                                                                      |
| -------------------------------------------------------------------------------------- | ----------- | ------------------------------------------ | ------------------------------------------------------------------------------- |
| [`validation_failed`](https://ownrecord.io/docs/reference/errors.md#validation_failed) | 400         | A filter or pagination value is malformed. | Fix the fields listed in `details.issues` and send the request again.           |
| [`permission_denied`](https://ownrecord.io/docs/reference/errors.md#permission_denied) | 403         | You can't see this brand's webhooks.       | Ask an organization owner or admin for a role or scope that allows this action. |

It can also return these [common errors](https://ownrecord.io/docs/reference.md#common-errors): [`api_version_unsupported`](https://ownrecord.io/docs/reference/errors.md#api_version_unsupported), [`authentication_required`](https://ownrecord.io/docs/reference/errors.md#authentication_required), [`api_key_invalid`](https://ownrecord.io/docs/reference/errors.md#api_key_invalid), [`scope_required`](https://ownrecord.io/docs/reference/errors.md#scope_required), [`resource_not_found`](https://ownrecord.io/docs/reference/errors.md#resource_not_found), [`dry_run_not_supported`](https://ownrecord.io/docs/reference/errors.md#dry_run_not_supported), [`rate_limited`](https://ownrecord.io/docs/reference/errors.md#rate_limited), [`internal_error`](https://ownrecord.io/docs/reference/errors.md#internal_error).