---
title: "List publisher payouts"
type: reference
method: GET
path: /rest-api/site/{siteId}/payouts.do
tag: "Network Finances"
---

# List publisher payouts

`GET https://YOUR-NETWORK-DOMAIN/rest-api/site/{siteId}/payouts.do`

The payouts booked against one site (publisher) — the Payouts card of the site and the Publishers Payments grid of Network Finances — newest first, optionally narrowed to some years and months. 'totalAmount' is the sum of every payout the filters match, not only of the returned page. 'balance' is the site's balance record for 'balanceMonth' (the current month by default) as the Publisher balance grid shows it: balance, paid out and still to be paid; it is null while no balance has been calculated for that month. Requires the NETWORK_BILLING_MANAGEMENT and PUBLISHERS_PAYMENTS permissions, or SHOW_PUBLISHERS_PAYOUTS, and inventory VIEW (SHARED or ALL); with SHARED the site must be shared with the caller.

## Path params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `siteId` | integer | yes | `2001` | Site ID |

## Query params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `balanceMonth` | string | no | `2026-08` | Month whose balance record 'balance' reports, yyyy-MM (2010-01 to 2050-12). The current month when omitted. |
| `limit` | integer | no | `50` | Page size, 1 to 1000 |
| `month` | array<integer> | no | `9` | Only payments of these months (1-12) |
| `start` | integer | no | `0` | 0-based offset of the first payment to return |
| `year` | array<integer> | no | `2026` | Only payments of these years |

## Responses

- `200` — {success, siteId, siteName, total, start, limit, totalAmount, payouts:[{paymentId, date (yyyy-MM-dd), year, month, amount, comment}], balance:{year, month, balance, paidOut, toBePaid}|null}
- `400` — 'start', 'limit' or 'balanceMonth' is out of range or malformed
- `401` — Authentication error
- `403` — The caller lacks one of the required permissions
- `404` — No such site, or it is not shared with the caller

## Example request

```bash
curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/site/2001/payouts.do?balanceMonth=2026-08&limit=50&month=9' \
  --header 'X-Api-Key: YOUR_API_KEY'
```

Source: https://epom.com/ad-server/docs/api/network-finances/get-site-payouts