pay-holds

ark.list_pay_holds

Lists visible active or resolved pay holds and claims with load, customer, value, note, and creator context.

Availability: Expanded preview
Scopes: loads:readbilling:read
ARK permissions: canViewLoadsone of: canViewBillingone of: canViewPayHoldsReportone of: canEditLoadone of: canMakeAdjustments
Team visibility: Required and enforced
Idempotency-Key: Not required
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

statusquerystring: one of: active, resolved, all; default: "active"
claim_typequerystring: one of: claim, hold, all; default: "all"
value_fromquerynumber: min: 0
value_toquerynumber: min: 0
load_number_fromquerynumber: min: 0
load_number_toquerynumber: min: 0
created_byquerystring: format: uuid
currencyquerystring: one of: USD, CAD, MXN
searchquerystring: Search across load number, customer, notes, pickup number, PO, BOL, creator name, and creator email.; min length: 1; max length: 100
limitqueryinteger: default: 25; min: 1; max: 100
offsetqueryinteger: default: 0; min: 0

None.

Shell

curl 'https://arktms.com/api/v1/billing/pay-holds' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Pay holds

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.payHoldsarray<object>required

data.paginationobjectrequired