> ## Documentation Index > Fetch the complete documentation index at: https://docs.watchdog.no/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /openapi-preview.json get /v1/claims openapi: 3.1.0 info: title: Watchdog API (preview) version: 1.0.0 description: >- Development preview for agreements, price items, document relationships, canonical invoices, alerts and alert topics, claims and attached alerts, shared entity activity and comments, Document uploads, invoice imports, explicit invoice-agreement matching, and workflow runs. This contract is under development and is not served by api.watchdog.no. Request bodies are limited to 2 MiB (2,097,152 bytes), including all JSON fields and line data, except POST /v1/support/contact which permits 32 MiB for base64 attachments. File bytes are uploaded directly to storage. The existing public REST service retains its separate contract. servers: - url: http://localhost:3500 description: Local development Worker security: [] paths: /v1/claims: get: tags: - Claims summary: List claims description: >- 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. operationId: listClaims parameters: - name: X-Organization-Id in: header required: false schema: type: string description: >- 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. - schema: type: string enum: - 'true' - 'false' description: >- 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. required: false description: >- 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. name: mine in: query - schema: type: string description: >- 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. required: false description: >- 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. name: team_ids in: query - schema: type: string required: false name: supplier_ids in: query - schema: type: string required: false name: agreement_ids in: query - schema: type: string required: false name: statuses in: query - schema: type: string required: false name: creator_user_ids in: query - schema: type: string minLength: 1 maxLength: 200 description: Literal substring of the claim title or supplier name. required: false description: Literal substring of the claim title or supplier name. name: search in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ required: false name: created_from in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ required: false name: created_through in: query - schema: type: integer minimum: 1 maximum: 100 default: 50 description: Maximum number of results per page. required: false description: Maximum number of results per page. name: limit in: query - schema: type: string maxLength: 4096 description: >- Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page. required: false description: >- Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page. name: cursor in: query - schema: type: string enum: - created_at - updated_at default: created_at required: false name: sort in: query - schema: type: string enum: - asc - desc default: desc required: false name: direction in: query responses: '200': description: A page of claims. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Claim' maxItems: 100 next_cursor: type: - string - 'null' required: - data - next_cursor '400': description: >- 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). headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: '#/components/schemas/Error_validation_error' example: 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 '401': description: Missing or invalid bearer credential. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. WWW-Authenticate: schema: type: string required: false description: Bearer authentication challenge, when supplied. content: application/json: schema: $ref: '#/components/schemas/Error_invalid_token' example: error: code: invalid_token message: Missing or invalid bearer credential. request_id: req_example '403': description: >- Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: >- #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required 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 '404': description: The resource does not exist in the current organization. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: '#/components/schemas/Error_not_found' example: error: code: not_found message: The resource does not exist in the current organization. request_id: req_example '409': description: >- One or more selected teams have invalid saved filter rules. Update the team filters before retrying. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: '#/components/schemas/Error_conflict' 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 '429': description: The IP or authenticated credential exceeded its request limit. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. Retry-After: schema: type: string example: '60' required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/Error_rate_limit_exceeded' example: error: code: rate_limit_exceeded message: >- The IP or authenticated credential exceeded its request limit. request_id: req_example '500': description: >- Unexpected server failure. Include the request ID when contacting support. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: '#/components/schemas/Error_internal_error' example: error: code: internal_error message: >- Unexpected server failure. Include the request ID when contacting support. request_id: req_example '503': description: >- Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. Retry-After: schema: type: string example: '60' required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/Error_service_unavailable' example: error: code: service_unavailable message: >- Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided. request_id: req_example security: - ApiKeyBearer: [] - ClerkSessionBearer: [] components: schemas: Claim: type: object properties: id: type: string format: uuid agreement: type: object properties: id: type: string format: uuid title: type: - string - 'null' required: - id - title suppliers: type: array items: type: object properties: id: type: string format: uuid name: type: string required: - id - name title: type: - string - 'null' status: type: string enum: - pending - in_progress - completed - cancelled creator: type: - object - 'null' properties: user_id: type: - string - 'null' label: type: - string - 'null' required: - user_id - label created_at: type: string format: date-time updated_at: type: string format: date-time refund_summary: type: object properties: refund_count: type: integer amount_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount required: - refund_count - amount_by_currency summary: type: object properties: total: type: object properties: alert_count: type: integer invoice_count: type: integer description: >- Distinct invoices in this population. An invoice with multiple alert statuses counts in each applicable group, but only once in total. topic_count: type: integer description: >- Distinct topics represented by alerts in this population. Alerts without a topic do not contribute. A topic with multiple statuses counts in each applicable group, but only once in total. impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: >- Exact amounts in original currencies. Null alert impacts contribute zero. required: - alert_count - invoice_count - topic_count - impact_by_currency description: >- All currently attached alerts. The pending, claimed, credited, and dismissed populations partition it. pending: type: object properties: alert_count: type: integer invoice_count: type: integer description: >- Distinct invoices in this population. An invoice with multiple alert statuses counts in each applicable group, but only once in total. topic_count: type: integer description: >- Distinct topics represented by alerts in this population. Alerts without a topic do not contribute. A topic with multiple statuses counts in each applicable group, but only once in total. impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: >- Exact amounts in original currencies. Null alert impacts contribute zero. required: - alert_count - invoice_count - topic_count - impact_by_currency description: >- Attached alerts with status pending; still under review and not yet counted as pursued. claimed: type: object properties: alert_count: type: integer invoice_count: type: integer description: >- Distinct invoices in this population. An invoice with multiple alert statuses counts in each applicable group, but only once in total. topic_count: type: integer description: >- Distinct topics represented by alerts in this population. Alerts without a topic do not contribute. A topic with multiple statuses counts in each applicable group, but only once in total. impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: >- Exact amounts in original currencies. Null alert impacts contribute zero. required: - alert_count - invoice_count - topic_count - impact_by_currency description: Attached alerts with status claimed; amounts being pursued. credited: type: object properties: alert_count: type: integer invoice_count: type: integer description: >- Distinct invoices in this population. An invoice with multiple alert statuses counts in each applicable group, but only once in total. topic_count: type: integer description: >- Distinct topics represented by alerts in this population. Alerts without a topic do not contribute. A topic with multiple statuses counts in each applicable group, but only once in total. impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: >- Exact amounts in original currencies. Null alert impacts contribute zero. required: - alert_count - invoice_count - topic_count - impact_by_currency description: >- Attached alerts with status credited; amounts are alert impact, not recorded credits or refunds. dismissed: type: object properties: alert_count: type: integer invoice_count: type: integer description: >- Distinct invoices in this population. An invoice with multiple alert statuses counts in each applicable group, but only once in total. topic_count: type: integer description: >- Distinct topics represented by alerts in this population. Alerts without a topic do not contribute. A topic with multiple statuses counts in each applicable group, but only once in total. impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: >- Exact amounts in original currencies. Null alert impacts contribute zero. required: - alert_count - invoice_count - topic_count - impact_by_currency description: >- Attached alerts with status dismissed; amounts excluded from pursuit. required: - total - pending - claimed - credited - dismissed required: - id - agreement - suppliers - title - status - creator - created_at - updated_at - refund_summary - summary Error_validation_error: type: object properties: error: type: object properties: code: type: string enum: - validation_error message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_invalid_token: type: object properties: error: type: object properties: code: type: string enum: - invalid_token message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required: type: object properties: error: type: object properties: code: type: string enum: - forbidden - token_disabled - organization_required - insufficient_role - mfa_required message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_not_found: type: object properties: error: type: object properties: code: type: string enum: - not_found message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_conflict: type: object properties: error: type: object properties: code: type: string enum: - conflict message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_rate_limit_exceeded: type: object properties: error: type: object properties: code: type: string enum: - rate_limit_exceeded message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_internal_error: type: object properties: error: type: object properties: code: type: string enum: - internal_error message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_service_unavailable: type: object properties: error: type: object properties: code: type: string enum: - service_unavailable message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error securitySchemes: ApiKeyBearer: type: http scheme: bearer description: >- Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission. ClerkSessionBearer: type: http scheme: bearer description: Clerk session with an active organization. ````