API documentation | API docs for agents | OpenAPI 3.1

GET /api/v1/carrier-invites

ark.list_carrier_invites

Lists carrier onboarding invites for the organization with status, DOT, email, expiration, submission, and linked-carrier state.

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

statusqueryCarrierInviteStatusFilter
queryquerystring: min length: 1; max length: 100
limitqueryinteger: default: 25; min: 1; max: 100
offsetqueryinteger: default: 0; min: 0

Request body

None.

Example request

Shell

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

Success response

Carrier invites

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.invitesarray<object>required

data.paginationobjectrequired

Errors

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