Autocomplete

Returns all accounts of the user returned in a basic auto-complete array.

GET

https://firefly.example.com/api/v1/autocomplete/accounts

curl -X GET 'https://firefly.example.com/api/v1/autocomplete/accounts?query=string&limit=10&date=2026-10-01' \
  -H 'X-Trace-Id: 40c71bbb-c676-4f24-83cf-cc725d7d7a00' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://firefly.example.com/api/v1/autocomplete/accounts?query=string&limit=10&date=2026-10-01', {
  method: 'GET',
  headers: {
    'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://firefly.example.com/api/v1/autocomplete/accounts?query=string&limit=10&date=2026-10-01',
    headers={
        'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

[
  {
    "id": "2",
    "name": "Checking Account",
    "name_with_balance": "Checking Account ($123.45)",
    "active": true,
    "type": "Asset account",
    "currency_id": "12",
    "currency_name": "Euro",
    "currency_code": "EUR",
    "currency_symbol": "$",
    "currency_decimal_places": 2,
    "account_currency_id": "2",
    "account_currency_name": "US Dollar",
    "account_currency_code": "USD",
    "account_currency_symbol": "$",
    "account_currency_decimal_places": 2
  }
]

{
  "message": "Bad Request",
  "exception": "BadRequestHttpException"
}

{
  "message": "Unauthenticated",
  "exception": "AuthenticationException"
}

{
  "message": "Resource not found",
  "exception": "NotFoundHttpException"
}

{
  "message": "The given data was invalid.",
  "errors": {
    "email": [
      "string"
    ],
    "force": [
      "string"
    ],
    "blocked": [
      "string"
    ],
    "field": [
      "string"
    ],
    "role": [
      "string"
    ],
    "blocked_code": [
      "string"
    ],
    "name": [
      "string"
    ],
    "type": [
      "string"
    ],
    "iban": [
      "string"
    ],
    "start": [
      "string"
    ],
    "end": [
      "string"
    ],
    "date": [
      "string"
    ]
  }
}

{
  "message": "Internal Exception",
  "exception": "InternalException"
}

Parameters

querystringquery

The autocomplete search query.

limitinteger<int32>query

The number of items returned.

datestringquery

If the account is an asset account or a liability, the autocomplete will also return the balance of the account on this date in the AC title.

typesArray<AccountTypeFilter>allassetcashexpenserevenuespecialhiddenliabilityliabilitiesDefault accountCash accountAsset accountExpense accountRevenue accountInitial balance accountBeneficiary accountImport accountReconciliation accountLoanDebtMortgagequery

Optional filter on the account type(s) used in the autocomplete.

Response

200OKArray<AutocompleteAccount>

A list of accounts with very basic information.

Response fields application/json

Array<AutocompleteAccount>

Show child attributes

idstringrequired

Example

namestringrequired

Name of the account found by an auto-complete search.

Example

Checking Account

name_with_balancestringrequired

Asset accounts and liabilities have a second field with the given date's account balance in the account currency or primary currency.

Example

Checking Account ($123.45)

activebooleanrequired

Is the account active or not?

Example

true

typestringrequired

Account type of the account found by the auto-complete search.

Example

Asset account

currency_idstringrequired

ID for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead.

Example

currency_namestringrequired

Currency name for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead.

Example

Euro

currency_codestringrequired

Currency code for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead.

Example

EUR

currency_symbolstringrequired

Currency symbol for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead.

Example

currency_decimal_placesinteger<int32>required

Number of decimal places for the currency used by this account. If the user prefers amounts converted to their primary currency, this primary currency is used instead.

Example

account_currency_idstringrequired

ID for the currency used by this account. Even if "convertToPrimary" is on, the account currency ID is displayed here.

Example

account_currency_namestringrequired

Name for the currency used by this account. Even if "convertToPrimary" is on, the account currency name is displayed here.

Example

US Dollar

account_currency_codestringrequired

Code for the currency used by this account. Even if "convertToPrimary" is on, the account currency code is displayed here.

Example

USD

account_currency_symbolstringrequired

Code for the currency used by this account. Even if "convertToPrimary" is on, the account currency code is displayed here.

Example

account_currency_decimal_placesinteger<int32>required

Number of decimal places for the currency used by this account. Even if "convertToPrimary" is on, the account currency code is displayed here.

Example

400Bad RequestBadRequestResponse

Bad request

Response fields application/json

messagestring

Example

Bad Request

exceptionstring

Example

BadRequestHttpException

401UnauthorizedUnauthenticatedResponse

Unauthenticated

Response fields application/json

messagestring

Example

Unauthenticated

exceptionstring

Example

AuthenticationException

404Not FoundNotFoundResponse

Page not found

Response fields application/json

messagestring

Example

Resource not found

exceptionstring

Example

NotFoundHttpException

422Unprocessable EntityValidationErrorResponse

Validation error. The body will have the exact details.

Response fields application/json

messagestring

Example

The given data was invalid.

errorsobject

Show child attributes

emailArray<string>

forceArray<string>

blockedArray<string>

fieldArray<string>

roleArray<string>

blocked_codeArray<string>

nameArray<string>

typeArray<string>

ibanArray<string>

startArray<string>

endArray<string>

dateArray<string>

500Internal Server ErrorInternalExceptionResponse

Internal exception

Response fields application/json

messagestring

Example

Internal Exception

exceptionstring

Example

InternalException

Authorization

firefly_iii_authoauth2

OAuth2 authorization code flow. Create a client on your installation's /profile page; it authorizes at /oauth/authorize and issues tokens at /oauth/token there. The URLs below are the demo site's. How to use the API walks through it.

local_bearer_authhttp (bearer)

A Personal Access Token, sent as a bearer token. Create one on your installation under Options > Profile > OAuth > Personal Access Tokens.