---
title: "GET /v1/recipient-groups"
method: GET
path: "/v1/recipient-groups"
tags: ["RecipientGroupService"]
---

# GET /v1/recipient-groups

`GET /v1/recipient-groups`

## Query parameters

- `page` integer
- `pageSize` integer
- `keyword` string
- `status` integer

## Response `200`

OK

- RabbitApiV1ListRecipientGroupReply
  - `items` RabbitApiV1RecipientGroupItem[]
    - `uid` string
    - `name` string
    - `metadata` object
    - `templates` RabbitApiV1TemplateItem[]
      - `uid` string
      - `name` string
      - `messageType` integer
      - `jsonData` string
      - `createdAt` string
      - `updatedAt` string
      - `status` integer
    - `emailConfigs` RabbitApiV1EmailConfigItem[]
      - `uid` string
      - `name` string
      - `host` string
      - `port` integer
      - `username` string
      - `password` string
      - `createdAt` string
      - `updatedAt` string
      - `status` integer
    - `webhookConfigs` RabbitApiV1WebhookItem[]
      - `uid` string
      - `app` integer
      - `name` string
      - `url` string
      - `method` integer
      - `headers` object
      - `secret` string
      - `createdAt` string
      - `updatedAt` string
      - `status` integer
    - `members` RabbitApiV1RecipientGroupMemberItem[]
      - `memberUid` string
      - `isEmail` boolean
      - `isSms` boolean
      - `isPhone` boolean
      - `memberName` string
      - `memberAvatar` string
      - `memberEmail` string
      - `memberPhone` string
    - `status` integer
    - `createdAt` string
    - `updatedAt` string
  - `total` string
  - `page` integer
  - `pageSize` integer

---

[API](https://skmtc.net/aide-family/apis/untitled-api.md) · [All operations](https://skmtc.net/aide-family/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aide-family/untitled-api/versions/695b37f99d58/schema)