---
title: "This endpoint returns merchant groups categorized as pending, custom, or rejected."
method: GET
path: "/api/user_merchant_groups"
tags: ["UserMerchantGroups"]
---

# This endpoint returns merchant groups categorized as pending, custom, or rejected.

`GET /api/user_merchant_groups`

## Query parameters

- `group_id` string

## Response `200`

OK

- UserMerchantGroupsSchema
  - `custom_merchants` UserMerchantGroupSchema[]
    - `group_id` string
    - `merchant_heron_id` string, required
    - `merchant_name` string, required
  - `pending_merchants` UserMerchantGroupSchema[]
    - `group_id` string
    - `merchant_heron_id` string, required
    - `merchant_name` string, required
  - `rejected_merchants` UserMerchantGroupSchema[]
    - `group_id` string
    - `merchant_heron_id` string, required
    - `merchant_name` string, required

---

[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)