Поселково

Справочник

Собран из кода: каждая возможность объявлена один раз, и эта страница — её же описание. Разойтись с тем, что сервер действительно принимает, она не может.
Эндпоинтов: 85Скачать OpenAPI 3.1

Common

GET
/api/v1/settlements/{settlement}/tagged/{tag}
Lists everything in a settlement carrying one tag — articles, photographs, objects, tasks, contacts, parcels — newest first with keyset pagination, each with its type, identifier and current title. Tags are the residents' own words: the same «стройка» on a photograph and on a diary entry is what ties them together. Narrow to one type when only, say, the photographs are wanted.
Инструмент MCPlist_tagged
Скоупбез токена
MCP-серверы
публичный каталог
житель
поселок
платформа
Параметры
ПолеТипОбязательноЧто это
settlement
в адресе
stringда
The settlement, by the identifier from list_settlements.
tag
в адресе
stringда
The tag, as its slug or as typed — «туи», «стройка».
type
enumнет
Only things of one type: `article`, `media`, `parcel_object`, `task`, `contact`, `parcel`.
Значения
contact
company
article
media
parcel_object
task
parcel
knowledge_article
cursor
string | nullнет
Where the previous page ended, exactly as the previous response returned it. Omit for the first page.
Пример запроса
{
  "type": "contact",
  "cursor": "cursor"
}
Пример ответа
{
  "tag": {
    "slug": "стройка",
    "name": "Стройка"
  },
  "items": [
    {
      "type": "article",
      "id": "7331894216458250",
      "title": "Первый день на участке"
    },
    {
      "type": "media",
      "id": "7331894216458280",
      "title": "Котлован"
    },
    {
      "type": "parcel_object",
      "id": "7331894216458260",
      "title": "Скважина"
    }
  ],
  "cursor": "7331894216458300"
}

Company

Device

Journal

Knowledge

Media

Messenger

Notification

GET
/api/v1/notifications
Lists what the platform has told the current account — a decision on a correction they proposed, and in time a claim reviewed or an import finished — newest first, with keyset pagination and a count of the unread ones. Each entry carries a translation key and its replacements rather than a ready sentence, because the wording lives in the interface and changes with it: render the key, or say what the topic and the subject are. Use read_notification once the person has been told.
Инструмент MCPlist_notifications
Скоупmcp:read
MCP-серверы
житель
поселок
платформа
Параметры
ПолеТипОбязательноЧто это
cursor
integer | nullнет
The identifier of the last notification of the previous page. Omit for the first page; the response returns the next one.
Пример запроса
{
  "cursor": 1
}
Пример ответа
{
  "notifications": [
    {
      "id": "7331894216458240",
      "topic": "my_requests",
      "key": "notifications.proposal_approved",
      "replacements": {
        "subject": "Кровля Плюс"
      },
      "url": "/settlements/sosnovy-bereg/contacts/krovlya-plyus",
      "created_at": "2026-09-08T14:12:00+03:00",
      "read": false
    }
  ],
  "cursor": null,
  "unread": 1
}
POST
/api/v1/notifications/{notification}/read
Marks one of the current account's notifications as seen, by the identifier list_notifications returned, and answers with how many are left unread. Use it after telling the person what a notification said, so the bell in their browser stops counting it. Marking one that is already read changes nothing and is not an error.
Инструмент MCPread_notification
Скоупmcp:write
MCP-серверы
житель
поселок
платформа
Параметры
ПолеТипОбязательноЧто это
notification
в адресе
integerда
The notification, as the feed returned it.
Пример ответа
{
  "read": true,
  "unread": 0
}
POST
/api/v1/notifications/preferences
Chooses which notifications the current account gets and through which ways. A topic is the account's part in the story: my_requests is what became of what it filed, review_queue is what waits for its decision, reminders is what the product reminds it of on its own schedule. A way is how: in_app is the bell in the interface, mail is a letter. Letters the account needs — a password reset, the address confirmation — are not topics and cannot be switched off here. Everything is on until it is switched off, and what is not named is left as it was. Answers with the whole set of preferences as they now stand.
Инструмент MCPset_notification_preferences
Скоупmcp:write
MCP-серверы
житель
поселок
платформа
Параметры
ПолеТипОбязательноЧто это
channels
arrayнет
A way, everywhere: {"in_app": true}. Names come from the notification_channel enum.
topics
arrayнет
A topic's own answer per way: {"my_requests": {"in_app": false}}. Names come from the notification_topic enum.
Пример запроса
{
  "channels": [],
  "topics": []
}
Пример ответа
{
  "channels": {
    "in_app": true
  },
  "topics": {
    "my_requests": {
      "in_app": true
    }
  }
}

Parcel

Proposal

Review

GET
/api/v1/settlements/{settlement}/reviews
Lists what residents wrote about one directory contact or one registered company: the grade each of them gave, in their own words where they wrote any, and the photographs of the work where they attached any. Use it after list_contacts, with the same identifier, to answer why a contact is graded as they are. Every verdict says whether its author claims to have hired the contact — their own claim — and whether we confirmed them as a resident of the settlement, which is ours. Most verdicts are published to the settlement's residents rather than publicly, so a call without an account may come back empty on a contact that has grades.
Инструмент MCPlist_reviews
Скоупбез токена
MCP-серверы
публичный каталог
житель
поселок
платформа
Параметры
ПолеТипОбязательноЧто это
settlement
в адресе
stringда
The settlement whose shard the verdicts live on, by the identifier from list_settlements.
subject_type
enumда
What sort of subject: a directory contact, or a company from the register.
Значения
contact
company
subject_id
integerда
The subject, as the directory returned it.
cursor
integer | nullнет
The identifier of the last verdict of the previous page. Omit for the first page; the response returns the next one.
Пример запроса
{
  "subject_type": "contact",
  "subject_id": 1,
  "cursor": 1
}
Пример ответа
{
  "reviews": [
    {
      "id": "7331894216458244",
      "medal": "gold",
      "body": "Крыли крышу в июне, уложились в срок, за год ни одной протечки.",
      "author": "Пётр С.",
      "has_used_service": true,
      "is_verified_resident": true,
      "is_verified_work": false,
      "visibility": "residents",
      "photos": [
        {
          "id": "7331894216458245",
          "path": "image/directory/c3/d4/roof-june.webp",
          "caption": "Через год после работы"
        }
      ],
      "created_at": "2026-09-07T12:30:00+03:00"
    },
    {
      "id": "7331894216458243",
      "medal": "silver",
      "body": null,
      "author": "Ирина М.",
      "has_used_service": true,
      "is_verified_resident": true,
      "is_verified_work": false,
      "visibility": "residents",
      "photos": [],
      "created_at": "2026-09-05T09:14:00+03:00"
    }
  ],
  "cursor": "7331894216458243"
}
POST
/api/v1/settlements/{settlement}/reviews
Records the current account's verdict on a directory contact or a registered company, as one of four grades: gold, silver, bronze, or a fourth grade for "do not". Gold and the fourth grade are worth ten times silver and silver ten times bronze, because the top and bottom grades mean conviction and the middle ones mean hesitation. Words are optional — a grade on its own is a complete verdict. Only a confirmed resident of the settlement may grade, one grade per subject: posting again replaces the earlier one rather than adding to it.
Инструмент MCPpost_review
Скоупmcp:write
MCP-серверы
житель
Параметры
ПолеТипОбязательноЧто это
settlement
в адресе
stringда
The settlement this verdict is written in, by the identifier from list_settlements.
subject_type
enumда
What is being graded: a directory contact, or a company from the register.
Значения
contact
company
subject_id
integerда
The identifier of the thing being graded, as the directory returned it.
medal
enumда
The verdict. Gold and the fourth grade mean conviction; silver and bronze mean "good, but I am not signing my name to more than that".
Значения
gold
silver
bronze
dung
body
string | nullнет
Why, in the person's own words. Optional — a medal alone is a complete verdict.
has_used_service
boolean | nullнет
Whether the person actually hired this contact rather than only having heard about them. Shown as their own claim, not as anything we checked.
visibility
enumнет
Who may read it. Defaults to the settlement's residents.
Значения
private
residents
settlement
public
Пример запроса
{
  "subject_type": "contact",
  "subject_id": 1,
  "medal": "gold",
  "body": "body",
  "has_used_service": true,
  "visibility": "private"
}
Пример ответа
{
  "data": {
    "id": "7331894216458244",
    "settlement_id": "7331894216458240",
    "subject_type": "contact",
    "subject_id": "7331894216458242",
    "medal": "gold",
    "weight": 1,
    "body": "Крыли крышу в июне, уложились в срок, за год ни одной протечки.",
    "has_used_service": true,
    "is_verified_resident": true,
    "is_verified_work": false,
    "visibility": "residents",
    "moderation_status": "published",
    "created_at": "2026-09-07T12:30:00+03:00",
    "updated_at": "2026-09-07T12:30:00+03:00"
  }
}
DELETE
/api/v1/settlements/{settlement}/reviews
Removes the current account's own verdict on a directory contact or a registered company, and rewinds the subject's rating as though it had never been given. Use it for a grade that should not have been given at all — the wrong contact, a mistake. To change a grade rather than remove it, call post_review again: it replaces the standing one. Only the author's own verdict can be reached, so this cannot be used on somebody else's.
Инструмент MCPwithdraw_review
Скоупmcp:write
MCP-серверы
житель
Параметры
ПолеТипОбязательноЧто это
settlement
в адресе
stringда
The settlement the verdict was written in, by the identifier from list_settlements.
subject_type
enumда
What sort of subject: a directory contact, or a company from the register.
Значения
contact
company
subject_id
integerда
The subject, as the directory returned it.
Пример запроса
{
  "subject_type": "contact",
  "subject_id": 1
}
Пример ответа
{
  "withdrawn": true
}

Settlement

Task

User

POST
/api/v1/settings/interface
Changes how the product is drawn for the account making the call: which parts of the shell stay on screen while a page scrolls, and which set of colours it is drawn in. Reach for it when somebody asks to change the look of the interface rather than the data in it.
Инструмент MCPsave_interface_settings
Скоупmcp:write
MCP-серверы
платформа
поселок
компания
житель
Параметры
ПолеТипОбязательноЧто это
sticky_header
booleanнет
Whether the header stays on screen while a page scrolls.
sticky_sidebar
booleanнет
Whether the sidebar stays on screen while a page scrolls.
assistant_width
integer | nullнет
The assistant panel's width in pixels, null for the component's own.
skin
string | nullнет
The skin this account prefers, null while it has never chosen.
objects_view
string | nullнет
How the plot's inventory is read: `table` or `tiles`, null while never chosen.
Пример запроса
{
  "sticky_header": true,
  "sticky_sidebar": true,
  "assistant_width": 1,
  "skin": "skin",
  "objects_view": "objects_view"
}
Пример ответа
{
  "sticky_header": true,
  "sticky_sidebar": true,
  "assistant_width": 420,
  "skin": "grey",
  "objects_view": "tiles"
}