{ "info": { "_postman_id": "2c29d70e-3a75-4011-8aac-7471a1c0cbd4", "name": "ListingsAPI", "description": "REST API for managing business locations: sync listings across Google, Facebook, Bing and other publishers, respond to reviews, publish posts, and pull local search analytics. Authenticate with an API key from the developer dashboard.\n\nContact Support:\n Name: Listings API support\n Email: support@listingsapi.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "33146265", "_collection_link": "https://go.postman.co/collection/56624059-2c29d70e-3a75-4011-8aac-7471a1c0cbd4?source=collection_link" }, "item": [ { "name": "Locations", "item": [ { "name": "Get locations by the Store Codes.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations-by-store-codes?storeCodes=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations-by-store-codes" ], "query": [ { "key": "storeCodes", "value": "string", "description": "JSON-encoded array of store code strings, e.g. `[\"ACME01\",\"jio678\"]`. URL-encode the value." } ] }, "description": "Returns full location details for one or more locations identified by their store codes." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations-by-store-codes?storeCodes=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations-by-store-codes" ], "query": [ { "description": "JSON-encoded array of store code strings, e.g. `[\"ACME01\",\"jio678\"]`. URL-encode the value.", "key": "storeCodes", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"getLocationsByStoreCodes\": [\n {\n \"id\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"databaseId\": 1800289,\n \"accountId\": 62670,\n \"storeId\": \"ACME01\",\n \"name\": \"Jenny Home\",\n \"archived\": false,\n \"street\": \"19 east, 5th B cross road, Trinity Enclave Main Rd, Banjara Layout\",\n \"city\": \"Bengaluru\",\n \"stateIso\": \"KA\",\n \"postalCode\": \"560043\",\n \"countryIso\": \"IN\",\n \"phone\": \"8073326913\",\n \"categoryId\": 15,\n \"subCategoryId\": 1432,\n \"subCategoryName\": \"Restaurants\",\n \"package\": \"PREMIUM\",\n \"planId\": 3797,\n \"planName\": \"Launch\",\n \"folderId\": \"d90630a7-7af0-450f-bdfe-6457eb438b1f\",\n \"folderName\": \"root\",\n \"tags\": [\n \"all\"\n ],\n \"placeActionLinks\": [\n {\n \"placeActionType\": \"FOOD_ORDERING\",\n \"uri\": \"https://order.example.com\",\n \"isPreferred\": true,\n \"name\": \"locations/1944.../placeActionLinks/54ada85bc246058a\",\n \"submissionStatus\": \"success\"\n }\n ],\n \"discoveredPlaceActionLinks\": []\n }\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations-by-store-codes?storeCodes=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations-by-store-codes" ], "query": [ { "description": "JSON-encoded array of store code strings, e.g. `[\"ACME01\",\"jio678\"]`. URL-encode the value.", "key": "storeCodes", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations-by-store-codes?storeCodes=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations-by-store-codes" ], "query": [ { "description": "JSON-encoded array of store code strings, e.g. `[\"ACME01\",\"jio678\"]`. URL-encode the value.", "key": "storeCodes", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations-by-store-codes?storeCodes=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations-by-store-codes" ], "query": [ { "description": "JSON-encoded array of store code strings, e.g. `[\"ACME01\",\"jio678\"]`. URL-encode the value.", "key": "storeCodes", "value": "string" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "All locations that belong to an account.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations?first=7322&after=string&last=7322&before=string&filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations" ], "query": [ { "key": "first", "value": "7322", "description": "Number of records to fetch from the start of the connection (forward pagination). Combine with `after`." }, { "key": "after", "value": "string", "description": "Cursor to fetch records after. Pass `pageInfo.endCursor` from the previous page." }, { "key": "last", "value": "7322", "description": "Number of records to fetch from the end of the connection (backward pagination). Combine with `before`." }, { "key": "before", "value": "string", "description": "Cursor to fetch records before. Pass `pageInfo.startCursor` to page backwards." }, { "key": "filter", "value": "string", "description": "JSON-encoded filter object to narrow the result set (e.g. by tag, folder, or approval status)." } ] }, "description": "Returns a cursor-paginated list of locations in your account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations?first=7322&after=string&last=7322&before=string&filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations" ], "query": [ { "description": "Number of records to fetch from the start of the connection (forward pagination). Combine with `after`.", "key": "first", "value": "7322" }, { "description": "Cursor to fetch records after. Pass `pageInfo.endCursor` from the previous page.", "key": "after", "value": "string" }, { "description": "Number of records to fetch from the end of the connection (backward pagination). Combine with `before`.", "key": "last", "value": "7322" }, { "description": "Cursor to fetch records before. Pass `pageInfo.startCursor` to page backwards.", "key": "before", "value": "string" }, { "description": "JSON-encoded filter object to narrow the result set (e.g. by tag, folder, or approval status).", "key": "filter", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"allLocations\": {\n \"edges\": [\n {\n \"cursor\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"node\": {\n \"id\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"databaseId\": 1800289,\n \"accountId\": 62670,\n \"accountName\": \"owner@brightsmile-dental.com\",\n \"name\": \"Jenny Home\",\n \"approved\": \"APPROVED\",\n \"archived\": false,\n \"archivalScheduledAt\": null,\n \"archivedAt\": null,\n \"street\": \"19 east, 5th B cross road, Trinity Enclave Main Rd, Banjara Layout\",\n \"city\": \"Bengaluru\",\n \"stateIso\": \"KA\",\n \"stateName\": \"Karnataka\",\n \"postalCode\": \"560043\",\n \"countryIso\": \"IN\",\n \"countryCode\": \"91\",\n \"latitude\": \"13.0334524\",\n \"longitude\": \"77.6669171\",\n \"phone\": \"8073326913\",\n \"additionalPhones\": [],\n \"bizUrl\": null,\n \"hideAddress\": false,\n \"storeId\": null,\n \"categoryId\": 15,\n \"subCategoryId\": 1432,\n \"subCategoryName\": \"Restaurants\",\n \"additionalCategoryIds\": [],\n \"additionalCategoryNames\": [],\n \"description\": \"This is a standalone duplex house. A comfortable, private villa located in the Banjara Layout neighbourhood of Bengaluru, offering spacious duplex living with easy access to the surrounding Trinity Enclave area and central Bengaluru.\",\n \"businessHours\": [],\n \"package\": \"PREMIUM\",\n \"planId\": 3797,\n \"planName\": \"Launch\",\n \"folderId\": \"d90630a7-7af0-450f-bdfe-6457eb438b1f\",\n \"folderName\": \"root\",\n \"tags\": [\n \"all\"\n ],\n \"temporarilyClosed\": false,\n \"ownerEmail\": null,\n \"ownerName\": null,\n \"googleVerificationStatus\": {\n \"status\": \"NOT_CONNECTED\",\n \"message\": null\n },\n \"voiceStatus\": 3,\n \"uid\": \"3c92283c-6145-4a43-8a62-0c15fd712021\",\n \"createdDate\": \"July 06, 2026\",\n \"lastUpdatedDate\": \"July 06, 2026\",\n \"updatedAt\": \"2026-07-06T18:33:29.664Z\",\n \"placeActionLinks\": [\n {\n \"placeActionType\": \"FOOD_ORDERING\",\n \"uri\": \"https://order.example.com\",\n \"isPreferred\": true,\n \"name\": \"locations/1944.../placeActionLinks/54ada85bc246058a\",\n \"submissionStatus\": \"success\",\n \"submissionMessage\": \"Already up to date on Google.\",\n \"lastSubmittedAt\": \"2026-07-08T12:14:36Z\"\n }\n ],\n \"discoveredPlaceActionLinks\": [\n {\n \"placeActionType\": \"APPOINTMENT\",\n \"uri\": \"https://book.example.com\",\n \"isPreferred\": false,\n \"name\": \"locations/1944.../placeActionLinks/abc123\",\n \"providerType\": \"MERCHANT\",\n \"isEditable\": true\n }\n ]\n }\n }\n ],\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"hasPreviousPage\": false,\n \"endCursor\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"total\": 1\n }\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations?first=7322&after=string&last=7322&before=string&filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations" ], "query": [ { "description": "Number of records to fetch from the start of the connection (forward pagination). Combine with `after`.", "key": "first", "value": "7322" }, { "description": "Cursor to fetch records after. Pass `pageInfo.endCursor` from the previous page.", "key": "after", "value": "string" }, { "description": "Number of records to fetch from the end of the connection (backward pagination). Combine with `before`.", "key": "last", "value": "7322" }, { "description": "Cursor to fetch records before. Pass `pageInfo.startCursor` to page backwards.", "key": "before", "value": "string" }, { "description": "JSON-encoded filter object to narrow the result set (e.g. by tag, folder, or approval status).", "key": "filter", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations?first=7322&after=string&last=7322&before=string&filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations" ], "query": [ { "description": "Number of records to fetch from the start of the connection (forward pagination). Combine with `after`.", "key": "first", "value": "7322" }, { "description": "Cursor to fetch records after. Pass `pageInfo.endCursor` from the previous page.", "key": "after", "value": "string" }, { "description": "Number of records to fetch from the end of the connection (backward pagination). Combine with `before`.", "key": "last", "value": "7322" }, { "description": "Cursor to fetch records before. Pass `pageInfo.startCursor` to page backwards.", "key": "before", "value": "string" }, { "description": "JSON-encoded filter object to narrow the result set (e.g. by tag, folder, or approval status).", "key": "filter", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations?first=7322&after=string&last=7322&before=string&filter=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations" ], "query": [ { "description": "Number of records to fetch from the start of the connection (forward pagination). Combine with `after`.", "key": "first", "value": "7322" }, { "description": "Cursor to fetch records after. Pass `pageInfo.endCursor` from the previous page.", "key": "after", "value": "string" }, { "description": "Number of records to fetch from the end of the connection (backward pagination). Combine with `before`.", "key": "last", "value": "7322" }, { "description": "Cursor to fetch records before. Pass `pageInfo.startCursor` to page backwards.", "key": "before", "value": "string" }, { "description": "JSON-encoded filter object to narrow the result set (e.g. by tag, folder, or approval status).", "key": "filter", "value": "string" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Create a new location.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"name\": \"Acme Dental\",\n \"description\": \"Acme Dental is a family-owned dental practice in downtown New York offering preventive care, cosmetic dentistry, orthodontics, and emergency appointments. Our board-certified team combines modern equipment with a gentle, patient-first approach, and same-week appointments are available for new patients.\",\n \"storeId\": \"ACME01\",\n \"street\": \"123 Jump Street\",\n \"city\": \"New York\",\n \"stateIso\": \"NY\",\n \"postalCode\": \"10013\",\n \"countryIso\": \"US\",\n \"phone\": \"6443859313\",\n \"subCategoryId\": 1432,\n \"folderIds\": [\n \"d90630a7-7af0-450f-bdfe-6457eb438b1f\"\n ],\n \"businessHours\": [\n {\n \"day\": \"MONDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"TUESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"WEDNESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"THURSDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"FRIDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"SATURDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"10:00am\",\n \"end\": \"02:00pm\"\n }\n ]\n },\n {\n \"day\": \"SUNDAY\",\n \"type\": \"CLOSED\",\n \"slots\": []\n }\n ],\n \"placeActionLinks\": [\n {\n \"placeActionType\": \"APPOINTMENT\",\n \"uri\": \"https://book.acmedental.example.com\",\n \"isPreferred\": true\n },\n {\n \"placeActionType\": \"ONLINE_APPOINTMENT\",\n \"uri\": \"https://virtual.acmedental.example.com\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations" ] }, "description": "Creates a new business location in your account and queues it for listing submission." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"name\": \"Acme Dental\",\n \"description\": \"Acme Dental is a family-owned dental practice in downtown New York offering preventive care, cosmetic dentistry, orthodontics, and emergency appointments. Our board-certified team combines modern equipment with a gentle, patient-first approach, and same-week appointments are available for new patients.\",\n \"storeId\": \"ACME01\",\n \"street\": \"123 Jump Street\",\n \"city\": \"New York\",\n \"stateIso\": \"NY\",\n \"postalCode\": \"10013\",\n \"countryIso\": \"US\",\n \"phone\": \"6443859313\",\n \"subCategoryId\": 1432,\n \"folderIds\": [\n \"d90630a7-7af0-450f-bdfe-6457eb438b1f\"\n ],\n \"businessHours\": [\n {\n \"day\": \"MONDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"TUESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"WEDNESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"THURSDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"FRIDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"SATURDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"10:00am\",\n \"end\": \"02:00pm\"\n }\n ]\n },\n {\n \"day\": \"SUNDAY\",\n \"type\": \"CLOSED\",\n \"slots\": []\n }\n ],\n \"placeActionLinks\": [\n {\n \"placeActionType\": \"APPOINTMENT\",\n \"uri\": \"https://book.acmedental.example.com\",\n \"isPreferred\": true\n },\n {\n \"placeActionType\": \"ONLINE_APPOINTMENT\",\n \"uri\": \"https://virtual.acmedental.example.com\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"createLocation\": {\n \"clientMutationId\": null,\n \"success\": true,\n \"errors\": null,\n \"location\": {\n \"id\": \"TG9jYXRpb246MTgwMDI5MA==\",\n \"databaseId\": 1800290,\n \"storeId\": \"ACME01\",\n \"name\": \"Acme Dental\",\n \"street\": \"123 Jump Street\",\n \"city\": \"New York\",\n \"stateIso\": \"NY\",\n \"postalCode\": \"10013\",\n \"countryIso\": \"US\",\n \"phone\": \"6443859313\",\n \"status\": \"PENDING\",\n \"primaryGbpSiteCategoryId\": null,\n \"tags\": [],\n \"folders\": [\n {\n \"id\": \"d90630a7-7af0-450f-bdfe-6457eb438b1f\",\n \"name\": \"root\",\n \"root\": true\n }\n ],\n \"placeActionLinks\": [\n {\n \"placeActionType\": \"APPOINTMENT\",\n \"uri\": \"https://book.acmedental.example.com\",\n \"isPreferred\": true,\n \"name\": null,\n \"submissionStatus\": null\n },\n {\n \"placeActionType\": \"ONLINE_APPOINTMENT\",\n \"uri\": \"https://virtual.acmedental.example.com\",\n \"isPreferred\": false,\n \"name\": null,\n \"submissionStatus\": null\n }\n ],\n \"discoveredPlaceActionLinks\": []\n }\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"name\": \"Acme Dental\",\n \"description\": \"Acme Dental is a family-owned dental practice in downtown New York offering preventive care, cosmetic dentistry, orthodontics, and emergency appointments. Our board-certified team combines modern equipment with a gentle, patient-first approach, and same-week appointments are available for new patients.\",\n \"storeId\": \"ACME01\",\n \"street\": \"123 Jump Street\",\n \"city\": \"New York\",\n \"stateIso\": \"NY\",\n \"postalCode\": \"10013\",\n \"countryIso\": \"US\",\n \"phone\": \"6443859313\",\n \"subCategoryId\": 1432,\n \"folderIds\": [\n \"d90630a7-7af0-450f-bdfe-6457eb438b1f\"\n ],\n \"businessHours\": [\n {\n \"day\": \"MONDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"TUESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"WEDNESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"THURSDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"FRIDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"SATURDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"10:00am\",\n \"end\": \"02:00pm\"\n }\n ]\n },\n {\n \"day\": \"SUNDAY\",\n \"type\": \"CLOSED\",\n \"slots\": []\n }\n ],\n \"placeActionLinks\": [\n {\n \"placeActionType\": \"APPOINTMENT\",\n \"uri\": \"https://book.acmedental.example.com\",\n \"isPreferred\": true\n },\n {\n \"placeActionType\": \"ONLINE_APPOINTMENT\",\n \"uri\": \"https://virtual.acmedental.example.com\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"name\": \"Acme Dental\",\n \"description\": \"Acme Dental is a family-owned dental practice in downtown New York offering preventive care, cosmetic dentistry, orthodontics, and emergency appointments. Our board-certified team combines modern equipment with a gentle, patient-first approach, and same-week appointments are available for new patients.\",\n \"storeId\": \"ACME01\",\n \"street\": \"123 Jump Street\",\n \"city\": \"New York\",\n \"stateIso\": \"NY\",\n \"postalCode\": \"10013\",\n \"countryIso\": \"US\",\n \"phone\": \"6443859313\",\n \"subCategoryId\": 1432,\n \"folderIds\": [\n \"d90630a7-7af0-450f-bdfe-6457eb438b1f\"\n ],\n \"businessHours\": [\n {\n \"day\": \"MONDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"TUESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"WEDNESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"THURSDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"FRIDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"SATURDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"10:00am\",\n \"end\": \"02:00pm\"\n }\n ]\n },\n {\n \"day\": \"SUNDAY\",\n \"type\": \"CLOSED\",\n \"slots\": []\n }\n ],\n \"placeActionLinks\": [\n {\n \"placeActionType\": \"APPOINTMENT\",\n \"uri\": \"https://book.acmedental.example.com\",\n \"isPreferred\": true\n },\n {\n \"placeActionType\": \"ONLINE_APPOINTMENT\",\n \"uri\": \"https://virtual.acmedental.example.com\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"name\": \"Acme Dental\",\n \"description\": \"Acme Dental is a family-owned dental practice in downtown New York offering preventive care, cosmetic dentistry, orthodontics, and emergency appointments. Our board-certified team combines modern equipment with a gentle, patient-first approach, and same-week appointments are available for new patients.\",\n \"storeId\": \"ACME01\",\n \"street\": \"123 Jump Street\",\n \"city\": \"New York\",\n \"stateIso\": \"NY\",\n \"postalCode\": \"10013\",\n \"countryIso\": \"US\",\n \"phone\": \"6443859313\",\n \"subCategoryId\": 1432,\n \"folderIds\": [\n \"d90630a7-7af0-450f-bdfe-6457eb438b1f\"\n ],\n \"businessHours\": [\n {\n \"day\": \"MONDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"TUESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"WEDNESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"THURSDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"FRIDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"SATURDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"10:00am\",\n \"end\": \"02:00pm\"\n }\n ]\n },\n {\n \"day\": \"SUNDAY\",\n \"type\": \"CLOSED\",\n \"slots\": []\n }\n ],\n \"placeActionLinks\": [\n {\n \"placeActionType\": \"APPOINTMENT\",\n \"uri\": \"https://book.acmedental.example.com\",\n \"isPreferred\": true\n },\n {\n \"placeActionType\": \"ONLINE_APPOINTMENT\",\n \"uri\": \"https://virtual.acmedental.example.com\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Search for locations.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/search?query=string&filter=string&first=7322&after=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "search" ], "query": [ { "key": "query", "value": "string", "description": "Search keyword matched against location name, street address, city, and store ID. Omit to page through every location." }, { "key": "filter", "value": "string", "description": "JSON-encoded filter object to narrow results (for example by folder or approval status)." }, { "key": "first", "value": "7322", "description": "Number of records to fetch, starting from the most recent." }, { "key": "after", "value": "string", "description": "Cursor to fetch records after (forward pagination). Pass the previous page's `pageInfo.endCursor`." } ] }, "description": "Returns a cursor-paginated list of locations matching a keyword, searchable by name, address, or store ID." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/search?query=string&filter=string&first=7322&after=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "search" ], "query": [ { "description": "Search keyword matched against location name, street address, city, and store ID. Omit to page through every location.", "key": "query", "value": "string" }, { "description": "JSON-encoded filter object to narrow results (for example by folder or approval status).", "key": "filter", "value": "string" }, { "description": "Number of records to fetch, starting from the most recent.", "key": "first", "value": "7322" }, { "description": "Cursor to fetch records after (forward pagination). Pass the previous page's `pageInfo.endCursor`.", "key": "after", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"searchLocations\": {\n \"edges\": [\n {\n \"cursor\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"node\": {\n \"accountId\": 62670,\n \"accountName\": \"owner@brightsmile-dental.com\",\n \"addOns\": [],\n \"additionalCategoryIds\": [],\n \"additionalCategoryNames\": [],\n \"additionalGbpSiteCategoryIds\": [],\n \"additionalGbpSiteCategoryNames\": [],\n \"additionalInfo\": null,\n \"additionalPhones\": [],\n \"aiAnalyticsEnabled\": false,\n \"approved\": \"APPROVED\",\n \"archivalScheduledAt\": null,\n \"archived\": false,\n \"archivedAt\": null,\n \"bizUrl\": null,\n \"bizUrlUtm\": false,\n \"bookingUrl\": null,\n \"businessHours\": [],\n \"cancellationScheduledAt\": null,\n \"categoryId\": 15,\n \"city\": \"Bengaluru\",\n \"clientName\": \"owner@brightsmile-dental.com\",\n \"contentPreferredLanguage\": \"ENGLISH\",\n \"countryCode\": \"91\",\n \"countryIso\": \"IN\",\n \"createErrors\": [],\n \"createdDate\": \"July 06, 2026\",\n \"customAttributes\": [],\n \"databaseId\": 1800289,\n \"defaultAgencyTag\": \"ownerbrightsmiledentalcom\",\n \"description\": \"This is a standalone duplex house. A comfortable, private villa located in the Banjara Layout neighbourhood of Bengaluru.\",\n \"discoveredPlaceActionLinks\": [],\n \"enabledSiteIds\": [],\n \"facebookUrl\": null,\n \"folderId\": \"d90630a7-7af0-450f-bdfe-6457eb438b1f\",\n \"folderName\": \"root\",\n \"franchise\": false,\n \"googleAdsPhone\": null,\n \"googleVerificationStatus\": {\n \"message\": null,\n \"status\": \"NOT_CONNECTED\"\n },\n \"googleplusUrl\": null,\n \"hideAddress\": false,\n \"id\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"instagramUrl\": null,\n \"isRestaurant\": true,\n \"lastUpdatedDate\": \"July 06, 2026\",\n \"latitude\": \"13.0334524\",\n \"linkedinUrl\": null,\n \"locationPhotos\": [],\n \"longitude\": \"77.6669171\",\n \"managedServiceSiteBuckets\": [],\n \"managedServiceSites\": [],\n \"moreHours\": [],\n \"name\": \"Jenny Home\",\n \"offeringsUrl\": null,\n \"ownerEmail\": null,\n \"ownerName\": null,\n \"package\": \"PREMIUM\",\n \"paymentMethods\": [],\n \"phone\": \"8073326913\",\n \"pinterestUrl\": null,\n \"placeActionLinks\": [],\n \"planId\": 3797,\n \"planName\": \"Launch\",\n \"postalCode\": \"560043\",\n \"primaryGbpSiteCategoryId\": null,\n \"primaryGbpSiteCategoryName\": null,\n \"publisherAttributes\": [],\n \"reservationUrl\": null,\n \"serviceArea\": null,\n \"serviceItems\": [],\n \"stateIso\": \"KA\",\n \"stateName\": \"Karnataka\",\n \"storeId\": null,\n \"street\": \"19 east, 5th B cross road, Trinity Enclave Main Rd, Banjara Layout\",\n \"street1\": null,\n \"subCategoryId\": 1432,\n \"subCategoryName\": \"Restaurants\",\n \"tagline\": null,\n \"tags\": [\n \"all\"\n ],\n \"temporarilyClosed\": false,\n \"tiktokUrl\": null,\n \"toplineMessage\": null,\n \"twitterUrl\": null,\n \"uid\": \"3c92283c-6145-4a43-8a62-0c15fd712021\",\n \"updatedAt\": \"2026-07-06T18:33:29.664Z\",\n \"videos\": [],\n \"voiceStatus\": 3,\n \"yearOfIncorporation\": null,\n \"youtubeUrl\": null\n }\n }\n ],\n \"pageInfo\": {\n \"endCursor\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"hasNextPage\": false,\n \"hasPreviousPage\": false,\n \"total\": 1\n }\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/search?query=string&filter=string&first=7322&after=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "search" ], "query": [ { "description": "Search keyword matched against location name, street address, city, and store ID. Omit to page through every location.", "key": "query", "value": "string" }, { "description": "JSON-encoded filter object to narrow results (for example by folder or approval status).", "key": "filter", "value": "string" }, { "description": "Number of records to fetch, starting from the most recent.", "key": "first", "value": "7322" }, { "description": "Cursor to fetch records after (forward pagination). Pass the previous page's `pageInfo.endCursor`.", "key": "after", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/search?query=string&filter=string&first=7322&after=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "search" ], "query": [ { "description": "Search keyword matched against location name, street address, city, and store ID. Omit to page through every location.", "key": "query", "value": "string" }, { "description": "JSON-encoded filter object to narrow results (for example by folder or approval status).", "key": "filter", "value": "string" }, { "description": "Number of records to fetch, starting from the most recent.", "key": "first", "value": "7322" }, { "description": "Cursor to fetch records after (forward pagination). Pass the previous page's `pageInfo.endCursor`.", "key": "after", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/search?query=string&filter=string&first=7322&after=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "search" ], "query": [ { "description": "Search keyword matched against location name, street address, city, and store ID. Omit to page through every location.", "key": "query", "value": "string" }, { "description": "JSON-encoded filter object to narrow results (for example by folder or approval status).", "key": "filter", "value": "string" }, { "description": "Number of records to fetch, starting from the most recent.", "key": "first", "value": "7322" }, { "description": "Cursor to fetch records after (forward pagination). Pass the previous page's `pageInfo.endCursor`.", "key": "after", "value": "string" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Fetch location info via cursor ids.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations-by-ids?locationIds=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations-by-ids" ], "query": [ { "key": "locationIds", "value": "string" } ] }, "description": "Returns full location information for a specified set of location IDs in one request." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations-by-ids?locationIds=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations-by-ids" ], "query": [ { "key": "locationIds", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"getLocationsByIds\": [\n {\n \"id\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"databaseId\": 1800289,\n \"accountId\": 62670,\n \"storeId\": null,\n \"name\": \"Jenny Home\",\n \"archived\": false,\n \"archivedAt\": null,\n \"street\": \"19 east, 5th B cross road, Trinity Enclave Main Rd, Banjara Layout\",\n \"city\": \"Bengaluru\",\n \"stateIso\": \"KA\",\n \"postalCode\": \"560043\",\n \"countryIso\": \"IN\",\n \"countryCode\": \"91\",\n \"latitude\": \"13.0334524\",\n \"longitude\": \"77.6669171\",\n \"phone\": \"8073326913\",\n \"additionalPhones\": [],\n \"bizUrl\": null,\n \"hideAddress\": false,\n \"categoryId\": 15,\n \"subCategoryId\": 1432,\n \"subCategoryName\": \"Restaurants\",\n \"additionalCategoryIds\": [],\n \"description\": \"This is a standalone duplex house. A comfortable, private villa located in the Banjara Layout neighbourhood of Bengaluru, offering spacious duplex living with easy access to the surrounding Trinity Enclave area and central Bengaluru.\",\n \"contentPreferredLanguage\": \"ENGLISH\",\n \"businessHours\": [],\n \"moreHours\": [],\n \"package\": \"PREMIUM\",\n \"planId\": 3797,\n \"planName\": \"Launch\",\n \"folderId\": \"d90630a7-7af0-450f-bdfe-6457eb438b1f\",\n \"folderName\": \"root\",\n \"tags\": [\n \"all\"\n ],\n \"temporarilyClosed\": false,\n \"ownerName\": null,\n \"ownerEmail\": null,\n \"paymentMethods\": [],\n \"locationPhotos\": [],\n \"isRestaurant\": true,\n \"voiceStatus\": 3,\n \"yearOfIncorporation\": null,\n \"placeActionLinks\": [\n {\n \"placeActionType\": \"FOOD_ORDERING\",\n \"uri\": \"https://order.example.com\",\n \"isPreferred\": true,\n \"name\": \"locations/1944.../placeActionLinks/54ada85bc246058a\",\n \"submissionStatus\": \"success\",\n \"submissionMessage\": \"Already up to date on Google.\",\n \"lastSubmittedAt\": \"2026-07-08T12:14:36Z\"\n }\n ],\n \"discoveredPlaceActionLinks\": [\n {\n \"placeActionType\": \"APPOINTMENT\",\n \"uri\": \"https://book.example.com\",\n \"isPreferred\": false,\n \"name\": \"locations/1944.../placeActionLinks/abc123\",\n \"providerType\": \"MERCHANT\",\n \"isEditable\": true\n }\n ]\n }\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations-by-ids?locationIds=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations-by-ids" ], "query": [ { "key": "locationIds", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations-by-ids?locationIds=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations-by-ids" ], "query": [ { "key": "locationIds", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations-by-ids?locationIds=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations-by-ids" ], "query": [ { "key": "locationIds", "value": "string" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Update information on a location.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"id\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"phone\": \"8073326999\",\n \"businessHours\": [\n {\n \"day\": \"MONDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"TUESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"WEDNESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"THURSDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"FRIDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"SATURDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"10:00am\",\n \"end\": \"02:00pm\"\n }\n ]\n },\n {\n \"day\": \"SUNDAY\",\n \"type\": \"CLOSED\",\n \"slots\": []\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "update" ] }, "description": "Updates writable fields on an existing location. Only the fields you send are changed." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"id\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"phone\": \"8073326999\",\n \"businessHours\": [\n {\n \"day\": \"MONDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"TUESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"WEDNESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"THURSDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"FRIDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"SATURDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"10:00am\",\n \"end\": \"02:00pm\"\n }\n ]\n },\n {\n \"day\": \"SUNDAY\",\n \"type\": \"CLOSED\",\n \"slots\": []\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "update" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"updateLocation\": {\n \"clientMutationId\": null,\n \"success\": true,\n \"errors\": null,\n \"location\": {\n \"id\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"databaseId\": 1800289,\n \"name\": \"Jenny Home\",\n \"street\": \"19 east, 5th B cross road, Trinity Enclave Main Rd, Banjara Layout\",\n \"city\": \"Bengaluru\",\n \"stateIso\": \"KA\",\n \"countryIso\": \"IN\",\n \"postalCode\": \"560043\",\n \"phone\": \"8073326999\",\n \"storeId\": null,\n \"status\": \"APPROVED\",\n \"placeActionLinks\": [\n {\n \"placeActionType\": \"FOOD_ORDERING\",\n \"uri\": \"https://order.example.com\",\n \"isPreferred\": true,\n \"name\": null,\n \"submissionStatus\": null\n }\n ],\n \"discoveredPlaceActionLinks\": []\n }\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"id\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"phone\": \"8073326999\",\n \"businessHours\": [\n {\n \"day\": \"MONDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"TUESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"WEDNESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"THURSDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"FRIDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"SATURDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"10:00am\",\n \"end\": \"02:00pm\"\n }\n ]\n },\n {\n \"day\": \"SUNDAY\",\n \"type\": \"CLOSED\",\n \"slots\": []\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "update" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"id\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"phone\": \"8073326999\",\n \"businessHours\": [\n {\n \"day\": \"MONDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"TUESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"WEDNESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"THURSDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"FRIDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"SATURDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"10:00am\",\n \"end\": \"02:00pm\"\n }\n ]\n },\n {\n \"day\": \"SUNDAY\",\n \"type\": \"CLOSED\",\n \"slots\": []\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "update" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"id\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"phone\": \"8073326999\",\n \"businessHours\": [\n {\n \"day\": \"MONDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"TUESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"WEDNESDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"THURSDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"FRIDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"09:00am\",\n \"end\": \"05:00pm\"\n }\n ]\n },\n {\n \"day\": \"SATURDAY\",\n \"type\": \"OPEN\",\n \"slots\": [\n {\n \"start\": \"10:00am\",\n \"end\": \"02:00pm\"\n }\n ]\n },\n {\n \"day\": \"SUNDAY\",\n \"type\": \"CLOSED\",\n \"slots\": []\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "update" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Attach media files to a location as photos (stitched via schemastitcher).", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photos\": [\n {\n \"photo\": \"https://cdn.example.com/jenny-home/logo.png\"\n },\n {\n \"photo\": \"https://cdn.example.com/jenny-home/storefront.jpg\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos" ] }, "description": "Attaches media to a location, either by public image URL or by referencing files already in your media library." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photos\": [\n {\n \"photo\": \"https://cdn.example.com/jenny-home/logo.png\"\n },\n {\n \"photo\": \"https://cdn.example.com/jenny-home/storefront.jpg\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"addLocationPhotos\": {\n \"clientMutationId\": null,\n \"photos\": [\n {\n \"id\": \"TWVkaWFGaWxlOjU4Nzg5MzE=\",\n \"url\": \"https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/f47d62a6.png\",\n \"caption\": null,\n \"starred\": false\n },\n {\n \"id\": \"TWVkaWFGaWxlOjU4Nzg5MzI=\",\n \"url\": \"https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/ef4ffb12.jpg\",\n \"caption\": null,\n \"starred\": false\n }\n ],\n \"errors\": null\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photos\": [\n {\n \"photo\": \"https://cdn.example.com/jenny-home/logo.png\"\n },\n {\n \"photo\": \"https://cdn.example.com/jenny-home/storefront.jpg\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photos\": [\n {\n \"photo\": \"https://cdn.example.com/jenny-home/logo.png\"\n },\n {\n \"photo\": \"https://cdn.example.com/jenny-home/storefront.jpg\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photos\": [\n {\n \"photo\": \"https://cdn.example.com/jenny-home/logo.png\"\n },\n {\n \"photo\": \"https://cdn.example.com/jenny-home/storefront.jpg\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Remove photos from a location.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photoIds\": [\n \"TWVkaWFGaWxlOjU4Nzg5MzI=\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "remove" ] }, "description": "Detaches one or more media files from a location by their media IDs." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photoIds\": [\n \"TWVkaWFGaWxlOjU4Nzg5MzI=\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "remove" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"removeLocationPhotos\": {\n \"clientMutationId\": null,\n \"removedCount\": 1,\n \"errors\": null\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photoIds\": [\n \"TWVkaWFGaWxlOjU4Nzg5MzI=\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "remove" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photoIds\": [\n \"TWVkaWFGaWxlOjU4Nzg5MzI=\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "remove" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photoIds\": [\n \"TWVkaWFGaWxlOjU4Nzg5MzI=\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "remove" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Mark photos as favourite.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photoIds\": [\n \"TWVkaWFGaWxlOjU4Nzg5MzI=\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/star", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "star" ] }, "description": "Marks one or more of a location's additional photos as favourites for priority placement on supported publishers." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photoIds\": [\n \"TWVkaWFGaWxlOjU4Nzg5MzI=\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/star", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "star" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"starLocationPhotos\": {\n \"clientMutationId\": null,\n \"photos\": [\n {\n \"id\": \"TWVkaWFGaWxlOjU4Nzg5MzI=\",\n \"url\": \"https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/ef4ffb12.jpg\",\n \"caption\": null,\n \"starred\": true\n }\n ],\n \"errors\": null\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photoIds\": [\n \"TWVkaWFGaWxlOjU4Nzg5MzI=\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/star", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "star" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photoIds\": [\n \"TWVkaWFGaWxlOjU4Nzg5MzI=\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/star", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "star" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"photoIds\": [\n \"TWVkaWFGaWxlOjU4Nzg5MzI=\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/star", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "star" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Archive locations.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"TG9jYXRpb246MTgwMDI5MA==\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "archive" ] }, "description": "Schedules one or more locations for archival at the end of the current billing cycle." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"TG9jYXRpb246MTgwMDI5MA==\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "archive" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"archiveLocations\": {\n \"clientMutationId\": null,\n \"bulkEditTaskId\": null,\n \"errors\": null,\n \"success\": null,\n \"result\": [\n {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"status\": \"ARCHIVE_SCHEDULED\",\n \"success\": true,\n \"errors\": null\n },\n {\n \"locationId\": \"TG9jYXRpb246MTgwMDI5MA==\",\n \"status\": \"ARCHIVE_SCHEDULED\",\n \"success\": true,\n \"errors\": null\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"TG9jYXRpb246MTgwMDI5MA==\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "archive" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"TG9jYXRpb246MTgwMDI5MA==\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "archive" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"TG9jYXRpb246MTgwMDI5MA==\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "archive" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Cancel archival of locations.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/cancel_archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "cancel_archive" ] }, "description": "Cancels a pending archival for locations in ARCHIVE_SCHEDULED status, restoring them to active." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/cancel_archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "cancel_archive" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"cancelLocationsArchive\": {\n \"clientMutationId\": null,\n \"bulkEditTaskId\": null,\n \"errors\": null,\n \"success\": null,\n \"result\": [\n {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"status\": \"ACTIVE\",\n \"success\": true,\n \"errors\": null\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/cancel_archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "cancel_archive" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/cancel_archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "cancel_archive" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/cancel_archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "cancel_archive" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "List media files attached to a single location (starred + unstarred).", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/photos", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "photos" ], "variable": [ { "key": "locationId", "value": "6662", "description": "The location's raw Base64-encoded Relay ID (for example `TG9jYXRpb246MTgwMDI4OQ==`). Send it un-encoded — a numeric database ID or a URL-encoded value returns `SY90002: Invalid Id`." } ] }, "description": "Returns all media files attached to a single location, including starred and unstarred photos." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/photos", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "photos" ], "variable": [ { "key": "locationId", "value": "6662", "description": "The location's raw Base64-encoded Relay ID (for example `TG9jYXRpb246MTgwMDI4OQ==`). Send it un-encoded — a numeric database ID or a URL-encoded value returns `SY90002: Invalid Id`." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"mediaFilesOfLocation\": [\n {\n \"id\": \"TWVkaWFGaWxlOjU4Nzg5MzE=\",\n \"url\": \"https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/f47d62a6.jpg\",\n \"thumbnailUrl\": \"https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/thumbnail_f47d62a6.jpg\",\n \"categoryName\": \"Logo\",\n \"categoryId\": \"4\",\n \"fileType\": \"image\",\n \"starred\": false,\n \"viewsCount\": 0\n },\n {\n \"id\": \"TWVkaWFGaWxlOjU4Nzg5MzI=\",\n \"url\": \"https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/ef4ffb12.jpg\",\n \"thumbnailUrl\": \"https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3f/59c670a3/thumbnail_ef4ffb12.jpg\",\n \"categoryName\": \"Additional\",\n \"categoryId\": \"12\",\n \"fileType\": \"image\",\n \"starred\": true,\n \"viewsCount\": 143\n }\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/photos", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "photos" ], "variable": [ { "key": "locationId", "value": "6662", "description": "The location's raw Base64-encoded Relay ID (for example `TG9jYXRpb246MTgwMDI4OQ==`). Send it un-encoded — a numeric database ID or a URL-encoded value returns `SY90002: Invalid Id`." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/photos", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "photos" ], "variable": [ { "key": "locationId", "value": "6662", "description": "The location's raw Base64-encoded Relay ID (for example `TG9jYXRpb246MTgwMDI4OQ==`). Send it un-encoded — a numeric database ID or a URL-encoded value returns `SY90002: Invalid Id`." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/photos", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "photos" ], "variable": [ { "key": "locationId", "value": "6662", "description": "The location's raw Base64-encoded Relay ID (for example `TG9jYXRpb246MTgwMDI4OQ==`). Send it un-encoded — a numeric database ID or a URL-encoded value returns `SY90002: Invalid Id`." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Return the status of a bulk add-media-to-location request.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/requests/:requestId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "requests", ":requestId" ], "variable": [ { "key": "requestId", "value": "string", "description": "UUID request ID returned in the `request` object by the add-photos endpoint when a batch exceeds 30 photos." } ] }, "description": "Returns the current processing status for a bulk photo upload request." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/requests/:requestId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "requests", ":requestId" ], "variable": [ { "key": "requestId", "value": "string", "description": "UUID request ID returned in the `request` object by the add-photos endpoint when a batch exceeds 30 photos." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"getLocationPhotosUploadStatus\": {\n \"requestId\": \"e6c2d9d9-9a18-4015-88cf-9a4e19a6f49a\",\n \"status\": \"SUCCESS\",\n \"photos\": [\n {\n \"mediaId\": \"TWVkaWFGaWxlOjkxODI3\",\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"status\": \"SUCCESS\",\n \"errorMessage\": null\n },\n {\n \"mediaId\": null,\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"status\": \"ERROR\",\n \"errorMessage\": \"Image dimensions below the minimum 250x250.\"\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/requests/:requestId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "requests", ":requestId" ], "variable": [ { "key": "requestId", "value": "string", "description": "UUID request ID returned in the `request` object by the add-photos endpoint when a batch exceeds 30 photos." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/requests/:requestId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "requests", ":requestId" ], "variable": [ { "key": "requestId", "value": "string", "description": "UUID request ID returned in the `request` object by the add-photos endpoint when a batch exceeds 30 photos." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/photos/requests/:requestId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "photos", "requests", ":requestId" ], "variable": [ { "key": "requestId", "value": "string", "description": "UUID request ID returned in the `request` object by the add-photos endpoint when a batch exceeds 30 photos." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] } ], "description": "Create, update, archive, and inspect business locations." }, { "name": "Listings", "item": [ { "name": "Get duplicate listings for the given location.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/listings/duplicates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "listings", "duplicates" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] }, "description": "Returns duplicate listing entries detected for a single location, grouped by publisher site." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/listings/duplicates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "listings", "duplicates" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"duplicateListingsForLocation\": [\n {\n \"id\": \"U2l0ZToxNTA=\",\n \"name\": \"City Squares\",\n \"url\": \"citysquares.com\",\n \"listings\": [\n {\n \"id\": \"RHVwbGljYXRlOjIzNTk4NDUw\",\n \"listingItemId\": \"TGlzdGluZ0l0ZW06MjM1OTg0NTA=\",\n \"name\": \"Woodbury Train Station\",\n \"liveLink\": \"http://citysquares.com/b/woodbury-train-station-23598450\",\n \"status\": \"POTENTIAL\"\n }\n ]\n }\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/listings/duplicates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "listings", "duplicates" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/listings/duplicates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "listings", "duplicates" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/listings/duplicates", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "listings", "duplicates" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Get voice assistants for a location.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/voice-assistants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "voice-assistants" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID. Accepts either the base64-encoded node ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or the raw numeric database ID (e.g. `1800289`)." } ] }, "description": "Returns the voice assistant listing sync status for a location across Google Assistant, Alexa, Siri, Cortana, and Bixby." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/voice-assistants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "voice-assistants" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID. Accepts either the base64-encoded node ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or the raw numeric database ID (e.g. `1800289`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"voiceAssistantsForLocation\": [\n {\n \"databaseId\": \"104468723\",\n \"voiceIdentifier\": \"GOOGLE_ASSISTANT\",\n \"name\": \"Google Assistant\",\n \"connectedAccountId\": null,\n \"syncStatus\": \"REQUIRING_ACTION\",\n \"actionRequired\": true,\n \"syncIssue\": null,\n \"errors\": []\n },\n {\n \"databaseId\": \"104468711\",\n \"voiceIdentifier\": \"SIRI\",\n \"name\": \"Siri\",\n \"connectedAccountId\": null,\n \"syncStatus\": \"IN_PROGRESS\",\n \"actionRequired\": false,\n \"syncIssue\": \"Google connection is required.\",\n \"errors\": []\n },\n {\n \"databaseId\": \"104468714\",\n \"voiceIdentifier\": \"ALEXA\",\n \"name\": \"Alexa\",\n \"connectedAccountId\": null,\n \"syncStatus\": \"IN_PROGRESS\",\n \"actionRequired\": false,\n \"syncIssue\": null,\n \"errors\": []\n }\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/voice-assistants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "voice-assistants" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID. Accepts either the base64-encoded node ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or the raw numeric database ID (e.g. `1800289`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/voice-assistants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "voice-assistants" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID. Accepts either the base64-encoded node ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or the raw numeric database ID (e.g. `1800289`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/voice-assistants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "voice-assistants" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID. Accepts either the base64-encoded node ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or the raw numeric database ID (e.g. `1800289`)." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Duplicate listing rollup for tag.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/duplicates?tag=string&filters=string&page=7322&perPage=7322", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "duplicates" ], "query": [ { "key": "tag", "value": "string", "description": "Location tag to scope the rollup to. Use `all` to span every location in the account." }, { "key": "filters", "value": "string", "description": "URL-encoded JSON filter object. Requires a `status` — one of `POTENTIAL`, `PROCESSING`, `FIXED`, `FAILED`. Optional `siteId` narrows to a single publisher. Example: `{\"status\":\"POTENTIAL\"}`." }, { "key": "page", "value": "7322", "description": "1-based page number." }, { "key": "perPage", "value": "7322", "description": "Records per page." } ] }, "description": "Returns a paginated, account-wide rollup of potential duplicate listings across every location under a tag." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/duplicates?tag=string&filters=string&page=7322&perPage=7322", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "duplicates" ], "query": [ { "description": "Location tag to scope the rollup to. Use `all` to span every location in the account.", "key": "tag", "value": "string" }, { "description": "URL-encoded JSON filter object. Requires a `status` — one of `POTENTIAL`, `PROCESSING`, `FIXED`, `FAILED`. Optional `siteId` narrows to a single publisher. Example: `{\"status\":\"POTENTIAL\"}`.", "key": "filters", "value": "string" }, { "description": "1-based page number.", "key": "page", "value": "7322" }, { "description": "Records per page.", "key": "perPage", "value": "7322" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"duplicateListingsRollup\": {\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"hasPreviousPage\": false,\n \"totalPages\": 34,\n \"totalRecords\": 1673\n },\n \"records\": [\n {\n \"id\": \"3329229\",\n \"name\": \"Woodbury Train Station\",\n \"nameValid\": false,\n \"duplicateProcessingState\": \"POTENTIAL\",\n \"liveLink\": \"http://citysquares.com/b/woodbury-train-station-23598450\",\n \"locationId\": \"73451\",\n \"siteName\": \"City Squares\",\n \"siteUrl\": \"citysquares.com\"\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/duplicates?tag=string&filters=string&page=7322&perPage=7322", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "duplicates" ], "query": [ { "description": "Location tag to scope the rollup to. Use `all` to span every location in the account.", "key": "tag", "value": "string" }, { "description": "URL-encoded JSON filter object. Requires a `status` — one of `POTENTIAL`, `PROCESSING`, `FIXED`, `FAILED`. Optional `siteId` narrows to a single publisher. Example: `{\"status\":\"POTENTIAL\"}`.", "key": "filters", "value": "string" }, { "description": "1-based page number.", "key": "page", "value": "7322" }, { "description": "Records per page.", "key": "perPage", "value": "7322" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/duplicates?tag=string&filters=string&page=7322&perPage=7322", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "duplicates" ], "query": [ { "description": "Location tag to scope the rollup to. Use `all` to span every location in the account.", "key": "tag", "value": "string" }, { "description": "URL-encoded JSON filter object. Requires a `status` — one of `POTENTIAL`, `PROCESSING`, `FIXED`, `FAILED`. Optional `siteId` narrows to a single publisher. Example: `{\"status\":\"POTENTIAL\"}`.", "key": "filters", "value": "string" }, { "description": "1-based page number.", "key": "page", "value": "7322" }, { "description": "Records per page.", "key": "perPage", "value": "7322" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/duplicates?tag=string&filters=string&page=7322&perPage=7322", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "duplicates" ], "query": [ { "description": "Location tag to scope the rollup to. Use `all` to span every location in the account.", "key": "tag", "value": "string" }, { "description": "URL-encoded JSON filter object. Requires a `status` — one of `POTENTIAL`, `PROCESSING`, `FIXED`, `FAILED`. Optional `siteId` narrows to a single publisher. Example: `{\"status\":\"POTENTIAL\"}`.", "key": "filters", "value": "string" }, { "description": "1-based page number.", "key": "page", "value": "7322" }, { "description": "Records per page.", "key": "perPage", "value": "7322" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Marking the duplicate listing item.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"listingItemIds\": [\n \"TGlzdGluZ0l0ZW06MjM1OTg0NTA=\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/mark-as-duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "mark-as-duplicate" ] }, "description": "Flags one or more detected listing items as confirmed duplicates so Listings API can suppress them." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"listingItemIds\": [\n \"TGlzdGluZ0l0ZW06MjM1OTg0NTA=\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/mark-as-duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "mark-as-duplicate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"markAsDuplicate\": {\n \"success\": true,\n \"errors\": null\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"listingItemIds\": [\n \"TGlzdGluZ0l0ZW06MjM1OTg0NTA=\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/mark-as-duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "mark-as-duplicate" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"listingItemIds\": [\n \"TGlzdGluZ0l0ZW06MjM1OTg0NTA=\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/mark-as-duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "mark-as-duplicate" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"listingItemIds\": [\n \"TGlzdGluZ0l0ZW06MjM1OTg0NTA=\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/mark-as-duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "mark-as-duplicate" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Marking the non duplicate listing item.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"listingItemIds\": [\n \"TGlzdGluZ0l0ZW06MjM1OTg0NTA=\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/mark-as-not-duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "mark-as-not-duplicate" ] }, "description": "Dismisses one or more potential duplicates as false positives so they stop appearing in the duplicates list." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"listingItemIds\": [\n \"TGlzdGluZ0l0ZW06MjM1OTg0NTA=\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/mark-as-not-duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "mark-as-not-duplicate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"markAsNotDuplicate\": {\n \"success\": true,\n \"errors\": null\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"listingItemIds\": [\n \"TGlzdGluZ0l0ZW06MjM1OTg0NTA=\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/mark-as-not-duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "mark-as-not-duplicate" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"listingItemIds\": [\n \"TGlzdGluZ0l0ZW06MjM1OTg0NTA=\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/mark-as-not-duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "mark-as-not-duplicate" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"listingItemIds\": [\n \"TGlzdGluZ0l0ZW06MjM1OTg0NTA=\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/listings/mark-as-not-duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "listings", "mark-as-not-duplicate" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Get listings for a location.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/listings/premium?listingType=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "listings", "premium" ], "query": [ { "key": "listingType", "value": "string", "description": "Which listing tier to return: `premium` for the plan's premium directory listings, or `additional` for additional/free listings." } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] }, "description": "Returns the sync status of every publisher directory in a location's plan." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/listings/premium?listingType=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "listings", "premium" ], "query": [ { "description": "Which listing tier to return: `premium` for the plan's premium directory listings, or `additional` for additional/free listings.", "key": "listingType", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"listingsForLocation\": [\n {\n \"id\": \"TGlzdGluZzoxMDQ0Njg3MjM=\",\n \"databaseId\": \"104468723\",\n \"site\": {\n \"id\": \"U2l0ZTox\",\n \"databaseId\": \"1\",\n \"name\": \"Google Maps\",\n \"url\": \"maps.google.com\",\n \"syScore\": \"100\"\n },\n \"syncStatus\": \"REQUIRING_ACTION\",\n \"displayStatus\": \"Connect your account to sync the listing\",\n \"actionRequired\": true,\n \"listingUrl\": null,\n \"connectedAccountId\": null,\n \"lastUpdate\": \"2026-07-06T18:33:28Z\",\n \"indexStatus\": false,\n \"syncIssue\": null,\n \"verified\": false\n },\n {\n \"id\": \"TGlzdGluZzoxMDQ0Njg3MTQ=\",\n \"databaseId\": \"104468714\",\n \"site\": {\n \"id\": \"U2l0ZToxODA=\",\n \"databaseId\": \"180\",\n \"name\": \"Bing\",\n \"url\": \"www.bing.com\",\n \"syScore\": \"97\"\n },\n \"syncStatus\": \"IN_PROGRESS\",\n \"displayStatus\": \"Information submitted to partner; awaiting response\",\n \"actionRequired\": false,\n \"listingUrl\": null,\n \"connectedAccountId\": null,\n \"lastUpdate\": \"2026-07-06T18:33:35Z\",\n \"indexStatus\": false,\n \"syncIssue\": null,\n \"verified\": false\n },\n {\n \"id\": \"TGlzdGluZzoxMDQ0Njg3Mjc=\",\n \"databaseId\": \"104468727\",\n \"site\": {\n \"id\": \"U2l0ZTozODc=\",\n \"databaseId\": \"387\",\n \"name\": \"BeLocalFocussed\",\n \"url\": \"belocalfocussed.com\",\n \"syScore\": \"80\"\n },\n \"syncStatus\": \"SYNCED\",\n \"displayStatus\": \"Synced\",\n \"actionRequired\": false,\n \"listingUrl\": \"https://belocalfocussed.com/jenny-home-26x0ffkd0e\",\n \"connectedAccountId\": null,\n \"lastUpdate\": \"2026-07-06T18:33:30Z\",\n \"indexStatus\": false,\n \"syncIssue\": null,\n \"verified\": false\n },\n {\n \"id\": \"TGlzdGluZzoxMDQ0Njg3MDk=\",\n \"databaseId\": \"104468709\",\n \"site\": {\n \"id\": \"U2l0ZTozMDE=\",\n \"databaseId\": \"301\",\n \"name\": \"Local Mint\",\n \"url\": \"localmint.com\",\n \"syScore\": \"69\"\n },\n \"syncStatus\": \"FAILED\",\n \"displayStatus\": \"Partner experiencing issues; awaiting response\",\n \"actionRequired\": false,\n \"listingUrl\": null,\n \"connectedAccountId\": null,\n \"lastUpdate\": \"2026-07-06T18:34:03Z\",\n \"indexStatus\": false,\n \"syncIssue\": \"Publisher requires website URL\",\n \"verified\": false\n }\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/listings/premium?listingType=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "listings", "premium" ], "query": [ { "description": "Which listing tier to return: `premium` for the plan's premium directory listings, or `additional` for additional/free listings.", "key": "listingType", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/listings/premium?listingType=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "listings", "premium" ], "query": [ { "description": "Which listing tier to return: `premium` for the plan's premium directory listings, or `additional` for additional/free listings.", "key": "listingType", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/listings/premium?listingType=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "listings", "premium" ], "query": [ { "description": "Which listing tier to return: `premium` for the plan's premium directory listings, or `additional` for additional/free listings.", "key": "listingType", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] } ], "description": "Premium and additional directory listings, duplicates, and AI evaluation." }, { "name": "Connected Accounts", "item": [ { "name": "connectedAccountsInfo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts?accountId=string&filters=string&sort=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts" ], "query": [ { "key": "accountId", "value": "string", "description": "Listings API account ID to scope results to. Defaults to the account that owns the API key." }, { "key": "filters", "value": "string", "description": "JSON-encoded object used to narrow the result set (for example by connection status or account type)." }, { "key": "sort", "value": "string", "description": "JSON-encoded object describing the sort order to apply to the records." }, { "key": "pageInfo", "value": "string", "description": "JSON-encoded pagination object, e.g. `{\"page\":1,\"perPage\":20}`." } ] }, "description": "Returns the Google and Facebook accounts connected to your Listings API account, with connection health and linked-location counts." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts?accountId=string&filters=string&sort=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts" ], "query": [ { "description": "Listings API account ID to scope results to. Defaults to the account that owns the API key.", "key": "accountId", "value": "string" }, { "description": "JSON-encoded object used to narrow the result set (for example by connection status or account type).", "key": "filters", "value": "string" }, { "description": "JSON-encoded object describing the sort order to apply to the records.", "key": "sort", "value": "string" }, { "description": "JSON-encoded pagination object, e.g. `{\"page\":1,\"perPage\":20}`.", "key": "pageInfo", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"connectedAccountsInfo\": {\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"hasPreviousPage\": false,\n \"totalPages\": 1,\n \"totalRecords\": 1\n },\n \"records\": [\n {\n \"accountId\": \"62670\",\n \"clientName\": \"owner@brightsmile-dental.com\",\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\",\n \"connectedAccountType\": \"GoogleAccount\",\n \"connectedLocationsCount\": 0,\n \"connectivityIssue\": null,\n \"email\": \"owner@brightsmile-dental.com\",\n \"lastFetchMatchesRequestedAt\": \"2026-07-06 21:43:07 UTC\",\n \"remarks\": null,\n \"requestMatches\": false,\n \"requestMatchesStatus\": \"MATCH_COMPLETED\",\n \"status\": \"CONNECTED\"\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts?accountId=string&filters=string&sort=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts" ], "query": [ { "description": "Listings API account ID to scope results to. Defaults to the account that owns the API key.", "key": "accountId", "value": "string" }, { "description": "JSON-encoded object used to narrow the result set (for example by connection status or account type).", "key": "filters", "value": "string" }, { "description": "JSON-encoded object describing the sort order to apply to the records.", "key": "sort", "value": "string" }, { "description": "JSON-encoded pagination object, e.g. `{\"page\":1,\"perPage\":20}`.", "key": "pageInfo", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts?accountId=string&filters=string&sort=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts" ], "query": [ { "description": "Listings API account ID to scope results to. Defaults to the account that owns the API key.", "key": "accountId", "value": "string" }, { "description": "JSON-encoded object used to narrow the result set (for example by connection status or account type).", "key": "filters", "value": "string" }, { "description": "JSON-encoded object describing the sort order to apply to the records.", "key": "sort", "value": "string" }, { "description": "JSON-encoded pagination object, e.g. `{\"page\":1,\"perPage\":20}`.", "key": "pageInfo", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts?accountId=string&filters=string&sort=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts" ], "query": [ { "description": "Listings API account ID to scope results to. Defaults to the account that owns the API key.", "key": "accountId", "value": "string" }, { "description": "JSON-encoded object used to narrow the result set (for example by connection status or account type).", "key": "filters", "value": "string" }, { "description": "JSON-encoded object describing the sort order to apply to the records.", "key": "sort", "value": "string" }, { "description": "JSON-encoded pagination object, e.g. `{\"page\":1,\"perPage\":20}`.", "key": "pageInfo", "value": "string" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "connectedAccountDetails", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/details", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "details" ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected account (from the list connected accounts endpoint)." } ] }, "description": "Returns the details of a single connected Google or Facebook account by its ID." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/details", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "details" ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected account (from the list connected accounts endpoint)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"connectedAccountDetails\": {\n \"details\": {\n \"accountId\": \"62670\",\n \"clientName\": \"owner@brightsmile-dental.com\",\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\",\n \"connectedAccountType\": \"GoogleAccount\",\n \"connectedLocationsCount\": 0,\n \"connectivityIssue\": null,\n \"email\": \"owner@brightsmile-dental.com\",\n \"lastFetchMatchesRequestedAt\": \"2026-07-06 21:43:07 UTC\",\n \"remarks\": null,\n \"requestMatches\": false,\n \"requestMatchesStatus\": \"MATCH_COMPLETED\",\n \"status\": \"CONNECTED\"\n }\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/details", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "details" ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected account (from the list connected accounts endpoint)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/details", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "details" ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected account (from the list connected accounts endpoint)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/details", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "details" ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected account (from the list connected accounts endpoint)." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Listings belonging to a connected account.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connected-account-listings?connectedAccountId=string&filters=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connected-account-listings" ], "query": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected account whose listings to fetch." }, { "key": "filters", "value": "string", "description": "JSON-encoded object used to search within listings (for example by business name, address, phone, or postal code)." }, { "key": "pageInfo", "value": "string", "description": "JSON-encoded pagination object, e.g. `{\"page\":1,\"perPage\":20}`. Up to 500 records per page." } ] }, "description": "Returns the Google Business Profile or Facebook listings accessible to a connected account, with optional filtering and pagination." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connected-account-listings?connectedAccountId=string&filters=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connected-account-listings" ], "query": [ { "description": "UUID of the connected account whose listings to fetch.", "key": "connectedAccountId", "value": "string" }, { "description": "JSON-encoded object used to search within listings (for example by business name, address, phone, or postal code).", "key": "filters", "value": "string" }, { "description": "JSON-encoded pagination object, e.g. `{\"page\":1,\"perPage\":20}`. Up to 500 records per page.", "key": "pageInfo", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"connectedAccountListings\": {\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"hasPreviousPage\": false,\n \"totalPages\": 1,\n \"totalRecords\": 60\n },\n \"records\": [\n {\n \"accountTypeName\": \"Google\",\n \"address\": \"123 William St, NY 10038, Manhattan, US\",\n \"id\": \"R21iQnVsa0RhdGFMYWtlOjA2MDQ4NmExLTA0NzQtNDc4NS1iMjNhLTBkOGM4MzhmNGQ5OA==\",\n \"liveLink\": null,\n \"locationName\": \"Trial\",\n \"phone\": \"(718) 667-7787\"\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connected-account-listings?connectedAccountId=string&filters=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connected-account-listings" ], "query": [ { "description": "UUID of the connected account whose listings to fetch.", "key": "connectedAccountId", "value": "string" }, { "description": "JSON-encoded object used to search within listings (for example by business name, address, phone, or postal code).", "key": "filters", "value": "string" }, { "description": "JSON-encoded pagination object, e.g. `{\"page\":1,\"perPage\":20}`. Up to 500 records per page.", "key": "pageInfo", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connected-account-listings?connectedAccountId=string&filters=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connected-account-listings" ], "query": [ { "description": "UUID of the connected account whose listings to fetch.", "key": "connectedAccountId", "value": "string" }, { "description": "JSON-encoded object used to search within listings (for example by business name, address, phone, or postal code).", "key": "filters", "value": "string" }, { "description": "JSON-encoded pagination object, e.g. `{\"page\":1,\"perPage\":20}`. Up to 500 records per page.", "key": "pageInfo", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connected-account-listings?connectedAccountId=string&filters=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connected-account-listings" ], "query": [ { "description": "UUID of the connected account whose listings to fetch.", "key": "connectedAccountId", "value": "string" }, { "description": "JSON-encoded object used to search within listings (for example by business name, address, phone, or postal code).", "key": "filters", "value": "string" }, { "description": "JSON-encoded pagination object, e.g. `{\"page\":1,\"perPage\":20}`. Up to 500 records per page.", "key": "pageInfo", "value": "string" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "connectionSuggestionsForAccount", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/connection-suggestions?accountId=string&filters=string&sortBy=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "connection-suggestions" ], "query": [ { "key": "accountId", "value": "string", "description": "Listings API account ID to scope suggestions to. Defaults to the account the API key belongs to." }, { "key": "filters", "value": "string", "description": "JSON-encoded filter object to narrow the suggestions." }, { "key": "sortBy", "value": "string", "description": "JSON-encoded sort object." }, { "key": "pageInfo", "value": "string", "description": "JSON-encoded pagination object (page / perPage)." } ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected account to list suggestions for." } ] }, "description": "Returns suggested matches between Listings API locations and Google Business Profile or Facebook listings for a connected account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/connection-suggestions?accountId=string&filters=string&sortBy=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "connection-suggestions" ], "query": [ { "description": "Listings API account ID to scope suggestions to. Defaults to the account the API key belongs to.", "key": "accountId", "value": "string" }, { "description": "JSON-encoded filter object to narrow the suggestions.", "key": "filters", "value": "string" }, { "description": "JSON-encoded sort object.", "key": "sortBy", "value": "string" }, { "description": "JSON-encoded pagination object (page / perPage).", "key": "pageInfo", "value": "string" } ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected account to list suggestions for." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"connectionSuggestionsForAccount\": {\n \"pageInfo\": {\n \"hasNextPage\": false,\n \"hasPreviousPage\": false,\n \"totalPages\": 1,\n \"totalRecords\": 2\n },\n \"records\": [\n {\n \"accountEmail\": \"contact@brightsmile-dental.com\",\n \"accountType\": \"GMB\",\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\",\n \"locationId\": \"73415\",\n \"matchedDataDatabaseId\": \"0d5e306f-0da0-46e3-929f-fd3c67ccd8cc\",\n \"locationInfo\": {\n \"name\": \"My Business\",\n \"city\": \"Lincoln\",\n \"stateIso\": \"NE\"\n },\n \"suggestedLocationInfo\": {\n \"locationInfo\": {\n \"name\": \"My Business\",\n \"city\": \"Lincoln\"\n }\n }\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/connection-suggestions?accountId=string&filters=string&sortBy=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "connection-suggestions" ], "query": [ { "description": "Listings API account ID to scope suggestions to. Defaults to the account the API key belongs to.", "key": "accountId", "value": "string" }, { "description": "JSON-encoded filter object to narrow the suggestions.", "key": "filters", "value": "string" }, { "description": "JSON-encoded sort object.", "key": "sortBy", "value": "string" }, { "description": "JSON-encoded pagination object (page / perPage).", "key": "pageInfo", "value": "string" } ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected account to list suggestions for." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/connection-suggestions?accountId=string&filters=string&sortBy=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "connection-suggestions" ], "query": [ { "description": "Listings API account ID to scope suggestions to. Defaults to the account the API key belongs to.", "key": "accountId", "value": "string" }, { "description": "JSON-encoded filter object to narrow the suggestions.", "key": "filters", "value": "string" }, { "description": "JSON-encoded sort object.", "key": "sortBy", "value": "string" }, { "description": "JSON-encoded pagination object (page / perPage).", "key": "pageInfo", "value": "string" } ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected account to list suggestions for." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/connection-suggestions?accountId=string&filters=string&sortBy=string&pageInfo=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "connection-suggestions" ], "query": [ { "description": "Listings API account ID to scope suggestions to. Defaults to the account the API key belongs to.", "key": "accountId", "value": "string" }, { "description": "JSON-encoded filter object to narrow the suggestions.", "key": "filters", "value": "string" }, { "description": "JSON-encoded sort object.", "key": "sortBy", "value": "string" }, { "description": "JSON-encoded pagination object (page / perPage).", "key": "pageInfo", "value": "string" } ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected account to list suggestions for." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "getFoldersUnderGoogleAccount", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/folders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "folders" ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected Google account (from the list connected accounts endpoint)." } ] }, "description": "Returns the Google Business Profile folders (groups) accessible to a connected Google account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/folders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "folders" ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected Google account (from the list connected accounts endpoint)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"getFoldersUnderGoogleAccount\": [\n {\n \"folderId\": \"accounts/104890024806530350198\",\n \"folderName\": \"Aniruddha Basu\",\n \"locationCount\": null\n }\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/folders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "folders" ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected Google account (from the list connected accounts endpoint)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/folders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "folders" ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected Google account (from the list connected accounts endpoint)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/:connectedAccountId/folders", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", ":connectedAccountId", "folders" ], "variable": [ { "key": "connectedAccountId", "value": "string", "description": "UUID of the connected Google account (from the list connected accounts endpoint)." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "bulkConnectLinkForGoogle", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"successUrl\": \"https://app.example.com/connect/google/success\",\n \"errorUrl\": \"https://app.example.com/connect/google/error\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-google", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-google" ] }, "description": "Returns an OAuth URL to link a Google Business Profile account to your Listings API account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"successUrl\": \"https://app.example.com/connect/google/success\",\n \"errorUrl\": \"https://app.example.com/connect/google/error\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-google", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-google" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"bulkConnectLinkForGoogle\": {\n \"errors\": null,\n \"success\": true,\n \"url\": \"https://claim.verifymybiz.com/locations/redirect_oauth_bulk/google_oauth2?onboarding=false&platform=local&token=9009dc92-2b18-421f-b856-d157f3f06d6b\"\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"successUrl\": \"https://app.example.com/connect/google/success\",\n \"errorUrl\": \"https://app.example.com/connect/google/error\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-google", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-google" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"successUrl\": \"https://app.example.com/connect/google/success\",\n \"errorUrl\": \"https://app.example.com/connect/google/error\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-google", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-google" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"successUrl\": \"https://app.example.com/connect/google/success\",\n \"errorUrl\": \"https://app.example.com/connect/google/error\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-google", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-google" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "bulkConnectLinkForFacebook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"successUrl\": \"https://app.example.com/connect/facebook/success\",\n \"errorUrl\": \"https://app.example.com/connect/facebook/error\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-facebook", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-facebook" ] }, "description": "Returns an OAuth URL to link a Facebook Pages account to your Listings API account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"successUrl\": \"https://app.example.com/connect/facebook/success\",\n \"errorUrl\": \"https://app.example.com/connect/facebook/error\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-facebook", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-facebook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"bulkConnectLinkForFacebook\": {\n \"errors\": null,\n \"success\": true,\n \"url\": \"https://claim.verifymybiz.com/locations/redirect_oauth_bulk/facebook?onboarding=false&platform=local&token=bfac8e06-8d72-4810-9c50-ae7ee12a7b52\"\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"successUrl\": \"https://app.example.com/connect/facebook/success\",\n \"errorUrl\": \"https://app.example.com/connect/facebook/error\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-facebook", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-facebook" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"successUrl\": \"https://app.example.com/connect/facebook/success\",\n \"errorUrl\": \"https://app.example.com/connect/facebook/error\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-facebook", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-facebook" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"successUrl\": \"https://app.example.com/connect/facebook/success\",\n \"errorUrl\": \"https://app.example.com/connect/facebook/error\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-facebook", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-facebook" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "connectedAccountsTriggerMatches", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountIds\": [\n \"4f712c17-4f95-42dd-90f4-97171a2e67b5\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/trigger-matches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "trigger-matches" ] }, "description": "Fetches the Google and Facebook profiles for connected accounts and matches them against your Listings API locations." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountIds\": [\n \"4f712c17-4f95-42dd-90f4-97171a2e67b5\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/trigger-matches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "trigger-matches" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"connectedAccountsTriggerMatches\": {\n \"failedIds\": null,\n \"success\": true\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountIds\": [\n \"4f712c17-4f95-42dd-90f4-97171a2e67b5\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/trigger-matches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "trigger-matches" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountIds\": [\n \"4f712c17-4f95-42dd-90f4-97171a2e67b5\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/trigger-matches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "trigger-matches" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountIds\": [\n \"4f712c17-4f95-42dd-90f4-97171a2e67b5\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/trigger-matches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "trigger-matches" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "confirmConnectMatches", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"matchRecordIds\": [\n \"0d5e306f-0da0-46e3-929f-fd3c67ccd8cc\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/confirm-matches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "confirm-matches" ] }, "description": "Confirms suggested location-to-listing matches returned by the connection suggestions endpoint." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"matchRecordIds\": [\n \"0d5e306f-0da0-46e3-929f-fd3c67ccd8cc\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/confirm-matches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "confirm-matches" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"confirmConnectMatches\": {\n \"failedIds\": null,\n \"success\": true\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"matchRecordIds\": [\n \"0d5e306f-0da0-46e3-929f-fd3c67ccd8cc\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/confirm-matches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "confirm-matches" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"matchRecordIds\": [\n \"0d5e306f-0da0-46e3-929f-fd3c67ccd8cc\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/confirm-matches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "confirm-matches" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"matchRecordIds\": [\n \"0d5e306f-0da0-46e3-929f-fd3c67ccd8cc\"\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/confirm-matches", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "confirm-matches" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "gmbBulkDisconnect", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"d2397854-52c2-41d7-95f1-b90cba16498d\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-google", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-google" ] }, "description": "Disconnects a connected Google Business Profile account (or specific locations under it) from your Listings API account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"d2397854-52c2-41d7-95f1-b90cba16498d\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-google", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-google" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"gmbBulkDisconnect\": {\n \"success\": true\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"d2397854-52c2-41d7-95f1-b90cba16498d\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-google", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-google" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"d2397854-52c2-41d7-95f1-b90cba16498d\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-google", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-google" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"d2397854-52c2-41d7-95f1-b90cba16498d\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-google", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-google" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "fbBulkDisconnect", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"d2397854-52c2-41d7-95f1-b90cba16498d\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-facebook", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-facebook" ] }, "description": "Disconnects a previously connected Facebook Pages account from your Listings API account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"d2397854-52c2-41d7-95f1-b90cba16498d\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-facebook", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-facebook" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"fbBulkDisconnect\": {\n \"success\": true\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"d2397854-52c2-41d7-95f1-b90cba16498d\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-facebook", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-facebook" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"d2397854-52c2-41d7-95f1-b90cba16498d\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-facebook", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-facebook" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"d2397854-52c2-41d7-95f1-b90cba16498d\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-facebook", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-facebook" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "connectListing", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\",\n \"connectedAccountListingId\": \"R29vZ2xlTG9jYXRpb246ODc3NTkzNGItNTA5OC00ZDBhLThiNDQ=\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-listing" ] }, "description": "Links a specific Google Business Profile or Facebook listing to a Listings API location." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\",\n \"connectedAccountListingId\": \"R29vZ2xlTG9jYXRpb246ODc3NTkzNGItNTA5OC00ZDBhLThiNDQ=\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-listing" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"connectListing\": {\n \"message\": null,\n \"success\": true\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\",\n \"connectedAccountListingId\": \"R29vZ2xlTG9jYXRpb246ODc3NTkzNGItNTA5OC00ZDBhLThiNDQ=\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-listing" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\",\n \"connectedAccountListingId\": \"R29vZ2xlTG9jYXRpb246ODc3NTkzNGItNTA5OC00ZDBhLThiNDQ=\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-listing" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\",\n \"connectedAccountListingId\": \"R29vZ2xlTG9jYXRpb246ODc3NTkzNGItNTA5OC00ZDBhLThiNDQ=\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/connect-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "connect-listing" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "createLocationFromConnectedAccountListing", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\",\n \"connectedAccountListingId\": \"R21iQnVsa0RhdGFMYWtlOjU3NzU5MzRiLTUwOTgtNGQwYS04YjQ0LTNjY2ZlZmZkZmUzNw==\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/create-location-from-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "create-location-from-listing" ] }, "description": "Creates a new Listings API location from an existing Google Business Profile or Facebook listing in a connected account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\",\n \"connectedAccountListingId\": \"R21iQnVsa0RhdGFMYWtlOjU3NzU5MzRiLTUwOTgtNGQwYS04YjQ0LTNjY2ZlZmZkZmUzNw==\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/create-location-from-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "create-location-from-listing" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"createLocationFromConnectedAccountListing\": {\n \"success\": true,\n \"locationId\": 88277,\n \"errors\": null\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\",\n \"connectedAccountListingId\": \"R21iQnVsa0RhdGFMYWtlOjU3NzU5MzRiLTUwOTgtNGQwYS04YjQ0LTNjY2ZlZmZkZmUzNw==\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/create-location-from-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "create-location-from-listing" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\",\n \"connectedAccountListingId\": \"R21iQnVsa0RhdGFMYWtlOjU3NzU5MzRiLTUwOTgtNGQwYS04YjQ0LTNjY2ZlZmZkZmUzNw==\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/create-location-from-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "create-location-from-listing" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\",\n \"connectedAccountListingId\": \"R21iQnVsa0RhdGFMYWtlOjU3NzU5MzRiLTUwOTgtNGQwYS04YjQ0LTNjY2ZlZmZkZmUzNw==\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/create-location-from-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "create-location-from-listing" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "createGmbListingForLocation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/create/gmb-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "create", "gmb-listing" ] }, "description": "Creates a new Google Business Profile listing for an existing Listings API location and links it to a connected Google account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/create/gmb-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "create", "gmb-listing" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"createGmbListingForLocation\": {\n \"clientMutationId\": null,\n \"success\": true,\n \"errors\": null\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/create/gmb-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "create", "gmb-listing" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/create/gmb-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "create", "gmb-listing" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"locationId\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"connectedAccountId\": \"4f712c17-4f95-42dd-90f4-97171a2e67b5\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/create/gmb-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "create", "gmb-listing" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "disconnectConnectedAccountListing", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"locationIds\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-listing" ] }, "description": "Unlinks the connected Google or Facebook listing from one or more Listings API locations." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"locationIds\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-listing" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"disconnectConnectedAccountListing\": {\n \"deleted\": 1\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"locationIds\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-listing" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"locationIds\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-listing" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"locationIds\": [\n \"string\",\n \"string\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/connected-accounts/disconnect-listing", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "connected-accounts", "disconnect-listing" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] } ], "description": "Bulk Google / Facebook / Yelp / TripAdvisor account connection flows." }, { "name": "Reviews", "item": [ { "name": "Paginated list of interactions (reviews / Q&A / social) for a single location, with filters.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/reviews?tag=string&siteUrls=string&startDate=string&searchString=string&endDate=string&category=string&categories=string&ratingFilters=string&ratingFilter=7322&responseStatus=string&sortOrder=string&first=7322&after=string&last=7322&before=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "reviews" ], "query": [ { "key": "tag", "value": "string", "description": "Filter by a location tag." }, { "key": "siteUrls", "value": "string", "description": "JSON-encoded array of publisher hostnames to include, e.g. `[\"maps.google.com\",\"yelp.com\"]`." }, { "key": "startDate", "value": "string", "description": "Start of the date-range filter (YYYY-MM-DD)." }, { "key": "searchString", "value": "string", "description": "Full-text search across interaction content." }, { "key": "endDate", "value": "string", "description": "End of the date-range filter (YYYY-MM-DD)." }, { "key": "category", "value": "string", "description": "Single interaction category, e.g. `REVIEW`." }, { "key": "categories", "value": "string", "description": "JSON-encoded array of interaction categories." }, { "key": "ratingFilters", "value": "string", "description": "JSON-encoded array of star ratings to include, e.g. `[3,4]`." }, { "key": "ratingFilter", "value": "7322", "description": "Single star rating to filter by." }, { "key": "responseStatus", "value": "string", "description": "JSON-encoded response-status filter. Values: `RESPONDED`, `PENDING`." }, { "key": "sortOrder", "value": "string", "description": "JSON-encoded sort order. Values: `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`." }, { "key": "first", "value": "7322", "description": "Number of records to return from the beginning (newest first)." }, { "key": "after", "value": "string", "description": "Cursor value — return records after this cursor (forward pagination)." }, { "key": "last", "value": "7322", "description": "Number of records to return from the end." }, { "key": "before", "value": "string", "description": "Cursor value — return records before this cursor (backward pagination)." } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID — a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`)." } ] }, "description": "Returns a cursor-paginated list of reviews and social interactions for a single location, with filters." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/reviews?tag=string&siteUrls=string&startDate=string&searchString=string&endDate=string&category=string&categories=string&ratingFilters=string&ratingFilter=7322&responseStatus=string&sortOrder=string&first=7322&after=string&last=7322&before=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "reviews" ], "query": [ { "description": "Filter by a location tag.", "key": "tag", "value": "string" }, { "description": "JSON-encoded array of publisher hostnames to include, e.g. `[\"maps.google.com\",\"yelp.com\"]`.", "key": "siteUrls", "value": "string" }, { "description": "Start of the date-range filter (YYYY-MM-DD).", "key": "startDate", "value": "string" }, { "description": "Full-text search across interaction content.", "key": "searchString", "value": "string" }, { "description": "End of the date-range filter (YYYY-MM-DD).", "key": "endDate", "value": "string" }, { "description": "Single interaction category, e.g. `REVIEW`.", "key": "category", "value": "string" }, { "description": "JSON-encoded array of interaction categories.", "key": "categories", "value": "string" }, { "description": "JSON-encoded array of star ratings to include, e.g. `[3,4]`.", "key": "ratingFilters", "value": "string" }, { "description": "Single star rating to filter by.", "key": "ratingFilter", "value": "7322" }, { "description": "JSON-encoded response-status filter. Values: `RESPONDED`, `PENDING`.", "key": "responseStatus", "value": "string" }, { "description": "JSON-encoded sort order. Values: `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`.", "key": "sortOrder", "value": "string" }, { "description": "Number of records to return from the beginning (newest first).", "key": "first", "value": "7322" }, { "description": "Cursor value — return records after this cursor (forward pagination).", "key": "after", "value": "string" }, { "description": "Number of records to return from the end.", "key": "last", "value": "7322" }, { "description": "Cursor value — return records before this cursor (backward pagination).", "key": "before", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID — a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"interactions\": {\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"hasPreviousPage\": false,\n \"endCursor\": \"SW50ZXJhY3Rpb246OWUyNmQyYTg=\"\n },\n \"edges\": [\n {\n \"node\": {\n \"id\": \"9e26d2a8-a6ed-42ea-8454-47d1c92ea841\",\n \"source\": \"maps.google.com\",\n \"content\": \"nice place for family together\",\n \"authorName\": \"vaibhav nakate\",\n \"rating\": 5,\n \"date\": \"2019-04-02T22:11:13.036997+00:00\",\n \"category\": \"Review\",\n \"type\": \"Review\",\n \"responded\": false,\n \"responseCount\": 0,\n \"canRespond\": true,\n \"permalink\": \"https://maps.google.com/maps?cid=...\"\n },\n \"cursor\": \"SW50ZXJhY3Rpb246OWUyNmQyYTg=\"\n }\n ],\n \"totalCount\": 425\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/reviews?tag=string&siteUrls=string&startDate=string&searchString=string&endDate=string&category=string&categories=string&ratingFilters=string&ratingFilter=7322&responseStatus=string&sortOrder=string&first=7322&after=string&last=7322&before=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "reviews" ], "query": [ { "description": "Filter by a location tag.", "key": "tag", "value": "string" }, { "description": "JSON-encoded array of publisher hostnames to include, e.g. `[\"maps.google.com\",\"yelp.com\"]`.", "key": "siteUrls", "value": "string" }, { "description": "Start of the date-range filter (YYYY-MM-DD).", "key": "startDate", "value": "string" }, { "description": "Full-text search across interaction content.", "key": "searchString", "value": "string" }, { "description": "End of the date-range filter (YYYY-MM-DD).", "key": "endDate", "value": "string" }, { "description": "Single interaction category, e.g. `REVIEW`.", "key": "category", "value": "string" }, { "description": "JSON-encoded array of interaction categories.", "key": "categories", "value": "string" }, { "description": "JSON-encoded array of star ratings to include, e.g. `[3,4]`.", "key": "ratingFilters", "value": "string" }, { "description": "Single star rating to filter by.", "key": "ratingFilter", "value": "7322" }, { "description": "JSON-encoded response-status filter. Values: `RESPONDED`, `PENDING`.", "key": "responseStatus", "value": "string" }, { "description": "JSON-encoded sort order. Values: `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`.", "key": "sortOrder", "value": "string" }, { "description": "Number of records to return from the beginning (newest first).", "key": "first", "value": "7322" }, { "description": "Cursor value — return records after this cursor (forward pagination).", "key": "after", "value": "string" }, { "description": "Number of records to return from the end.", "key": "last", "value": "7322" }, { "description": "Cursor value — return records before this cursor (backward pagination).", "key": "before", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID — a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/reviews?tag=string&siteUrls=string&startDate=string&searchString=string&endDate=string&category=string&categories=string&ratingFilters=string&ratingFilter=7322&responseStatus=string&sortOrder=string&first=7322&after=string&last=7322&before=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "reviews" ], "query": [ { "description": "Filter by a location tag.", "key": "tag", "value": "string" }, { "description": "JSON-encoded array of publisher hostnames to include, e.g. `[\"maps.google.com\",\"yelp.com\"]`.", "key": "siteUrls", "value": "string" }, { "description": "Start of the date-range filter (YYYY-MM-DD).", "key": "startDate", "value": "string" }, { "description": "Full-text search across interaction content.", "key": "searchString", "value": "string" }, { "description": "End of the date-range filter (YYYY-MM-DD).", "key": "endDate", "value": "string" }, { "description": "Single interaction category, e.g. `REVIEW`.", "key": "category", "value": "string" }, { "description": "JSON-encoded array of interaction categories.", "key": "categories", "value": "string" }, { "description": "JSON-encoded array of star ratings to include, e.g. `[3,4]`.", "key": "ratingFilters", "value": "string" }, { "description": "Single star rating to filter by.", "key": "ratingFilter", "value": "7322" }, { "description": "JSON-encoded response-status filter. Values: `RESPONDED`, `PENDING`.", "key": "responseStatus", "value": "string" }, { "description": "JSON-encoded sort order. Values: `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`.", "key": "sortOrder", "value": "string" }, { "description": "Number of records to return from the beginning (newest first).", "key": "first", "value": "7322" }, { "description": "Cursor value — return records after this cursor (forward pagination).", "key": "after", "value": "string" }, { "description": "Number of records to return from the end.", "key": "last", "value": "7322" }, { "description": "Cursor value — return records before this cursor (backward pagination).", "key": "before", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID — a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/reviews?tag=string&siteUrls=string&startDate=string&searchString=string&endDate=string&category=string&categories=string&ratingFilters=string&ratingFilter=7322&responseStatus=string&sortOrder=string&first=7322&after=string&last=7322&before=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "reviews" ], "query": [ { "description": "Filter by a location tag.", "key": "tag", "value": "string" }, { "description": "JSON-encoded array of publisher hostnames to include, e.g. `[\"maps.google.com\",\"yelp.com\"]`.", "key": "siteUrls", "value": "string" }, { "description": "Start of the date-range filter (YYYY-MM-DD).", "key": "startDate", "value": "string" }, { "description": "Full-text search across interaction content.", "key": "searchString", "value": "string" }, { "description": "End of the date-range filter (YYYY-MM-DD).", "key": "endDate", "value": "string" }, { "description": "Single interaction category, e.g. `REVIEW`.", "key": "category", "value": "string" }, { "description": "JSON-encoded array of interaction categories.", "key": "categories", "value": "string" }, { "description": "JSON-encoded array of star ratings to include, e.g. `[3,4]`.", "key": "ratingFilters", "value": "string" }, { "description": "Single star rating to filter by.", "key": "ratingFilter", "value": "7322" }, { "description": "JSON-encoded response-status filter. Values: `RESPONDED`, `PENDING`.", "key": "responseStatus", "value": "string" }, { "description": "JSON-encoded sort order. Values: `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`.", "key": "sortOrder", "value": "string" }, { "description": "Number of records to return from the beginning (newest first).", "key": "first", "value": "7322" }, { "description": "Cursor value — return records after this cursor (forward pagination).", "key": "after", "value": "string" }, { "description": "Number of records to return from the end.", "key": "last", "value": "7322" }, { "description": "Cursor value — return records before this cursor (backward pagination).", "key": "before", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID — a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`)." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Paginated list of interactions across many locations (rollup scope).", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/rollup_interactions?tag=string&locationFilters=string&siteUrls=string&startDate=string&endDate=string&searchString=string&category=string&categories=string&ratingFilters=string&ratingFilter=7322&responseStatus=string&sortOrder=string&first=7322&after=string&last=7322&before=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "rollup_interactions" ], "query": [ { "key": "tag", "value": "string", "description": "Location tag defining the rollup scope. Required — the request returns 400 without it. Use `all` to span every location." }, { "key": "locationFilters", "value": "string", "description": "JSON-encoded array of location IDs to restrict the rollup to." }, { "key": "siteUrls", "value": "string", "description": "JSON-encoded array of publisher hostnames to include." }, { "key": "startDate", "value": "string", "description": "Start of the date-range filter (YYYY-MM-DD)." }, { "key": "endDate", "value": "string", "description": "End of the date-range filter (YYYY-MM-DD)." }, { "key": "searchString", "value": "string", "description": "Full-text search across interaction content." }, { "key": "category", "value": "string", "description": "Single interaction category, e.g. `REVIEW`." }, { "key": "categories", "value": "string", "description": "JSON-encoded array of interaction categories." }, { "key": "ratingFilters", "value": "string", "description": "JSON-encoded array of star ratings to include, e.g. `[3,4]`." }, { "key": "ratingFilter", "value": "7322", "description": "Single star rating to filter by." }, { "key": "responseStatus", "value": "string", "description": "JSON-encoded response-status filter. Values: `RESPONDED`, `PENDING`." }, { "key": "sortOrder", "value": "string", "description": "JSON-encoded sort order. Values: `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`." }, { "key": "first", "value": "7322", "description": "Number of records to return from the beginning." }, { "key": "after", "value": "string", "description": "Cursor value — return records after this cursor (forward pagination)." }, { "key": "last", "value": "7322", "description": "Number of records to return from the end." }, { "key": "before", "value": "string", "description": "Cursor value — return records before this cursor (backward pagination)." } ] }, "description": "Returns a cursor-paginated list of interactions across many locations in the account, with filtering and sorting." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/rollup_interactions?tag=string&locationFilters=string&siteUrls=string&startDate=string&endDate=string&searchString=string&category=string&categories=string&ratingFilters=string&ratingFilter=7322&responseStatus=string&sortOrder=string&first=7322&after=string&last=7322&before=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "rollup_interactions" ], "query": [ { "description": "Location tag defining the rollup scope. Required — the request returns 400 without it. Use `all` to span every location.", "key": "tag", "value": "string" }, { "description": "JSON-encoded array of location IDs to restrict the rollup to.", "key": "locationFilters", "value": "string" }, { "description": "JSON-encoded array of publisher hostnames to include.", "key": "siteUrls", "value": "string" }, { "description": "Start of the date-range filter (YYYY-MM-DD).", "key": "startDate", "value": "string" }, { "description": "End of the date-range filter (YYYY-MM-DD).", "key": "endDate", "value": "string" }, { "description": "Full-text search across interaction content.", "key": "searchString", "value": "string" }, { "description": "Single interaction category, e.g. `REVIEW`.", "key": "category", "value": "string" }, { "description": "JSON-encoded array of interaction categories.", "key": "categories", "value": "string" }, { "description": "JSON-encoded array of star ratings to include, e.g. `[3,4]`.", "key": "ratingFilters", "value": "string" }, { "description": "Single star rating to filter by.", "key": "ratingFilter", "value": "7322" }, { "description": "JSON-encoded response-status filter. Values: `RESPONDED`, `PENDING`.", "key": "responseStatus", "value": "string" }, { "description": "JSON-encoded sort order. Values: `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`.", "key": "sortOrder", "value": "string" }, { "description": "Number of records to return from the beginning.", "key": "first", "value": "7322" }, { "description": "Cursor value — return records after this cursor (forward pagination).", "key": "after", "value": "string" }, { "description": "Number of records to return from the end.", "key": "last", "value": "7322" }, { "description": "Cursor value — return records before this cursor (backward pagination).", "key": "before", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"rollupInteractions\": {\n \"pageInfo\": {\n \"hasNextPage\": true,\n \"hasPreviousPage\": false\n },\n \"edges\": [\n {\n \"node\": {\n \"id\": \"9e26d2a8-a6ed-42ea-8454-47d1c92ea841\",\n \"source\": \"maps.google.com\",\n \"content\": \"Excellent service, highly recommend.\",\n \"authorName\": \"Priya S.\",\n \"rating\": 5,\n \"date\": \"2026-06-30T12:04:11+00:00\",\n \"category\": \"Review\",\n \"type\": \"Review\",\n \"responded\": false,\n \"responseCount\": 0,\n \"canRespond\": true,\n \"locationId\": 1800289\n },\n \"cursor\": \"SW50ZXJhY3Rpb246OWUyNmQyYTg=\"\n }\n ],\n \"totalCount\": 1284\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/rollup_interactions?tag=string&locationFilters=string&siteUrls=string&startDate=string&endDate=string&searchString=string&category=string&categories=string&ratingFilters=string&ratingFilter=7322&responseStatus=string&sortOrder=string&first=7322&after=string&last=7322&before=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "rollup_interactions" ], "query": [ { "description": "Location tag defining the rollup scope. Required — the request returns 400 without it. Use `all` to span every location.", "key": "tag", "value": "string" }, { "description": "JSON-encoded array of location IDs to restrict the rollup to.", "key": "locationFilters", "value": "string" }, { "description": "JSON-encoded array of publisher hostnames to include.", "key": "siteUrls", "value": "string" }, { "description": "Start of the date-range filter (YYYY-MM-DD).", "key": "startDate", "value": "string" }, { "description": "End of the date-range filter (YYYY-MM-DD).", "key": "endDate", "value": "string" }, { "description": "Full-text search across interaction content.", "key": "searchString", "value": "string" }, { "description": "Single interaction category, e.g. `REVIEW`.", "key": "category", "value": "string" }, { "description": "JSON-encoded array of interaction categories.", "key": "categories", "value": "string" }, { "description": "JSON-encoded array of star ratings to include, e.g. `[3,4]`.", "key": "ratingFilters", "value": "string" }, { "description": "Single star rating to filter by.", "key": "ratingFilter", "value": "7322" }, { "description": "JSON-encoded response-status filter. Values: `RESPONDED`, `PENDING`.", "key": "responseStatus", "value": "string" }, { "description": "JSON-encoded sort order. Values: `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`.", "key": "sortOrder", "value": "string" }, { "description": "Number of records to return from the beginning.", "key": "first", "value": "7322" }, { "description": "Cursor value — return records after this cursor (forward pagination).", "key": "after", "value": "string" }, { "description": "Number of records to return from the end.", "key": "last", "value": "7322" }, { "description": "Cursor value — return records before this cursor (backward pagination).", "key": "before", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/rollup_interactions?tag=string&locationFilters=string&siteUrls=string&startDate=string&endDate=string&searchString=string&category=string&categories=string&ratingFilters=string&ratingFilter=7322&responseStatus=string&sortOrder=string&first=7322&after=string&last=7322&before=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "rollup_interactions" ], "query": [ { "description": "Location tag defining the rollup scope. Required — the request returns 400 without it. Use `all` to span every location.", "key": "tag", "value": "string" }, { "description": "JSON-encoded array of location IDs to restrict the rollup to.", "key": "locationFilters", "value": "string" }, { "description": "JSON-encoded array of publisher hostnames to include.", "key": "siteUrls", "value": "string" }, { "description": "Start of the date-range filter (YYYY-MM-DD).", "key": "startDate", "value": "string" }, { "description": "End of the date-range filter (YYYY-MM-DD).", "key": "endDate", "value": "string" }, { "description": "Full-text search across interaction content.", "key": "searchString", "value": "string" }, { "description": "Single interaction category, e.g. `REVIEW`.", "key": "category", "value": "string" }, { "description": "JSON-encoded array of interaction categories.", "key": "categories", "value": "string" }, { "description": "JSON-encoded array of star ratings to include, e.g. `[3,4]`.", "key": "ratingFilters", "value": "string" }, { "description": "Single star rating to filter by.", "key": "ratingFilter", "value": "7322" }, { "description": "JSON-encoded response-status filter. Values: `RESPONDED`, `PENDING`.", "key": "responseStatus", "value": "string" }, { "description": "JSON-encoded sort order. Values: `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`.", "key": "sortOrder", "value": "string" }, { "description": "Number of records to return from the beginning.", "key": "first", "value": "7322" }, { "description": "Cursor value — return records after this cursor (forward pagination).", "key": "after", "value": "string" }, { "description": "Number of records to return from the end.", "key": "last", "value": "7322" }, { "description": "Cursor value — return records before this cursor (backward pagination).", "key": "before", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/rollup_interactions?tag=string&locationFilters=string&siteUrls=string&startDate=string&endDate=string&searchString=string&category=string&categories=string&ratingFilters=string&ratingFilter=7322&responseStatus=string&sortOrder=string&first=7322&after=string&last=7322&before=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "rollup_interactions" ], "query": [ { "description": "Location tag defining the rollup scope. Required — the request returns 400 without it. Use `all` to span every location.", "key": "tag", "value": "string" }, { "description": "JSON-encoded array of location IDs to restrict the rollup to.", "key": "locationFilters", "value": "string" }, { "description": "JSON-encoded array of publisher hostnames to include.", "key": "siteUrls", "value": "string" }, { "description": "Start of the date-range filter (YYYY-MM-DD).", "key": "startDate", "value": "string" }, { "description": "End of the date-range filter (YYYY-MM-DD).", "key": "endDate", "value": "string" }, { "description": "Full-text search across interaction content.", "key": "searchString", "value": "string" }, { "description": "Single interaction category, e.g. `REVIEW`.", "key": "category", "value": "string" }, { "description": "JSON-encoded array of interaction categories.", "key": "categories", "value": "string" }, { "description": "JSON-encoded array of star ratings to include, e.g. `[3,4]`.", "key": "ratingFilters", "value": "string" }, { "description": "Single star rating to filter by.", "key": "ratingFilter", "value": "7322" }, { "description": "JSON-encoded response-status filter. Values: `RESPONDED`, `PENDING`.", "key": "responseStatus", "value": "string" }, { "description": "JSON-encoded sort order. Values: `NEWEST_FIRST`, `OLDEST_FIRST`, `LAST_RESPONDED`.", "key": "sortOrder", "value": "string" }, { "description": "Number of records to return from the beginning.", "key": "first", "value": "7322" }, { "description": "Cursor value — return records after this cursor (forward pagination).", "key": "after", "value": "string" }, { "description": "Number of records to return from the end.", "key": "last", "value": "7322" }, { "description": "Cursor value — return records before this cursor (backward pagination).", "key": "before", "value": "string" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Fetch full interaction records by ID.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/reviewDetails?interactionIds=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "reviewDetails" ], "query": [ { "key": "interactionIds", "value": "string", "description": "JSON-encoded array of interaction IDs to fetch, e.g. `[\"b2fa765e-c62b-4e0b-b1d6-1c67c855f5e0\"]`. Passed as a URL-encoded JSON string." } ] }, "description": "Returns full interaction objects for a specific set of interaction IDs." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/reviewDetails?interactionIds=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "reviewDetails" ], "query": [ { "description": "JSON-encoded array of interaction IDs to fetch, e.g. `[\"b2fa765e-c62b-4e0b-b1d6-1c67c855f5e0\"]`. Passed as a URL-encoded JSON string.", "key": "interactionIds", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"interactionDetails\": {\n \"interactions\": [\n {\n \"id\": \"b2fa765e-c62b-4e0b-b1d6-1c67c855f5e0\",\n \"source\": \"maps.google.com\",\n \"content\": \"Great place for dessert!\",\n \"authorName\": \"Jordan M.\",\n \"category\": \"Review\",\n \"type\": \"Review\",\n \"rating\": 5,\n \"date\": \"2026-05-12T09:22:41+00:00\",\n \"responded\": true,\n \"responseCount\": 1,\n \"canRespond\": true,\n \"responses\": [\n {\n \"id\": \"2090753a-ece6-4837-8336-8494ad308523\",\n \"content\": \"Thank you so much for the kind words!\",\n \"authorName\": \"Jenny Home\",\n \"date\": \"2026-05-13T14:02:00+00:00\",\n \"interactionStatus\": \"CONFIRMED\",\n \"editedResponse\": false\n }\n ]\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/reviewDetails?interactionIds=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "reviewDetails" ], "query": [ { "description": "JSON-encoded array of interaction IDs to fetch, e.g. `[\"b2fa765e-c62b-4e0b-b1d6-1c67c855f5e0\"]`. Passed as a URL-encoded JSON string.", "key": "interactionIds", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/reviewDetails?interactionIds=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "reviewDetails" ], "query": [ { "description": "JSON-encoded array of interaction IDs to fetch, e.g. `[\"b2fa765e-c62b-4e0b-b1d6-1c67c855f5e0\"]`. Passed as a URL-encoded JSON string.", "key": "interactionIds", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/reviewDetails?interactionIds=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "reviewDetails" ], "query": [ { "description": "JSON-encoded array of interaction IDs to fetch, e.g. `[\"b2fa765e-c62b-4e0b-b1d6-1c67c855f5e0\"]`. Passed as a URL-encoded JSON string.", "key": "interactionIds", "value": "string" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Per-location interactions settings (connected sites, thresholds).", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/reviews/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "reviews", "settings" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] }, "description": "Returns the review sources configured for a single location, with their connection URLs." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/reviews/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "reviews", "settings" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"interactionsSetting\": {\n \"siteSettings\": [\n {\n \"name\": \"maps.google.com\",\n \"url\": null\n },\n {\n \"name\": \"facebook.com\",\n \"url\": null\n },\n {\n \"name\": \"yelp.com\",\n \"url\": null\n },\n {\n \"name\": \"tripadvisor.com\",\n \"url\": null\n },\n {\n \"name\": \"yellowpages.com\",\n \"url\": null\n },\n {\n \"name\": \"foursquare.com\",\n \"url\": null\n },\n {\n \"name\": \"opentable.com\",\n \"url\": null\n },\n {\n \"name\": \"trustpilot.com\",\n \"url\": null\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/reviews/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "reviews", "settings" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/reviews/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "reviews", "settings" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/reviews/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "reviews", "settings" ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Analytics KPIs for a single location over a date range.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/review-analytics-overview?startDate=1948-04-27&endDate=1948-04-27", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "review-analytics-overview" ], "query": [ { "key": "startDate", "value": "1948-04-27", "description": "Start of the analytics period (YYYY-MM-DD). Required for the `review-analytics-timeline` route." }, { "key": "endDate", "value": "1948-04-27", "description": "End of the analytics period (YYYY-MM-DD). Required for the `review-analytics-timeline` route." } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID — a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`)." } ] }, "description": "Returns overview review analytics (KPIs) for a location. Two sibling routes return a time-series timeline and a per-site breakdown." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/review-analytics-overview?startDate=1948-04-27&endDate=1948-04-27", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "review-analytics-overview" ], "query": [ { "description": "Start of the analytics period (YYYY-MM-DD). Required for the `review-analytics-timeline` route.", "key": "startDate", "value": "1948-04-27" }, { "description": "End of the analytics period (YYYY-MM-DD). Required for the `review-analytics-timeline` route.", "key": "endDate", "value": "1948-04-27" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID — a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"interactionsAnalyticsStats\": {\n \"stats\": [\n {\n \"name\": \"total-reviews\",\n \"value\": 9705423,\n \"delta\": 100\n },\n {\n \"name\": \"new-reviews\",\n \"value\": 9705423,\n \"delta\": 100\n },\n {\n \"name\": \"overall-rating\",\n \"value\": 4.432533457738633,\n \"delta\": 100\n },\n {\n \"name\": \"review-response-rate\",\n \"value\": 47.39994331004429,\n \"delta\": 100\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/review-analytics-overview?startDate=1948-04-27&endDate=1948-04-27", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "review-analytics-overview" ], "query": [ { "description": "Start of the analytics period (YYYY-MM-DD). Required for the `review-analytics-timeline` route.", "key": "startDate", "value": "1948-04-27" }, { "description": "End of the analytics period (YYYY-MM-DD). Required for the `review-analytics-timeline` route.", "key": "endDate", "value": "1948-04-27" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID — a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/review-analytics-overview?startDate=1948-04-27&endDate=1948-04-27", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "review-analytics-overview" ], "query": [ { "description": "Start of the analytics period (YYYY-MM-DD). Required for the `review-analytics-timeline` route.", "key": "startDate", "value": "1948-04-27" }, { "description": "End of the analytics period (YYYY-MM-DD). Required for the `review-analytics-timeline` route.", "key": "endDate", "value": "1948-04-27" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID — a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/review-analytics-overview?startDate=1948-04-27&endDate=1948-04-27", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "review-analytics-overview" ], "query": [ { "description": "Start of the analytics period (YYYY-MM-DD). Required for the `review-analytics-timeline` route.", "key": "startDate", "value": "1948-04-27" }, { "description": "End of the analytics period (YYYY-MM-DD). Required for the `review-analytics-timeline` route.", "key": "endDate", "value": "1948-04-27" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Location ID — a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`)." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Per-site metadata (colors, icons, plan support).", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/reviews/site-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "reviews", "site-config" ] }, "description": "Returns every review platform available to the account based on its subscription." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/reviews/site-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "reviews", "site-config" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"interactionSiteConfig\": [\n {\n \"site\": \"Google\",\n \"siteUrl\": \"maps.google.com\"\n },\n {\n \"site\": \"Facebook\",\n \"siteUrl\": \"facebook.com\"\n },\n {\n \"site\": \"Yelp\",\n \"siteUrl\": \"yelp.com\"\n },\n {\n \"site\": \"Zillow\",\n \"siteUrl\": \"zillow.com\"\n },\n {\n \"site\": \"Dealerrater\",\n \"siteUrl\": \"dealerrater.com\"\n },\n {\n \"site\": \"Cars.com\",\n \"siteUrl\": \"cars.com\"\n },\n {\n \"site\": \"Edmunds\",\n \"siteUrl\": \"edmunds.com\"\n },\n {\n \"site\": \"Foursquare\",\n \"siteUrl\": \"foursquare.com\"\n },\n {\n \"site\": \"Trustpilot\",\n \"siteUrl\": \"trustpilot.com\"\n },\n {\n \"site\": \"BBB\",\n \"siteUrl\": \"bbb.org\"\n },\n {\n \"site\": \"Indeed\",\n \"siteUrl\": \"indeed.com\"\n },\n {\n \"site\": \"Judysbook\",\n \"siteUrl\": \"judysbook.com\"\n },\n {\n \"site\": \"Cargurus\",\n \"siteUrl\": \"cargurus.com\"\n },\n {\n \"site\": \"Tripadvisor\",\n \"siteUrl\": \"tripadvisor.com\"\n },\n {\n \"site\": \"Tripadvisor Attractions\",\n \"siteUrl\": \"tripadvisor-attractions.com\"\n },\n {\n \"site\": \"Glassdoor\",\n \"siteUrl\": \"glassdoor.com\"\n },\n {\n \"site\": \"OpenTable\",\n \"siteUrl\": \"opentable.com\"\n },\n {\n \"site\": \"Yellowpages\",\n \"siteUrl\": \"yellowpages.com\"\n },\n {\n \"site\": \"Zomato\",\n \"siteUrl\": \"zomato.com\"\n }\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/reviews/site-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "reviews", "site-config" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/reviews/site-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "reviews", "site-config" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/reviews/site-config", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "reviews", "site-config" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Post a response to a review / Q&A / social interaction on the source site.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"interactionId\": \"9e26d2a8-a6ed-42ea-8454-47d1c92ea841\",\n \"responseContent\": \"Thank you for visiting Jenny Home — we're glad you enjoyed your experience!\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond" ] }, "description": "Posts a public response to a review or interaction on its source platform.\n\n**Common errors**\n- SY50121 — Google Reviews accept only a single owner reply per review; a second response is rejected." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"interactionId\": \"9e26d2a8-a6ed-42ea-8454-47d1c92ea841\",\n \"responseContent\": \"Thank you for visiting Jenny Home — we're glad you enjoyed your experience!\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"respondToInteraction\": {\n \"interaction\": {\n \"id\": \"2090753a-ece6-4837-8336-8494ad308523\",\n \"interactionId\": \"9e26d2a8-a6ed-42ea-8454-47d1c92ea841\",\n \"content\": \"Thank you for visiting Jenny Home — we're glad you enjoyed your experience!\",\n \"interactionStatus\": \"CREATED\",\n \"editedResponse\": false\n },\n \"errors\": null\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"interactionId\": \"9e26d2a8-a6ed-42ea-8454-47d1c92ea841\",\n \"responseContent\": \"Thank you for visiting Jenny Home — we're glad you enjoyed your experience!\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"interactionId\": \"9e26d2a8-a6ed-42ea-8454-47d1c92ea841\",\n \"responseContent\": \"Thank you for visiting Jenny Home — we're glad you enjoyed your experience!\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"interactionId\": \"9e26d2a8-a6ed-42ea-8454-47d1c92ea841\",\n \"responseContent\": \"Thank you for visiting Jenny Home — we're glad you enjoyed your experience!\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Edit a previously posted response to a review.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reviewId\": \"9e26d2a8-a6ed-42ea-8454-47d1c92ea841\",\n \"responseId\": \"2090753a-ece6-4837-8336-8494ad308523\",\n \"responseContent\": \"Thank you again — we've updated our reply to include our new store hours.\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond/edit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond", "edit" ] }, "description": "Edits a previously posted owner response on a review or interaction." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"reviewId\": \"9e26d2a8-a6ed-42ea-8454-47d1c92ea841\",\n \"responseId\": \"2090753a-ece6-4837-8336-8494ad308523\",\n \"responseContent\": \"Thank you again — we've updated our reply to include our new store hours.\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond/edit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond", "edit" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"editReviewResponse\": {\n \"status\": \"true\",\n \"reviewId\": \"9e26d2a8-a6ed-42ea-8454-47d1c92ea841\",\n \"responseId\": \"2090753a-ece6-4837-8336-8494ad308523\"\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"reviewId\": \"9e26d2a8-a6ed-42ea-8454-47d1c92ea841\",\n \"responseId\": \"2090753a-ece6-4837-8336-8494ad308523\",\n \"responseContent\": \"Thank you again — we've updated our reply to include our new store hours.\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond/edit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond", "edit" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"reviewId\": \"9e26d2a8-a6ed-42ea-8454-47d1c92ea841\",\n \"responseId\": \"2090753a-ece6-4837-8336-8494ad308523\",\n \"responseContent\": \"Thank you again — we've updated our reply to include our new store hours.\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond/edit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond", "edit" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"reviewId\": \"9e26d2a8-a6ed-42ea-8454-47d1c92ea841\",\n \"responseId\": \"2090753a-ece6-4837-8336-8494ad308523\",\n \"responseContent\": \"Thank you again — we've updated our reply to include our new store hours.\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond/edit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond", "edit" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Archive a response item by ID (soft-delete from the local cache).", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"responseId\": \"2090753a-ece6-4837-8336-8494ad308523\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond/archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond", "archive" ] }, "description": "Archives an existing owner response, removing it from the active responses tracked for an interaction." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"responseId\": \"2090753a-ece6-4837-8336-8494ad308523\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond/archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond", "archive" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"archiveReviewResponse\": {\n \"status\": \"true\",\n \"errors\": null\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"responseId\": \"2090753a-ece6-4837-8336-8494ad308523\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond/archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond", "archive" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"responseId\": \"2090753a-ece6-4837-8336-8494ad308523\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond/archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond", "archive" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"responseId\": \"2090753a-ece6-4837-8336-8494ad308523\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/locations/reviews/respond/archive", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", "reviews", "respond", "archive" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] } ], "description": "Reviews and review-response endpoints, including analytics." }, { "name": "Posts", "item": [ { "name": "Individual social post view page.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts", ":postId" ], "variable": [ { "key": "postId", "value": "string", "description": "Base64-encoded social post ID (e.g. from the `id` field of a posts list, or the `socialPost.id` returned by POST /posts)." } ] }, "description": "Returns a single social post campaign with its content, per-site publish status, and engagement analytics." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts", ":postId" ], "variable": [ { "key": "postId", "value": "string", "description": "Base64-encoded social post ID (e.g. from the `id` field of a posts list, or the `socialPost.id` returned by POST /posts)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"socialPostView\": {\n \"socialPostId\": \"U29jaWFsUG9zdDo0NDEyMg==\",\n \"socialPostInfo\": {\n \"id\": \"U29jaWFsUG9zdDo0NDEyMg==\",\n \"name\": \"Summer Hours Update\",\n \"status\": \"SUCCESS\",\n \"type\": \"ANNOUNCEMENT\",\n \"createdAt\": \"2026-06-28\",\n \"scheduledStartDate\": \"2026-06-28\",\n \"scheduledEndDate\": \"2026-07-28\",\n \"views\": 128,\n \"clicks\": 14,\n \"shares\": 0,\n \"reactions\": 3,\n \"comments\": 1,\n \"sites\": [\n \"GOOGLE\"\n ],\n \"message\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"We have extended our summer hours! Open until 9pm on weekdays.\"\n }\n ],\n \"cta\": [\n {\n \"type\": {\n \"value\": \"LEARN_MORE\",\n \"label\": \"Learn more\"\n },\n \"url\": \"https://jennyhome.example/hours\",\n \"site\": \"GOOGLE\",\n \"tinyUrl\": \"https://tiny.cc/jh-hours\"\n }\n ],\n \"contextInfo\": null,\n \"mediaUrl\": [\n {\n \"url\": \"https://cdn.listingsapi.com/posts/44122/summer.jpg\",\n \"site\": \"GOOGLE\",\n \"type\": \"IMAGE\"\n }\n ],\n \"publishDetails\": [\n {\n \"site\": \"GOOGLE\",\n \"status\": \"PUBLISHED\",\n \"createdDate\": \"2026-06-28\",\n \"publishedDate\": \"2026-06-28\",\n \"submissionError\": null\n }\n ],\n \"postLinks\": [\n {\n \"site\": \"GOOGLE\",\n \"link\": \"https://www.google.com/maps/place/?post=44122\"\n }\n ],\n \"locationIds\": [\n 1800289\n ]\n },\n \"publishedLocationsCount\": 1,\n \"socialPostAnalyticsBySite\": [\n {\n \"site\": \"GOOGLE\",\n \"views\": 128,\n \"clicks\": 14,\n \"reactions\": 3,\n \"shares\": 0,\n \"comments\": 1\n }\n ],\n \"socialPostAnalyticsByLocationId\": [\n {\n \"locationId\": 1800289,\n \"siteStats\": [\n {\n \"site\": \"GOOGLE\",\n \"status\": \"PUBLISHED\",\n \"views\": 128,\n \"clicks\": 14,\n \"reactions\": 3,\n \"shares\": 0,\n \"comments\": 1\n }\n ]\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts", ":postId" ], "variable": [ { "key": "postId", "value": "string", "description": "Base64-encoded social post ID (e.g. from the `id` field of a posts list, or the `socialPost.id` returned by POST /posts)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts", ":postId" ], "variable": [ { "key": "postId", "value": "string", "description": "Base64-encoded social post ID (e.g. from the `id` field of a posts list, or the `socialPost.id` returned by POST /posts)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts", ":postId" ], "variable": [ { "key": "postId", "value": "string", "description": "Base64-encoded social post ID (e.g. from the `id` field of a posts list, or the `socialPost.id` returned by POST /posts)." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Delete a social post.", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"clientMutationId\": \"delete-44122-req-1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts", ":postId" ], "variable": [ { "key": "postId", "value": "string", "description": "Base64-encoded social post ID to delete (the `id` from a posts list or the create response)." } ] }, "description": "Permanently deletes a social post campaign and removes it from every site it was published to." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"clientMutationId\": \"delete-44122-req-1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts", ":postId" ], "variable": [ { "key": "postId", "value": "string", "description": "Base64-encoded social post ID to delete (the `id` from a posts list or the create response)." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"deleteSocialPost\": {\n \"success\": true,\n \"socialPostId\": \"U29jaWFsUG9zdDo0NDEyMg==\"\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"clientMutationId\": \"delete-44122-req-1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts", ":postId" ], "variable": [ { "key": "postId", "value": "string", "description": "Base64-encoded social post ID to delete (the `id` from a posts list or the create response)." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"clientMutationId\": \"delete-44122-req-1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts", ":postId" ], "variable": [ { "key": "postId", "value": "string", "description": "Base64-encoded social post ID to delete (the `id` from a posts list or the create response)." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"clientMutationId\": \"delete-44122-req-1\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts", ":postId" ], "variable": [ { "key": "postId", "value": "string", "description": "Base64-encoded social post ID to delete (the `id` from a posts list or the create response)." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Create social posts for multiple locations.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"postName\": \"Grand Opening Announcement\",\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\"\n ],\n \"postType\": \"ANNOUNCEMENT\",\n \"postSites\": [\n \"GOOGLE\"\n ],\n \"postMessage\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"We are now open! Visit Jenny Home this week for our grand opening.\"\n }\n ],\n \"postCta\": [\n {\n \"site\": \"GOOGLE\",\n \"type\": \"LEARN_MORE\",\n \"url\": \"https://jennyhome.example/opening\"\n }\n ],\n \"postMediaUrl\": [\n {\n \"site\": \"GOOGLE\",\n \"url\": \"https://cdn.example.com/opening.jpg\",\n \"type\": \"IMAGE\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/posts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts" ] }, "description": "Creates an ANNOUNCEMENT social post and publishes it to the chosen sites for one or more locations." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"postName\": \"Grand Opening Announcement\",\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\"\n ],\n \"postType\": \"ANNOUNCEMENT\",\n \"postSites\": [\n \"GOOGLE\"\n ],\n \"postMessage\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"We are now open! Visit Jenny Home this week for our grand opening.\"\n }\n ],\n \"postCta\": [\n {\n \"site\": \"GOOGLE\",\n \"type\": \"LEARN_MORE\",\n \"url\": \"https://jennyhome.example/opening\"\n }\n ],\n \"postMediaUrl\": [\n {\n \"site\": \"GOOGLE\",\n \"url\": \"https://cdn.example.com/opening.jpg\",\n \"type\": \"IMAGE\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/posts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"createSocialPost\": {\n \"clientMutationId\": null,\n \"success\": true,\n \"errors\": [],\n \"socialPost\": {\n \"id\": \"U29jaWFsUG9zdDo0NDEyMg==\",\n \"name\": \"Grand Opening Announcement\",\n \"status\": \"INPROGRESS\",\n \"type\": \"ANNOUNCEMENT\",\n \"createdAt\": \"2026-06-28\",\n \"sites\": [\n \"GOOGLE\"\n ],\n \"message\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"We are now open! Visit Jenny Home this week for our grand opening.\"\n }\n ],\n \"cta\": [\n {\n \"type\": {\n \"value\": \"LEARN_MORE\",\n \"label\": \"Learn more\"\n },\n \"url\": \"https://jennyhome.example/opening\",\n \"site\": \"GOOGLE\",\n \"tinyUrl\": null\n }\n ],\n \"contextInfo\": null,\n \"mediaUrl\": [\n {\n \"url\": \"https://cdn.example.com/opening.jpg\",\n \"site\": \"GOOGLE\",\n \"type\": \"IMAGE\"\n }\n ],\n \"publishDetails\": [\n {\n \"site\": \"GOOGLE\",\n \"status\": \"PUBLISHING\",\n \"createdDate\": \"2026-06-28\",\n \"submissionError\": null\n }\n ],\n \"postLinks\": [],\n \"locationIds\": [\n 1800289\n ]\n }\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"postName\": \"Grand Opening Announcement\",\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\"\n ],\n \"postType\": \"ANNOUNCEMENT\",\n \"postSites\": [\n \"GOOGLE\"\n ],\n \"postMessage\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"We are now open! Visit Jenny Home this week for our grand opening.\"\n }\n ],\n \"postCta\": [\n {\n \"site\": \"GOOGLE\",\n \"type\": \"LEARN_MORE\",\n \"url\": \"https://jennyhome.example/opening\"\n }\n ],\n \"postMediaUrl\": [\n {\n \"site\": \"GOOGLE\",\n \"url\": \"https://cdn.example.com/opening.jpg\",\n \"type\": \"IMAGE\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/posts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"postName\": \"Grand Opening Announcement\",\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\"\n ],\n \"postType\": \"ANNOUNCEMENT\",\n \"postSites\": [\n \"GOOGLE\"\n ],\n \"postMessage\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"We are now open! Visit Jenny Home this week for our grand opening.\"\n }\n ],\n \"postCta\": [\n {\n \"site\": \"GOOGLE\",\n \"type\": \"LEARN_MORE\",\n \"url\": \"https://jennyhome.example/opening\"\n }\n ],\n \"postMediaUrl\": [\n {\n \"site\": \"GOOGLE\",\n \"url\": \"https://cdn.example.com/opening.jpg\",\n \"type\": \"IMAGE\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/posts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"postName\": \"Grand Opening Announcement\",\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\"\n ],\n \"postType\": \"ANNOUNCEMENT\",\n \"postSites\": [\n \"GOOGLE\"\n ],\n \"postMessage\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"We are now open! Visit Jenny Home this week for our grand opening.\"\n }\n ],\n \"postCta\": [\n {\n \"site\": \"GOOGLE\",\n \"type\": \"LEARN_MORE\",\n \"url\": \"https://jennyhome.example/opening\"\n }\n ],\n \"postMediaUrl\": [\n {\n \"site\": \"GOOGLE\",\n \"url\": \"https://cdn.example.com/opening.jpg\",\n \"type\": \"IMAGE\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/posts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "posts" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Create social posts for multiple locations.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"postName\": \"July Reopening Announcement\",\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"TG9jYXRpb246MTgwMDI5MA==\"\n ],\n \"postType\": \"ANNOUNCEMENT\",\n \"postSites\": [\n \"GOOGLE\",\n \"FACEBOOK\"\n ],\n \"postMessage\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"We're back! Visit us this week for our summer menu.\"\n },\n {\n \"site\": \"FACEBOOK\",\n \"message\": \"We're back! Swing by for the new summer menu.\"\n }\n ],\n \"postMediaUrl\": [\n {\n \"site\": \"GOOGLE\",\n \"url\": \"https://cdn.example.com/summer.jpg\",\n \"type\": \"IMAGE\"\n }\n ],\n \"postScheduledDates\": {\n \"startDatetime\": \"2026-07-10T09:00:00Z\",\n \"endDatetime\": \"2026-07-24T23:59:00Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/bulk-posts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "bulk-posts" ] }, "description": "Creates one social post and publishes it across many locations in a single request." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"postName\": \"July Reopening Announcement\",\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"TG9jYXRpb246MTgwMDI5MA==\"\n ],\n \"postType\": \"ANNOUNCEMENT\",\n \"postSites\": [\n \"GOOGLE\",\n \"FACEBOOK\"\n ],\n \"postMessage\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"We're back! Visit us this week for our summer menu.\"\n },\n {\n \"site\": \"FACEBOOK\",\n \"message\": \"We're back! Swing by for the new summer menu.\"\n }\n ],\n \"postMediaUrl\": [\n {\n \"site\": \"GOOGLE\",\n \"url\": \"https://cdn.example.com/summer.jpg\",\n \"type\": \"IMAGE\"\n }\n ],\n \"postScheduledDates\": {\n \"startDatetime\": \"2026-07-10T09:00:00Z\",\n \"endDatetime\": \"2026-07-24T23:59:00Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/bulk-posts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "bulk-posts" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"createSocialPost\": {\n \"clientMutationId\": null,\n \"success\": true,\n \"errors\": null,\n \"socialPost\": {\n \"id\": \"U29jaWFsUG9zdDo5OTIwMQ==\",\n \"name\": \"July Reopening Announcement\",\n \"status\": \"SCHEDULED\",\n \"type\": \"ANNOUNCEMENT\",\n \"createdAt\": \"2026-07-08\",\n \"scheduledStartDate\": \"2026-07-10\",\n \"scheduledEndDate\": \"2026-07-24\",\n \"sites\": [\n \"GOOGLE\",\n \"FACEBOOK\"\n ],\n \"locationIds\": [\n 1800289,\n 1800290\n ]\n }\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"postName\": \"July Reopening Announcement\",\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"TG9jYXRpb246MTgwMDI5MA==\"\n ],\n \"postType\": \"ANNOUNCEMENT\",\n \"postSites\": [\n \"GOOGLE\",\n \"FACEBOOK\"\n ],\n \"postMessage\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"We're back! Visit us this week for our summer menu.\"\n },\n {\n \"site\": \"FACEBOOK\",\n \"message\": \"We're back! Swing by for the new summer menu.\"\n }\n ],\n \"postMediaUrl\": [\n {\n \"site\": \"GOOGLE\",\n \"url\": \"https://cdn.example.com/summer.jpg\",\n \"type\": \"IMAGE\"\n }\n ],\n \"postScheduledDates\": {\n \"startDatetime\": \"2026-07-10T09:00:00Z\",\n \"endDatetime\": \"2026-07-24T23:59:00Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/bulk-posts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "bulk-posts" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"postName\": \"July Reopening Announcement\",\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"TG9jYXRpb246MTgwMDI5MA==\"\n ],\n \"postType\": \"ANNOUNCEMENT\",\n \"postSites\": [\n \"GOOGLE\",\n \"FACEBOOK\"\n ],\n \"postMessage\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"We're back! Visit us this week for our summer menu.\"\n },\n {\n \"site\": \"FACEBOOK\",\n \"message\": \"We're back! Swing by for the new summer menu.\"\n }\n ],\n \"postMediaUrl\": [\n {\n \"site\": \"GOOGLE\",\n \"url\": \"https://cdn.example.com/summer.jpg\",\n \"type\": \"IMAGE\"\n }\n ],\n \"postScheduledDates\": {\n \"startDatetime\": \"2026-07-10T09:00:00Z\",\n \"endDatetime\": \"2026-07-24T23:59:00Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/bulk-posts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "bulk-posts" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"postName\": \"July Reopening Announcement\",\n \"locationIds\": [\n \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"TG9jYXRpb246MTgwMDI5MA==\"\n ],\n \"postType\": \"ANNOUNCEMENT\",\n \"postSites\": [\n \"GOOGLE\",\n \"FACEBOOK\"\n ],\n \"postMessage\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"We're back! Visit us this week for our summer menu.\"\n },\n {\n \"site\": \"FACEBOOK\",\n \"message\": \"We're back! Swing by for the new summer menu.\"\n }\n ],\n \"postMediaUrl\": [\n {\n \"site\": \"GOOGLE\",\n \"url\": \"https://cdn.example.com/summer.jpg\",\n \"type\": \"IMAGE\"\n }\n ],\n \"postScheduledDates\": {\n \"startDatetime\": \"2026-07-10T09:00:00Z\",\n \"endDatetime\": \"2026-07-24T23:59:00Z\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v4/bulk-posts", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "bulk-posts" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Individual social post view page.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/bulk-posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "bulk-posts", ":postId" ], "variable": [ { "key": "postId", "value": "string" } ] }, "description": "Returns a single bulk (multi-location) post campaign with its content, per-location publish status, and engagement analytics." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/bulk-posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "bulk-posts", ":postId" ], "variable": [ { "key": "postId", "value": "string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"socialPostViewBulk\": {\n \"socialPostId\": \"U29jaWFsUG9zdDo1MTA4OA==\",\n \"socialPostInfo\": {\n \"id\": \"U29jaWFsUG9zdDo1MTA4OA==\",\n \"name\": \"Diwali Offer - All Stores\",\n \"status\": \"SUCCESS\",\n \"type\": \"OFFER\",\n \"createdAt\": \"2026-06-20\",\n \"scheduledStartDate\": \"2026-06-22\",\n \"scheduledEndDate\": \"2026-07-06\",\n \"views\": 4210,\n \"clicks\": 318,\n \"shares\": 12,\n \"reactions\": 87,\n \"comments\": 4,\n \"sites\": [\n \"GOOGLE\",\n \"FACEBOOK\"\n ],\n \"message\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"Festive savings across all our stores this week.\"\n },\n {\n \"site\": \"FACEBOOK\",\n \"message\": \"Festive savings across all our stores this week!\"\n }\n ],\n \"cta\": [\n {\n \"type\": {\n \"value\": \"GET_OFFER\",\n \"label\": \"Get offer\"\n },\n \"url\": \"https://jennyhome.example/diwali\",\n \"site\": \"GOOGLE\",\n \"tinyUrl\": \"https://tiny.cc/jh-diwali\"\n }\n ],\n \"contextInfo\": {\n \"couponCode\": \"DIWALI25\",\n \"redeemUrl\": \"https://jennyhome.example/diwali\",\n \"termsConditions\": \"Valid in-store only. Cannot be combined with other offers.\",\n \"title\": \"25% off storewide\",\n \"discount\": \"25%\",\n \"startDay\": \"2026-06-22\",\n \"endDay\": \"2026-07-06\"\n },\n \"mediaUrl\": [\n {\n \"url\": \"https://cdn.listingsapi.com/posts/51088/diwali.jpg\",\n \"site\": \"GOOGLE\",\n \"type\": \"IMAGE\"\n }\n ],\n \"publishDetails\": [\n {\n \"site\": \"GOOGLE\",\n \"status\": \"PUBLISHED\",\n \"createdDate\": \"2026-06-20\",\n \"publishedDate\": \"2026-06-22\",\n \"submissionError\": null\n },\n {\n \"site\": \"FACEBOOK\",\n \"status\": \"PUBLISHED\",\n \"createdDate\": \"2026-06-20\",\n \"publishedDate\": \"2026-06-22\",\n \"submissionError\": null\n }\n ],\n \"postLinks\": [\n {\n \"site\": \"GOOGLE\",\n \"link\": \"https://www.google.com/maps/place/?post=51088\"\n }\n ],\n \"locationIds\": [\n 1800289,\n 1800290,\n 1800291\n ]\n },\n \"publishedLocationsCount\": 3,\n \"socialPostAnalyticsBySite\": [\n {\n \"site\": \"GOOGLE\",\n \"views\": 3120,\n \"clicks\": 240,\n \"reactions\": 61,\n \"shares\": 0,\n \"comments\": 0\n },\n {\n \"site\": \"FACEBOOK\",\n \"views\": 1090,\n \"clicks\": 78,\n \"reactions\": 26,\n \"shares\": 12,\n \"comments\": 4\n }\n ],\n \"socialPostAnalyticsByLocationId\": [\n {\n \"locationId\": 1800289,\n \"siteStats\": [\n {\n \"site\": \"GOOGLE\",\n \"status\": \"PUBLISHED\",\n \"views\": 1040,\n \"clicks\": 80,\n \"reactions\": 20,\n \"shares\": 0,\n \"comments\": 0\n },\n {\n \"site\": \"FACEBOOK\",\n \"status\": \"PUBLISHED\",\n \"views\": 360,\n \"clicks\": 26,\n \"reactions\": 9,\n \"shares\": 4,\n \"comments\": 1\n }\n ]\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/bulk-posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "bulk-posts", ":postId" ], "variable": [ { "key": "postId", "value": "string" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/bulk-posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "bulk-posts", ":postId" ], "variable": [ { "key": "postId", "value": "string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/bulk-posts/:postId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "bulk-posts", ":postId" ], "variable": [ { "key": "postId", "value": "string" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "List of post campaigns for tags/locations.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/posts?locationIds=string&tag=string&filters=string&page=7322&perPage=7322&sortFields=string&componentIdentifier=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "posts" ], "query": [ { "key": "locationIds", "value": "string", "description": "JSON-encoded array of location IDs to include alongside the path location." }, { "key": "tag", "value": "string", "description": "Segment/tag to pull posts from. Pass `all` to fetch every post for the location. Omitting this returns an error, not an empty list." }, { "key": "filters", "value": "string", "description": "JSON-encoded SocialPostFiltersInput (e.g. by `type`, `status`, `creationDateRange`, `siteUrls`)." }, { "key": "page", "value": "7322", "description": "1-based page number for offset pagination." }, { "key": "perPage", "value": "7322", "description": "Number of records per page." }, { "key": "sortFields", "value": "string", "description": "JSON-encoded sort object `{ \"field\": \"created_at\", \"order\": \"Descending\" }`. `field` is one of name, type, status, created_at, schedule_start_date, schedule_end_date, client_name, clicks, views, shares." }, { "key": "componentIdentifier", "value": "string", "description": "Filter to posts created by a specific component/integration." } ], "variable": [ { "key": "locationId", "value": "string", "description": "Base64-encoded location cursor / global ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). Pass it verbatim — do not URL-encode it. The base64 cursor always resolves; the raw numeric database ID also works on this endpoint, but the base64 form is the portable choice across the API." } ] }, "description": "Returns a page of social post campaigns (announcements, events, offers) that target a single location." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/posts?locationIds=string&tag=string&filters=string&page=7322&perPage=7322&sortFields=string&componentIdentifier=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "posts" ], "query": [ { "description": "JSON-encoded array of location IDs to include alongside the path location.", "key": "locationIds", "value": "string" }, { "description": "Segment/tag to pull posts from. Pass `all` to fetch every post for the location. Omitting this returns an error, not an empty list.", "key": "tag", "value": "string" }, { "description": "JSON-encoded SocialPostFiltersInput (e.g. by `type`, `status`, `creationDateRange`, `siteUrls`).", "key": "filters", "value": "string" }, { "description": "1-based page number for offset pagination.", "key": "page", "value": "7322" }, { "description": "Number of records per page.", "key": "perPage", "value": "7322" }, { "description": "JSON-encoded sort object `{ \"field\": \"created_at\", \"order\": \"Descending\" }`. `field` is one of name, type, status, created_at, schedule_start_date, schedule_end_date, client_name, clicks, views, shares.", "key": "sortFields", "value": "string" }, { "description": "Filter to posts created by a specific component/integration.", "key": "componentIdentifier", "value": "string" } ], "variable": [ { "key": "locationId", "value": "string", "description": "Base64-encoded location cursor / global ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). Pass it verbatim — do not URL-encode it. The base64 cursor always resolves; the raw numeric database ID also works on this endpoint, but the base64 form is the portable choice across the API." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"rollupSocialPosts\": {\n \"records\": [\n {\n \"id\": \"U29jaWFsUG9zdDo0NDEyMg==\",\n \"name\": \"Summer Hours Update\",\n \"status\": \"SUCCESS\",\n \"type\": \"ANNOUNCEMENT\",\n \"createdAt\": \"2026-06-28\",\n \"scheduledStartDate\": \"2026-06-28\",\n \"scheduledEndDate\": \"2026-07-28\",\n \"views\": 128,\n \"clicks\": 14,\n \"shares\": 0,\n \"reactions\": 3,\n \"comments\": 1,\n \"sites\": [\n \"GOOGLE\"\n ],\n \"message\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"We have extended our summer hours! Open until 9pm on weekdays.\"\n }\n ],\n \"cta\": [\n {\n \"type\": {\n \"value\": \"LEARN_MORE\",\n \"label\": \"Learn more\"\n },\n \"url\": \"https://jennyhome.example/hours\",\n \"site\": \"GOOGLE\",\n \"tinyUrl\": \"https://tiny.cc/jh-hours\"\n }\n ],\n \"contextInfo\": null,\n \"mediaUrl\": [\n {\n \"url\": \"https://cdn.listingsapi.com/posts/44122/summer.jpg\",\n \"site\": \"GOOGLE\",\n \"type\": \"IMAGE\"\n }\n ],\n \"publishDetails\": [\n {\n \"site\": \"GOOGLE\",\n \"status\": \"PUBLISHED\",\n \"createdDate\": \"2026-06-28\",\n \"publishedDate\": \"2026-06-28\",\n \"submissionError\": null\n }\n ],\n \"postLinks\": [\n {\n \"site\": \"GOOGLE\",\n \"link\": \"https://www.google.com/maps/place/?post=44122\"\n }\n ],\n \"locationIds\": [\n 1800289\n ],\n \"clientName\": \"Jenny Home\"\n }\n ],\n \"locationDetails\": [\n {\n \"id\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"name\": \"Jenny Home\",\n \"street\": \"19 east, 5th B cross road, Trinity Enclave Main Rd, Banjara Layout\",\n \"city\": \"Bengaluru\",\n \"postalCode\": \"560043\",\n \"countryIso\": \"IN\",\n \"stateIso\": \"KA\",\n \"stateName\": \"Karnataka\",\n \"storeId\": null\n }\n ],\n \"pageInfo\": {\n \"totalPages\": 1,\n \"hasNextPage\": false,\n \"hasPreviousPage\": false,\n \"totalRecords\": 1\n }\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/posts?locationIds=string&tag=string&filters=string&page=7322&perPage=7322&sortFields=string&componentIdentifier=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "posts" ], "query": [ { "description": "JSON-encoded array of location IDs to include alongside the path location.", "key": "locationIds", "value": "string" }, { "description": "Segment/tag to pull posts from. Pass `all` to fetch every post for the location. Omitting this returns an error, not an empty list.", "key": "tag", "value": "string" }, { "description": "JSON-encoded SocialPostFiltersInput (e.g. by `type`, `status`, `creationDateRange`, `siteUrls`).", "key": "filters", "value": "string" }, { "description": "1-based page number for offset pagination.", "key": "page", "value": "7322" }, { "description": "Number of records per page.", "key": "perPage", "value": "7322" }, { "description": "JSON-encoded sort object `{ \"field\": \"created_at\", \"order\": \"Descending\" }`. `field` is one of name, type, status, created_at, schedule_start_date, schedule_end_date, client_name, clicks, views, shares.", "key": "sortFields", "value": "string" }, { "description": "Filter to posts created by a specific component/integration.", "key": "componentIdentifier", "value": "string" } ], "variable": [ { "key": "locationId", "value": "string", "description": "Base64-encoded location cursor / global ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). Pass it verbatim — do not URL-encode it. The base64 cursor always resolves; the raw numeric database ID also works on this endpoint, but the base64 form is the portable choice across the API." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/posts?locationIds=string&tag=string&filters=string&page=7322&perPage=7322&sortFields=string&componentIdentifier=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "posts" ], "query": [ { "description": "JSON-encoded array of location IDs to include alongside the path location.", "key": "locationIds", "value": "string" }, { "description": "Segment/tag to pull posts from. Pass `all` to fetch every post for the location. Omitting this returns an error, not an empty list.", "key": "tag", "value": "string" }, { "description": "JSON-encoded SocialPostFiltersInput (e.g. by `type`, `status`, `creationDateRange`, `siteUrls`).", "key": "filters", "value": "string" }, { "description": "1-based page number for offset pagination.", "key": "page", "value": "7322" }, { "description": "Number of records per page.", "key": "perPage", "value": "7322" }, { "description": "JSON-encoded sort object `{ \"field\": \"created_at\", \"order\": \"Descending\" }`. `field` is one of name, type, status, created_at, schedule_start_date, schedule_end_date, client_name, clicks, views, shares.", "key": "sortFields", "value": "string" }, { "description": "Filter to posts created by a specific component/integration.", "key": "componentIdentifier", "value": "string" } ], "variable": [ { "key": "locationId", "value": "string", "description": "Base64-encoded location cursor / global ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). Pass it verbatim — do not URL-encode it. The base64 cursor always resolves; the raw numeric database ID also works on this endpoint, but the base64 form is the portable choice across the API." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/posts?locationIds=string&tag=string&filters=string&page=7322&perPage=7322&sortFields=string&componentIdentifier=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "posts" ], "query": [ { "description": "JSON-encoded array of location IDs to include alongside the path location.", "key": "locationIds", "value": "string" }, { "description": "Segment/tag to pull posts from. Pass `all` to fetch every post for the location. Omitting this returns an error, not an empty list.", "key": "tag", "value": "string" }, { "description": "JSON-encoded SocialPostFiltersInput (e.g. by `type`, `status`, `creationDateRange`, `siteUrls`).", "key": "filters", "value": "string" }, { "description": "1-based page number for offset pagination.", "key": "page", "value": "7322" }, { "description": "Number of records per page.", "key": "perPage", "value": "7322" }, { "description": "JSON-encoded sort object `{ \"field\": \"created_at\", \"order\": \"Descending\" }`. `field` is one of name, type, status, created_at, schedule_start_date, schedule_end_date, client_name, clicks, views, shares.", "key": "sortFields", "value": "string" }, { "description": "Filter to posts created by a specific component/integration.", "key": "componentIdentifier", "value": "string" } ], "variable": [ { "key": "locationId", "value": "string", "description": "Base64-encoded location cursor / global ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). Pass it verbatim — do not URL-encode it. The base64 cursor always resolves; the raw numeric database ID also works on this endpoint, but the base64 form is the portable choice across the API." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "List of post campaigns for tags/locations.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/bulk-posts?locationIds=string&tag=string&filters=string&page=7322&perPage=7322&sortFields=string&componentIdentifier=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "bulk-posts" ], "query": [ { "key": "locationIds", "value": "string", "description": "JSON-encoded array of location IDs to include alongside the path location." }, { "key": "tag", "value": "string", "description": "Segment/tag to pull campaigns from. Pass `all` to fetch every bulk campaign touching the location. Omitting this returns an error, not an empty list." }, { "key": "filters", "value": "string", "description": "JSON-encoded SocialPostFiltersInput (e.g. by `type`, `status`, `creationDateRange`, `siteUrls`)." }, { "key": "page", "value": "7322", "description": "1-based page number for offset pagination." }, { "key": "perPage", "value": "7322", "description": "Number of records per page." }, { "key": "sortFields", "value": "string", "description": "JSON-encoded sort object `{ \"field\": \"created_at\", \"order\": \"Descending\" }`. `field` is one of name, type, status, created_at, schedule_start_date, schedule_end_date, client_name, clicks, views, shares." }, { "key": "componentIdentifier", "value": "string", "description": "Filter to campaigns created by a specific component/integration." } ], "variable": [ { "key": "locationId", "value": "string", "description": "Base64-encoded location cursor / global ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). Pass it verbatim — do not URL-encode it. The base64 cursor always resolves; the raw numeric database ID also works on this endpoint, but the base64 form is the portable choice across the API." } ] }, "description": "Returns a page of bulk (multi-location) post campaigns that include a single location." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/bulk-posts?locationIds=string&tag=string&filters=string&page=7322&perPage=7322&sortFields=string&componentIdentifier=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "bulk-posts" ], "query": [ { "description": "JSON-encoded array of location IDs to include alongside the path location.", "key": "locationIds", "value": "string" }, { "description": "Segment/tag to pull campaigns from. Pass `all` to fetch every bulk campaign touching the location. Omitting this returns an error, not an empty list.", "key": "tag", "value": "string" }, { "description": "JSON-encoded SocialPostFiltersInput (e.g. by `type`, `status`, `creationDateRange`, `siteUrls`).", "key": "filters", "value": "string" }, { "description": "1-based page number for offset pagination.", "key": "page", "value": "7322" }, { "description": "Number of records per page.", "key": "perPage", "value": "7322" }, { "description": "JSON-encoded sort object `{ \"field\": \"created_at\", \"order\": \"Descending\" }`. `field` is one of name, type, status, created_at, schedule_start_date, schedule_end_date, client_name, clicks, views, shares.", "key": "sortFields", "value": "string" }, { "description": "Filter to campaigns created by a specific component/integration.", "key": "componentIdentifier", "value": "string" } ], "variable": [ { "key": "locationId", "value": "string", "description": "Base64-encoded location cursor / global ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). Pass it verbatim — do not URL-encode it. The base64 cursor always resolves; the raw numeric database ID also works on this endpoint, but the base64 form is the portable choice across the API." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"rollupSocialPosts\": {\n \"records\": [\n {\n \"id\": \"U29jaWFsUG9zdDo1MTA4OA==\",\n \"name\": \"Diwali Offer - All Stores\",\n \"status\": \"SUCCESS\",\n \"type\": \"OFFER\",\n \"createdAt\": \"2026-06-20\",\n \"scheduledStartDate\": \"2026-06-22\",\n \"scheduledEndDate\": \"2026-07-06\",\n \"views\": 4210,\n \"clicks\": 318,\n \"shares\": 12,\n \"reactions\": 87,\n \"comments\": 4,\n \"sites\": [\n \"GOOGLE\",\n \"FACEBOOK\"\n ],\n \"message\": [\n {\n \"site\": \"GOOGLE\",\n \"message\": \"Festive savings across all our stores this week.\"\n },\n {\n \"site\": \"FACEBOOK\",\n \"message\": \"Festive savings across all our stores this week!\"\n }\n ],\n \"cta\": [\n {\n \"type\": {\n \"value\": \"GET_OFFER\",\n \"label\": \"Get offer\"\n },\n \"url\": \"https://jennyhome.example/diwali\",\n \"site\": \"GOOGLE\",\n \"tinyUrl\": \"https://tiny.cc/jh-diwali\"\n }\n ],\n \"contextInfo\": {\n \"couponCode\": \"DIWALI25\",\n \"redeemUrl\": \"https://jennyhome.example/diwali\",\n \"termsConditions\": \"Valid in-store only. Cannot be combined with other offers.\",\n \"title\": \"25% off storewide\",\n \"discount\": \"25%\",\n \"startDay\": \"2026-06-22\",\n \"endDay\": \"2026-07-06\"\n },\n \"mediaUrl\": [\n {\n \"url\": \"https://cdn.listingsapi.com/posts/51088/diwali.jpg\",\n \"site\": \"GOOGLE\",\n \"type\": \"IMAGE\"\n }\n ],\n \"publishDetails\": [\n {\n \"site\": \"GOOGLE\",\n \"status\": \"PUBLISHED\",\n \"createdDate\": \"2026-06-20\",\n \"publishedDate\": \"2026-06-22\",\n \"submissionError\": null\n },\n {\n \"site\": \"FACEBOOK\",\n \"status\": \"PUBLISHED\",\n \"createdDate\": \"2026-06-20\",\n \"publishedDate\": \"2026-06-22\",\n \"submissionError\": null\n }\n ],\n \"postLinks\": [\n {\n \"site\": \"GOOGLE\",\n \"link\": \"https://www.google.com/maps/place/?post=51088\"\n }\n ],\n \"locationIds\": [\n 1800289,\n 1800290,\n 1800291\n ],\n \"clientName\": \"Jenny Home\"\n }\n ],\n \"locationDetails\": [\n {\n \"id\": \"TG9jYXRpb246MTgwMDI4OQ==\",\n \"name\": \"Jenny Home\",\n \"street\": \"19 east, 5th B cross road, Trinity Enclave Main Rd, Banjara Layout\",\n \"city\": \"Bengaluru\",\n \"postalCode\": \"560043\",\n \"countryIso\": \"IN\",\n \"stateIso\": \"KA\",\n \"stateName\": \"Karnataka\",\n \"storeId\": null\n }\n ],\n \"pageInfo\": {\n \"totalPages\": 1,\n \"hasNextPage\": false,\n \"hasPreviousPage\": false,\n \"totalRecords\": 1\n }\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/bulk-posts?locationIds=string&tag=string&filters=string&page=7322&perPage=7322&sortFields=string&componentIdentifier=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "bulk-posts" ], "query": [ { "description": "JSON-encoded array of location IDs to include alongside the path location.", "key": "locationIds", "value": "string" }, { "description": "Segment/tag to pull campaigns from. Pass `all` to fetch every bulk campaign touching the location. Omitting this returns an error, not an empty list.", "key": "tag", "value": "string" }, { "description": "JSON-encoded SocialPostFiltersInput (e.g. by `type`, `status`, `creationDateRange`, `siteUrls`).", "key": "filters", "value": "string" }, { "description": "1-based page number for offset pagination.", "key": "page", "value": "7322" }, { "description": "Number of records per page.", "key": "perPage", "value": "7322" }, { "description": "JSON-encoded sort object `{ \"field\": \"created_at\", \"order\": \"Descending\" }`. `field` is one of name, type, status, created_at, schedule_start_date, schedule_end_date, client_name, clicks, views, shares.", "key": "sortFields", "value": "string" }, { "description": "Filter to campaigns created by a specific component/integration.", "key": "componentIdentifier", "value": "string" } ], "variable": [ { "key": "locationId", "value": "string", "description": "Base64-encoded location cursor / global ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). Pass it verbatim — do not URL-encode it. The base64 cursor always resolves; the raw numeric database ID also works on this endpoint, but the base64 form is the portable choice across the API." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/bulk-posts?locationIds=string&tag=string&filters=string&page=7322&perPage=7322&sortFields=string&componentIdentifier=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "bulk-posts" ], "query": [ { "description": "JSON-encoded array of location IDs to include alongside the path location.", "key": "locationIds", "value": "string" }, { "description": "Segment/tag to pull campaigns from. Pass `all` to fetch every bulk campaign touching the location. Omitting this returns an error, not an empty list.", "key": "tag", "value": "string" }, { "description": "JSON-encoded SocialPostFiltersInput (e.g. by `type`, `status`, `creationDateRange`, `siteUrls`).", "key": "filters", "value": "string" }, { "description": "1-based page number for offset pagination.", "key": "page", "value": "7322" }, { "description": "Number of records per page.", "key": "perPage", "value": "7322" }, { "description": "JSON-encoded sort object `{ \"field\": \"created_at\", \"order\": \"Descending\" }`. `field` is one of name, type, status, created_at, schedule_start_date, schedule_end_date, client_name, clicks, views, shares.", "key": "sortFields", "value": "string" }, { "description": "Filter to campaigns created by a specific component/integration.", "key": "componentIdentifier", "value": "string" } ], "variable": [ { "key": "locationId", "value": "string", "description": "Base64-encoded location cursor / global ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). Pass it verbatim — do not URL-encode it. The base64 cursor always resolves; the raw numeric database ID also works on this endpoint, but the base64 form is the portable choice across the API." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/bulk-posts?locationIds=string&tag=string&filters=string&page=7322&perPage=7322&sortFields=string&componentIdentifier=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "bulk-posts" ], "query": [ { "description": "JSON-encoded array of location IDs to include alongside the path location.", "key": "locationIds", "value": "string" }, { "description": "Segment/tag to pull campaigns from. Pass `all` to fetch every bulk campaign touching the location. Omitting this returns an error, not an empty list.", "key": "tag", "value": "string" }, { "description": "JSON-encoded SocialPostFiltersInput (e.g. by `type`, `status`, `creationDateRange`, `siteUrls`).", "key": "filters", "value": "string" }, { "description": "1-based page number for offset pagination.", "key": "page", "value": "7322" }, { "description": "Number of records per page.", "key": "perPage", "value": "7322" }, { "description": "JSON-encoded sort object `{ \"field\": \"created_at\", \"order\": \"Descending\" }`. `field` is one of name, type, status, created_at, schedule_start_date, schedule_end_date, client_name, clicks, views, shares.", "key": "sortFields", "value": "string" }, { "description": "Filter to campaigns created by a specific component/integration.", "key": "componentIdentifier", "value": "string" } ], "variable": [ { "key": "locationId", "value": "string", "description": "Base64-encoded location cursor / global ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`). Pass it verbatim — do not URL-encode it. The base64 cursor always resolves; the raw numeric database ID also works on this endpoint, but the base64 form is the portable choice across the API." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] } ], "description": "Create and manage Google Business Profile posts — announcements, events, and offers — across locations." }, { "name": "Analytics", "item": [ { "name": "Facebook v4 metrics for a single location over a date range.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/facebook-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "facebook-analytics" ], "query": [ { "key": "fromDate", "value": "string", "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted." }, { "key": "toDate", "value": "string", "description": "End of the range (YYYY-MM-DD)." } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] }, "description": "Returns daily Facebook Page interaction metrics for a location over a date range." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/facebook-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "facebook-analytics" ], "query": [ { "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted.", "key": "fromDate", "value": "string" }, { "description": "End of the range (YYYY-MM-DD).", "key": "toDate", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"facebookInsights\": {\n \"views\": [\n {\n \"startTime\": \"2025-06-01T00:00:00+00:00\",\n \"value\": 120\n }\n ],\n \"ctaAction\": [\n {\n \"startTime\": \"2025-06-01T00:00:00+00:00\",\n \"value\": 5\n }\n ],\n \"directionsAction\": [\n {\n \"startTime\": \"2025-06-01T00:00:00+00:00\",\n \"value\": 3\n }\n ],\n \"phoneAction\": [\n {\n \"startTime\": \"2025-06-01T00:00:00+00:00\",\n \"value\": 2\n }\n ],\n \"websiteAction\": [\n {\n \"startTime\": \"2025-06-01T00:00:00+00:00\",\n \"value\": 9\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/facebook-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "facebook-analytics" ], "query": [ { "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted.", "key": "fromDate", "value": "string" }, { "description": "End of the range (YYYY-MM-DD).", "key": "toDate", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/facebook-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "facebook-analytics" ], "query": [ { "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted.", "key": "fromDate", "value": "string" }, { "description": "End of the range (YYYY-MM-DD).", "key": "toDate", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/facebook-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "facebook-analytics" ], "query": [ { "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted.", "key": "fromDate", "value": "string" }, { "description": "End of the range (YYYY-MM-DD).", "key": "toDate", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Google My Business v4 metrics for a single location over a date range.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/google-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "google-analytics" ], "query": [ { "key": "fromDate", "value": "string", "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted." }, { "key": "toDate", "value": "string", "description": "End of the range (YYYY-MM-DD)." } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] }, "description": "Returns daily Google Business Profile interaction metrics for a location over a date range." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/google-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "google-analytics" ], "query": [ { "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted.", "key": "fromDate", "value": "string" }, { "description": "End of the range (YYYY-MM-DD).", "key": "toDate", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"googleInsights\": {\n \"total\": [\n {\n \"startTime\": \"2025-06-01T00:00:00+00:00\",\n \"value\": 412\n },\n {\n \"startTime\": \"2025-06-02T00:00:00+00:00\",\n \"value\": 388\n }\n ],\n \"search\": [\n {\n \"startTime\": \"2025-06-01T00:00:00+00:00\",\n \"value\": 300\n }\n ],\n \"maps\": [\n {\n \"startTime\": \"2025-06-01T00:00:00+00:00\",\n \"value\": 112\n }\n ],\n \"directionsAction\": [\n {\n \"startTime\": \"2025-06-01T00:00:00+00:00\",\n \"value\": 24\n }\n ],\n \"phoneAction\": [\n {\n \"startTime\": \"2025-06-01T00:00:00+00:00\",\n \"value\": 8\n }\n ],\n \"websiteAction\": [\n {\n \"startTime\": \"2025-06-01T00:00:00+00:00\",\n \"value\": 41\n }\n ],\n \"businessBookings\": [\n {\n \"startTime\": \"2025-06-01T00:00:00+00:00\",\n \"value\": 0\n }\n ],\n \"businessFoodOrders\": [\n {\n \"startTime\": \"2025-06-01T00:00:00+00:00\",\n \"value\": 0\n }\n ],\n \"businessFoodMenuClicks\": [\n {\n \"startTime\": \"2025-06-01T00:00:00+00:00\",\n \"value\": 0\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/google-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "google-analytics" ], "query": [ { "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted.", "key": "fromDate", "value": "string" }, { "description": "End of the range (YYYY-MM-DD).", "key": "toDate", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/google-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "google-analytics" ], "query": [ { "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted.", "key": "fromDate", "value": "string" }, { "description": "End of the range (YYYY-MM-DD).", "key": "toDate", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/google-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "google-analytics" ], "query": [ { "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted.", "key": "fromDate", "value": "string" }, { "description": "End of the range (YYYY-MM-DD).", "key": "toDate", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Bing Places v4 metrics for a single location over a date range.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/bing-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "bing-analytics" ], "query": [ { "key": "fromDate", "value": "string", "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted." }, { "key": "toDate", "value": "string", "description": "End of the range (YYYY-MM-DD)." } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] }, "description": "Returns weekly Bing Places profile view metrics for a location over a date range." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/bing-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "bing-analytics" ], "query": [ { "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted.", "key": "fromDate", "value": "string" }, { "description": "End of the range (YYYY-MM-DD).", "key": "toDate", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"bingInsights\": {\n \"views\": [\n {\n \"startTime\": \"2025-06-02T00:00:00+00:00\",\n \"value\": 73\n },\n {\n \"startTime\": \"2025-06-09T00:00:00+00:00\",\n \"value\": 58\n }\n ]\n }\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/bing-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "bing-analytics" ], "query": [ { "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted.", "key": "fromDate", "value": "string" }, { "description": "End of the range (YYYY-MM-DD).", "key": "toDate", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/bing-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "bing-analytics" ], "query": [ { "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted.", "key": "fromDate", "value": "string" }, { "description": "End of the range (YYYY-MM-DD).", "key": "toDate", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/locations/:locationId/bing-analytics?fromDate=string&toDate=string", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "locations", ":locationId", "bing-analytics" ], "query": [ { "description": "Start of the range (YYYY-MM-DD). Defaults to a recent window when omitted.", "key": "fromDate", "value": "string" }, { "description": "End of the range (YYYY-MM-DD).", "key": "toDate", "value": "string" } ], "variable": [ { "key": "locationId", "value": "6662", "description": "Base64-encoded location ID (Relay id, e.g. TG9jYXRpb246MTgwMDI4OQ==). The raw numeric id is not accepted here." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] } ], "description": "Per-publisher insights (Google / Facebook / Bing) and indexing rate." }, { "name": "Supporting APIs", "item": [ { "name": "List of supported countries.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/countries", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "countries" ] }, "description": "Returns every country Listings API supports along with its states/provinces and the ISO codes used when creating or updating locations." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/countries", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "countries" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"supportedCountries\": [\n {\n \"databaseId\": 13,\n \"hasCity\": true,\n \"id\": \"Q291bnRyeToxMw==\",\n \"iso\": \"AU\",\n \"name\": \"Australia\",\n \"states\": [\n {\n \"countryId\": 13,\n \"id\": \"139\",\n \"iso\": \"VIC\",\n \"name\": \"Victoria\"\n },\n {\n \"countryId\": 13,\n \"id\": \"142\",\n \"iso\": \"NSW\",\n \"name\": \"New South Wales\"\n },\n {\n \"countryId\": 13,\n \"id\": \"141\",\n \"iso\": \"QLD\",\n \"name\": \"Queensland\"\n }\n ]\n },\n {\n \"databaseId\": 17,\n \"hasCity\": true,\n \"id\": \"Q291bnRyeToxNw==\",\n \"iso\": \"BE\",\n \"name\": \"Belgium\",\n \"states\": []\n }\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/countries", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "countries" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/countries", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "countries" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/countries", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "countries" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "List of sub-categories.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/sub-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "sub-categories" ] }, "description": "Returns the full catalog of subcategories used to classify locations when creating or updating them." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/sub-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "sub-categories" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"subcategories\": [\n {\n \"databaseId\": 639,\n \"id\": \"U3ViQ2F0ZWdvcnk6NjM5\",\n \"key\": \"3d-printing\",\n \"name\": \"3D Printing\",\n \"primary\": true\n },\n {\n \"databaseId\": 4589,\n \"id\": \"U3ViQ2F0ZWdvcnk6NDU4OQ==\",\n \"key\": \"3d-printing-service\",\n \"name\": \"3D printing service\",\n \"primary\": true\n },\n {\n \"databaseId\": 3268,\n \"id\": \"U3ViQ2F0ZWdvcnk6MzI2OA==\",\n \"key\": \"aadhaar-center\",\n \"name\": \"Aadhaar center\",\n \"primary\": true\n }\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/sub-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "sub-categories" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/sub-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "sub-categories" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/sub-categories", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "sub-categories" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "planSites", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/plan-sites", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "plan-sites" ] }, "description": "Returns every publisher directory site included in the account's plan, with each site's ID, URL, and supported countries." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/plan-sites", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "plan-sites" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"planSites\": [\n {\n \"hideAddressSupportedCountries\": [\n \"US\",\n \"CA\",\n \"AU\",\n \"IN\",\n \"GB\"\n ],\n \"id\": 1,\n \"name\": \"Google Maps\",\n \"supportedCountries\": [\n \"US\",\n \"CA\",\n \"IN\",\n \"GB\",\n \"DE\"\n ],\n \"url\": \"maps.google.com\"\n },\n {\n \"hideAddressSupportedCountries\": [\n \"US\",\n \"CA\",\n \"AU\",\n \"IN\",\n \"GB\"\n ],\n \"id\": 184,\n \"name\": \"Facebook\",\n \"supportedCountries\": [\n \"US\",\n \"CA\",\n \"IN\",\n \"GB\",\n \"DE\"\n ],\n \"url\": \"facebook.com\"\n },\n {\n \"hideAddressSupportedCountries\": [\n \"US\",\n \"CA\",\n \"AU\",\n \"GB\"\n ],\n \"id\": 2,\n \"name\": \"Yelp\",\n \"supportedCountries\": [\n \"US\",\n \"CA\",\n \"GB\",\n \"DE\",\n \"FR\"\n ],\n \"url\": \"yelp.com\"\n }\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/plan-sites", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "plan-sites" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/plan-sites", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "plan-sites" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/plan-sites", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "plan-sites" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] }, { "name": "Active billing subscriptions for an account.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v4/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "subscriptions" ] }, "description": "Returns the active billing subscriptions (plans and tenures) on the account." }, "response": [ { "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "subscriptions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"activeSubscriptions\": [\n {\n \"name\": \"Launch\",\n \"paymentSubscriptionId\": \"61ab21be-11b8-4828-b292-75dc008aba97\",\n \"planId\": \"price_0TeANIppwoE3L8zjHjemFTNj\",\n \"tenure\": \"NA\"\n }\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "subscriptions" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "subscriptions" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" }, { "name": "Server error", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/v4/subscriptions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v4", "subscriptions" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"code\": \"string\",\n \"message\": \"string\",\n \"field\": \"string\"\n}" } ] } ], "description": "Supporting reference data — countries, sub-categories, and publisher site categories — plus the subscription plan and the publisher sites included in it." } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://listingsapi.com" } ] }