API documentation | API docs for agents | OpenAPI 3.1
GET /api/v1/loads/{loadId}/dispatches/{dispatchId}/notes
ark.list_dispatch_notes
Lists broker-entered notes for a visible load dispatch with creator context and newest-first pagination.
- Availability
- Core preview
- Scopes
loads:read- ARK permissions
canViewLoads- 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
loadIdpathstringrequired- format: uuid
dispatchIdpathstringrequired- format: uuid
limitqueryinteger- default: 50; min: 1; max: 100
cursorquerystring- Opaque cursor returned by the previous page. Prefer this over before_created_at.
before_created_atquerystring- format: date-time
Request body
None.
Example request
Shell
curl 'https://arktms.com/api/v1/loads/<loadId>/dispatches/<dispatchId>/notes' \
-H "Authorization: Bearer $ARK_API_TOKEN"Success response
Dispatch notes
objectstringrequiredokbooleanrequiredapi_versionstringrequiredrequest_idstringrequireddataobjectrequireddata.loadIdstringrequiredformat: uuid
data.dispatchIdstringrequiredformat: uuid
data.itemsarray<object>requireddata.paginationobjectrequiredErrors
HTTP 400- Invalid request
HTTP 401- Authentication required
HTTP 403- Permission, scope, team, or entitlement denied
HTTP 404- Resource not found