---
title: "Count payouts by status"
method: GET
path: "/payouts/counts"
tags: ["Payouts"]
---

# Count payouts by status

`GET /payouts/counts`

## Request

- Base URL: `https://viral.app/api/v1`
- URL: `https://viral.app/api/v1/payouts/counts`
- Auth: API key in header `x-api-key`

Returns counts for upcoming, due, canceled, and paid payouts. Use `statuses` to limit which counts are returned.

## Query parameters

- `campaignIds` string[]
- `creatorIds` string[]
- `statuses` string[]
- `referenceDate` string, date-time

## Response `200`

OK

- object
  - `upcoming` integer
  - `due` integer
  - `canceled` integer
  - `paid` integer

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `404`: 404
- `408`: 408
- `429`: 429
- `500`: 500

---

[API](https://skmtc.dev/viral/apis/viral-app-api.md) · [All operations](https://skmtc.dev/viral/apis/viral-app-api/llms.txt) · [OpenAPI document](https://skmtc.dev/viral/apis/viral-app-api/revisions/31e97fa79ef1?raw)