Skip to main content
GET
/
api
/
v1
/
transactions
List transactions
curl --request GET \
  --url https://app.sure.am/api/v1/transactions \
  --header 'Authorization: <authorization>'
{
  "transactions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "date": "2023-12-25",
      "amount": "<string>",
      "currency": "<string>",
      "name": "<string>",
      "classification": "<string>",
      "account": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "account_type": "<string>"
      },
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "color": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "notes": "<string>",
      "category": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "classification": "<string>",
        "color": "<string>",
        "icon": "<string>"
      },
      "merchant": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "transfer": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": "<string>",
        "currency": "<string>",
        "other_account": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "account_type": "<string>"
        }
      }
    }
  ],
  "pagination": {
    "page": 2,
    "per_page": 2,
    "total_count": 1,
    "total_pages": 1
  }
}

Headers

Authorization
string
required

Bearer token with read scope

Query Parameters

page
integer

Page number (default: 1)

per_page
integer

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

account_id
string

Filter by account ID

category_id
string

Filter by category ID

merchant_id
string

Filter by merchant ID

start_date
string<date>

Filter transactions from this date

end_date
string<date>

Filter transactions until this date

min_amount
number

Filter by minimum amount

max_amount
number

Filter by maximum amount

type
enum<string>

Filter by transaction type

Available options:
income,
expense

Search by name, notes, or merchant name

account_ids
string[]

Filter by multiple account IDs

category_ids
string[]

Filter by multiple category IDs

merchant_ids
string[]

Filter by multiple merchant IDs

tag_ids
string[]

Filter by tag IDs

Response

200 - application/json

transactions filtered by date range

transactions
object[]
required
pagination
object
required