---
title: "List webhook subscriptions"
method: GET
path: "/v1/webhooks"
tags: ["Webhooks"]
---

# List webhook subscriptions

`GET /v1/webhooks`

## Request

- Base URL: `https://api.registrum.co.uk`
- URL: `https://api.registrum.co.uk/v1/webhooks`
- Auth: API key in header `X-API-Key`

List all active webhook subscriptions for the authenticated API key.

## Response `200`

List of active webhook subscriptions for this API key

- WebhookListEnvelope: Response envelope for GET /v1/webhooks.
  - `status` string: 'success' or 'error'
  - `data` WebhookList: Active webhook subscriptions for the API key.
    - `webhooks` WebhookSubscription[], required: Active webhook subscriptions
      - `id` string, required: Webhook ID (UUID). Use it with GET and DELETE /v1/webhooks/{webhook_id}
      - `api_key_id` string, nullable: ID of the API key that owns this webhook
      - `url` string, required: URL that receives signed POST deliveries when a watched company changes
      - `company_numbers` string[], required: Companies House numbers being watched
      - `events` string[], required: Event types subscribed to, e.g. `status_change`, `accounts_overdue`
      - `secret` string, required: HMAC-SHA256 signing secret for verifying the `X-Registrum-Signature` header. Store it securely
      - `is_active` boolean, required: True while the subscription is delivering
      - `created_at` string, nullable: ISO 8601 timestamp when the webhook was created
      - `last_triggered_at` string, nullable: ISO 8601 timestamp of the last delivery attempt (null if never triggered)
      - `failure_count` integer, nullable: Consecutive delivery failures recorded for this webhook
    - `count` integer, required: Number of webhooks returned
  - `cached` boolean: True if this response was served from cache rather than fetched live
  - `cache_age_seconds` integer, nullable: How many seconds ago this data was fetched from Companies House (null if not cached)
  - `fetched_at` string, nullable: ISO 8601 instant (UTC) when this data was actually fetched from Companies House. Use this, not cache_age_seconds, to show a user when the data was last checked: an age is measured at the moment this response was produced, so anything that caches the response downstream will overstate freshness by however long it held it. This instant does not drift. Null when unknown - render nothing rather than a guessed date.
  - `data_source` string: 'live' - fetched from Companies House right now; 'cached' - served from local cache (data is recent, no upstream call needed); 'cached_rate_conserved' - served from cache because the CH API budget is above 70% utilisation; data may be up to 30 days old in this state
  - `credits_used` integer: Number of API credits consumed by this request
  - `credits_remaining` integer, nullable: API credits remaining this month (null in dev mode)

## Other responses

- `401`: Missing or invalid API key

---

[API](https://skmtc.dev/registrum/apis/registrum-api.md) · [All operations](https://skmtc.dev/registrum/apis/registrum-api/llms.txt) · [OpenAPI document](https://skmtc.dev/registrum/apis/registrum-api/revisions/2bf0ecf7cc02?raw)
