Skip to main content
List agreements

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.

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

Case-insensitive substring search across agreement titles and linked supplier names.

Required string length: 1 - 200
statuses
string
supplier_ids
string

Agreements with at least one of these organization-owned suppliers selected.

recipient_ids
string

Agreements covering any of these organization-owned recipients, including agreements with no recipient restriction.

tag_ids
string

Comma-separated organization tag IDs. Matches agreements with any of these tags; combines with other filters using AND.

excluded_supplier_ids
string

Leave out agreements with any of these suppliers selected.

excluded_tag_ids
string

Leave out agreements with any of these tags.

has_alert_statuses
string

Agreements with at least one alert in any of these statuses.

effective_from
string
Pattern: ^\d{4}-\d{2}-\d{2}$
effective_through
string
Pattern: ^\d{4}-\d{2}-\d{2}$
expiration_from
string
Pattern: ^\d{4}-\d{2}-\d{2}$
expiration_through
string
Pattern: ^\d{4}-\d{2}-\d{2}$
valid_on
string
Pattern: ^\d{4}-\d{2}-\d{2}$
sort
enum<string>
default:created_at

supplier sorts by the alphabetically first supplier. alert_progress is the share of alerts that are not pending (agreements without alerts last). open_alert_impact sums pending and claimed impact in the organization currency.

Available options:
created_at,
title,
effective_date,
expiration_date,
supplier,
pending_topic_count,
alert_progress,
open_alert_impact
direction
enum<string>
default:desc
Available options:
asc,
desc

Response

Agreement summaries with complete supplier, recipient and tag arrays.

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