Query parameters

• page number

  Default value is 1.

• perPage number

  Default value is 10.

• skip number

  If skip/limit not provided, page/perPage will take precedence

• limit number

  If skip/limit not provided, page/perPage will take precedence

• caseId string Required

  Case ID this financial data belongs to.

• plaidItemId string

  Internal PlaidItem document ID. Optional for extraction code users — resolved automatically from caseId.

• financialAccountId string Required

  Internal FinancialAccount document ID.

• category string

  Filter by transaction category (categoryPrimary). Case-insensitive partial match.

• subcategory string

  Filter by transaction subcategory (Plaid categoryDetailed). Case-insensitive partial match. Only matches transactions whose primary category has not been overridden.

• name string

  Filter by transaction name. Case-insensitive partial match.

• merchant string

  Filter to a single merchant. Exact match on merchantName, as returned by the transaction list. Transactions with no merchant name never match.

• startDate string

  Filter transactions from this date (inclusive). Format: YYYY-MM-DD.

• endDate string

  Filter transactions up to this date (inclusive). Format: YYYY-MM-DD.

• minAmount number

  Filter transactions with amount >= minAmount.

• maxAmount number

  Filter transactions with amount <= maxAmount (absolute value).

• transactionType string

  Filter by transaction type. debit = money out (positive in Plaid), credit = money in (negative in Plaid).

  Values are debit or credit.

• sortBy string

  Field to sort by.

  Values are date, amount, or category. Default value is date.

• sortOrder string

  Sort direction.

  Values are asc or desc. Default value is desc.

• tagIds array[string]

  Filter transactions that have all of the provided tag IDs.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • data object Required
    Hide data attributes Show data attributes object

    • total number Required
    • page number
    • perPage number
    • skip number
    • limit number
    • totalPages number Required
    • nextPage number | null Required
    • previousPage number | null Required
    • data array[object]
      Hide data attributes Show data attributes object

      • id string Required
      • plaidItemId string Required
      • plaidTransactionId string Required
      • amount number Required

        Absolute value of the transaction amount.

      • transactionType string Required

        debit = money out, credit = money in.

        Values are debit or credit.

      • authorizedDate string(date-time) | null
      • detailed string | null
      • category string | null

        Effective category: the user override when set, otherwise Plaid’s primary category.

      • categoryOverridden boolean Required

        True when category comes from a user override rather than Plaid.

      • createdAt string(date-time) Required
      • transactionDate string(date-time) Required
      • financialAccount string Required
      • currency string | null
      • merchantName string | null
      • name string Required
      • paymentChannel string Required
      • pending boolean Required
      • pendingTransactionId string | null
      • plaidAccountId string Required
      • transactionCode string | null
      • unofficialCurrencyCode string | null
      • updatedAt string(date-time) Required
      • isRecurring boolean Required

        True if this transaction belongs to a recurring stream.

      • tags array[object]
        Hide tags attributes Show tags attributes object

        • id string Required
        • name string Required
      • attachedTags array[object]
        Hide attachedTags attributes Show attachedTags attributes object

        • tagId string Required

          Tag id (Tag._id)

        • tag string Required

          Tag display name (Tag.name)

        • addedBy string Required

          Values are user, ai, auto, auto-import, system, or default.

        • addedById string | null
        • removedAt string(date-time) | null
        • removedBy string | null

          Values are user, ai, auto, auto-import, system, or default.

        • removedById string | null
  • statusCode number Required
  • timestamp string(date-time) Required