ARK TMS

MCP documentation | MCP docs for agents

ark_list_pay_holds

ark.list_pay_holds

List visible active or resolved ARK 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
Approval policy
none
ARK approval request
Not required
Idempotency
Not required
Read-only
Yes
Destructive
No
External side effect
No
Rate limit
OAuth MCP credential and organization budgets

Input

statusstring

Optional pay hold status filter.

one of: active, resolved, all; default: "active"

claimTypestring

Optional claim vs hold filter.

one of: claim, hold, all; default: "all"

valueFromnumber

min: 0

valueTonumber

min: 0

loadNumberFromnumber

min: 0

loadNumberTonumber

min: 0

createdBystring

Optional creator user ID filter.

format: uuid

currencystring

Optional carrier currency filter.

one of: USD, CAD, MXN

searchstring

Optional search across load number, customer, notes, pickup number, PO, BOL, creator name, and creator email.

min length: 1; max length: 100

limitinteger

default: 25; min: 1; max: 100

offsetinteger

default: 0; min: 0

Result

The tool returns the canonical ark.list_pay_holds operation result in structuredContent and mirrors the same JSON as text. Errors set isError: true and return a stable error code, message, and optional details.