> ## Documentation Index
> Fetch the complete documentation index at: https://docs.equated.co/llms.txt
> Use this file to discover all available pages before exploring further.

# List transactions

> Returns bank-feed transactions for the organization, newest first. Transactions represent movements in connected bank and credit card accounts; each has a set of postings (ledger lines) that categorize the money.

Key filter parameters:
- `accountIds` — filter by **financial account** (bank feed source, e.g. checking account), not a ledger/chart-of-accounts entry. Get valid IDs from `GET /api/bank-accounts`.
- `categoryAccountIds` — filter by the **ledger account** assigned to the transaction's postings (e.g. show all transactions categorized to "Software & SaaS").
- `postingStatuses` — comma-separated: `UNSTAGED` (raw, uncategorized), `DRAFT` (in inbox, pending review), `POSTED` (confirmed). Omit to return all statuses.
- `amountDirection` — `in` for money received into the account, `out` for money spent.
- `from` / `to` — filter by transaction date (YYYY-MM-DD).
- `orgMerchantIds` — filter by assigned vendor/customer merchant.
- `feedScope` — `bank` drops payment-processor balances (Square, Etsy) from the results; `all` (the default) keeps them, and an account named in `accountIds` shows under either scope.



## OpenAPI

````yaml /openapi.json get /api/transactions
openapi: 3.1.0
info:
  title: Equated API
  version: 1.0.0
  description: >-
    Agent-facing accounting API. Authenticate with a bearer token issued from
    Settings → API Tokens, or via the in-app session cookie when called from the
    web client.
servers:
  - url: https://app.equated.co
    description: API server
security: []
paths:
  /api/transactions:
    get:
      tags:
        - Transactions
      summary: List transactions
      description: >-
        Returns bank-feed transactions for the organization, newest first.
        Transactions represent movements in connected bank and credit card
        accounts; each has a set of postings (ledger lines) that categorize the
        money.


        Key filter parameters:

        - `accountIds` — filter by **financial account** (bank feed source, e.g.
        checking account), not a ledger/chart-of-accounts entry. Get valid IDs
        from `GET /api/bank-accounts`.

        - `categoryAccountIds` — filter by the **ledger account** assigned to
        the transaction's postings (e.g. show all transactions categorized to
        "Software & SaaS").

        - `postingStatuses` — comma-separated: `UNSTAGED` (raw, uncategorized),
        `DRAFT` (in inbox, pending review), `POSTED` (confirmed). Omit to return
        all statuses.

        - `amountDirection` — `in` for money received into the account, `out`
        for money spent.

        - `from` / `to` — filter by transaction date (YYYY-MM-DD).

        - `orgMerchantIds` — filter by assigned vendor/customer merchant.

        - `feedScope` — `bank` drops payment-processor balances (Square, Etsy)
        from the results; `all` (the default) keeps them, and an account named
        in `accountIds` shows under either scope.
      parameters:
        - schema:
            type: string
            description: Comma-separated financial account ids
          required: false
          description: Comma-separated financial account ids
          name: accountIds
          in: query
        - schema:
            type: string
            description: Comma-separated register (ledger) account ids
          required: false
          description: Comma-separated register (ledger) account ids
          name: registerAccountIds
          in: query
        - schema:
            type: string
          required: false
          name: orgMerchantIds
          in: query
        - schema:
            type: string
          required: false
          name: from
          in: query
        - schema:
            type: string
          required: false
          name: to
          in: query
        - schema:
            type: string
          required: false
          name: search
          in: query
        - schema:
            type: string
          required: false
          name: categoryAccountIds
          in: query
        - schema:
            type: string
            description: Comma-separated subset of UNSTAGED,DRAFT,POSTED
          required: false
          description: Comma-separated subset of UNSTAGED,DRAFT,POSTED
          name: postingStatuses
          in: query
        - schema:
            type: number
            nullable: true
            minimum: 0
          required: false
          name: amountGt
          in: query
        - schema:
            type: number
            nullable: true
            minimum: 0
          required: false
          name: amountLt
          in: query
        - schema:
            type: string
            enum:
              - in
              - out
          required: false
          name: amountDirection
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
          required: false
          name: order
          in: query
        - schema:
            type: string
            enum:
              - bank
              - all
            description: >-
              bank hides payment-processor balances; all (the default) includes
              them
          required: false
          description: >-
            bank hides payment-processor balances; all (the default) includes
            them
          name: feedScope
          in: query
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 500
          required: false
          name: limit
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
          required: false
          name: offset
          in: query
      responses:
        '200':
          description: Paginated transactions
          content:
            application/json:
              schema:
                type: object
                properties:
                  transactions:
                    type: array
                    items:
                      $ref: '#/components/schemas/TransactionSummary'
                  total:
                    type: integer
                    minimum: 0
                  counts:
                    type: object
                    properties:
                      inbox:
                        type: integer
                        minimum: 0
                      posted:
                        type: integer
                        minimum: 0
                      all:
                        type: integer
                        minimum: 0
                    required:
                      - inbox
                      - posted
                      - all
                required:
                  - transactions
                  - total
                  - counts
      security:
        - bearerAuth: []
components:
  schemas:
    TransactionSummary:
      type: object
      properties:
        id:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        providerTransactionId:
          type: string
        accountId:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        name:
          type: string
        amount:
          type: string
        isoCurrencyCode:
          type: string
          nullable: true
        date:
          type: string
        status:
          type: string
        postingStatus:
          type: string
          enum:
            - UNSTAGED
            - DRAFT
            - POSTED
        orgMerchantId:
          type: integer
          nullable: true
          minimum: 0
          exclusiveMinimum: true
        merchant:
          type: object
          nullable: true
          properties:
            id:
              type: integer
              minimum: 0
              exclusiveMinimum: true
            name:
              type: string
            website:
              type: string
              nullable: true
          required:
            - id
            - name
            - website
          additionalProperties:
            nullable: true
        categoryAccountId:
          type: integer
          nullable: true
          minimum: 0
          exclusiveMinimum: true
        categoryAccountName:
          type: string
          nullable: true
        accountName:
          type: string
          nullable: true
        amountBase:
          type: string
          nullable: true
        baseCurrency:
          type: string
          nullable: true
        linkedDocumentTypes:
          type: array
          items:
            type: string
      required:
        - id
        - providerTransactionId
        - accountId
        - name
        - amount
        - isoCurrencyCode
        - date
        - status
        - postingStatus
        - orgMerchantId
        - merchant
        - categoryAccountId
        - categoryAccountName
        - accountName
        - amountBase
        - baseCurrency
      additionalProperties:
        nullable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API token issued from the Equated app under Settings → API Tokens.

````