Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


Code Block

Understanding the API via the UI

Everything you can do in the UI, can also be done via the API. Open up the dev tools in the browser, switch to the Network panel, then do the action you want in the UI and observe the API requests that complete the action in the Network panel.

You may notice that some parts of the API (like adding organisation roles to users) currently only support user-based authentication rather than client-based authentication. Should you need to use these APIs right now, you can actually get a JWT token for the user and use that to authenticate. Look at the login flow in the network panel, and pay attention to the JWT we return when you login AND when you access an org. Those are the bearer tokens (depending on whether you are at the site, or org level).


Below are details of the Postman Collections and Environment that you can use.