👓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.

📄API Documentation

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.

An example of a group of endpoints in the side navigation menu

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

An example of the main page for a specific endpoint

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