> For the complete documentation index, see [llms.txt](https://docs.brokvix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.brokvix.com/rest-api.md).

# REST API reference

This area is for developers integrating approved Brokvix CRM APIs. It is an **API reference**, not a guide to using the Client Portal or Admin Portal. The first reference collection will cover client-facing operations; mobile-specific contracts will be added only where they differ from the approved client contract.

* [Client API reference](/rest-api/client-api.md) — the planned operation collection and its current publication status.
* [Contract and compatibility](/rest-api/contract-and-compatibility.md) — how supported operations, versions, authentication, errors, and changes are defined.

An endpoint used by a browser or mobile app is not automatically a supported third-party integration endpoint. The operation reference will be generated from a reviewed OpenAPI specification and will include only approved operations. Until that specification is published here, do not treat this section as a complete implementation contract.

If you are trying to **use** a broker portal rather than integrate software, go to the [Client Portal](/crm-client.md). If you configure tenants and brands, go to the [Admin Portal](/crm-admin/platform-configuration.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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 following URL with the `ask` and `goal` query parameters:

```
GET https://docs.brokvix.com/rest-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

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.