---
title: "List Payout Groups"
method: GET
path: "/rewards/payout-groups"
tags: ["Payout Groups"]
---

# List Payout Groups

`GET /rewards/payout-groups`

Retrieves a list of payout groups.

## Query parameters

- `limit` integer
- `page_cursor` string
- `asset_type` string
- `name_prefix` string
- `claimer_address` string
- `ledger` string
- `jurisdiction` string
- `onchain_statuses` string[]
- `min_balance` string

## Response `200`

A successful response.

- ListPayoutGroupsResponse
  - `items` PayoutGroup[] — Payout groups in this page of results.
    - `id` string, required
    - `ledger` string, required
    - `asset_type` string, required
    - `rate_id` string, required
    - `jurisdiction` string, required
    - `name` string
    - `claimer_address` string, required — Address with signing authority to claim rewards for this group.
    - `manager_address` string — Address that manages this payout group. Defaults to claimer_address if not explicitly set.
    - `destination_address` string — Address that receives reward payouts for this group. Defaults to claimer_address if not explicitly set.
    - `onchain_group_id` string, int64
    - `onchain_status` 'UNREGISTERED' | 'PENDING_REGISTRATION' | 'NEEDS_REREGISTRATION' | 'ACTIVE' | 'FAILED_REGISTRATION' | 'PENDING_DELETION' | 'FAILED_DELETION' | 'PENDING_MULTIPLIER_UPDATE' | 'MULTIPLIER_UPDATE_FAILED' | 'UNREGISTERED_INSUFFICIENT_BALANCE', required — PayoutGroupOnchainStatus represents the on-chain registration status of a payout group.
    - `balance` string, required — Current balance of addresses in this payout group. Does not include any pending/unclaimed rewards.
    - `balance_at` string, date-time
    - `last_claim_all_at` string, date-time
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `next_page_cursor` string
  - `count` integer — Total number of payout groups matching the current filters (without pagination).

---

[API](https://skmtc.net/paxos/apis/paxos-api.md) · [All operations](https://skmtc.net/paxos/apis/paxos-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/paxos/paxos-api/revisions/0687ca8c9a8d/schema)