Skip to main content
List alert group summaries

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Query Parameters

mine
enum<string>

Match the shared teams the authenticated user belongs to in this organization. Teams combine with OR; other filters combine with AND. No memberships or saved rules means no matches. Cannot be combined with team_ids when true.

Available options:
true,
false
team_ids
string

Shared team IDs (maximum 50; comma-separated in a query string, a JSON array in a command body). Teams combine with OR. Missing, foreign, or personal teams return 404; invalid saved rules return 409.

claim_ids
string

Match alerts currently attached to any selected claim; null matches alerts in no claim. Removed or transferred attachments are excluded. Claim status does not restrict matches; use claim_statuses.

has_claim
enum<string>

Use false to select alerts that are not currently attached to any claim.

Available options:
true,
false
claim_statuses
string

Match alerts whose current claim has any of these statuses.

invoice_ids
string
excluded_invoice_ids
string

Leave out alerts on any of these invoices.

agreement_ids
string
excluded_agreement_ids
string

Leave out alerts for any of these agreements.

supplier_ids
string
excluded_supplier_ids
string

Leave out alerts for any of these suppliers.

recipient_ids
string
excluded_recipient_ids
string

Leave out alerts on invoices for any of these recipients. Alerts on invoices without a recipient still match.

tag_ids
string
topic_ids
string

Match alerts in any selected topic; null matches uncategorized alerts.

excluded_topic_ids
string

Leave out alerts in any of these topics. Uncategorized alerts still match.

has_topic
enum<string>

Use false to select uncategorized alerts.

Available options:
true,
false
statuses
string
confidence_levels
string

Match any listed confidence level; null matches alerts without one.

currency_codes
string
correction_types
string
freshness
enum<string>
Available options:
current,
outdated,
unknown
impact_min
string

Minimum impact in the organization currency, inclusive. Alerts without an impact never match.

Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
impact_max
string

Maximum impact in the organization currency, inclusive. Alerts without an impact never match.

Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
issued_from
string

Invoice issued on or after this date.

Pattern: ^\d{4}-\d{2}-\d{2}$
issued_through
string

Invoice issued on or before this date.

Pattern: ^\d{4}-\d{2}-\d{2}$
created_from
string

Created on or after this calendar date in the organization's timezone.

Pattern: ^\d{4}-\d{2}-\d{2}$
created_through
string

Created on or before this calendar date in the organization's timezone.

Pattern: ^\d{4}-\d{2}-\d{2}$

Matches, ignoring case, the alert title, explanation and expected line; the supplier; the invoice number, title and line; the agreement title; or the topic title and description. A UUID also matches the alert, invoice, supplier or agreement ID.

Required string length: 1 - 200
limit
integer
default:50

Maximum number of results per page.

Required range: 1 <= x <= 100
cursor
string

Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.

Maximum string length: 4096
group_by
enum<string>
required
Available options:
agreement,
invoice,
topic,
claim,
status,
freshness
sort
enum<string>
default:impact_amount

impact_amount compares organization_currency.impact_amount.

Available options:
impact_amount,
total_count,
title
direction
enum<string>
default:desc
Available options:
asc,
desc

Response

A page of alert group summaries with status counts and totals per currency.

data
object[]
required
Maximum array length: 100
next_cursor
string | null
required