List exports

GET

https://api.runledger.co/v1/exports

GET

/v1/exports

curl https://api.runledger.co/v1/exports \
     -H "Authorization: Bearer <api_key>"

{
  "object": "string",
  "data": [
    {
      "id": "exp_4wE7rT0yUp",
      "object": "string",
      "type": "balances",
      "format": "csv",
      "status": "pending",
      "livemode": true,
      "created_at": "2024-01-15T09:30:00Z",
      "source": "api",
      "row_count": 1,
      "download_url": "string",
      "download_expires_at": "2024-01-15T09:30:00Z",
      "error": {
        "type": "https://docs.runledger.co/reference/idempotency-and-errors#error-codes",
        "title": "Insufficient balance",
        "status": 402,
        "code": "invalid_request",
        "request_id": "req_7Hc2Lq0vTz8d",
        "retryable": true,
        "detail": "The hold needs 400 ai_credits but 120 are available.",
        "param": "events.3.timestamp",
        "required_scope": "config:write",
        "errors": [
          {
            "code": "confirmation_window_short",
            "message": "The charge confirms almost at once, so only the reversal horizon protects you.",
            "path": "outcome_definitions.0.confirmation_window"
          }
        ],
        "blocked_by": [
          {
            "object": "routing_rule",
            "id": "rr_3vT8nK2xWa"
          }
        ],
        "doc_url": "https://docs.runledger.co/reference/idempotency-and-errors#error-codes"
      },
      "completed_at": "2024-01-15T09:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Every export in this environment, newest first, however it was created: in the dashboard, with POST /v1/exports, or by an agent. Each carries its status, and source (dashboard, api or agent) says how it was created. A ready export’s download_url is left out of the list: retrieve the export with GET /v1/exports/{export_id} for a fresh one.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Query parameters

limitintegerOptional1-100Defaults to 20

Maximum number of objects to return, from 1 to 100.

cursorstringOptional

The next_cursor from the previous page.

Response

A page of exports.

object"list"

datalist of objects

has_moreboolean

next_cursorstringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error