{ "openapi": "3.0.1", "info": { "title": "Local Business Listings Submission API", "description": "Submit, manage and sync business listings across 50+ directories, maps and search engines via one API. REST APIs for Local Search Citations, Reviews, Analytics and Posts.", "version": "0.2", "x-build-id": "HjX3J7Rpe5TegfNp9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/listingsapi~local-business-listings-submission-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-listingsapi-local-business-listings-submission-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/listingsapi~local-business-listings-submission-api/runs": { "post": { "operationId": "runs-sync-listingsapi-local-business-listings-submission-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/listingsapi~local-business-listings-submission-api/run-sync": { "post": { "operationId": "run-sync-listingsapi-local-business-listings-submission-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "apiKey", "operation" ], "properties": { "apiKey": { "title": "Listings API key", "type": "string", "description": "Your Listings API key. Create one at https://listingsapi.com/dashboard/api-keys. Sent as `Authorization: API `." }, "operation": { "title": "Operation", "enum": [ "activeSubscriptions", "bulkConnectLinkForFacebook", "bulkConnectLinkForGoogle", "confirmConnectMatches", "connectedAccountDetails", "connectedAccountsInfo", "connectedAccountsTriggerMatches", "connectionSuggestionsForAccount", "connectListing", "createGmbListingForLocation", "createLocationFromConnectedAccountListing", "disconnectConnectedAccountListing", "fbBulkDisconnect", "getFoldersUnderGoogleAccount", "gmbBulkDisconnect", "connectedAccountListings", "planSites", "bingInsights", "facebookInsights", "googleInsights", "duplicateListingsRollup", "duplicateListingsForLocation", "listingsForLocationPremium", "voiceAssistantsForLocation", "markAsDuplicate", "markAsNotDuplicate", "addLocationPhotos", "allLocations", "archiveLocations", "cancelLocationsArchive", "createLocation", "getLocationsByIds", "getLocationsByStoreCodes", "subcategories", "supportedCountries", "starLocationPhotos", "removeLocationPhotos", "searchLocations", "updateLocation", "mediaFilesOfLocation", "getLocationPhotosUploadStatus", "createSocialPost", "createBulkSocialPost", "deleteSocialPost", "socialPostView", "socialPostViewBulk", "rollupSocialPostsByLocation", "rollupSocialPostsBulk", "interactionsAnalyticsStats", "archiveReviewResponse", "editReviewResponse", "interactionDetails", "interactions", "rollupInteractions", "interactionsSetting", "interactionSiteConfig", "respondToInteraction" ], "type": "string", "description": "Which Listings API endpoint to call." }, "pathParams": { "title": "Path parameters", "type": "object", "description": "Values for path placeholders, e.g. { \"locationId\": \"123\" }. Required for operations whose path contains an id.", "default": {} }, "query": { "title": "Query parameters", "type": "object", "description": "Query-string parameters as key/value pairs, e.g. { \"limit\": 50 }.", "default": {} }, "body": { "title": "Request body", "type": "object", "description": "JSON body for write operations (create/update). Ignored for read-only GET operations.", "default": {} }, "paginate": { "title": "Auto-paginate", "type": "boolean", "description": "For list endpoints, follow pageInfo.hasNextPage and collect every page into the dataset.", "default": false }, "maxItems": { "title": "Max items (0 = no limit)", "minimum": 0, "type": "integer", "description": "Stop after collecting this many items across pages. 0 means no cap.", "default": 0 }, "cursorParam": { "title": "Cursor query parameter", "type": "string", "description": "Query parameter used to pass the pagination cursor (Relay-style; default 'after').", "default": "after" }, "baseUrl": { "title": "API base URL", "type": "string", "description": "Only change this for testing against a non-production environment.", "default": "https://listingsapi.com" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }