API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/edi/connections

ark.list_edi_partner_connections

Lists broker-admin EDI partner connection requests, active assignments, routing identifiers, and shipper-to-customer mappings.

Availability: Expanded preview
Scopes: edi:read
ARK permissions: canAdminEdi
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

include_requestsqueryboolean: default: true
include_connectionsqueryboolean: default: true

Request body

None.

Example request

Shell

curl 'https://arktms.com/api/v1/edi/connections' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Success response

EDI partner connections

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.requestsarray<object>required

data.connectionsarray<object>required

data.countsobjectrequired

Errors

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