List imports

List all imports for the user’s family with pagination and filtering.

GET /api/v1/imports

List imports

cURL

curl --request GET \
  --url https://app.sure.am/api/v1/imports \
  --header 'X-Api-Key: <api-key>'

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "TransactionImport",
      "status": "pending",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rows_count": 1,
      "error": "<string>"
    }
  ],
  "meta": {
    "current_page": 2,
    "total_pages": 1,
    "total_count": 1,
    "per_page": 2,
    "next_page": 123,
    "prev_page": 123
  }
}

Authorizations

X-Api-Key · string · header · required

API key for authentication. Generate one from your account settings.

Query Parameters

page · integer

Page number (default: 1)

per_page · integer

Items per page (default: 25, max: 100)

status · enum<string>

Filter by status

Available options: pending, complete, importing, reverting, revert_failed, failed

type · enum<string>

Filter by import type

Available options: TransactionImport, TradeImport, AccountImport, MintImport, CategoryImport, RuleImport, PdfImport, QifImport, SureImport

Response

200 - application/json

imports filtered by type

data · object[] · required

Show child attributes

meta · object · required

Show child attributes