API documentation | API docs for agents | OpenAPI 3.1

search

ark.search

Searches across available loads, customers, carriers, locations, users, and docs with one query. Each domain is filtered by the connected actor’s scopes, permissions, and team visibility.

Availability: Core preview
Scopes: context:read
ARK permissions: None
Team visibility: Not entity-scoped
Idempotency-Key: Not required
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

qquerystringrequired: min length: 2; max length: 100
domainsquerystring: Comma-separated domain filters: loads, customers, carriers, locations, users, docs.
limit_per_domainqueryinteger: default: 5; min: 1; max: 10

Request body

None.

Example request

Shell

curl 'https://arktms.com/api/v1/search?q=<q>' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

Cross-entity search results

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.querystringrequired

data.resultsarray<object>required

Errors

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