API documentation | API docs for agents | OpenAPI 3.1
GET /api/v1/load-board/postings/preview
ark.get_load_board_posting_preview
Returns DAT or Sylectus posting defaults and validation context before a load-board post or update action.
- Availability
- Expanded 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
source_idquerystringrequired- Load ID, or spot-load ID when source_type is spot_load.
- format: uuid
providerquerystring- one of: dat, sylectus; default: "dat"
source_typequerystring- one of: load, spot_load; default: "load"
modequerystring- one of: draft, update; default: "draft"
Request body
None.
Example request
Shell
curl 'https://arktms.com/api/v1/load-board/postings/preview?source_id=<source_id>' \
-H "Authorization: Bearer $ARK_API_TOKEN"Success response
Load board posting preview
objectstringrequiredokbooleanrequiredapi_versionstringrequiredrequest_idstringrequireddataobjectrequireddata.sourceIdstringrequiredformat: uuid
data.sourceTypestringrequiredone of: load, spot_load
data.providerstringrequiredone of: dat, sylectus
data.modestringrequiredone of: draft, update
data.previewobjectrequiredErrors
HTTP 400- Invalid request
HTTP 401- Authentication required
HTTP 403- Permission, scope, team, or entitlement denied
HTTP 404- Resource not found