Use OAuth 2.0 to obtain an access token, then authorize Rankr to access the Opportunities API within the Scope: opportunities.readonly. For write operations, ensure additional permissions are granted through your GHL admin.
Rankr uses OAuth 2.0 tokens to securely authenticate with external APIs. Store tokens securely and rotate them on a schedule.
GET /opportunities/search — Search opportunities; GET /opportunities/:id — Retrieve a specific opportunity; GET /opportunities/pipelines — List pipelines; POST /opportunities — Create an opportunity; PUT /opportunities/:id — Update an opportunity; PUT /opportunities/:id/status — Update status; DELETE /opportunities/:id — Delete an opportunity
Trigger when a new or updated opportunity is detected in Rankr to create or update a corresponding record in Opportunities API.
Actions: create, update, and fetch opportunities; map fields like id, name, stage, and value to keep data in sync.
GET /opportunities/search
id, name, stage, pipeline, close_date
Trigger on status updates in Opportunities API to reflect in Rankr.
Update Rankr records and trigger follow-up actions.
PUT /opportunities/:id/status
id, status
Schedule data pulls for Rankr dashboards or trigger on nightly sync.
Fetch and map key fields to Rankr dashboards (id, name, amount, close_date, stage).
GET /opportunities/search
id, name, amount, close_date, stage
Automate the lead-to-opportunity handoff without writing code.
Create powerful automations and reports via visual workflows.
Fast time-to-value with plug-and-play endpoints and mappings.
Essential terms and processes to understand when integrating the Opportunities API with Rankr.
An authorization framework that enables secure access to the GHL API without sharing user passwords.
A specific URL exposed by the API to perform an action or fetch data.
A callback URL that receives real-time event notifications from the API.
Permissions granted to a token that define what operations are allowed.
Automatically route opportunities to the right owner in Rankr and mirror updates in Opportunities API.
Pull opportunities data into Rankr dashboards for live insights.
Trigger follow-up tasks in Rankr when an opportunity moves stages.
Register the Opportunities API in GHL and obtain client credentials; configure Rankr to use them.
Grant the required scopes (opportunities.readonly; request write if needed) and confirm access in Rankr.
Test authentication, data mapping, and end-to-end workflows before going live.
The Opportunities API is a RESTful interface that lets you search, retrieve, create, update, and delete opportunity records. It enables you to work with opportunities across your sales workflow from a single, consistent API. Common use cases include syncing opportunities between Rankr and your CRMs, powering automated dashboards, and triggering automations as opportunities move through stages.
Authentication is handled via OAuth 2.0 tokens. You’ll obtain an access token from the GHL developer portal and include it in API requests. Tokens should be stored securely and refreshed before expiry; Rankr should handle token renewal automatically.
Available endpoints include: GET /opportunities/search, GET /opportunities/:id, GET /opportunities/pipelines, POST /opportunities, PUT /opportunities/:id, PUT /opportunities/:id/status, and DELETE /opportunities/:id. Each endpoint supports common query parameters and field mappings to suit your workflows.
Yes. You can use PUT /opportunities/:id to update records and POST /opportunities to create new ones; ensure you have the necessary permissions. Be mindful of rate limits and data validation to avoid conflicts.
Typical fields to map include id, name, stage, pipeline, value, close_date, and owner. Map IDs between Rankr and GHL to maintain referential integrity and keep dashboards accurate.
No-code workflows are possible using automation tools like Zapier and native Rankr automations; triggers and actions can be configured without code. If you prefer, you can still use API calls directly for advanced scenarios.
API keys are issued through the GHL developer portal. You will register an app, generate client credentials, and attach them to Rankr. Keep credentials secure and rotate them on a schedule; update Rankr configurations whenever keys change.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
