Contract
- shape
- collection
- authority
- read
- evidence
- none
- subscription
- false
- permission
- any one of: staff.read (the staff role staff_read held in the Internal org, tradehq_role.staff_role); account.owner (account role owner or higher in the account of the org `org_id`); org.admin (carried by the caller's role template in the org `org_id`); a deactivated caller is refused first
- idempotency
- safe
- emits
- none
- MCP tool
- list_audit_exports
- REST
- POST https://api.containertradehq.com/v1/cap/list_audit_exports
Idempotency: a read: calling again changes nothing
Inputs
| name | type | required | validation |
|---|---|---|---|
| org_id | org_id | required | tradehq-org-id; 1 to 20 characters The org whose exports are listed. |
| export_id | text | optional | 1 to 20 characters Only this export, as export_audit_events answered it. |
| limit | integer | optional | 1 to 50; default 10 The page size. |
| after | text | optional | 1 to 20 characters The previous page's next_after. |
Paginated: next next_after · page_max 50 · walk_max 1000 · ceiling declared
Response
items· object[]next_after· stringnull · Pass as `after` for the next page; null on the last one.
Full JSON Schema
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"export_id": {
"type": "string",
"description": "The export.",
"x-data-class": "operational"
},
"requested_at": {
"type": "string",
"format": "date-time",
"description": "When it was asked for.",
"x-data-class": "operational"
},
"requested_by": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"pattern": "^[A-Za-z0-9_-]{1,20}$",
"format": "tradehq-user-id",
"description": "Who asked for it.",
"x-data-class": "operational"
},
"status": {
"type": "string",
"enum": [
"running",
"ready",
"failed"
],
"description": "running while it is built; ready once both files are written; failed when they could not be.",
"x-data-class": "operational"
},
"filters": {
"type": "object",
"description": "The filters it was asked with, by list_audit_events' input names.",
"x-data-class": "operational"
},
"row_count": {
"type": [
"integer",
"null"
],
"description": "How many events the files hold, once ready.",
"x-data-class": "operational"
},
"finished_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When it landed or failed.",
"x-data-class": "operational"
},
"expires_at": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When its links stop working: 24 hours after it finished, fixed.",
"x-data-class": "operational"
},
"failure": {
"type": [
"string",
"null"
],
"description": "Why a failed export failed.",
"x-data-class": "operational"
},
"links": {
"type": [
"object",
"null"
],
"description": "{csv, json}: a signed download link for each file, while a ready export's links last; null otherwise.",
"x-data-class": "operational"
}
},
"required": [
"export_id",
"requested_at",
"requested_by",
"status",
"filters",
"row_count",
"finished_at",
"expires_at",
"failure",
"links"
],
"additionalProperties": false
},
"maxItems": 50
},
"next_after": {
"type": [
"string",
"null"
],
"description": "Pass as `after` for the next page; null on the last one."
}
},
"required": [
"items",
"next_after"
],
"additionalProperties": false
} Refusals
The platform refusals apply to every call: version, authentication, authority, validation and rate limits, each in the same envelope.
Surfaces
- Voice: degraded: visualization
- Push: emits nothing
- OneBox: no document originates an audit export
- Outbound: crosses to no counterparty
Events
None emitted.
Related
list_accounts, list_agent_reads, list_audit_events, list_orgs, list_unit_access, list_users