> ## 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 merchants

> List the org's merchants with lifetime spend/revenue totals and a 12-month monthly series. Filter by `role` (vendor/customer) and an optional date window; sort by amount or last activity. Merchants are auto-extracted from transaction names — see the Merchants concept doc.



## OpenAPI

````yaml /openapi.json get /api/merchants
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/merchants:
    get:
      tags:
        - Merchants
      summary: List merchants
      description: >-
        List the org's merchants with lifetime spend/revenue totals and a
        12-month monthly series. Filter by `role` (vendor/customer) and an
        optional date window; sort by amount or last activity. Merchants are
        auto-extracted from transaction names — see the Merchants concept doc.
      parameters:
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
          required: false
          name: from
          in: query
        - schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
          required: false
          name: to
          in: query
        - schema:
            type: string
            enum:
              - amount
              - date
          required: false
          name: sort
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
          required: false
          name: direction
          in: query
        - schema:
            type: string
            enum:
              - vendor
              - customer
              - all
          required: false
          name: role
          in: query
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 200
          required: false
          name: limit
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
          required: false
          name: offset
          in: query
      responses:
        '200':
          description: Merchants with aggregates
          content:
            application/json:
              schema:
                type: object
                properties:
                  merchants:
                    type: array
                    items:
                      $ref: '#/components/schemas/MerchantListItem'
                required:
                  - merchants
      security:
        - bearerAuth: []
components:
  schemas:
    MerchantListItem:
      type: object
      properties:
        id:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        sourceType:
          type: string
        externalId:
          type: string
          nullable: true
        name:
          type: string
        description:
          type: string
          nullable: true
        website:
          type: string
          nullable: true
        imageUrl:
          type: string
          nullable: true
        logo:
          type: string
          nullable: true
        isOverridden:
          type: object
          properties:
            name:
              type: boolean
            description:
              type: boolean
          required:
            - name
            - description
        isVendor:
          type: boolean
        isCustomer:
          type: boolean
        transactionCount:
          type: number
        totalSpent:
          type: number
        lastTransactionDate:
          type: string
          nullable: true
        monthlySpend:
          type: array
          items:
            $ref: '#/components/schemas/MonthlySpendPoint'
      required:
        - id
        - sourceType
        - externalId
        - name
        - description
        - website
        - imageUrl
        - logo
        - isOverridden
        - isVendor
        - isCustomer
        - transactionCount
        - totalSpent
        - lastTransactionDate
        - monthlySpend
      additionalProperties:
        nullable: true
    MonthlySpendPoint:
      type: object
      properties:
        month:
          type: string
        amount:
          type: number
      required:
        - month
        - amount
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API token issued from the Equated app under Settings → API Tokens.

````