---
title: "Get Scoped Referral Network"
method: GET
path: "/cabinet/admin/referral-network/scoped"
tags: ["Cabinet Admin Referral Network"]
---

# Get Scoped Referral Network

`GET /cabinet/admin/referral-network/scoped`

Return scoped referral network graph for selected campaigns, partners, and/or users.

## Query parameters

- `campaign_ids` integer[]
- `partner_ids` integer[]
- `user_ids` integer[]

## Response `200`

Successful Response

- NetworkGraphResponse
  - `users` NetworkUserNode[], required
    - `id` integer, required
    - `tg_id` integer, nullable, required
    - `username` string, nullable, required
    - `email` string, nullable, required
    - `display_name` string, required
    - `is_partner` boolean, required
    - `referrer_id` integer, nullable, required
    - `campaign_id` integer, nullable, required
    - `direct_referrals` integer, required
    - `total_branch_users` integer, required
    - `branch_revenue_kopeks` integer, required
    - `personal_revenue_kopeks` integer, required
    - `personal_spent_kopeks` integer, required
    - `subscription_name` string, nullable, required
    - `subscription_end` string, nullable, required
    - `registered_at` string, nullable, required
  - `campaigns` NetworkCampaignNode[], required
    - `id` integer, required
    - `name` string, required
    - `start_parameter` string, required
    - `is_active` boolean, required
    - `direct_users` integer, required
    - `total_network_users` integer, required
    - `total_revenue_kopeks` integer, required
    - `conversion_rate` number, required
    - `avg_check_kopeks` integer, required
    - `top_referrers` TopReferrer[], required
      - `user_id` integer, required
      - `username` string, nullable, required
      - `referral_count` integer, required
  - `edges` NetworkEdge[], required
    - `source` string, required
    - `target` string, required
    - `type` string, required
  - `total_users` integer, required
  - `total_referrers` integer, required
  - `total_campaigns` integer, required
  - `total_earnings_kopeks` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/bedolagam/apis/remnawave-bot-admin-api.md) · [All operations](https://skmtc.net/bedolagam/apis/remnawave-bot-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bedolagam/remnawave-bot-admin-api/versions/45956d1b13ec/schema)