---
description: >-
  С помощью представленных методов вы можете получить информацию о рефералах,
  реферерах вашего контакта.
---

# Реферальная система

{% hint style="info" %}
**Реферер** – пользователь стоящий выше, тот кто пригласил в реферальную программу.

**Реферал** – пользователь стоящий ниже, тот кого пригласили в реферальную программу.
{% endhint %}

{% hint style="warning" %}
Как правильно сформировать запрос?! Смотрим в [основах](../osnovy)
{% endhint %}

## Получить реферер контакта

<mark style="color:blue;">`GET`</mark> `https://app.cleverapp.pro/api/v1/getReferrers`

Этот метод позволяет получить список или дерево рефереров контакта.

#### Path Parameters

| Name                                          | Type    | Description                                                                                                                               |
| --------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| contact\_id<mark style="color:red;">\*</mark> | integer | ID контакта                                                                                                                               |
| depth                                         | integer | Глубина дерева, мин. 1, макс. 10.                                                                                                         |
| is\_flat                                      | boolean | По умолчанию вы получаете информацию в виде дерева, если укажите значение этого поля в `1`, то информация придет в виде списка рефереров. |

{% tabs %}
{% tab title="200: OK Запрос успешно обработан. Результат в виде дерева, включая текущий контакт" %}
```javascript
{
  "data": {
    "id": 3,
    "name": "Иван Иванов",
    "messenger": "telegram",
    "created_at": "2019-05-10T10:38:28+00:00",
    "referrer": {
      "id": 2,
      "name": "Петр Петров",
      "messenger": "telegram",
      "created_at": "2019-05-10T10:38:25+00:00",
      "referrer": {
        "id": 1,
        "name": "Василий Васильев",
        "messenger": "telegram",
        "created_at": "2019-05-10T10:11:42+00:00"
      }
    }
  }
}
```
{% endtab %}
{% endtabs %}

## Получить рефералы контакта

<mark style="color:green;">`POST`</mark> `https://app.cleverapp.pro/api/v1/getReferrals`

Этот метод позволяет получить список рефералов контакта.

#### Path Parameters

| Name                                          | Type    | Description                                                                                                                                           |
| --------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| filters                                       | object  | Поля для фильтрации данных. Например фильтр по тегу: `{"tag_name": "Горячий"} {"tag_name": ["Горячий", "Холодный"]} {"tag_id": 1} {"tag_id": [1, 2]}` |
| page                                          | integer | Номер страницы результатов.                                                                                                                           |
| contact\_id<mark style="color:red;">\*</mark> | integer | ID контакта.                                                                                                                                          |

{% tabs %}
{% tab title="200: OK Запрос успешно обработан" %}
```javascript
{
    // Response
}
```
{% endtab %}
{% endtabs %}

## Получить количество рефералов всей сети контакта

<mark style="color:green;">`POST`</mark> `https://app.cleverapp.pro/api/v1/getCountReferrals`

Этот метод позволяет получить количество рефералов всей сети контакта.

#### Path Parameters

| Name                                          | Type    | Description                                                                                                                                           |
| --------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| filters                                       | object  | Поля для фильтрации данных. Например фильтр по тегу: `{"tag_name": "Горячий"} {"tag_name": ["Горячий", "Холодный"]} {"tag_id": 1} {"tag_id": [1, 2]}` |
| contact\_id<mark style="color:red;">\*</mark> | integer | ID контакта.                                                                                                                                          |

{% tabs %}
{% tab title="200: OK Запрос успешно обработан" %}
```
{
  "data": {
    "count": 1
  }
}
```
{% endtab %}
{% endtabs %}
