PHPackages                             kenny-mgn/profitbase-php-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. kenny-mgn/profitbase-php-client

ActiveLibrary[API Development](/categories/api)

kenny-mgn/profitbase-php-client
===============================

Guzzle-based PHP client for the Profitbase API with access token handling and rate limit control.

1.0.1(6mo ago)016↓50%MITPHPPHP ^8.1CI passing

Since Oct 22Pushed 6mo agoCompare

[ Source](https://github.com/Kenny-MGN/profitbase-php-client)[ Packagist](https://packagist.org/packages/kenny-mgn/profitbase-php-client)[ RSS](/packages/kenny-mgn-profitbase-php-client/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (4)Versions (3)Used By (0)

Profitbase API Client for PHP
=============================

[](#profitbase-api-client-for-php)

[![CI](https://github.com/Kenny-MGN/profitbase-php-client/actions/workflows/ci.yml/badge.svg)](https://github.com/Kenny-MGN/profitbase-php-client/actions)[![Latest Stable Version](https://camo.githubusercontent.com/340b287d3877ed4d87826d58c8e35d7c5835d1f7bf73496919c9bbd4226f275e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6b656e6e792d6d676e2f70726f666974626173652d7068702d636c69656e742e737667)](https://packagist.org/packages/Kenny-MGN/profitbase-php-client)[![License](https://camo.githubusercontent.com/e569898bcd9b76a8da6bae51d6009a3a3010383b58b9d5360102177c3b32999d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f4b656e6e792d4d474e2f70726f666974626173652d7068702d636c69656e742e737667)](LICENSE)[![PHPStan](https://camo.githubusercontent.com/163b114d35c38fa7e5b939e796cda588cbce8dd8fddcfed0e236b4e15a7843a7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7374617469632d2d616e616c797369732d5048505374616e2d626c75652e737667)](https://phpstan.org/)[![Code Style](https://camo.githubusercontent.com/b7ef520b869f85fce0526eb44fd1502e29ebd15b1198360eded108fa0b464824/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64652532307374796c652d5053522d2d31322d677265656e2e737667)](https://www.php-fig.org/psr/psr-12/)

Содержание
----------

[](#содержание)

- [Описание](#%D0%BE%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D0%B5)
- [Требования](#%D1%82%D1%80%D0%B5%D0%B1%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F)
- [Установка](#%D1%83%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0)
- [Быстрый старт](#%D0%B1%D1%8B%D1%81%D1%82%D1%80%D1%8B%D0%B9-%D1%81%D1%82%D0%B0%D1%80%D1%82)
- [Query-параметры](#query-%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D1%8B)
    - [Передача множественных значений](#%D0%BF%D0%B5%D1%80%D0%B5%D0%B4%D0%B0%D1%87%D0%B0-%D0%BC%D0%BD%D0%BE%D0%B6%D0%B5%D1%81%D1%82%D0%B2%D0%B5%D0%BD%D0%BD%D1%8B%D1%85-%D0%B7%D0%BD%D0%B0%D1%87%D0%B5%D0%BD%D0%B8%D0%B9-%D0%B2-query-%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0%D1%85)
- [Конфигурация HTTP-клиента (Guzzle)](#%D0%BA%D0%BE%D0%BD%D1%84%D0%B8%D0%B3%D1%83%D1%80%D0%B0%D1%86%D0%B8%D1%8F-http-%D0%BA%D0%BB%D0%B8%D0%B5%D0%BD%D1%82%D0%B0-guzzle)
- [Потоковый режим](#%D0%BF%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%B2%D1%8B%D0%B9-%D1%80%D0%B5%D0%B6%D0%B8%D0%BC)
- [Ограничение частоты запросов (Rate Limit)](#%D0%BE%D0%B3%D1%80%D0%B0%D0%BD%D0%B8%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%87%D0%B0%D1%81%D1%82%D0%BE%D1%82%D1%8B-%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%BE%D0%B2-rate-limit)
    - [Асинхронность и многопоточность](#%D0%B0%D1%81%D0%B8%D0%BD%D1%85%D1%80%D0%BE%D0%BD%D0%BD%D0%BE%D1%81%D1%82%D1%8C-%D0%B8-%D0%BC%D0%BD%D0%BE%D0%B3%D0%BE%D0%BF%D0%BE%D1%82%D0%BE%D1%87%D0%BD%D0%BE%D1%81%D1%82%D1%8C)
- [Методы доступа к Profitbase API](#%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D1%8B-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-profitbase-api)
- [Обратная связь](#%D0%BE%D0%B1%D1%80%D0%B0%D1%82%D0%BD%D0%B0%D1%8F-%D1%81%D0%B2%D1%8F%D0%B7%D1%8C)
- [Лицензия](#%D0%BB%D0%B8%D1%86%D0%B5%D0%BD%D0%B7%D0%B8%D1%8F)

Описание
--------

[](#описание)

**Profitbase API Client for PHP** – это обёртка над HTTP-клиентом [Guzzle](https://github.com/guzzle/guzzle), предназначенная для взаимодействия с [Profitbase API](https://developer.profitbase.ru/). Данный пакет реализует автоматическое управление токеном доступа (access token): его первоначальное получение, обновление по истечении срока действия и троттлинг запросов для соблюдения ограничений частоты обращений (rate limit) к **Profitbase API**.

Требования
----------

[](#требования)

- PHP >= 8.1
- PHP Extensions: `curl`, `json`

Установка
---------

[](#установка)

```
composer require kenny-mgn/profitbase-php-client
```

Быстрый старт
-------------

[](#быстрый-старт)

```
use KennyMgn\ProfitbaseClient\ProfitbaseClient;

try {
    $client = ProfitbaseClient::create('your-api-key', 'https://pbXXXXX.profitbase.ru/api/v4/json');
    $response = $client->houses();

    $jsonString = $response->getBody()->getContents();
    $arrayResult = json_decode($jsonString, associative: true);
} catch (Throwable $throwable) {
    echo $throwable->getMessage();
}
```

Методы запросов к Profitbase API возвращают ответ в виде [ResponseInterface](https://docs.guzzlephp.org/en/stable/psr7.html#responses). Основные методы:

```
# HTTP статус ответа
$response->getStatusCode();

# Тело ответа
$body = $response->getBody();

# Читаем всё содержимое в память
$jsonString = $body->getContents();
```

Query-параметры
---------------

[](#query-параметры)

Во всех методах обращения к Profitbase API можно передавать дополнительные query-параметры через массив `$queryParams`.

Если эндпоинт имеет стандартные параметры, они обычно уже вынесены в сигнатуру метода, например:

```
public function specialOffers(
    ?bool $isArchived = null,
    ?bool $isDiscounted = null,
    array $queryParams = []
)
```

Параметры `$isArchived` и `$isDiscounted` — основные, определённые в методе.

Массив `$queryParams` позволяет добавлять любые другие query-параметры для гибкости, даже если эндпоинт сейчас их не принимает.

### Передача множественных значений в query-параметрах

[](#передача-множественных-значений-в-query-параметрах)

В **Profitbase API** для передачи нескольких значений одного параметра query string должен иметь вид:

```
?ids[]=1&ids[]=2&ids[]=3

```

В данном пакете это достигается созданием массива вида:

```
$queryParams = ['ids[]' => [1, 2, 3]];
```

Библиотека автоматически преобразует такой массив в правильный формат query string для запроса к API.

Пример использования:

```
$client = ProfitbaseClient::create($apiKey, $baseEndpoint);
$response = $client->properties(['status[]' => ['AVAILABLE', 'BOOKED']]);
```

Конфигурация HTTP-клиента (Guzzle)
----------------------------------

[](#конфигурация-http-клиента-guzzle)

При создании экземпляра клиента `ProfitbaseClient` можно передавать массив `$httpClientConfig` с дополнительными параметрами конфигурации Guzzle. Любые переданные параметры **переопределяют стандартные настройки HTTP-клиента**,
что позволяет гибко управлять поведением соединений, таймаутами, заголовками и другими опциями.

Пример создания клиента с кастомной конфигурацией:

```
$client = ProfitbaseClient::create(
    $apiKey,
    $baseEndpoint,
    [
        'timeout' => 20,
        'headers' => ['X-Custom-Header' => 'value'],
    ]
);
```

Все доступные параметры **Guzzle** можно найти в официальной документации: [Guzzle Request Options](https://docs.guzzlephp.org/en/stable/request-options.html).

Потоковый режим
---------------

[](#потоковый-режим)

По умолчанию клиент работает в потоковом режиме, позволяющем обрабатывать данные по мере их поступления и использовать библиотеки вроде [cerbero/json-parser](https://github.com/cerbero90/json-parser) для порционной обработки больших JSON-ответов.

```
use Cerbero\JsonParser\JsonParser;
use KennyMgn\ProfitbaseClient\ProfitbaseClient;

try {
    $client = ProfitbaseClient::create($apiKey, $baseEndpoint);
    $response = $client->houses();

    $stream = $response->getBody();
    JsonParser::parse($stream)->traverse(function (mixed $value, string|int $key, JsonParser $parser) {
        // Действия
    });
} catch (Throwable $throwable) {
    echo $throwable->getMessage();
}
```

Чтобы создать экземпляр клиента не в потоковом режиме, передайте параметр конфигурации `stream => false`:

```
$client = ProfitbaseClient::create($apiKey, $baseEndpoint, ['stream' => false]);
```

Ограничение частоты запросов (Rate Limit)
-----------------------------------------

[](#ограничение-частоты-запросов-rate-limit)

**Profitbase API** ограничивает частоту обращений: **не более одного запроса в секунду** от одного клиента. Чтобы соблюдать это требование, класс `ProfitbaseClient` включает встроенный механизм ограничения количества запросов. По умолчанию между последовательными запросами выдерживается пауза в **1 секунду**.

Интервал можно изменить методом:

```
$client->limitRequestRateTo(2);
```

### Асинхронность и многопоточность

[](#асинхронность-и-многопоточность)

Класс `ProfitbaseClient` реализован синхронно — все запросы выполняются последовательно в одном потоке. Он **не поддерживает асинхронные вызовы или параллельное выполнение** запросов из коробки.

Если вы попытаетесь выполнять несколько запросов одновременно (например, из разных потоков или процессов), ограничение на уровне PHP-кода не сможет их синхронизировать — в этом случае ограничение частоты запросов нужно обеспечивать самостоятельно.

Методы доступа к Profitbase API
-------------------------------

[](#методы-доступа-к-profitbase-api)

Раздел описывает публичные методы класса `ProfitbaseClient`, соответствующие эндпоинтам **Profitbase API**, с указанием HTTP-метода, пути и поддерживаемых параметров.

Структура данного раздела (группировка и наименования) повторяет структуру официальной документации **Profitbase API**. Это сделано для удобства навигации и быстрой сопоставимости методов клиента с эндпоинтами API.

Подробное описание параметров запросов (включая `query string` и `body`) и форматов ответов см. в официальной документации Profitbase: .

---

### Навигация по методам доступа к Profitbase API

[](#навигация-по-методам-доступа-к-profitbase-api)

[auth](#auth)

- [Авторизация](#%D0%90%D0%B2%D1%82%D0%BE%D1%80%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F)

[houses](#houses)

- [Метод получения списка домов с возможностью фильтрации](#%D0%BC%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%B4%D0%BE%D0%BC%D0%BE%D0%B2-%D1%81-%D0%B2%D0%BE%D0%B7%D0%BC%D0%BE%D0%B6%D0%BD%D0%BE%D1%81%D1%82%D1%8C%D1%8E-%D1%84%D0%B8%D0%BB%D1%8C%D1%82%D1%80%D0%B0%D1%86%D0%B8%D0%B8)
- [Метод получения количества этажей в конкретном доме](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D0%BA%D0%BE%D0%BB%D0%B8%D1%87%D0%B5%D1%81%D1%82%D0%B2%D0%B0-%D1%8D%D1%82%D0%B0%D0%B6%D0%B5%D0%B9-%D0%B2-%D0%BA%D0%BE%D0%BD%D0%BA%D1%80%D0%B5%D1%82%D0%BD%D0%BE%D0%BC-%D0%B4%D0%BE%D0%BC%D0%B5)
- [Метод получения количества помещений в конкретном доме на конкретном этаже](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D0%BA%D0%BE%D0%BB%D0%B8%D1%87%D0%B5%D1%81%D1%82%D0%B2%D0%B0-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B9-%D0%B2-%D0%BA%D0%BE%D0%BD%D0%BA%D1%80%D0%B5%D1%82%D0%BD%D0%BE%D0%BC-%D0%B4%D0%BE%D0%BC%D0%B5-%D0%BD%D0%B0-%D0%BA%D0%BE%D0%BD%D0%BA%D1%80%D0%B5%D1%82%D0%BD%D0%BE%D0%BC-%D1%8D%D1%82%D0%B0%D0%B6%D0%B5)
- [Устаревший метод v3 получения списка домов](#%D0%A3%D1%81%D1%82%D0%B0%D1%80%D0%B5%D0%B2%D1%88%D0%B8%D0%B9-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4-v3-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%B4%D0%BE%D0%BC%D0%BE%D0%B2)
- [Метод создания дома в существующий ЖК](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D1%8F-%D0%B4%D0%BE%D0%BC%D0%B0-%D0%B2-%D1%81%D1%83%D1%89%D0%B5%D1%81%D1%82%D0%B2%D1%83%D1%8E%D1%89%D0%B8%D0%B9-%D0%96%D0%9A)
- [Метод обновления данных в конкретном доме](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BE%D0%B1%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F-%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85-%D0%B2-%D0%BA%D0%BE%D0%BD%D0%BA%D1%80%D0%B5%D1%82%D0%BD%D0%BE%D0%BC-%D0%B4%D0%BE%D0%BC%D0%B5)
- [Метод для поиска домов по названию, адресу и названию ЖК](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B4%D0%BB%D1%8F-%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0-%D0%B4%D0%BE%D0%BC%D0%BE%D0%B2-%D0%BF%D0%BE-%D0%BD%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D1%8E-%D0%B0%D0%B4%D1%80%D0%B5%D1%81%D1%83-%D0%B8-%D0%BD%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D1%8E-%D0%96%D0%9A)

[projects](#projects)

- [Метод получения списка ЖК](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%96%D0%9A)
- [Метод создания ЖК](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D1%8F-%D0%96%D0%9A)
- [Метод обновления ЖК](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BE%D0%B1%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F-%D0%96%D0%9A)
- [Метод для поиска ЖК по названию, адресу и названию дома, названию застройщика](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B4%D0%BB%D1%8F-%D0%BF%D0%BE%D0%B8%D1%81%D0%BA%D0%B0-%D0%96%D0%9A-%D0%BF%D0%BE-%D0%BD%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D1%8E-%D0%B0%D0%B4%D1%80%D0%B5%D1%81%D1%83-%D0%B8-%D0%BD%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D1%8E-%D0%B4%D0%BE%D0%BC%D0%B0-%D0%BD%D0%B0%D0%B7%D0%B2%D0%B0%D0%BD%D0%B8%D1%8E-%D0%B7%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D1%89%D0%B8%D0%BA%D0%B0)

[properties](#properties)

- [Метод получения списка помещений с возможностью фильтрации](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B9-%D1%81-%D0%B2%D0%BE%D0%B7%D0%BC%D0%BE%D0%B6%D0%BD%D0%BE%D1%81%D1%82%D1%8C%D1%8E-%D1%84%D0%B8%D0%BB%D1%8C%D1%82%D1%80%D0%B0%D1%86%D0%B8%D0%B8)
- [Метод создания помещения в конкретный дом](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D1%8F-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D1%8F-%D0%B2-%D0%BA%D0%BE%D0%BD%D0%BA%D1%80%D0%B5%D1%82%D0%BD%D1%8B%D0%B9-%D0%B4%D0%BE%D0%BC)
- [Метод обновления данных в конкретном помещении](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BE%D0%B1%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F-%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85-%D0%B2-%D0%BA%D0%BE%D0%BD%D0%BA%D1%80%D0%B5%D1%82%D0%BD%D0%BE%D0%BC-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B8)
- [Метод получения списка типов помещений и их дополнительных полей](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D1%82%D0%B8%D0%BF%D0%BE%D0%B2-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B9-%D0%B8-%D0%B8%D1%85-%D0%B4%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D1%8B%D1%85-%D0%BF%D0%BE%D0%BB%D0%B5%D0%B9)
- [Метод получения списка помещений привязанных к конкретной сделке](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B9-%D0%BF%D1%80%D0%B8%D0%B2%D1%8F%D0%B7%D0%B0%D0%BD%D0%BD%D1%8B%D1%85-%D0%BA-%D0%BA%D0%BE%D0%BD%D0%BA%D1%80%D0%B5%D1%82%D0%BD%D0%BE%D0%B9-%D1%81%D0%B4%D0%B5%D0%BB%D0%BA%D0%B5)
- [Метод получения истории изменения статусов по конкретному помещению](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D0%B8%D1%81%D1%82%D0%BE%D1%80%D0%B8%D0%B8-%D0%B8%D0%B7%D0%BC%D0%B5%D0%BD%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D1%82%D0%B0%D1%82%D1%83%D1%81%D0%BE%D0%B2-%D0%BF%D0%BE-%D0%BA%D0%BE%D0%BD%D0%BA%D1%80%D0%B5%D1%82%D0%BD%D0%BE%D0%BC%D1%83-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D1%8E)
- [Устаревший метод v3 получения списка помещений в конкретном доме](#%D0%A3%D1%81%D1%82%D0%B0%D1%80%D0%B5%D0%B2%D1%88%D0%B8%D0%B9-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4-v3-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B9-%D0%B2-%D0%BA%D0%BE%D0%BD%D0%BA%D1%80%D0%B5%D1%82%D0%BD%D0%BE%D0%BC-%D0%B4%D0%BE%D0%BC%D0%B5)
- [Метод получения списка сделок привязанных к конкретным помещениям](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D1%81%D0%B4%D0%B5%D0%BB%D0%BE%D0%BA-%D0%BF%D1%80%D0%B8%D0%B2%D1%8F%D0%B7%D0%B0%D0%BD%D0%BD%D1%8B%D1%85-%D0%BA-%D0%BA%D0%BE%D0%BD%D0%BA%D1%80%D0%B5%D1%82%D0%BD%D1%8B%D0%BC-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D1%8F%D0%BC)
- [Метод изменения статуса помещения](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B8%D0%B7%D0%BC%D0%B5%D0%BD%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D1%82%D0%B0%D1%82%D1%83%D1%81%D0%B0-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D1%8F)
- [Метод продления брони в конкретном помещении](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D1%80%D0%BE%D0%B4%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F-%D0%B1%D1%80%D0%BE%D0%BD%D0%B8-%D0%B2-%D0%BA%D0%BE%D0%BD%D0%BA%D1%80%D0%B5%D1%82%D0%BD%D0%BE%D0%BC-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B8)

[board](#board)

- [Метод получения шахматки дома](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%88%D0%B0%D1%85%D0%BC%D0%B0%D1%82%D0%BA%D0%B8-%D0%B4%D0%BE%D0%BC%D0%B0)

[presets](#presets)

- [Метод получения планировок помещений с возможностью фильтрации](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D0%BF%D0%BB%D0%B0%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%BE%D0%BA-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B9-%D1%81-%D0%B2%D0%BE%D0%B7%D0%BC%D0%BE%D0%B6%D0%BD%D0%BE%D1%81%D1%82%D1%8C%D1%8E-%D1%84%D0%B8%D0%BB%D1%8C%D1%82%D1%80%D0%B0%D1%86%D0%B8%D0%B8)
- [Устаревший метод получения планировок помещений в доме](#%D0%A3%D1%81%D1%82%D0%B0%D1%80%D0%B5%D0%B2%D1%88%D0%B8%D0%B9-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D0%BF%D0%BB%D0%B0%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%BE%D0%BA-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B9-%D0%B2-%D0%B4%D0%BE%D0%BC%D0%B5)

[facade](#facade)

- [Метод получения списка фасадов дома](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D1%84%D0%B0%D1%81%D0%B0%D0%B4%D0%BE%D0%B2-%D0%B4%D0%BE%D0%BC%D0%B0)

[floor](#floor)

- [Метод получения планировок этажей дома](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D0%BF%D0%BB%D0%B0%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%BE%D0%BA-%D1%8D%D1%82%D0%B0%D0%B6%D0%B5%D0%B9-%D0%B4%D0%BE%D0%BC%D0%B0)

[actions](#actions)

- [Метод получения списка активных акции со списком помещений по каждой акции](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%B0%D0%BA%D1%82%D0%B8%D0%B2%D0%BD%D1%8B%D1%85-%D0%B0%D0%BA%D1%86%D0%B8%D0%B8-%D1%81%D0%BE-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%BE%D0%BC-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B9-%D0%BF%D0%BE-%D0%BA%D0%B0%D0%B6%D0%B4%D0%BE%D0%B9-%D0%B0%D0%BA%D1%86%D0%B8%D0%B8)

[crm](#crm)

- [Метод получения списка сделок или конкретной сделки](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D1%81%D0%B4%D0%B5%D0%BB%D0%BE%D0%BA-%D0%B8%D0%BB%D0%B8-%D0%BA%D0%BE%D0%BD%D0%BA%D1%80%D0%B5%D1%82%D0%BD%D0%BE%D0%B9-%D1%81%D0%B4%D0%B5%D0%BB%D0%BA%D0%B8)
- [Метод получения списка сделок в которые добавлено конкретное помещение](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D1%81%D0%B4%D0%B5%D0%BB%D0%BE%D0%BA-%D0%B2-%D0%BA%D0%BE%D1%82%D0%BE%D1%80%D1%8B%D0%B5-%D0%B4%D0%BE%D0%B1%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%BE-%D0%BA%D0%BE%D0%BD%D0%BA%D1%80%D0%B5%D1%82%D0%BD%D0%BE%D0%B5-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B5)
- [Метод добавления помещения в сделку](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B4%D0%BE%D0%B1%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D1%8F-%D0%B2-%D1%81%D0%B4%D0%B5%D0%BB%D0%BA%D1%83)
- [Метод удаления помещений из сделки](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D1%83%D0%B4%D0%B0%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B9-%D0%B8%D0%B7-%D1%81%D0%B4%D0%B5%D0%BB%D0%BA%D0%B8)
- [Метод обновления полей Proftibase в сделке по помещению](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BE%D0%B1%D0%BD%D0%BE%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F-%D0%BF%D0%BE%D0%BB%D0%B5%D0%B9-Proftibase-%D0%B2-%D1%81%D0%B4%D0%B5%D0%BB%D0%BA%D0%B5-%D0%BF%D0%BE-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D1%8E)
- [Метод синхронизации статуса помещения с этапом сделки CRM согласно разметке статусов приложения CRM для Profitbase](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D1%81%D0%B8%D0%BD%D1%85%D1%80%D0%BE%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8-%D1%81%D1%82%D0%B0%D1%82%D1%83%D1%81%D0%B0-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81-%D1%8D%D1%82%D0%B0%D0%BF%D0%BE%D0%BC-%D1%81%D0%B4%D0%B5%D0%BB%D0%BA%D0%B8-CRM-%D1%81%D0%BE%D0%B3%D0%BB%D0%B0%D1%81%D0%BD%D0%BE-%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B5-%D1%81%D1%82%D0%B0%D1%82%D1%83%D1%81%D0%BE%D0%B2-%D0%BF%D1%80%D0%B8%D0%BB%D0%BE%D0%B6%D0%B5%D0%BD%D0%B8%D1%8F-CRM-%D0%B4%D0%BB%D1%8F-Profitbase)

[order](#order)

- [Метод создания заявки на помещение](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D1%8F-%D0%B7%D0%B0%D1%8F%D0%B2%D0%BA%D0%B8-%D0%BD%D0%B0-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B5)

[history](#history)

- [Метод получения истории изменения статусов помещений с возможностью фильтрации](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D0%B8%D1%81%D1%82%D0%BE%D1%80%D0%B8%D0%B8-%D0%B8%D0%B7%D0%BC%D0%B5%D0%BD%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D1%82%D0%B0%D1%82%D1%83%D1%81%D0%BE%D0%B2-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B9-%D1%81-%D0%B2%D0%BE%D0%B7%D0%BC%D0%BE%D0%B6%D0%BD%D0%BE%D1%81%D1%82%D1%8C%D1%8E-%D1%84%D0%B8%D0%BB%D1%8C%D1%82%D1%80%D0%B0%D1%86%D0%B8%D0%B8)

[statuses](#statuses)

- [Метод получения списка статусов для crm, или конкретного статуса по id](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D1%81%D1%82%D0%B0%D1%82%D1%83%D1%81%D0%BE%D0%B2-%D0%B4%D0%BB%D1%8F-crm-%D0%B8%D0%BB%D0%B8-%D0%BA%D0%BE%D0%BD%D0%BA%D1%80%D0%B5%D1%82%D0%BD%D0%BE%D0%B3%D0%BE-%D1%81%D1%82%D0%B0%D1%82%D1%83%D1%81%D0%B0-%D0%BF%D0%BE-id)

[filter](#filter)

- [Метод для получения списка отображаемых в виджете фильтров](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B4%D0%BB%D1%8F-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%BE%D1%82%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B0%D0%B5%D0%BC%D1%8B%D1%85-%D0%B2-%D0%B2%D0%B8%D0%B4%D0%B6%D0%B5%D1%82%D0%B5-%D1%84%D0%B8%D0%BB%D1%8C%D1%82%D1%80%D0%BE%D0%B2)
- [Метод для получения списка доступных отделок для отображения в фильтре по отделке](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B4%D0%BB%D1%8F-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%BD%D1%8B%D1%85-%D0%BE%D1%82%D0%B4%D0%B5%D0%BB%D0%BE%D0%BA-%D0%B4%D0%BB%D1%8F-%D0%BE%D1%82%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D1%8F-%D0%B2-%D1%84%D0%B8%D0%BB%D1%8C%D1%82%D1%80%D0%B5-%D0%BF%D0%BE-%D0%BE%D1%82%D0%B4%D0%B5%D0%BB%D0%BA%D0%B5)
- [Получить характеристики для фильтра](#%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B8%D1%82%D1%8C-%D1%85%D0%B0%D1%80%D0%B0%D0%BA%D1%82%D0%B5%D1%80%D0%B8%D1%81%D1%82%D0%B8%D0%BA%D0%B8-%D0%B4%D0%BB%D1%8F-%D1%84%D0%B8%D0%BB%D1%8C%D1%82%D1%80%D0%B0)

[property-specification](#property-specification)

- [Метод получения списка характеристик для помещений с количеством аналогичных помещений в доме](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D1%85%D0%B0%D1%80%D0%B0%D0%BA%D1%82%D0%B5%D1%80%D0%B8%D1%81%D1%82%D0%B8%D0%BA-%D0%B4%D0%BB%D1%8F-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B9-%D1%81-%D0%BA%D0%BE%D0%BB%D0%B8%D1%87%D0%B5%D1%81%D1%82%D0%B2%D0%BE%D0%BC-%D0%B0%D0%BD%D0%B0%D0%BB%D0%BE%D0%B3%D0%B8%D1%87%D0%BD%D1%8B%D1%85-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D0%B9-%D0%B2-%D0%B4%D0%BE%D0%BC%D0%B5)
- [Получить список всех характеристик](#%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B8%D1%82%D1%8C-%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D0%B2%D1%81%D0%B5%D1%85-%D1%85%D0%B0%D1%80%D0%B0%D0%BA%D1%82%D0%B5%D1%80%D0%B8%D1%81%D1%82%D0%B8%D0%BA)
- [Получить характеристики по дому](#%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B8%D1%82%D1%8C-%D1%85%D0%B0%D1%80%D0%B0%D0%BA%D1%82%D0%B5%D1%80%D0%B8%D1%81%D1%82%D0%B8%D0%BA%D0%B8-%D0%BF%D0%BE-%D0%B4%D0%BE%D0%BC%D1%83)

[queue-reserve](#queue-reserve)

- [Метод получения списка очереди бронирования по указанному помещению](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%BE%D1%87%D0%B5%D1%80%D0%B5%D0%B4%D0%B8-%D0%B1%D1%80%D0%BE%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F-%D0%BF%D0%BE-%D1%83%D0%BA%D0%B0%D0%B7%D0%B0%D0%BD%D0%BD%D0%BE%D0%BC%D1%83-%D0%BF%D0%BE%D0%BC%D0%B5%D1%89%D0%B5%D0%BD%D0%B8%D1%8E)
- [Метод для удаления сделки из очереди бронирования](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B4%D0%BB%D1%8F-%D1%83%D0%B4%D0%B0%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%B4%D0%B5%D0%BB%D0%BA%D0%B8-%D0%B8%D0%B7-%D0%BE%D1%87%D0%B5%D1%80%D0%B5%D0%B4%D0%B8-%D0%B1%D1%80%D0%BE%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F)
- [Метод для добавления сделки в очередь бронирования](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B4%D0%BB%D1%8F-%D0%B4%D0%BE%D0%B1%D0%B0%D0%B2%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%B4%D0%B5%D0%BB%D0%BA%D0%B8-%D0%B2-%D0%BE%D1%87%D0%B5%D1%80%D0%B5%D0%B4%D1%8C-%D0%B1%D1%80%D0%BE%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F)
- [Метод для изменения порядка сделок в очереди бронирования](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B4%D0%BB%D1%8F-%D0%B8%D0%B7%D0%BC%D0%B5%D0%BD%D0%B5%D0%BD%D0%B8%D1%8F-%D0%BF%D0%BE%D1%80%D1%8F%D0%B4%D0%BA%D0%B0-%D1%81%D0%B4%D0%B5%D0%BB%D0%BE%D0%BA-%D0%B2-%D0%BE%D1%87%D0%B5%D1%80%D0%B5%D0%B4%D0%B8-%D0%B1%D1%80%D0%BE%D0%BD%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D1%8F)

[render](#render)

- [Метод получения списка генпланов](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%B3%D0%B5%D0%BD%D0%BF%D0%BB%D0%B0%D0%BD%D0%BE%D0%B2)

[users](#users)

- [Метод для получения информации о пользователях](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B4%D0%BB%D1%8F-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F-%D0%B8%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D0%B8%D0%B8-%D0%BE-%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F%D1%85)
- [Метод для изменения прав пользователей](#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-%D0%B4%D0%BB%D1%8F-%D0%B8%D0%B7%D0%BC%D0%B5%D0%BD%D0%B5%D0%BD%D0%B8%D1%8F-%D0%BF%D1%80%D0%B0%D0%B2-%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D0%B5%D0%B9)
- [Инициализация сброса пароля для пользователя](#%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-%D1%81%D0%B1%D1%80%D0%BE%D1%81%D0%B0-%D0%BF%D0%B0%D1%80%D0%BE%D0%BB%D1%8F-%D0%B4%D0%BB%D1%8F-%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8F)

[stock-version](#stock-version)

- [Получить изменения по версиям](#%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B8%D1%82%D1%8C-%D0%B8%D0%B7%D0%BC%D0%B5%D0%BD%D0%B5%D0%BD%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%B2%D0%B5%D1%80%D1%81%D0%B8%D1%8F%D0%BC)

---

### ⚠️ Примечание о непроверенных методах

[](#️-примечание-о-непроверенных-методах)

На реальном API была проверена работоспособность **только идемпотентных методов** (выполняющих безопасные операции не изменяющие состояние системы). Это связано с тем, что тестирование проводилось с **доступом только на чтение**.

Методы, выполнение которых изменяет состояние данных, **не были проверены на реальном API**. Такие методы в документации помечены специальным образом: ⚠️ *Не проверено на реальном API*.

---

### auth

[](#auth)

---

#### Авторизация

[](#авторизация)

Метод для аутентификации. Возвращает access\_token для доступа к API.

⚠️ **Примечание:** вызов `auth()` **не обязателен** — клиент **автоматически** обрабатывает получение, обновление и передачу `access_token` при каждом запросе.

**Эндпоинт:** `POST /authentication`

**Сигнатура:**

```
auth(string $apiKey): ResponseInterface
```

**Пример вызова:**

```
$client->auth('app-some-key');
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### houses

[](#houses)

---

#### Метод получения списка домов с возможностью фильтрации

[](#метод-получения-списка-домов-с-возможностью-фильтрации)

**Эндпоинт:** `GET /house`

**Сигнатура:**

```
houses(array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->houses(['isArchive' => false]);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод получения количества этажей в конкретном доме

[](#метод-получения-количества-этажей-в-конкретном-доме)

**Эндпоинт:** `GET /house/get-count-floors`

**Сигнатура:**

```
houseFloorCount(int $houseID, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->houseFloorCount(houseID: 12345);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод получения количества помещений в конкретном доме на конкретном этаже

[](#метод-получения-количества-помещений-в-конкретном-доме-на-конкретном-этаже)

**Эндпоинт:** `/house/get-count-properties-on-floor`

**Сигнатура:**

```
houseFloorPropertyCount(int $houseID, int $floor, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->houseFloorPropertyCount(houseID: 12345, floor: 5);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Устаревший метод v3 получения списка домов

[](#устаревший-метод-v3-получения-списка-домов)

**Эндпоинт:** ` /projects/{projectId}/houses`

**Сигнатура:**

```
housesLegacyV3(int $projectID, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->housesLegacyV3(projectID: 789);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод создания дома в существующий ЖК

[](#метод-создания-дома-в-существующий-жк)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `POST /house`

**Сигнатура:**

```
houseCreate(array $body, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->houseCreate(['title' => 'Корпус 1', 'projectId' => 789]);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод обновления данных в конкретном доме

[](#метод-обновления-данных-в-конкретном-доме)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `PUT /houses/{id}`

**Сигнатура:**

```
houseUpdate(int $houseID, array $body, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->houseUpdate(12345, ['title' => 'Корпус 1А']);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод для поиска домов по названию, адресу и названию ЖК

[](#метод-для-поиска-домов-по-названию-адресу-и-названию-жк)

**Эндпоинт:** `GET /houses/search`

**Сигнатура:**

```
housesSearch(string $searchQuery, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->housesSearch('Корпус 1');
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### projects

[](#projects)

---

#### Метод получения списка ЖК

[](#метод-получения-списка-жк)

**Эндпоинт:** `GET /projects`

**Сигнатура:**

```
projects(?bool $isArchive = null, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->projects(isArchive: false);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод создания ЖК

[](#метод-создания-жк)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `POST /projects`

**Сигнатура:**

```
projectCreate(array $body, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->projectCreate(['title' => 'Новомосковский', 'type' => 'complex']);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод обновления ЖК

[](#метод-обновления-жк)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `PUT /projects/{id}`

**Сигнатура:**

```
projectUpdate(int $projectID, array $body, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->projectUpdate(789, ['title' => 'Квартальный', 'type' => 'quarter']);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод для поиска ЖК по названию, адресу и названию дома, названию застройщика

[](#метод-для-поиска-жк-по-названию-адресу-и-названию-дома-названию-застройщика)

**Эндпоинт:** `GET /projects/search`

**Сигнатура:**

```
projectsSearch(string $searchQuery, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->projectsSearch('Новомосковский');
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### properties

[](#properties)

---

#### Метод получения списка помещений с возможностью фильтрации

[](#метод-получения-списка-помещений-с-возможностью-фильтрации)

**Эндпоинт:** `GET /property`

**Сигнатура:**

```
properties(array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->properties(['status[]' => ['AVAILABLE', 'BOOKED']]);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод создания помещения в конкретный дом

[](#метод-создания-помещения-в-конкретный-дом)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `POST /properties`

**Сигнатура:**

```
propertyCreate(array $body, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->propertyCreate([
    'house_id' => 1,
    'number' => 'A101',
    'rooms_amount' => 3,
    'section' => '1',
    'floor' => 11,
    'status' => 'AVAILABLE',
    "area" => [
        "area_total" => 60.2,
        "area_estimated" => 60.2,
        "area_living" => 60.2,
        "area_kitchen" => 60.2,
        "area_balcony" => 60.2,
        "area_without_balcony" => 60.2
    ],
]);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод обновления данных в конкретном помещении

[](#метод-обновления-данных-в-конкретном-помещении)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `PATCH /properties/{propertyId}`

**Сигнатура:**

```
propertyUpdate(int $propertyID, array $body, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->propertyUpdate(56789, ['status' => 'SOLD']);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод получения списка типов помещений и их дополнительных полей

[](#метод-получения-списка-типов-помещений-и-их-дополнительных-полей)

**Эндпоинт:** `GET /property-types`

**Сигнатура:**

```
propertyTypes(array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->propertyTypes();
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод получения списка помещений привязанных к конкретной сделке

[](#метод-получения-списка-помещений-привязанных-к-конкретной-сделке)

**Эндпоинт:** `GET /property/deal/{dealId}`

**Сигнатура:**

```
propertyDealList(int $dealID, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->propertyDealList(dealID: 112233);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод получения истории изменения статусов по конкретному помещению

[](#метод-получения-истории-изменения-статусов-по-конкретному-помещению)

**Эндпоинт:** `GET /property/history/{propertyId}`

**Сигнатура:**

```
propertyHistory(
    int $propertyID,
    ?int $offset = null,
    ?int $limit = null,
    array $queryParams = []
): ResponseInterface
```

**Пример вызова:**

```
$client->propertyHistory(56789, offset: 0, limit: 10);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Устаревший метод v3 получения списка помещений в конкретном доме

[](#устаревший-метод-v3-получения-списка-помещений-в-конкретном-доме)

**Эндпоинт:** `GET /projects/{projectId}/houses/{houseId}/properties/list`

**Сигнатура:**

```
propertiesLegacyV3(int $projectID, int $houseID, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->propertiesLegacyV3(projectID: 123, houseID: 456);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод получения списка сделок привязанных к конкретным помещениям

[](#метод-получения-списка-сделок-привязанных-к-конкретным-помещениям)

**Эндпоинт:** `GET /get-property-deals`

**Сигнатура:**

```
propertyDeals(array $propertyIDs, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->propertyDeals([56789, 56790]);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод изменения статуса помещения

[](#метод-изменения-статуса-помещения)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `POST /properties/{id}/status-change`

**Сигнатура:**

```
propertyStatusChange(int $propertyID, array $body, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->propertyStatusChange(56789, ['status' => 'UNAVAILABLE']);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод продления брони в конкретном помещении

[](#метод-продления-брони-в-конкретном-помещении)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `PATCH /reserve/prolong`

**Сигнатура:**

```
reserveProlong(array $body, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->reserveProlong(['propertyId' => 56789, 'date' => '2025-11-16 12:00']);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### board

[](#board)

---

#### Метод получения шахматки дома

[](#метод-получения-шахматки-дома)

**Эндпоинт:** `GET /board`

**Сигнатура:**

```
board(int $houseID, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->board(houseID: 12345);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### presets

[](#presets)

---

#### Метод получения планировок помещений с возможностью фильтрации

[](#метод-получения-планировок-помещений-с-возможностью-фильтрации)

**Эндпоинт:** `GET /plan`

**Сигнатура:**

```
plans(array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->plans(['projectId' => 123]);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Устаревший метод получения планировок помещений в доме

[](#устаревший-метод-получения-планировок-помещений-в-доме)

**Эндпоинт:** `GET /projects/{projectId}/houses/{houseId}/presets`

**Сигнатура:**

```
presetsLegacy(int $projectID, int $houseID, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->presetsLegacy(projectID: 789, houseID: 12345);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### facade

[](#facade)

---

#### Метод получения списка фасадов дома

[](#метод-получения-списка-фасадов-дома)

**Эндпоинт:** `GET /facade`

**Сигнатура:**

```
facades(int $houseID, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->facades(houseID: 12345);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### floor

[](#floor)

---

#### Метод получения планировок этажей дома

[](#метод-получения-планировок-этажей-дома)

**Эндпоинт:** `GET /floor`

**Сигнатура:**

```
floors(int $houseID, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->floors(houseID: 12345);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### actions

[](#actions)

---

#### Метод получения списка активных акции со списком помещений по каждой акции

[](#метод-получения-списка-активных-акции-со-списком-помещений-по-каждой-акции)

**Эндпоинт:** `GET /special-offer`

**Сигнатура:**

```
specialOffers(
    ?bool $isArchived = null,
    ?bool $isDiscounted = null,
    array $queryParams = []
): ResponseInterface
```

**Пример вызова:**

```
$client->specialOffers(isArchived: false, isDiscounted: true);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### crm

[](#crm)

---

#### Метод получения списка сделок или конкретной сделки

[](#метод-получения-списка-сделок-или-конкретной-сделки)

**Эндпоинт:** `GET /crm/deals`

**Сигнатура:**

```
crmDeals(?int $dealID = null, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->crmDeals(dealID: 112233);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод получения списка сделок в которые добавлено конкретное помещение

[](#метод-получения-списка-сделок-в-которые-добавлено-конкретное-помещение)

**Эндпоинт:** `GET /crm/deals/property/{propertyId}`

**Сигнатура:**

```
crmPropertyDeals(int $propertyID, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->crmPropertyDeals(56789);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод добавления помещения в сделку

[](#метод-добавления-помещения-в-сделку)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `POST /crm/addPropertyDeal`

**Сигнатура:**

```
crmPropertyDealAdd(array $body, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->crmPropertyDealAdd(['dealId' => 112233, 'propertyId' => 56789]);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод удаления помещений из сделки

[](#метод-удаления-помещений-из-сделки)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `POST /crm/removePropertyDeal`

**Сигнатура:**

```
crmPropertyDealRemove(int $dealID, array $body = [], array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->crmPropertyDealRemove(dealID: 112233);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод обновления полей Proftibase в сделке по помещению

[](#метод-обновления-полей-proftibase-в-сделке-по-помещению)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `GET /crm/update/deal/{dealId}/property/{propertyId} `**Сигнатура:**

```
crmDealPropertyUpdate(int $dealID, int $propertyID, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->crmDealPropertyUpdate(dealID: 112233, propertyID: 56789);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод синхронизации статуса помещения с этапом сделки CRM согласно разметке статусов приложения CRM для Profitbase

[](#метод-синхронизации-статуса-помещения-с-этапом-сделки-crm-согласно-разметке-статусов-приложения-crm-для-profitbase)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `GET /crm/syncPropertyStatus`

**Сигнатура:**

```
crmPropertyStatusSync(int $dealID, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->crmPropertyStatusSync(dealID: 112233);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### order

[](#order)

---

#### Метод создания заявки на помещение

[](#метод-создания-заявки-на-помещение)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `POST /orders`

**Сигнатура:**

```
orderCreate(array $body, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->orderCreate([
	'order' => [
		'name' => 'TEST',
		'phone' => '+79111111111',
		'email' => 'test@profitbase.ru',
		'apartment_id' => 248408,
		'calc_credit' => 1,
		'comment' => 'тестовая заявка',
		'widget_id' => 1
	]
]);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### history

[](#history)

---

#### Метод получения истории изменения статусов помещений с возможностью фильтрации

[](#метод-получения-истории-изменения-статусов-помещений-с-возможностью-фильтрации)

**Эндпоинт:** `POST /history`

**Сигнатура:**

```
history(array $body, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->history([
    'offset' => 0,
    'limit' => 20,
    'property_ids' => [
        3225787,
        3225788
    ],
    'from' => '2023-03-01 10:56:15',
    'to' => '2023-03-02 07:20:50',
]);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### statuses

[](#statuses)

---

#### Метод получения списка статусов для crm, или конкретного статуса по id

[](#метод-получения-списка-статусов-для-crm-или-конкретного-статуса-по-id)

**Эндпоинт:** `GET /custom-status/list`

**Сигнатура:**

```
customStatuses(string $crmID, ?string $statusID = null, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->customStatuses('bitrix');
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### filter

[](#filter)

---

#### Метод для получения списка отображаемых в виджете фильтров

[](#метод-для-получения-списка-отображаемых-в-виджете-фильтров)

**Эндпоинт:** `GET /filter`

**Сигнатура:**

```
filters(array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->filters();
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод для получения списка доступных отделок для отображения в фильтре по отделке

[](#метод-для-получения-списка-доступных-отделок-для-отображения-в-фильтре-по-отделке)

**Эндпоинт:** `GET /filter/facings`

**Сигнатура:**

```
filterFacings(array $houseIDs = [], array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->filterFacings([12345, 12346]);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Получить характеристики для фильтра

[](#получить-характеристики-для-фильтра)

**Эндпоинт:** `GET /filter/property-specifications`

**Сигнатура:**

```
filterPropertySpecifications(array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->filterPropertySpecifications();
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### property-specification

[](#property-specification)

---

#### Метод получения списка характеристик для помещений с количеством аналогичных помещений в доме

[](#метод-получения-списка-характеристик-для-помещений-с-количеством-аналогичных-помещений-в-доме)

**Эндпоинт:** `/property-specification`

**Сигнатура:**

```
propertySpecifications(array $propertyIDs = [], array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->propertySpecifications([56789, 56790]);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Получить список всех характеристик

[](#получить-список-всех-характеристик)

**Эндпоинт:** `GET /property-specification/list`

**Сигнатура:**

```
propertySpecificationList(array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->propertySpecificationList();
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Получить характеристики по дому

[](#получить-характеристики-по-дому)

**Эндпоинт:** `GET /property-specification/house`

**Сигнатура:**

```
propertySpecificationHouse(int $houseID, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->propertySpecificationHouse(houseID: 12345);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### queue-reserve

[](#queue-reserve)

---

#### Метод получения списка очереди бронирования по указанному помещению

[](#метод-получения-списка-очереди-бронирования-по-указанному-помещению)

**Эндпоинт:** `GET /queue-reserve/list`**Сигнатура:**

```
queueReserveList(int $propertyID, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->queueReserveList(propertyID: 56789);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод для удаления сделки из очереди бронирования

[](#метод-для-удаления-сделки-из-очереди-бронирования)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `POST /queue-reserve/delete`

**Сигнатура:**

```
queueReserveDelete(
    int $dealQueueItemID,
    array $body = [],
    array $queryParams = []
): ResponseInterface
```

**Пример вызова:**

```
$client->queueReserveDelete(dealQueueItemID: 123456);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод для добавления сделки в очередь бронирования

[](#метод-для-добавления-сделки-в-очередь-бронирования)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `POST /queue-reserve`

**Сигнатура:**

```
queueReserveCreate(
    int $propertyID,
    int|string $dealID,
    array $body = [],
    array $queryParams = []
): ResponseInterface
```

**Пример вызова:**

```
$client->queueReserveCreate(propertyID: 56789, dealID: 112233);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод для изменения порядка сделок в очереди бронирования

[](#метод-для-изменения-порядка-сделок-в-очереди-бронирования)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `POST /queue-reserve/change-position`

**Сигнатура:**

```
queueReserveChangePosition(
    int $sourceDealQueueItemID,
    int $targetDealQueueItemID,
    array $body = [],
    array $queryParams = []
): ResponseInterface
```

**Пример вызова:**

```
$client->queueReserveChangePosition(12456, 124);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### render

[](#render)

---

#### Метод получения списка генпланов

[](#метод-получения-списка-генпланов)

**Эндпоинт:** `GET /render`

**Сигнатура:**

```
renders(?int $projectID = null, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->renders(projectID: 789);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### users

[](#users)

---

#### Метод для получения информации о пользователях

[](#метод-для-получения-информации-о-пользователях)

**Эндпоинт:** `GET /user/info`

**Сигнатура:**

```
userInfo(array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->userInfo(['email' => 'some_email@test.com']);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Метод для изменения прав пользователей

[](#метод-для-изменения-прав-пользователей)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `PATCH /user/{userId}/access`

**Сигнатура:**

```
userAccessUpdate(int $userID, array $body, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->userAccessUpdate(
    334455,
    [
        'isAccountAccessEnabled' => 'true',
        'isUsersSectionAccessEnabled' => 'true',
        'isObjectsSectionAccessEnabled' => 'true'
    ]
);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

#### Инициализация сброса пароля для пользователя

[](#инициализация-сброса-пароля-для-пользователя)

⚠️ *Не проверено на реальном API*

**Эндпоинт:** `GET /user/{userId}/password/forgot`

**Сигнатура:**

```
userPasswordForgot(int $userID, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->userPasswordForgot(userID: 334455);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

---

### stock-version

[](#stock-version)

---

#### Получить изменения по версиям

[](#получить-изменения-по-версиям)

**Эндпоинт:** `POST /versions/find`

**Сигнатура:**

```
stockVersionsFind(array $body, array $queryParams = []): ResponseInterface
```

**Пример вызова:**

```
$client->stockVersionsFind([
    'ids' => [
        12345,
        12346
    ],
    'fields' => [
        'price',
        'status'
    ]
]);
```

[⤴ Вернуться к навигации по методам](#%D0%9D%D0%B0%D0%B2%D0%B8%D0%B3%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0%D0%BC-%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%B0-%D0%BA-Profitbase-API)

Обратная связь
--------------

[](#обратная-связь)

Если вы нашли ошибку или хотите предложить улучшение — создайте [issue](https://github.com/Kenny-MGN/profitbase-php-client/issues/new).

Лицензия
--------

[](#лицензия)

Проект распространяется под лицензией [MIT](LICENSE).

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance70

Regular maintenance activity

Popularity7

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

199d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/1c53944035b7e8068443de239a0c875ac425a9b70076a6350c115f889ebdc9ba?d=identicon)[Kenny-MGN](/maintainers/Kenny-MGN)

---

Top Contributors

[![Kenny-MGN](https://avatars.githubusercontent.com/u/42201186?v=4)](https://github.com/Kenny-MGN "Kenny-MGN (2 commits)")

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/kenny-mgn-profitbase-php-client/health.svg)

```
[![Health](https://phpackages.com/badges/kenny-mgn-profitbase-php-client/health.svg)](https://phpackages.com/packages/kenny-mgn-profitbase-php-client)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)