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

# List Webhooks

`GET /webhooks`

## Request

- Base URL: `https://api.thanks.io/api/v2`
- URL: `https://api.thanks.io/api/v2/webhooks`
- Auth: HTTP bearer

Return a paginated list of configured webhooks. Webhooks are available on paid subscriptions only.

## Query parameters

- `items_per_page` integer
- `type` 'order_item.status_update' | 'order.status_update' | 'order_item.delivered' | 'scans.scan_update' | 'scan_board.status_update'
- `scan_board_status` 'new' | 'contacted' | 'follow_up' | 'done': A QR Scan Board stage.

## Response `200`

OK

- object
  - `data` object[]
    - `id` integer
    - `user_id` integer
    - `mailing_list_id` integer, nullable
    - `type` 'order_item.status_update' | 'order.status_update' | 'order_item.delivered' | 'scans.scan_update' | 'scan_board.status_update'
    - `scan_board_status` 'new' | 'contacted' | 'follow_up' | 'done' | 'null', nullable: The Scan Board stage this webhook fires on. Required when type is scan_board.status_update; null for other types.
    - `description` string, nullable
    - `invoke_count` integer
    - `url` string, uri
    - `verb` string
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time
    - `deleted_at` string, date-time, nullable
  - `links` Links
    - `first` string, nullable: URL of the first page of results
    - `last` string, nullable: URL of the last page of results
    - `prev` string, nullable: URL of the previous page of results
    - `next` string, nullable: URL of the next page of results
  - `meta` Meta
    - `current_page` integer: Current page number
    - `from` integer, nullable: Index of the first item on the current page
    - `last_page` integer: Total number of pages
    - `path` string: Base URL for the resource
    - `per_page` integer: Number of items per page
    - `to` integer, nullable: Index of the last item on the current page
    - `total` integer: Total number of items
  - `can_manage_webhooks` boolean

## Other responses

- `403`: Access token is missing or invalid

## Changes

- **2026-10-19** `6a3359b14347`: 1 warning, 3 info
  - added the new `scan_board.status_update` enum value to the `data/items/type` response property for the response status `200`
  - added the new optional `query` request parameter `scan_board_status`
  - added the new optional `query` request parameter `type`
  - added the optional property `data/items/scan_board_status` to the response with the `200` status
- **2026-10-19** `bbe02ffe74f3`: 3 warning, 1 info
  - deleted the `query` request parameter `scan_board_status`
  - deleted the `query` request parameter `type`
  - removed the optional property `data/items/scan_board_status` from the response with the `200` status
  - removed the `scan_board.status_update` enum value from the `data/items/type` response property for the response status `200`
- **2026-10-18** `c10cfeb34552`: 1 warning, 3 info
  - added the new `scan_board.status_update` enum value to the `data/items/type` response property for the response status `200`
  - added the new optional `query` request parameter `scan_board_status`
  - added the new optional `query` request parameter `type`
  - added the optional property `data/items/scan_board_status` to the response with the `200` status
- …earlier changes not shown

[Operation history](https://skmtc.dev/thanks-io/apis/thanks-io-api/changes/webhooks/get.md)

---

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