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>'

import requests

url = "https://app.sure.am/api/v1/imports"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://app.sure.am/api/v1/imports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sure.am/api/v1/imports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sure.am/api/v1/imports"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.sure.am/api/v1/imports")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sure.am/api/v1/imports")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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