Overview
The REST API Playground is a built-in testing interface that lets you interact with Groundhogg’s REST API directly from your WordPress dashboard — no external tools like Postman required.
It provides a visual way to explore, test, and debug API endpoints using real data from your site.
It also serves as our Rest API Documentation, and provides specifics on most of Groundhogg’s endpoints.
You can get to the Rest API Playground by going to Groundhogg » Tools » Rest API Playground.
Endpoints for Add-ons
When using add-ons like Companies, Sales Pipeline, and the Booking Calendar, you’ll see additional endpoints appear in the playground.
FAQs / Troubleshooting
Q: Are ALL endpoints documented and available in the playground?
A: There are some uncommon endpoints that are not yet available in the playground because they are mostly for internal usage. If you need to see the full list of available endpoints for your site enter https://yoursite.com/wp-json/gh/v4/ into the URL bar of your browser. If you add your own custom endpoints those will also not be visible in the playground.
Q: Why can’t I edit flows via the API?
A: Flows are highly specialized, and while technically possible to edit them via the API it would require a lot of specialized tooling, and would be very error-prone. Best to add/edit them with the UI.
Q: Can I see past requests or log API traffic?
A: The playground doesn’t store request history, but you can view logs by using a plugin like Query Monitor or setting up server-side logging for the REST API.
Was this helpful?
Let us know if this document answered your question. That’s the only way we can improve.