API documentation | API docs for agents | OpenAPI 3.1

availability

ark.check_tracking_availability

Checks whether internal ARK Tracking can start for a visible dispatch and explains consent, app-account, phone, active-dispatch, or org-setting blockers.

Availability: Expanded preview
Scopes: loads:dispatch
ARK permissions: canAssignLoads
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

dispatch_idquerystringrequired: format: uuid

Request body

None.

Example request

Shell

curl 'https://arktms.com/api/v1/tracking/internal/availability?dispatch_id=<dispatch_id>' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

Tracking availability

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.providerstringrequired

one of: internal

data.dispatchIdstringrequired

format: uuid

data.loadIdstringrequired

format: uuid

data.availablebooleanrequired

data.reasonstring | nullrequired

data.driverNamestring | nullrequired

data.requiresConsentbooleanrequired

data.driverHasAppAccountbooleanrequired

data.missingPhonebooleanrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found