curl --request GET \
--url http://localhost:3500/v1/claims \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/claims', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/claims"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agreement": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"suppliers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"title": "<string>",
"status": "pending",
"creator": {
"user_id": "<string>",
"label": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"refund_summary": {
"refund_count": 123,
"amount_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"summary": {
"total": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"pending": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"claimed": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"credited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"dismissed": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
}
}
}
],
"next_cursor": "<string>"
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "One or more selected teams have invalid saved filter rules. Update the team filters before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}List claims
All claim statuses are included by default. Filters combine with AND, values within a filter with OR. Dates are inclusive calendar dates in the organization timezone. Search matches claim titles or supplier names. Suppliers come from the agreement, falling back to current alerts for legacy agreements without suppliers. Sort by created_at or updated_at with asc/desc direction; the default is created_at descending, with ID as the tie-breaker. Amounts are exact strings grouped by original currency; removed alerts do not contribute to amounts.
curl --request GET \
--url http://localhost:3500/v1/claims \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/claims', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/claims"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agreement": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>"
},
"suppliers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"title": "<string>",
"status": "pending",
"creator": {
"user_id": "<string>",
"label": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"refund_summary": {
"refund_count": 123,
"amount_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"summary": {
"total": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"pending": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"claimed": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"credited": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
},
"dismissed": {
"alert_count": 123,
"invoice_count": 123,
"topic_count": 123,
"impact_by_currency": [
{
"currency_code": "<string>",
"amount": "<string>"
}
]
}
}
}
],
"next_cursor": "<string>"
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "One or more selected teams have invalid saved filter rules. Update the team filters before retrying.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Authorizations
Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.
Headers
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
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.
true, false 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.
Literal substring of the claim title or supplier name.
1 - 200^\d{4}-\d{2}-\d{2}$^\d{4}-\d{2}-\d{2}$Maximum number of results per page.
1 <= x <= 100Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.
4096created_at, updated_at asc, desc