Connected Accounts
Overview
This document provides an overview of the API endpoints available for managing connected accounts. These endpoints allow you to connect and manage their Google Business Profile and Facebook profiles.
What Are Connected Accounts? A connected account is a user account linked to Google My Business or Facebook Pages, allowing seamless management of business listings across these platforms.
Key Capabilities:
- Easily link or unlink your Google My Business and Facebook Page profiles.
- Associate locations with Google and Facebook listings to publish information, fetch reviews, and more.
- Publish media and posts directly to the connected profiles.
- Retrieve detailed insights and performance metrics.
API Endpoints
Connect an Account
Use this API to establish a new connection between a Google My Business or Facebook Page account and the system. Once connected, the system can manage listings, fetch reviews, and synchronize data.
- Google My Business: Connect a new user account for Google My Business profiles.
- Facebook Page: Connect a new user account for Facebook Page profiles.
Disconnect a Connected Account
Use this API to remove an existing Google My Business or Facebook Page connection. This will stop syncing and managing listings associated with the disconnected account.
- Google My Business: Disconnect a connected account for Google My Business profiles.
- Facebook Page: Disconnect a connected account for Facebook Page profiles.
List All Connected Accounts
Use this API to retrieve a list of all connected accounts linked to a user’s profile. The response can be filtered by:
- Publisher type (Google, Facebook, etc.)
- Connection status (active, expired, or disconnected)
Fetch Details of a Connected Account
- Get detailed information about a specific connected account, including connection status and any connectivity issues.
Trigger New Matches
Use this API to automatically fetch all locations from the connected Google My Business or Facebook Page profile and attempt to match them with existing locations in the system.
List Connection Suggestions
Use this API Retrieve recommended connections for locations that have not yet been linked to a listing. The system analyzes available data to suggest appropriate matches.
Fetch Listings of a Connected Account
Use this API to retrieve all business listings associated with a Google My Business or Facebook Page account. Results can be filtered by location details for better organization.
Confirm Matches for a Connected Account
Use this API to confirm and finalize the matches suggested by the List Connection Suggestions endpoint, officially linking locations to their corresponding listings.
Connect a Location with a Listing
Use this API to establish a direct connection between a location and a listing from a connected account. This allows the system to manage the listing, ensuring business details stay updated.
Disconnect a Connected Location from a Listing
Use this API to remove the connection between a location and a listing on Google My Business or Facebook. This prevents further updates from being pushed to the listing.
:::info[]
To fetch a Facebook Page’s details, you must have the necessary permissions and roles: User Role Requirements: Admin or Moderator: The user must be an admin or moderator of the Page. Page Information Requirements: Address Presence: The Page must have a physical address listed.
:::