# Welcome!

API-интерфейс предназначен для обмена данными между сервисами FreshOffice и внешними клиентами.

Доступ к API осуществляется по протоколу Open Data Protocol. OData — это стандартизованный протокол, специально предназначенный для использования в системах API. 

Приведённые в описании примеры иллюстрируют некоторые полезные возможности OData в части выборки и представления данных, однако сами по себе эти примеры не являются достаточными для полного понимания принципов работы OData.

В большинстве случаев FreshOffice API соответствует протоколу OData, за исключением следующих моментов:

* Вывод данных осуществляется только в формате JSON, форматы XML и ATOM не поддерживаются;
* Поля метаданных ("\_\_metadata") и связанных сущностей ("\_\_deferred") не выводятся;

{% hint style="success" %}
**Внимание:** документация описывает устройство новой версии API, расположенного по адресу [**do.freshoffice.ru**](https://do.freshoffice.ru/welcome)  
{% endhint %}

{% hint style="warning" %}
Если вы используете предыдущею версию API  api.myfreshcloud.com, документация здесь [https://freshofficeapi.docs.apiary.io/#](https://freshofficeapi.docs.apiary.io)
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidoc.myfreshcloud.com/welcome.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.