---
title: "GET /v1/crm/metrics/bonus/balance/"
method: GET
path: "/v1/crm/metrics/bonus/balance/"
tags: ["v1"]
---

# GET /v1/crm/metrics/bonus/balance/

`GET /v1/crm/metrics/bonus/balance/`

## Request

- Base URL: `https://api.yume.cloud`
- URL: `https://api.yume.cloud/v1/crm/metrics/bonus/balance/`
- Auth: HTTP bearer

## Query parameters

- `end_at` string, required
- `ordering` string
- `page` integer
- `pageSize` integer
- `search` string
- `start_at` string, required

## Response `200`

- PaginatedMetricsClientBonusBalanceList
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` MetricsClientBonusBalance[], required
    - `id` integer, required
    - `client` BaseClient, required
      - `id` integer, required
      - `name` string, required
      - `type` 0 | 1: * `0` - Физ. лицо * `1` - Юр. лицо
      - `avatar` string, uri, nullable
      - `agreement_id` string, nullable, required
      - `signed` boolean
      - `sign_date` string, date, nullable
      - `sign_expires` string, date, nullable
      - `phone` string, required
      - `email` string, email, nullable
      - `legal_type` union
        - 0 | 1 | 2 | 3: * `0` - ИП * `1` - ТОО * `2` - АО * `3` - ПК
        - unknown
      - `extra` unknown
    - `amount` string, decimal

---

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