---
title: "List merchants"
method: GET
path: "/api/merchants/list"
tags: ["Merchants"]
---

# List merchants

`GET /api/merchants/list`

Get a paginated list of merchants with optional name and group_id filtering. Results are ordered by merchant ID for stable pagination.

## Query parameters

- `name` string
- `group_id` string
- `limit` integer
- `offset` integer

## Response `200`

List of merchants with pagination metadata

- object
  - `data` Merchant1[]
    - `aliases` string, nullable
    - `categories` MerchantCategory[]
      - `code` string, required
      - `description` string, nullable
      - `slug` string, nullable
    - `category_codes` string[]
    - `created` string, date-time
    - `debt_merchant_aliases` string, nullable
    - `frequency` integer
    - `group_id` 'Uber' | 'Google' | 'Intuit' | 'debt.mca_or_rbf' | 'debt.non_bank_business' | 'debt.equipment_and_auto_leasing' | 'debt.mortgage' | 'debt.personal_non_mortgage' | 'debt.collections' | 'debt.bank' | 'invoice_factoring' | 'fuel_provider' | 'gambling_and_betting' | 'null', nullable
    - `heron_id` string
    - `icon_url` string, url, nullable
    - `id` integer
    - `is_deleted` boolean
    - `is_priority` boolean
    - `logo_url` string, url, nullable
    - `name` string, required
    - `url` string, url, required
    - `use_name_as_alias` boolean, nullable
  - `has_more` boolean
  - `limit` integer
  - `offset` integer
  - `total` integer

---

[API](https://skmtc.dev/herondata/apis/heron-data-api.md) · [All operations](https://skmtc.dev/herondata/apis/heron-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/herondata/heron-data-api/revisions/f2e441edece2/schema)