Skip to main content
Use GET /claims to inspect the authenticated organization’s available claim balance before kicking off more work or to display usage state in an admin UI. Each live Xactimate export uses 1 claim.

Response shape

The claims response includes:
  • organization_id: the owner of the balance
  • available_claims: the current spendable total
  • expiring_claims_in_30_days: claims that will age out soon
  • total_granted_claims: claims granted across eligible buckets
  • total_used_claims: claims already consumed from eligible buckets
  • buckets: individual purchased-claim buckets with remaining claims and expiration timestamps

Example

curl https://api.capout.ai/claims \
  -H "capout-api-key: $CAPOUT_API_KEY"
{
  "organization_id": "org_123",
  "available_claims": 5,
  "expiring_claims_in_30_days": 0,
  "total_granted_claims": 8,
  "total_used_claims": 3,
  "buckets": [
    {
      "id": "purchased-claims-id",
      "source_type": "TOPUP_ONE_TIME",
      "quantity": 5,
      "claims_remaining": 4,
      "expires_at": "2026-08-01T00:00:00Z",
      "created_at": "2026-06-01T00:00:00Z"
    }
  ]
}

Practical uses

  • Block or warn before high-volume export batches
  • Surface expiring balances in internal tooling
  • Reconcile billing and usage reports against CapOut balances