# 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="https://970086564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F64M46VyTVjy4JXpxfk6s%2Fuploads%2FIul3LfEUGgUANoAv0Fpp%2Fimage.png?alt=media&#x26;token=92ec5c4c-5ce7-40ec-bcc0-7e355403a0e6" 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="https://970086564-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F64M46VyTVjy4JXpxfk6s%2Fuploads%2FKk3hdIyKppfTAuQxkNjD%2Fimage.png?alt=media&#x26;token=65e23706-97ee-4681-babd-0c1d115f4b40" 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.