Authenticate using OAuth 2.0 or an API key, with scope socialplanner/tag.readonly to access tag data. Keep credentials secure and rotate keys regularly.
Connect RealScout to the API by granting your app the proper permissions in your GHL dashboard. Use the client ID and secret to complete the OAuth flow and test endpoints.
Endpoint list used: GET /social-media-posting/:locationId/tags; POST /social-media-posting/:locationId/tags/details; socialplanner/statistics.readonly; POST /social-media-posting/statistics. Additional endpoints are available but not required for every page.
Triggered when a location’s post is created or updated in RealScout to fetch and store tags.
Actions: call GET /social-media-posting/:locationId/tags and POST /social-media-posting/:locationId/tags/details to populate tag data in RealScout.
GET /social-media-posting/:locationId/tags
locationId, tagId, tagName, timestamp
Triggered on a daily cadence to pull engagement and posting statistics.
Actions: call socialplanner/statistics.readonly and POST /social-media-posting/statistics to generate metrics in RealScout.
POST /social-media-posting/statistics
date, locationId, totalTags, engagementScore
Triggered when a stakeholder requests a report or on a scheduled run.
Actions: compile data from tag and statistics endpoints and render in a unified RealScout dashboard; option to export CSV.
socialplanner/statistics.readonly
metric, value, date, locationId
Faster access to tag data and post metrics without manual data entry.
Automated workflows reduce repetitive tasks and improve accuracy.
A single dashboard unifies listings, tags, and analytics for smarter decisions.
Key elements include Endpoints, Triggers, Actions, and Data Fields. Understand each to design reliable automations.
Application Programming Interface that allows systems to communicate with the Users API.
A callback URL that receives real-time event updates from the API.
Standard authorization framework used to grant access securely to the Users API.
A specific URL path for accessing a resource in the API.
Trigger updates to property listings when tag data changes to keep listings fresh.
Build dashboards that combine tag trends with listing performance.
Auto‑send weekly summaries to your team or clients.
Create a project, generate client credentials, and configure scopes.
Run the OAuth flow, grant permissions, and verify endpoints respond correctly.
Create a Zapier workflow linking the Users API endpoints to RealScout actions.
The Users API lets you read and manage tag data used for social posting and engagement metrics. Start with the tag retrieval endpoint to see what tags exist for a location. Then use the details endpoint to pull additional information about each tag. This foundation gives you the data you need to power RealScout listings and analytics.
No code is not required but helpful. RealScout can connect via prebuilt integrations or Zapier for no‑code workflows. If you need deeper customization, basic API knowledge helps but isn’t strictly required for many common tasks.
Begin with GET /social-media-posting/:locationId/tags to fetch available tags for a location. If you need more detail, call POST /social-media-posting/:locationId/tags/details to pull extra fields. This pair covers initial data needs for tagging workflows.
Security is built around OAuth 2.0 and API keys. Keep credentials secure, use least privilege scopes, rotate keys regularly, and monitor access logs. Use https for all endpoints and validate responses before processing data.
Yes. The Users API supports real time style updates via webhooks and periodic polling. For critical updates, set up webhooks where available and fallback to scheduled pulls to ensure you don’t miss changes.
The primary scope needed for tag access is socialplanner/tag.readonly. Additional scopes may be required for broader data and write actions. Always apply the minimum necessary scope to limit exposure.
Test the connection in your GHL dashboard using sample location IDs and a sandbox environment if available. Validate each endpoint’s response, then simulate a workflow to confirm data flows into RealScout as expected.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
