---
title: "Get WhiteLabel dashboard"
method: GET
path: "/rest/api/v1/projects/{projectId}/features/{featureId}/whitelabel/dashboard"
tags: ["Project API"]
---

# Get WhiteLabel dashboard

`GET /rest/api/v1/projects/{projectId}/features/{featureId}/whitelabel/dashboard`

## Request

- Base URL: `https://api.metacopier.io`
- URL: `https://api.metacopier.io/rest/api/v1/projects/{projectId}/features/{featureId}/whitelabel/dashboard`
- Auth: API key in header `X-API-KEY`
- TypeScript: <https://skmtc.dev/metacopier/apis/metacopier-api/docs/rest/api/v1/projects/:projectId/features/:featureId/whitelabel/dashboard/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `projectId` string, uuid, required
- `featureId` string, uuid, required

## Response `200`

OK

- WhiteLabelDashboardDTO: Comprehensive dashboard for WhiteLabel owners showing all linked projects, customers, accounts and invoices
  - `currency` string: Currency used for all financial calculations
  - `isTestStripeKey` boolean: True when the white-label is configured with an sk_test_ Stripe key. Read-only mirror used to drive frontend warnings.
  - `manualCollection` boolean: True when the white-label has opted in to per-customer manual collection (mirrors FeatureWhiteLabelDTO.manualCollection)
  - `projects` WhiteLabelProjectSummaryDTO[]: Detailed list of all projects linked to this WhiteLabel
    - `accountCount` integer: Number of accounts in this project
    - `activeAccountCount` integer: Number of active accounts
    - `balance` number: Current project balance
    - `blocked` boolean: Whether the project is blocked
    - `created` string, date-time: Project creation date
    - `customerCount` integer: Number of customers in this project
    - `customers` CustomerSummaryDTO[]: List of customers in this project
      - `accountCount` integer: Number of accounts owned by this customer in this project
      - `activeProjectCount` integer: Number of projects of this customer under this white-label that are still active (not blocked). When 0, the customer has already been fully blocked at the WL level.
      - `blocked` boolean: Whether customer is blocked
      - `created` string, date-time: Customer creation date
      - `currentMonthOutstanding` number: Sum of OPEN invoice amounts for this customer created in the current calendar month
      - `customerId` integer: Customer ID
      - `email` string: Customer email
      - `openInvoices` InvoiceSummaryDTO[]: All OPEN invoices for this customer across the projects of this white-label
        - `amount` number: Invoice amount
        - `created` string, date-time: Invoice creation date
        - `customerEmail` string: Customer email this invoice belongs to. Useful for grouping in the dashboard.
        - `description` string: Invoice description
        - `discount` number: Invoice discount
        - `dueDate` string, date-time: Invoice due date
        - `invoiceNumber` string: Invoice number
        - `manualCollection` boolean: True when this invoice is collected manually by the white-label owner (paymentProviderReference starts with 'Manual|')
        - `projectId` string, uuid: Project ID this invoice belongs to
        - `status` string: Invoice status (PAID, UNPAID, etc.)
      - `outstandingAmount` number: Sum of OPEN invoice amounts for this customer across all projects in this white-label
      - `paidAmount` number: Sum of PAID invoice amounts for this customer across all projects in this white-label
      - `permission` string: Customer permission in the project
      - `projectIds` string[]: IDs of all projects of this white-label where the customer is registered
    - `dedicated` boolean: Whether this is a dedicated project
    - `invoiceCount` integer: Number of invoices for this project
    - `invoices` InvoiceSummaryDTO[]: List of invoices for this project
      - `amount` number: Invoice amount
      - `created` string, date-time: Invoice creation date
      - `customerEmail` string: Customer email this invoice belongs to. Useful for grouping in the dashboard.
      - `description` string: Invoice description
      - `discount` number: Invoice discount
      - `dueDate` string, date-time: Invoice due date
      - `invoiceNumber` string: Invoice number
      - `manualCollection` boolean: True when this invoice is collected manually by the white-label owner (paymentProviderReference starts with 'Manual|')
      - `projectId` string, uuid: Project ID this invoice belongs to
      - `status` string: Invoice status (PAID, UNPAID, etc.)
    - `outstandingAmount` number: Outstanding amount for this project
    - `ownerEmail` string: Project owner email
    - `projectId` string, uuid: Project unique identifier
    - `projectName` string: Project name
    - `totalRevenue` number: Total revenue from this project
  - `recentInvoices` RecentInvoiceDTO[]: Recent invoices (last 10)
    - `amount` number: Amount
    - `created` string, date-time: Creation date
    - `invoiceNumber` string: Invoice number
    - `projectName` string: Project name
    - `status` string: Status
  - `recentProjects` RecentActivityDTO[]: Recently created projects (last 10)
    - `ownerEmail` string: Owner email
    - `projectId` string, uuid: Project ID
    - `projectName` string: Project name
    - `timestamp` string, date-time: Activity timestamp
  - `totalAccounts` integer: Total number of accounts across all projects
  - `totalActiveAccounts` integer: Total number of active accounts
  - `totalCustomers` integer: Total number of unique customers across all projects
  - `totalInvoices` integer: Total number of invoices across all projects
  - `totalManualOutstanding` number: Sum of OPEN invoice amounts across all customers that are eligible for manual collection. Zero when manualCollection=false.
  - `totalOutstanding` number: Total outstanding amount from unpaid invoices
  - `totalPaidInvoices` integer: Total number of paid invoices
  - `totalProjects` integer: Total number of projects linked to this WhiteLabel
  - `totalRevenue` number: Total revenue from all paid invoices in the WhiteLabel currency
  - `totalUnpaidInvoices` integer: Total number of unpaid invoices

## Changes

- **2026-08-10** `5c1371d2c0b2`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/metacopier/apis/metacopier-api/changes/rest/api/v1/projects/:projectId/features/:featureId/whitelabel/dashboard/get.md)

---

[API](https://skmtc.dev/metacopier/apis/metacopier-api.md) - [All operations](https://skmtc.dev/metacopier/apis/metacopier-api/llms.txt) - [OpenAPI document](https://skmtc.dev/metacopier/apis/metacopier-api/revisions/cbf3e7810fc2?raw)