API documentation | API docs for agents | OpenAPI 3.1
GET /api/v1/carriers/{carrierId}/files
ark.list_carrier_files
Lists files and compliance documents attached to a visible carrier.
- Availability
- Expanded preview
- Scopes
carriers:read- ARK permissions
canViewCarriers- 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
carrierIdpathstringrequired- Visible ARK carrier ID.
- format: uuid
typequerystring- Optional carrier document type filter, such as W9, Insurance, Authority, Contract, or Other.
limitqueryinteger- default: 50; min: 1; max: 100
cursorquerystring
Request body
None.
Example request
Shell
curl 'https://arktms.com/api/v1/carriers/<carrierId>/files' \
-H "Authorization: Bearer $ARK_API_TOKEN"Success response
OK
objectstringrequiredokbooleanrequiredapi_versionstringrequiredrequest_idstringrequireddataobjectrequireddata.carrierIdstringrequiredformat: uuid
data.carrierobjectrequireddata.itemsarray<object>requireddata.paginationobjectrequiredErrors
HTTP 400- Invalid request
HTTP 401- Authentication required
HTTP 403- Permission, scope, team, or entitlement denied
HTTP 404- Resource not found