# Using The API Reference

The top of this User Guide contains a link to the documentation for Plannr API which details all possible endpoints that can be consumed. The API follows a typical REST architecture, with most endpoints returning a JSON resource.

{% hint style="info" %}
[📄API Documentation](https://apidocs.plannrcrm.com/)
{% endhint %}

Endpoints are grouped based on the area of Plannr that they affect. Each endpoint has a tag for what type of HTTP request it needs to be, as well as a small description to describe what the endpoint does.

<figure><img src="/files/p0vjspjAcTyE9JaNalHQ" alt=""><figcaption><p>An example of a group of endpoints in the side navigation menu</p></figcaption></figure>

Upon clicking an endpoint in the navigation bar, the documentation will display the endpoint question and all relevant information for that endpoint.

<figure><img src="/files/FWMx5HAdu99InG0IGpSc" alt=""><figcaption><p>An example of the main page for a specific endpoint</p></figcaption></figure>

The search bar can also be utilised to search for specific endpoints, parameters, or response data.


---

# 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://api-how-to.plannrcrm.com/basics/using-the-documentation.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.