• Getting Started
    • Locations
      • Location Attributes
        MARKDOWN
      • Photo specifications for your business location
        MARKDOWN
      • Star and Unstar Photos
        MARKDOWN
      • Create a new business location
        POST
      • Update business location
        POST
      • List all locations
        GET
      • List particular locations
        GET
      • Search locations
        GET
      • Get locations by store codes
        GET
      • Upload Photos to a Location
        POST
      • Check Bulk Photo Upload Status
        GET
      • Star/Unstar Location Photos
        POST
      • Delete Location Photos
        POST
      • Archive multiple locations
        POST
      • Cancel scheduled location archival
        POST
      • Activate archived locations
        POST
      • List Active Subscriptions
        GET
      • Get a list of supported countries and their states
        GET
      • Get SubCategories and AdditionalCategories
        GET
      • Get Site Details for Your Plan
        GET
    • Organizing locations
      • Organizing locations
        MARKDOWN
      • Create a new folder
        POST
      • List all folders
        GET
      • List all folders under an account in hierarchical structure
        GET
      • Get details of a folder
        GET
      • Rename a folder
        POST
      • Add locations to a folder
        POST
      • Remove locations from a folder
        POST
      • Delete a folder
        POST
      • List locations under a folder
        GET
      • List all tags
        GET
      • List locations by tags
        GET
      • Add location to a tag
        POST
      • Remove location from a tag
        POST
    • User Management
      • User Attributes
      • Create User with Role
      • List Users
      • List Users by ID
      • Add Locations to User
      • Add User and folder
      • List User Roles
      • Add folders to user
      • List User Resources
      • Update a User
      • Remove Folders for User
      • Remove Locations for User
    • Grid Rank
      • Local Rank Grid
      • Create Rank Grid Report
      • Fetch All Grid Reports for Location
      • Fetch Rank Grid Report By ID
    • Review Campaigns
      • Review Campaign Info Attributes
      • Create a review campaign
      • Add customers to a review campaign
      • List review campaigns
      • List review campaign customers
    • Listings
      • Listings
      • Listing Status Webhooks
      • Get premium listings
      • Get voice listings for a location
      • Get duplicate listings for a location
      • Get all duplicate listings for an account
      • Mark listings as duplicates
      • Mark listings as not duplicates
      • Get AI listings
    • Connected Accounts
      • Connected Accounts
      • Connect Google Profile to Account
      • Connect Facebook Page to Account
      • List all connected accounts
      • List folders under a Google account
      • Create GMB Listing
      • Disconnect GMB Profile
      • Disconnect Facebook Account
      • Fetch Connected Account Details
      • Trigger New Matches
      • List Connection Suggestions
      • Fetch Connected Account Listings
      • Confirm Connected Account Matches
      • Connect a location with a listing of a connected account
      • Disconnect Location from Listing
    • Rankings
      • Rankings Analytics Attributes
      • Add keywords
      • List Keywords
      • Get keywords performance
      • Archive a keyword
      • Get Rollup Keyword Performance
      • Get Rankings Distribution By Time
    • Profile Analytics
      • Profile Analytics
      • Get Bing Analytics
      • Get Facebook Page Analytics
      • Get Google My Business Analytics
    • Reviews
      • Reviews
      • Review Sources
        • Get a list of interaction sources for location
        • Get a list of interaction sources for account
        • Add / Edit interaction source
      • Fetch all interactions
      • List Interactions by IDs
      • Respond to an Interaction
      • Edit Response for Interaction
      • Archive Response for Interaction
      • Get Interaction Analytics
      • Add Review Widget
      • Edit Review Widget
    • Automations
      • Temporary Close Location with a reopening date
    • Error Codes
      • ERROR CODES

    Getting Started

    Welcome to our API documentation. This API allows you to access endpoints such as Locations, Listings, Analytics, and more. The base URL for the API is <your_domain_url>.

    API Capabilities#

    With our API, you can:
    1.
    Manage and Update Business Locations: Oversee and modify business location details across multiple platforms
    2.
    Monitor and Analyze Online Reviews: Track and assess online reviews to enhance customer satisfaction
    3.
    Optimize Local SEO Strategies: Implement strategies to improve local search visibility
    4.
    Access Analytics: Retrieve data-driven insights to inform decision-making
    5.
    Manage Social Media Interactions and Listings: Handle social media engagements and listings from a centralized platform

    Generating Your API Key#

    To generate an API key:
    1.
    Log in to your workspace (e.g., <your_workspace_url>)
    2.
    Click on the settings menu located at the top-right of the navigation bar
    3.
    Select "Integrations" to view the API keys associated with your account
    4.
    Provide a simple name for the API key
    5.
    Click the "Generate" button
    6.
    An API key will be generated; ensure you copy and store it securely

    Authentication#

    For all requests, the Authorization and Content-Type headers must be included.
    If your API key is T9V35W3xxxxxxxxxxx, set the Authorization header as follows:
    Authorization: API T9V35W3xxxxxxxxxxx
    Set the Content-Type header to:
    Content-Type: application/json

    Making Your First API Call#

    To fetch subcategories supported by the platform, execute the following API call:
    Replace your_api_key with the API key associated with your account.

    Version Information#

    Version 4 (last updated: July 21, 2025)
    Modified at 2025-07-21 09:51:02
    Next
    Location Attributes
    Built with