Skip to main content
List claims

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.

supplier_ids
string
agreement_ids
string
statuses
string
creator_user_ids
string

Literal substring of the claim title or supplier name.

Required string length: 1 - 200
created_from
string
Pattern: ^\d{4}-\d{2}-\d{2}$
created_through
string
Pattern: ^\d{4}-\d{2}-\d{2}$
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
sort
enum<string>
default:created_at
Available options:
created_at,
updated_at
direction
enum<string>
default:desc
Available options:
asc,
desc

Response

A page of claims.

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