Access to the Users API requires a secure OAuth2 flow or API key method. Request a client_id and client_secret for your Plezi app and use the GHL scope: socialplanner/tag.readonly to read tag data.
Configure Plezi Plus and Star to request access tokens from GHL, rotate credentials regularly, and store tokens securely in your app. Use the standard OAuth2 flow with your client_id.
GET /social-media-posting/:locationId/tags — Retrieve tags for a location POST /social-media-posting/:locationId/tags/details — Create or update tag details socialplanner/statistics.readonly — Read-only statistics feed POST /social-media-posting/statistics — Submit statistics payload
Trigger: a tag is created or updated in Plezi’s social posting flow triggers a tag fetch from the Users API.
Actions: update Plezi’s tag catalog, refresh campaign segments, and log the event.
GET /social-media-posting/:locationId/tags
locationId, tagId, tagName, updatedAt
Trigger: new metrics are computed and ready to push via the statistics endpoint.
Actions: store metrics in Plezi analytics, update dashboards, alert when thresholds are crossed.
POST /social-media-posting/statistics
locationId, metrics, timestamp
Trigger: statistics.readonly data becomes available for syncing.
GET socialplanner/statistics.readonly
namespace, metrics, period
Automate data sync without custom coding, saving hours per week.
Keep Plezi dashboards fresh with real-time tag and statistics data.
Reduce errors with built-in retries and validation during data transfer.
Key elements and processes used to connect GHL Users API with Plezi Plus and Star, including endpoints, triggers, data fields, and workflow steps.
A unique identifier for a location in Plezi’s social posting context.
A tag associated with a location’s social posts, used to categorize content and extract insights.
The numeric or string ID that uniquely identifies a tag in the Users API.
Data points representing engagement and performance metrics exposed by the Users API.
Automatically trigger Plezi campaigns when tag data updates in the Users API.
Send a summarized metrics digest to stakeholders every week.
Use tag and statistics data to create dynamic Plezi audience segments.
Create a GHL API client to obtain client_id and client_secret for Plezi.
Grant the socialplanner/tag.readonly scope and any required scopes for read access.
Use the Plezi connector to run a test pull, verify responses, and confirm data flows.
You can pull tag data, statistics, and post details from the GHL Users API. Start with tags to segment campaigns, then pull statistics for performance insights. Use the endpoints to pull data and push to Plezi dashboards.
OAuth2 is the recommended approach for secure access. API keys can be used for simple reads, but tokens should be refreshed regularly for security.
At minimum you’ll use GET /social-media-posting/:locationId/tags, POST /social-media-posting/:locationId/tags/details, and POST /social-media-posting/statistics to drive campaigns and insights.
Sync frequency can range from real-time to hourly depending on the plan and endpoint limits. Use webhooks or scheduled tasks to fit your needs.
Store tokens securely, rotate keys, and implement least-privilege scopes. Monitor for unusual activity and use retries with exponential backoff.
Yes. Use a staging environment or sandbox mode to verify data flow before going live.
Endpoint documentation is available in the developer portal for GHL, and our integration guide provides Plezi-specific usage examples.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
