Exploring API Requests and Responses

The easiest way to explore the API is by using the admin panel as a reference.

The API against which you are developing is the same as the API that powers the Pakk admin panel used by tenants to conduct their day-to-day business. Effectively, this means that every interaction that can be performed via the admin panel, which is basically everything, can also be completed via the API.

The easiest way to explore the API and understand the shape of requests and responses is by using the admin panel as a reference. There are two main ways in which this can be achieved.

Show API Field Paths (Simple)

• Click on your profile picture/email address and in the admin panel settings panel that appears, toogle 'Show API Field Paths'.

• All fields will now display an extra label with the name of the field as it will appear in API requests and responses.

Inspect Requests and Responses

Arguably, the easiest way to get comfortable with the API is to observe how the admin panel uses it. Open your dev tools, go to the network tab and observe how actions in the admin panel are relayed via the API. Whatever the admin panel can do, so can you!