Use OAuth 2.0 to securely authorize Acadimiat access to the SaaS API and control scopes.
Admin setup and token management for Acadimiat to access the SaaS API.
Endpoint 1 GET /oauth/installedLocations retrieves installed locations for the account; Endpoint 2 oauth.write grants write access; Endpoint 3 POST /oauth/locationToken creates a location token; Endpoint 4 saas/location.write updates location data; Endpoint 5 PUT /update-saas-subscription/:locationId updates a subscription; Endpoint 6 POST /enable-saas/:locationId enables SaaS for a location.
Trigger when a new location is installed in SaaS API
Actions pull installedLocations and push to Acadimiat to keep records aligned
GET /oauth/installedLocations
locationId and installedLocations data
Trigger when a location needs SaaS access enabled
Actions call enable SaaS for the location
POST /enable-saas/:locationId
locationId
Trigger when subscription changes
Actions update subscription details in SaaS API and reflect in Acadimiat
PUT /update-saas-subscription/:locationId
locationId subscription details
No code setup with prebuilt workflows that connect SaaS API to Acadimiat
Fast setup using OAuth and endpoint mapping without custom coding
Secure and scalable integration managed from one platform
This glossary defines OAuth endpoints locations tokens and terms used in this guide
OAuth 2.0 authorization framework used to grant limited access to the SaaS API
A defined URL path and method that performs a specific action in the SaaS API
A distinct entity in your SaaS account connected to Acadimiat
A secure credential issued after authentication to access the API
Use Endpoint1 to fetch installedLocations and mirror changes in Acadimiat
Leverage Endpoint3 to generate location tokens and refresh as needed
Coordinate subscription updates via Endpoint5 and Endpoint6 to keep systems aligned
Begin with OAuth flow and install the SaaS API in Acadimiat
Map Endpoint1 6 and set permissions oauth readonly to suit needs
Run tests verify data flow and deploy to production
The SaaS API integration with Acadimiat enables secure data exchange between the two systems using OAuth. You can pull location data and apply actions in Acadimiat without manual coding. This setup supports real time synchronization and scalable operations.
Initial setup requires access to the endpoints that manage locations and subscription data. Start with GET /oauth/installedLocations to fetch current locations, then use POST /oauth/locationToken to obtain a token for location level operations. As you proceed, enablesa SaaS for a location with POST /enable-saas/:locationId and update subscriptions with PUT /update-saas-subscription/:locationId.
Tokens are issued after the OAuth flow and can be refreshed as needed. Acadimiat should securely store and rotate tokens, using the locationToken endpoint to manage location level access. Regularly review token scopes to maintain least privilege.
Yes, per location control is supported. You can enable SaaS for specific locations and manage their subscriptions independently. This allows granular access control within Acadimiat and the SaaS API.
No extensive coding is required. Use the built in connectors and endpoints to map data and automate flows. If your needs become complex you can extend with light scripting, but the core setup is no code.
Test the connection by running a dry run using GET /oauth/installedLocations and POST /enable-saas/:locationId to verify responses. Check token validity and subscription updates in a staging environment before going live.
Endpoint documentation is available in your GHL API reference and the autogenerated docs within Acadimiat. Review endpoint paths, required parameters, and response schemas to implement the integration confidently.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
