API reference

object"list"required

dataobject[]required

data[].idstringrequired

clm_ id.

data[].object"claim"required

data[].mode"live" | "test"required

test = created with a ctk_test_ key: only test keys see it, and it is never billed.

data[].externalRefstring | nullrequired

Your own id for this claim.

data[].claimNumberstring | nullrequired

data[].insuredNamestring | nullrequired

data[].lossAddressstring | nullrequired

data[].lossType"Fire" | "Water" | "Wind" | "Other" | nullrequired

data[].dateOfLossstring | nullrequired

YYYY-MM-DD.

data[].status"open" | "in_progress" | "review" | "closed"required

data[].insuranceCompanystring | nullrequired

data[].policyNumberstring | nullrequired

data[].valuationMode"rcv" | "acv" | "acv_only"required

data[].salesTaxBpinteger | nullrequired

Sales tax in basis points (825 = 8.25%).

data[].itemCountintegerrequired

Inventory lines, excluding auto-detected duplicates.

data[].approvedRcvCentsintegerrequired

Replacement cost of approved items, tax included (get_claim_status has the pre-tax approvedSubtotalCents).

data[].createdAtstring (date-time)required

data[].updatedAtstring (date-time)required

Last change to the claim record itself (not its items).

hasMorebooleanrequired

nextCursorstring | nullrequired

Pass as cursor for the next page; null on the last page.

idstringrequired

clm_ id.

object"claim"required

mode"live" | "test"required

test = created with a ctk_test_ key: only test keys see it, and it is never billed.

externalRefstring | nullrequired

Your own id for this claim.

claimNumberstring | nullrequired

insuredNamestring | nullrequired

lossAddressstring | nullrequired

lossType"Fire" | "Water" | "Wind" | "Other" | nullrequired

dateOfLossstring | nullrequired

YYYY-MM-DD.

status"open" | "in_progress" | "review" | "closed"required

insuranceCompanystring | nullrequired

policyNumberstring | nullrequired

valuationMode"rcv" | "acv" | "acv_only"required

salesTaxBpinteger | nullrequired

Sales tax in basis points (825 = 8.25%).

itemCountintegerrequired

Inventory lines, excluding auto-detected duplicates.

approvedRcvCentsintegerrequired

Replacement cost of approved items, tax included (get_claim_status has the pre-tax approvedSubtotalCents).

createdAtstring (date-time)required

updatedAtstring (date-time)required

Last change to the claim record itself (not its items).

idstringrequired

clm_ id.

object"claim"required

mode"live" | "test"required

test = created with a ctk_test_ key: only test keys see it, and it is never billed.

externalRefstring | nullrequired

Your own id for this claim.

claimNumberstring | nullrequired

insuredNamestring | nullrequired

lossAddressstring | nullrequired

lossType"Fire" | "Water" | "Wind" | "Other" | nullrequired

dateOfLossstring | nullrequired

YYYY-MM-DD.

status"open" | "in_progress" | "review" | "closed"required

insuranceCompanystring | nullrequired

policyNumberstring | nullrequired

valuationMode"rcv" | "acv" | "acv_only"required

salesTaxBpinteger | nullrequired

Sales tax in basis points (825 = 8.25%).

itemCountintegerrequired

Inventory lines, excluding auto-detected duplicates.

approvedRcvCentsintegerrequired

Replacement cost of approved items, tax included (get_claim_status has the pre-tax approvedSubtotalCents).

createdAtstring (date-time)required

updatedAtstring (date-time)required

Last change to the claim record itself (not its items).

countsobjectrequired

counts.itemsintegerrequired

Inventory lines, excluding auto-detected duplicates.

counts.itemsAwaitingReviewintegerrequired

pending and low_confidence items.

counts.itemsApprovedintegerrequired

counts.itemsRejectedintegerrequired

counts.roomsintegerrequired

counts.photosintegerrequired

totalsobjectrequired

Approved items only, valued with the claim's tax, depreciation and payment caps.

totals.approvedSubtotalCentsintegerrequired

totals.approvedTaxCentsintegerrequired

totals.approvedRcvCentsintegerrequired

totals.approvedAcvCentsintegerrequired

totals.approvedPaymentCentsintegerrequired

What the approved lines pay after payment caps.

analysisobjectrequired

analysis.status"no_photos" | "in_progress" | "awaiting_start" | "complete"required

in_progress while any inventory photo is queued or analyzing; awaiting_start when the only unanalyzed photos are staged (held until someone starts analysis in the app); complete otherwise.

analysis.photosTotalintegerrequired

Inventory photos (reference photos are never analyzed).

analysis.photosQueuedintegerrequired

Uploaded and waiting for analysis.

analysis.photosStagedintegerrequired

analysis.photosAnalyzingintegerrequired

analysis.photosCompletedintegerrequired

analysis.photosFailedintegerrequired

analysis.photosAttachedintegerrequired

Added to an existing item as extra evidence (attach_item_photos, or the app's add photo to item): stored, never analyzed.

idstringrequired

clm_ id.

object"claim"required

mode"live" | "test"required

test = created with a ctk_test_ key: only test keys see it, and it is never billed.

externalRefstring | nullrequired

Your own id for this claim.

claimNumberstring | nullrequired

insuredNamestring | nullrequired

lossAddressstring | nullrequired

lossType"Fire" | "Water" | "Wind" | "Other" | nullrequired

dateOfLossstring | nullrequired

YYYY-MM-DD.

status"open" | "in_progress" | "review" | "closed"required

insuranceCompanystring | nullrequired

policyNumberstring | nullrequired

valuationMode"rcv" | "acv" | "acv_only"required

salesTaxBpinteger | nullrequired

Sales tax in basis points (825 = 8.25%).

itemCountintegerrequired

Inventory lines, excluding auto-detected duplicates.

approvedRcvCentsintegerrequired

Replacement cost of approved items, tax included (get_claim_status has the pre-tax approvedSubtotalCents).

createdAtstring (date-time)required

updatedAtstring (date-time)required

Last change to the claim record itself (not its items).

object"list"required

dataobject[]required

data[].idstringrequired

pho_ id.

data[].object"photo"required

data[].claimIdstringrequired

clm_ id.

data[].roomIdstring | nullrequired

rom_ id, or null when the photo is not filed in a room.

data[].filenamestringrequired

data[].contentTypestringrequired

data[].sizeBytesinteger | nullrequired

data[].kind"inventory" | "reference"required

reference: a room overview shot, never analyzed for items.

data[].analysisStatus"queued" | "staged" | "analyzing" | "completed" | "failed" | "not_analyzed"required

queued: uploaded, waiting for analysis; staged: held until someone starts analysis in the app; analyzing; completed: items identified (possibly none); failed: analysis failed; not_analyzed: a reference photo, or one added to an existing item as extra evidence (never analyzed).

data[].stackIdstring | nullrequired

pho_ id of the stack lead when several photos show one item; null otherwise.

data[].urlsobjectrequired

Signed GET URLs. They expire at urlsExpireAt: fetch the photo again for fresh ones, never store them.

data[].urls.originalstringrequired

The uploaded file (may be HEIC).

data[].urls.compressedstringrequired

A WebP copy for display. Generated shortly after upload: until then this URL returns 404, so fall back to original.

data[].urls.thumbnailstringrequired

data[].urlsExpireAtstring (date-time)required

data[].createdAtstring (date-time)required

data[].updatedAtstring (date-time)required

hasMorebooleanrequired

nextCursorstring | nullrequired

Pass as cursor for the next page; null on the last page.

object"photo_batch"required

claimIdstringrequired

pipeline"ai" | "test_fixtures" | "test_live_ai"required

ai = the real pipeline (live keys); test_fixtures = canned items at once; test_live_ai = real pipeline, test claim.

photosobject[]required

photos[].idstringrequired

pho_ id.

photos[].object"photo"required

photos[].externalIdstring | nullrequired

photos[].filenamestringrequired

photos[].roomIdstring | nullrequired

rom_ id, or null when unfiled.

photos[].status"uploading" | "processing" | "analyzed" | "analysis_failed" | "ready" | "failed"required

processing = queued for or in AI analysis; analyzed = items extracted; ready = stored, not analyzed; failed = the upload never arrived or did not match.

failedobject[]required

failed[].indexinteger | nullrequired

Position in the request, when the failure is about one entry.

failed[].photoIdstring | nullrequired

failed[].externalIdstring | nullrequired

failed[].codestringrequired

failed[].messagestringrequired

idstringrequired

pho_ id.

object"photo"required

claimIdstringrequired

clm_ id.

roomIdstring | nullrequired

rom_ id, or null when the photo is not filed in a room.

filenamestringrequired

contentTypestringrequired

sizeBytesinteger | nullrequired

kind"inventory" | "reference"required

reference: a room overview shot, never analyzed for items.

analysisStatus"queued" | "staged" | "analyzing" | "completed" | "failed" | "not_analyzed"required

queued: uploaded, waiting for analysis; staged: held until someone starts analysis in the app; analyzing; completed: items identified (possibly none); failed: analysis failed; not_analyzed: a reference photo, or one added to an existing item as extra evidence (never analyzed).

stackIdstring | nullrequired

pho_ id of the stack lead when several photos show one item; null otherwise.

urlsobjectrequired

Signed GET URLs. They expire at urlsExpireAt: fetch the photo again for fresh ones, never store them.

urls.originalstringrequired

The uploaded file (may be HEIC).

urls.compressedstringrequired

A WebP copy for display. Generated shortly after upload: until then this URL returns 404, so fall back to original.

urls.thumbnailstringrequired

urlsExpireAtstring (date-time)required

createdAtstring (date-time)required

updatedAtstring (date-time)required

idstringrequired

upl_ id; pass it to the complete call.

object"photo_upload"required

claimIdstringrequired

uploadsobject[]required

uploads[].photoIdstringrequired

uploads[].externalIdstring | nullrequired

uploads[].filenamestringrequired

uploads[].method"PUT"required

uploads[].urlstringrequired

Presigned storage URL. PUT the exact bytes with the headers below.

uploads[].headersobjectrequired

uploads[].expiresAtstring (date-time)required

object"photo_batch"required

claimIdstringrequired

pipeline"ai" | "test_fixtures" | "test_live_ai"required

ai = the real pipeline (live keys); test_fixtures = canned items at once; test_live_ai = real pipeline, test claim.

photosobject[]required

photos[].idstringrequired

pho_ id.

photos[].object"photo"required

photos[].externalIdstring | nullrequired

photos[].filenamestringrequired

photos[].roomIdstring | nullrequired

rom_ id, or null when unfiled.

photos[].status"uploading" | "processing" | "analyzed" | "analysis_failed" | "ready" | "failed"required

processing = queued for or in AI analysis; analyzed = items extracted; ready = stored, not analyzed; failed = the upload never arrived or did not match.

failedobject[]required

failed[].indexinteger | nullrequired

Position in the request, when the failure is about one entry.

failed[].photoIdstring | nullrequired

failed[].externalIdstring | nullrequired

failed[].codestringrequired

failed[].messagestringrequired

object"list"required

dataobject[]required

data[].idstringrequired

rom_ id.

data[].object"room"required

data[].claimIdstringrequired

clm_ id of the claim the room belongs to.

data[].namestringrequired

data[].type"floor" | "room" | "subroom"required

data[].parentIdstring | nullrequired

rom_ id of the containing floor or room; null at the top level.

data[].displayOrderintegerrequired

Position among its siblings, as the app orders them.

data[].itemCountintegerrequired

Inventory lines filed in this room (not its subrooms), excluding auto-detected duplicates.

data[].createdAtstring (date-time)required

data[].updatedAtstring (date-time)required

hasMorebooleanrequired

nextCursorstring | nullrequired

Pass as cursor for the next page; null on the last page.

idstringrequired

itm_ id.

object"item"required

claimIdstringrequired

clm_ id.

roomIdstring | nullrequired

rom_ id, or null when the item is not filed in a room.

roomNamestring | nullrequired

namestringrequired

The line as the app shows it: the retailer title when chosen, else the description.

descriptionstringrequired

What the item is, as identified or typed; name differs when a retailer title was chosen.

retailerDescriptionstring | nullrequired

modelstring | nullrequired

categorystring | nullrequired

quantityintegerrequired

unitCostCentsinteger | nullrequired

Null until the item is priced.

pricedbooleanrequired

True once the item has a unit cost. An unpriced item cannot be approved: set unitCostCents or accept a replacement first.

status"pending" | "low_confidence" | "reviewing" | "approved" | "rejected"required

pending and low_confidence await review; reviewing is being priced (the item is locked: edits and approval are refused until it finishes); approved items count toward totals and exports; rejected items are left out of both.

needsReviewbooleanrequired

True while the item waits on a person: status pending or low_confidence.

condition"New" | "Above Average" | "Average" | "Below Average" | nullrequired

estimatedAgeYearsnumber | nullrequired

source"ai" | "manual"required

ai: identified from a photo; manual: entered or imported.

priceSourcestring | nullrequired

Where the price came from (retailer name).

priceSourceUrlstring | nullrequired

notesstring | nullrequired

photoIdsstring[]required

pho_ ids the item appears in, primary photo first.

valuationobjectrequired

valuation.subtotalCentsintegerrequired

Quantity x unit cost, before tax.

valuation.taxCentsintegerrequired

Sales tax at the claim's salesTaxBp.

valuation.rcvCentsintegerrequired

Replacement cost value: subtotal plus tax.

valuation.depreciationBpintegerrequired

Depreciation rate applied, in basis points (2500 = 25%).

valuation.depreciationCentsintegerrequired

valuation.acvCentsintegerrequired

Actual cash value: RCV less depreciation.

valuation.paymentCentsintegerrequired

What the claim pays for the line after any payment cap.

createdAtstring (date-time)required

updatedAtstring (date-time)required

idstringrequired

itm_ id.

object"item"required

claimIdstringrequired

clm_ id.

roomIdstring | nullrequired

rom_ id, or null when the item is not filed in a room.

roomNamestring | nullrequired

namestringrequired

The line as the app shows it: the retailer title when chosen, else the description.

descriptionstringrequired

What the item is, as identified or typed; name differs when a retailer title was chosen.

retailerDescriptionstring | nullrequired

modelstring | nullrequired

categorystring | nullrequired

quantityintegerrequired

unitCostCentsinteger | nullrequired

Null until the item is priced.

pricedbooleanrequired

True once the item has a unit cost. An unpriced item cannot be approved: set unitCostCents or accept a replacement first.

status"pending" | "low_confidence" | "reviewing" | "approved" | "rejected"required

pending and low_confidence await review; reviewing is being priced (the item is locked: edits and approval are refused until it finishes); approved items count toward totals and exports; rejected items are left out of both.

needsReviewbooleanrequired

True while the item waits on a person: status pending or low_confidence.

condition"New" | "Above Average" | "Average" | "Below Average" | nullrequired

estimatedAgeYearsnumber | nullrequired

source"ai" | "manual"required

ai: identified from a photo; manual: entered or imported.

priceSourcestring | nullrequired

Where the price came from (retailer name).

priceSourceUrlstring | nullrequired

notesstring | nullrequired

photoIdsstring[]required

pho_ ids the item appears in, primary photo first.

valuationobjectrequired

valuation.subtotalCentsintegerrequired

Quantity x unit cost, before tax.

valuation.taxCentsintegerrequired

Sales tax at the claim's salesTaxBp.

valuation.rcvCentsintegerrequired

Replacement cost value: subtotal plus tax.

valuation.depreciationBpintegerrequired

Depreciation rate applied, in basis points (2500 = 25%).

valuation.depreciationCentsintegerrequired

valuation.acvCentsintegerrequired

Actual cash value: RCV less depreciation.

valuation.paymentCentsintegerrequired

What the claim pays for the line after any payment cap.

createdAtstring (date-time)required

updatedAtstring (date-time)required

object"list"required

dataobject[]required

data[].object"category"required

data[].namestringrequired

Pass it as category when updating an item on this claim.

data[].codestring | nullrequired

The 3-letter code on claims whose taxonomy is xactimate (also accepted as category); null otherwise.

data[].depreciationType"annual" | "1st-year" | "flat" | nullrequired

How the category depreciates by default: annual (per year of age), 1st-year (once), flat (age ignored).

data[].depreciationBpinteger | nullrequired

Default depreciation rate in basis points (1000 = 10%).

data[].maxDepreciationBpinteger | nullrequired

Default depreciation cap in basis points; null = no cap.

data[].usefulLifeYearsinteger | nullrequired

hasMorebooleanrequired

nextCursorstring | nullrequired

Pass as cursor for the next page; null on the last page.

taxonomy"jmidg" | "xactimate"required

The claim's category system. The claim's own depreciation settings can override the defaults listed.

object"list"required

dataobject[]required

data[].idstringrequired

itm_ id.

data[].object"item"required

data[].claimIdstringrequired

clm_ id.

data[].roomIdstring | nullrequired

rom_ id, or null when the item is not filed in a room.

data[].roomNamestring | nullrequired

data[].namestringrequired

The line as the app shows it: the retailer title when chosen, else the description.

data[].descriptionstringrequired

What the item is, as identified or typed; name differs when a retailer title was chosen.

data[].retailerDescriptionstring | nullrequired

data[].modelstring | nullrequired

data[].categorystring | nullrequired

data[].quantityintegerrequired

data[].unitCostCentsinteger | nullrequired

Null until the item is priced.

data[].pricedbooleanrequired

True once the item has a unit cost. An unpriced item cannot be approved: set unitCostCents or accept a replacement first.

data[].status"pending" | "low_confidence" | "reviewing" | "approved" | "rejected"required

pending and low_confidence await review; reviewing is being priced (the item is locked: edits and approval are refused until it finishes); approved items count toward totals and exports; rejected items are left out of both.

data[].needsReviewbooleanrequired

True while the item waits on a person: status pending or low_confidence.

data[].condition"New" | "Above Average" | "Average" | "Below Average" | nullrequired

data[].estimatedAgeYearsnumber | nullrequired

data[].source"ai" | "manual"required

ai: identified from a photo; manual: entered or imported.

data[].priceSourcestring | nullrequired

Where the price came from (retailer name).

data[].priceSourceUrlstring | nullrequired

data[].notesstring | nullrequired

data[].photoIdsstring[]required

pho_ ids the item appears in, primary photo first.

data[].valuationobjectrequired

data[].valuation.subtotalCentsintegerrequired

Quantity x unit cost, before tax.

data[].valuation.taxCentsintegerrequired

Sales tax at the claim's salesTaxBp.

data[].valuation.rcvCentsintegerrequired

Replacement cost value: subtotal plus tax.

data[].valuation.depreciationBpintegerrequired

Depreciation rate applied, in basis points (2500 = 25%).

data[].valuation.depreciationCentsintegerrequired

data[].valuation.acvCentsintegerrequired

Actual cash value: RCV less depreciation.

data[].valuation.paymentCentsintegerrequired

What the claim pays for the line after any payment cap.

data[].createdAtstring (date-time)required

data[].updatedAtstring (date-time)required

hasMorebooleanrequired

nextCursorstring | nullrequired

Pass as cursor for the next page; null on the last page.

idstringrequired

itm_ id.

object"item"required

claimIdstringrequired

clm_ id.

roomIdstring | nullrequired

rom_ id, or null when the item is not filed in a room.

roomNamestring | nullrequired

namestringrequired

The line as the app shows it: the retailer title when chosen, else the description.

descriptionstringrequired

What the item is, as identified or typed; name differs when a retailer title was chosen.

retailerDescriptionstring | nullrequired

modelstring | nullrequired

categorystring | nullrequired

quantityintegerrequired

unitCostCentsinteger | nullrequired

Null until the item is priced.

pricedbooleanrequired

True once the item has a unit cost. An unpriced item cannot be approved: set unitCostCents or accept a replacement first.

status"pending" | "low_confidence" | "reviewing" | "approved" | "rejected"required

pending and low_confidence await review; reviewing is being priced (the item is locked: edits and approval are refused until it finishes); approved items count toward totals and exports; rejected items are left out of both.

needsReviewbooleanrequired

True while the item waits on a person: status pending or low_confidence.

condition"New" | "Above Average" | "Average" | "Below Average" | nullrequired

estimatedAgeYearsnumber | nullrequired

source"ai" | "manual"required

ai: identified from a photo; manual: entered or imported.

priceSourcestring | nullrequired

Where the price came from (retailer name).

priceSourceUrlstring | nullrequired

notesstring | nullrequired

photoIdsstring[]required

pho_ ids the item appears in, primary photo first.

valuationobjectrequired

valuation.subtotalCentsintegerrequired

Quantity x unit cost, before tax.

valuation.taxCentsintegerrequired

Sales tax at the claim's salesTaxBp.

valuation.rcvCentsintegerrequired

Replacement cost value: subtotal plus tax.

valuation.depreciationBpintegerrequired

Depreciation rate applied, in basis points (2500 = 25%).

valuation.depreciationCentsintegerrequired

valuation.acvCentsintegerrequired

Actual cash value: RCV less depreciation.

valuation.paymentCentsintegerrequired

What the claim pays for the line after any payment cap.

createdAtstring (date-time)required

updatedAtstring (date-time)required

object"list"required

itemIdstringrequired

searchedAtstring (date-time) | nullrequired

When the finder last searched for this item; null if it never has.

searchingbooleanrequired

True while a search for this item is running (the item is reviewing): the offers are still the previous search's. Call again in a little while.

dataobject[]required

The offers from the most recent search, best first.

data[].idstringrequired

rpl_ id; pass it to .../replacements/{replacementId}/accept.

data[].object"replacement"required

data[].titlestringrequired

The listing's product title.

data[].modelstring | nullrequired

data[].retailerstring | nullrequired

data[].priceCentsinteger | nullrequired

The listing's price for one, in integer cents; null when the listing had no price.

data[].urlstring | nullrequired

The retailer's product page, when one was found.

data[].imageUrlstring | nullrequired

data[].proposedbooleanrequired

True for the offer the finder picked for this item.

data[].outsidePreferredRetailersbooleanrequired

True when the retailer is not on the organization's preferred list.

data[].acceptedAtstring (date-time) | nullrequired

When this offer was applied to the item, if it was.

object"item_approval"required

claimIdstringrequired

approvedstring[]required

itm_ ids approved by this request.

alreadyApprovedstring[]required

itm_ ids that were approved already; nothing changed.

lockedstring[]required

itm_ ids still being priced (status reviewing). Retry them once pricing finishes.

skippedobject[]required

skipped[].itemIdstringrequired

skipped[].reason"unpriced" | "not_approvable"required

unpriced: the item has no unit cost; set unitCostCents or accept a replacement, then approve again. not_approvable: the item cannot be approved in its current state.

notFoundstring[]required

Ids that are not items on this claim (or not visible to this key).

object"item_rejection"required

claimIdstringrequired

rejectedstring[]required

itm_ ids rejected by this request.

alreadyRejectedstring[]required

lockedstring[]required

itm_ ids still being priced (status reviewing).

notFoundstring[]required

object"item_unapproval"required

claimIdstringrequired

unapprovedstring[]required

itm_ ids moved from approved back to pending.

notApprovedstring[]required

itm_ ids that were not approved; nothing changed.

notFoundstring[]required

object"item_price_from_link"required

itemobjectrequired

item.idstringrequired

itm_ id.

item.object"item"required

item.claimIdstringrequired

clm_ id.

item.roomIdstring | nullrequired

rom_ id, or null when the item is not filed in a room.

item.roomNamestring | nullrequired

item.namestringrequired

The line as the app shows it: the retailer title when chosen, else the description.

item.descriptionstringrequired

What the item is, as identified or typed; name differs when a retailer title was chosen.

item.retailerDescriptionstring | nullrequired

item.modelstring | nullrequired

item.categorystring | nullrequired

item.quantityintegerrequired

item.unitCostCentsinteger | nullrequired

Null until the item is priced.

item.pricedbooleanrequired

True once the item has a unit cost. An unpriced item cannot be approved: set unitCostCents or accept a replacement first.

item.status"pending" | "low_confidence" | "reviewing" | "approved" | "rejected"required

pending and low_confidence await review; reviewing is being priced (the item is locked: edits and approval are refused until it finishes); approved items count toward totals and exports; rejected items are left out of both.

item.needsReviewbooleanrequired

True while the item waits on a person: status pending or low_confidence.

item.condition"New" | "Above Average" | "Average" | "Below Average" | nullrequired

item.estimatedAgeYearsnumber | nullrequired

item.source"ai" | "manual"required

ai: identified from a photo; manual: entered or imported.

item.priceSourcestring | nullrequired

Where the price came from (retailer name).

item.priceSourceUrlstring | nullrequired

item.notesstring | nullrequired

item.photoIdsstring[]required

pho_ ids the item appears in, primary photo first.

item.valuationobjectrequired

item.valuation.subtotalCentsintegerrequired

Quantity x unit cost, before tax.

item.valuation.taxCentsintegerrequired

Sales tax at the claim's salesTaxBp.

item.valuation.rcvCentsintegerrequired

Replacement cost value: subtotal plus tax.

item.valuation.depreciationBpintegerrequired

Depreciation rate applied, in basis points (2500 = 25%).

item.valuation.depreciationCentsintegerrequired

item.valuation.acvCentsintegerrequired

Actual cash value: RCV less depreciation.

item.valuation.paymentCentsintegerrequired

What the claim pays for the line after any payment cap.

item.createdAtstring (date-time)required

item.updatedAtstring (date-time)required

pricedbooleanrequired

True when the link gave a price and it is now the item's unit cost. False: no price was found; an item that had a price is unchanged, and an unpriced item gets the page's store and link.

priceMethod"page" | "search" | nullrequired

page: read from the product page. search: the page could not be read, so the price is the same store's listing for the same product in shopping search; check it against the page. null when no price was found.

approvedbooleanrequired

True when the item is approved after this call.

approveSkipped"unpriced" | "not_approvable" | "price_via_search"

Only when approve was sent and the item was not approved: unpriced (the link gave no price), price_via_search (the price came from shopping search: check it against the page, then approve with approve_items), not_approvable (the item cannot be approved in its current state).

idstringrequired

itm_ id.

object"item"required

claimIdstringrequired

clm_ id.

roomIdstring | nullrequired

rom_ id, or null when the item is not filed in a room.

roomNamestring | nullrequired

namestringrequired

The line as the app shows it: the retailer title when chosen, else the description.

descriptionstringrequired

What the item is, as identified or typed; name differs when a retailer title was chosen.

retailerDescriptionstring | nullrequired

modelstring | nullrequired

categorystring | nullrequired

quantityintegerrequired

unitCostCentsinteger | nullrequired

Null until the item is priced.

pricedbooleanrequired

True once the item has a unit cost. An unpriced item cannot be approved: set unitCostCents or accept a replacement first.

status"pending" | "low_confidence" | "reviewing" | "approved" | "rejected"required

pending and low_confidence await review; reviewing is being priced (the item is locked: edits and approval are refused until it finishes); approved items count toward totals and exports; rejected items are left out of both.

needsReviewbooleanrequired

True while the item waits on a person: status pending or low_confidence.

condition"New" | "Above Average" | "Average" | "Below Average" | nullrequired

estimatedAgeYearsnumber | nullrequired

source"ai" | "manual"required

ai: identified from a photo; manual: entered or imported.

priceSourcestring | nullrequired

Where the price came from (retailer name).

priceSourceUrlstring | nullrequired

notesstring | nullrequired

photoIdsstring[]required

pho_ ids the item appears in, primary photo first.

valuationobjectrequired

valuation.subtotalCentsintegerrequired

Quantity x unit cost, before tax.

valuation.taxCentsintegerrequired

Sales tax at the claim's salesTaxBp.

valuation.rcvCentsintegerrequired

Replacement cost value: subtotal plus tax.

valuation.depreciationBpintegerrequired

Depreciation rate applied, in basis points (2500 = 25%).

valuation.depreciationCentsintegerrequired

valuation.acvCentsintegerrequired

Actual cash value: RCV less depreciation.

valuation.paymentCentsintegerrequired

What the claim pays for the line after any payment cap.

createdAtstring (date-time)required

updatedAtstring (date-time)required

idstringrequired

exp_ id.

object"export"required

claimIdstringrequired

format"pdf" | "xlsx" | "photo_zip"required

status"queued" | "processing" | "completed" | "failed" | "expired" | "cancelled"required

progressintegerrequired

0-100.

filenamestring | nullrequired

fileSizeBytesinteger | nullrequired

errorobject | nullrequired

error.codestringrequired

error.messagestringrequired

downloadsobject[]required

Empty until the export completes. A large photo ZIP comes in several parts.

downloads[].urlstringrequired

Presigned storage URL; GET it before expiresAt.

downloads[].filenamestringrequired

downloads[].bytesinteger | nullrequired

downloads[].expiresAtstring (date-time)required

createdAtstring (date-time)required

completedAtstring (date-time) | nullrequired

expiresAtstring (date-time) | nullrequired

When the finished file is deleted; export again after that.

idstringrequired

exp_ id.

object"export"required

claimIdstringrequired

format"pdf" | "xlsx" | "photo_zip"required

status"queued" | "processing" | "completed" | "failed" | "expired" | "cancelled"required

progressintegerrequired

0-100.

filenamestring | nullrequired

fileSizeBytesinteger | nullrequired

errorobject | nullrequired

error.codestringrequired

error.messagestringrequired

downloadsobject[]required

Empty until the export completes. A large photo ZIP comes in several parts.

downloads[].urlstringrequired

Presigned storage URL; GET it before expiresAt.

downloads[].filenamestringrequired

downloads[].bytesinteger | nullrequired

downloads[].expiresAtstring (date-time)required

createdAtstring (date-time)required

completedAtstring (date-time) | nullrequired

expiresAtstring (date-time) | nullrequired

When the finished file is deleted; export again after that.

idstringrequired

whe_ id.

object"webhook_endpoint"required

urlstringrequired

descriptionstring | nullrequired

events"claim.created" | "photos.analysis_completed" | "items.priced" | "inventory.approved" | "export.ready"[]required

mode"live" | "test"required

Receives only events of this mode (the mode of the key that registered it).

status"enabled" | "disabled"required

disabledReason"failing" | nullrequired

failing: every delivery failed for three days. Register the URL again to resume.

lastSuccessAtstring (date-time) | nullrequired

createdAtstring (date-time)required

object"list"required

dataobject[]required

data[].idstringrequired

whe_ id.

data[].object"webhook_endpoint"required

data[].urlstringrequired

data[].descriptionstring | nullrequired

data[].events"claim.created" | "photos.analysis_completed" | "items.priced" | "inventory.approved" | "export.ready"[]required

data[].mode"live" | "test"required

Receives only events of this mode (the mode of the key that registered it).

data[].status"enabled" | "disabled"required

data[].disabledReason"failing" | nullrequired

failing: every delivery failed for three days. Register the URL again to resume.

data[].lastSuccessAtstring (date-time) | nullrequired

data[].createdAtstring (date-time)required

hasMorebooleanrequired

nextCursorstring | nullrequired

Pass as cursor for the next page; null on the last page.

idstringrequired

whe_ id.

object"webhook_endpoint"required

urlstringrequired

descriptionstring | nullrequired

events"claim.created" | "photos.analysis_completed" | "items.priced" | "inventory.approved" | "export.ready"[]required

mode"live" | "test"required

Receives only events of this mode (the mode of the key that registered it).

status"enabled" | "disabled"required

disabledReason"failing" | nullrequired

failing: every delivery failed for three days. Register the URL again to resume.

lastSuccessAtstring (date-time) | nullrequired

createdAtstring (date-time)required

secretstringrequired

whsec_ signing secret. Shown only in this response: store it now.

object"list"required

dataobject[]required

data[].idstringrequired

whd_ id.

data[].object"webhook_delivery"required

data[].endpointIdstringrequired

whe_ id.

data[].eventIdstringrequired

evt_ id; also the id in the event body.

data[].eventTypestringrequired

data[].status"pending" | "sending" | "succeeded" | "failed"required

data[].attemptsintegerrequired

data[].responseCodeinteger | nullrequired

data[].responseSnippetstring | nullrequired

First 1 KB of your endpoint's last response.

data[].errorstring | nullrequired

data[].nextAttemptAtstring (date-time) | nullrequired

data[].lastAttemptAtstring (date-time) | nullrequired

data[].deliveredAtstring (date-time) | nullrequired

data[].createdAtstring (date-time)required

hasMorebooleanrequired

nextCursorstring | nullrequired

Pass as cursor for the next page; null on the last page.

idstringrequired

whd_ id.

object"webhook_delivery"required

endpointIdstringrequired

whe_ id.

eventIdstringrequired

evt_ id; also the id in the event body.

eventTypestringrequired

status"pending" | "sending" | "succeeded" | "failed"required

attemptsintegerrequired

responseCodeinteger | nullrequired

responseSnippetstring | nullrequired

First 1 KB of your endpoint's last response.

errorstring | nullrequired

nextAttemptAtstring (date-time) | nullrequired

lastAttemptAtstring (date-time) | nullrequired

deliveredAtstring (date-time) | nullrequired

createdAtstring (date-time)required

idstringrequired

whd_ id.

object"webhook_delivery"required

endpointIdstringrequired

whe_ id.

eventIdstringrequired

evt_ id; also the id in the event body.

eventTypestringrequired

status"pending" | "sending" | "succeeded" | "failed"required

attemptsintegerrequired

responseCodeinteger | nullrequired

responseSnippetstring | nullrequired

First 1 KB of your endpoint's last response.

errorstring | nullrequired

nextAttemptAtstring (date-time) | nullrequired

lastAttemptAtstring (date-time) | nullrequired

deliveredAtstring (date-time) | nullrequired

createdAtstring (date-time)required

object"me"required

organizationobjectrequired

organization.idstringrequired

org_ id.

organization.namestringrequired

mode"live" | "test"required

credentialobjectrequired

credential.type"api_key" | "oauth"required

credential.namestringrequired

The API key name, or the OAuth app name.

credential.prefixstringrequired

First characters of the key, as Settings shows it; "cto_" for an OAuth token.

credential.scopes"claims:read" | "claims:write" | "photos:read" | "photos:write" | "items:read" | "exports:write" | "webhooks:manage" | "items:write"[]required

credential.createdAtstring (date-time)required

credential.lastUsedAtstring (date-time) | nullrequired

credential.expiresAtstring (date-time) | nullrequired

openapistringrequired