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

# Search merchants by name

> Fuzzy-search the org's merchants by name, returning lightweight counterparties (id, name, role flags). Optionally filter by role.



## OpenAPI

````yaml /openapi.json get /api/merchants/search
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/search:
    get:
      tags:
        - Merchants
      summary: Search merchants by name
      description: >-
        Fuzzy-search the org's merchants by name, returning lightweight
        counterparties (id, name, role flags). Optionally filter by role.
      parameters:
        - schema:
            type: string
            default: ''
          required: false
          name: q
          in: query
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 100
            default: 20
          required: false
          name: limit
          in: query
        - schema:
            type: string
            enum:
              - vendor
              - customer
              - all
            default: all
          required: false
          name: role
          in: query
      responses:
        '200':
          description: Matching merchants
          content:
            application/json:
              schema:
                type: object
                properties:
                  merchants:
                    type: array
                    items:
                      $ref: '#/components/schemas/Merchant'
                required:
                  - merchants
      security:
        - bearerAuth: []
components:
  schemas:
    Merchant:
      type: object
      properties:
        id:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        orgMerchantId:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        name:
          type: string
        description:
          type: string
          nullable: true
        website:
          type: string
          nullable: true
        imageUrl:
          type: string
          nullable: true
        logo:
          type: string
          nullable: true
        isVendor:
          type: boolean
        isCustomer:
          type: boolean
      required:
        - id
        - orgMerchantId
        - name
        - description
        - website
        - imageUrl
        - logo
        - isVendor
        - isCustomer
      additionalProperties:
        nullable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API token issued from the Equated app under Settings → API Tokens.

````