API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/integrations/{provider}/settings

ark.get_integration_settings

Returns safe non-secret organization integration settings, active state, and credential presence for a provider setup panel.

Availability
Expanded preview
Scopes
admin: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

providerpathstringrequired
Integration provider.
one of: ark_tracking, dat, highway, macropoint, mycarrierportal, rmis, sylectus, truckertools

Request body

None.

Example request

Shell
curl 'https://arktms.com/api/v1/integrations/<provider>/settings' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

Integration settings

objectstringrequired
okbooleanrequired
api_versionstringrequired
request_idstringrequired
dataobjectrequired
data.providerstringrequired

one of: ark_tracking, dat, highway, macropoint, mycarrierportal, rmis, sylectus, truckertools

data.activebooleanrequired
data.configuredbooleanrequired

Errors

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