FIfirefly-iii
search

Count transactions matching the given filters.

Changed on

Returns the number of transactions that match the given meta-field filters. This is useful to check for existing transactions (for example to avoid duplicates) before storing new data.

get/v1/search/transactions/count

Request

  • Base URL
    https://demo.firefly-iii.org/api
  • URL
    https://demo.firefly-iii.org/api/v1/search/transactions/count
  • Auth
    • OAuth 2
      Authorization code: https://demo.firefly-iii.org/oauth/authorize
      Token URL: https://demo.firefly-iii.org/oauth/token
    • or HTTP bearer

Query parameters

external_identifierstring
Example:abcd-1234

Count transactions with this exact external identifier.

internal_referencestring
Example:INV-998

Count transactions with this exact internal reference.

notesstring
Example:groceries

Count transactions whose notes contain this string.

descriptionstring
Example:Monthly rent

Count transactions with this exact description.

include_deletedboolean

Whether to include soft-deleted transactions in the count.

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Response

The number of matching transactions.

countinteger

Example response

{
  "count": 42
}

Changes