openapi: 3.2.0 info: title: Synup Locations API version: '4' description: 'REST API v4 for the Synup local marketing platform: business locations, listing syndication to 80+ directories, review/interaction aggregation and response, review campaigns, local rank tracking and grid-rank heatmaps, local and social posts, AI post ideas, menus, connected accounts, users and profile analytics. ASSEMBLED BY API EVANGELIST from the per-endpoint OpenAPI documents Synup publishes on its own documentation host (developer.synup.com, Apidog project 797384). Every operation, parameter, response, example and schema below is verbatim provider content; only the merge into a single document is ours. Source index: https://developer.synup.com/llms.txt' contact: name: Synup Developer Documentation url: https://developer.synup.com/ x-assembled-by: api-evangelist enrichment pipeline (local-v1) x-assembled-from: 506 per-endpoint OpenAPI fragments published at https://developer.synup.com/.md x-assembled-date: '2026-08-13' servers: - url: https://api.synup.com/api/v4 description: Base ENV (as published in every Synup doc fragment). Tenant workspace domains (https://.synup.com/api/v4) also serve the same API. tags: - name: Locations paths: /locations/activate: post: summary: Activate archived locations deprecated: false description: "\nUse this API to reactivate one or more previously archived locations, allowing them to be updated and managed again.\n \n\n:::info[]\nImportant Notes:\n- Activating a location restores its functionality, enabling updates and modifications.\n- Only archived locations can be activated; active locations do not require this action.\n- Reactivating a location may resume billing based on your subscription plan.\n:::\n" operationId: activateLocations tags: - Locations parameters: - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string - name: Content-Type in: header description: '' required: true example: application/json schema: type: string requestBody: content: application/json: schema: type: object properties: input: type: object required: - locationIds properties: locationIds: type: array description: Array of location Node IDs to activate items: type: string x-apidog-orders: - locationIds x-apidog-orders: - input example: input: locationIds: - TG9jYXRpb246MTE3MTM4OQ== responses: '200': description: Locations activated successfully content: application/json: schema: type: object properties: data: type: object properties: activateLocations: type: object properties: bulkEditTaskId: type: - string - 'null' description: ID of bulk edit task if multiple locations are being activated clientMutationId: type: - string - 'null' errors: type: - array - 'null' items: type: string result: type: array items: type: object properties: errors: type: - array - 'null' items: type: string locationId: type: string description: Node ID of the location status: type: string enum: - ACTIVE description: Final status of the activation operation success: type: boolean description: Whether the operation was successful x-apidog-orders: - errors - locationId - status - success success: type: - boolean - 'null' x-apidog-orders: - bulkEditTaskId - clientMutationId - errors - result - success x-apidog-orders: - activateLocations x-apidog-orders: - data example: data: activateLocations: bulkEditTaskId: null clientMutationId: null errors: null result: - errors: null locationId: TG9jYXRpb246MTE3MTM4OQ== status: ACTIVE success: true success: null headers: {} x-apidog-name: OK '400': description: Bad request - invalid input content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Bad Request '401': description: Unauthorized - invalid or missing API key content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Unauthorized '403': description: Forbidden - insufficient permissions content: application/json: schema: type: object properties: errors: type: array items: type: string examples: - Insufficient permissions to activate locations x-apidog-orders: - errors headers: {} x-apidog-name: Forbidden security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13659836-run /locations/archive: post: summary: Archive multiple locations deprecated: false description: "\n\nThis API allows you to archive One or More Business Locations. \n\n:::info[]\n- Archiving a location does not delete it from your account.\n- Archived locations cannot be updated until reactivated.\n- The location will be scheduled for archival until the end of the billing cycle.\n- Once the invoice for the next month is generated, the location will be archived.\n- Payments for archived locations stop after the current billing cycle is completed.\n\n:::\n\n" operationId: archiveLocations tags: - Locations parameters: - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string requestBody: content: application/json: schema: type: object properties: input: type: object required: - locationIds properties: locationIds: type: array description: Array of location Node IDs to archive items: type: string x-apidog-orders: - locationIds x-apidog-orders: - input example: input: locationIds: - TG9jYXRpb246MTE4MzMzMA== - TG9jYXRpb246MTE3MTM4OQ== responses: '200': description: Locations archived successfully content: application/json: schema: type: object properties: data: type: object properties: archiveLocations: type: object properties: bulkEditTaskId: type: - string - 'null' clientMutationId: type: - string - 'null' errors: type: - array - 'null' items: type: string result: type: array items: type: object properties: errors: type: - array - 'null' items: type: string locationId: type: string description: Node ID of the location status: type: string enum: - ARCHIVED - ARCHIVE_SCHEDULED description: Final status of the archive operation success: type: boolean description: Whether the operation was successful x-apidog-orders: - errors - locationId - status - success success: type: - boolean - 'null' x-apidog-orders: - bulkEditTaskId - clientMutationId - errors - result - success x-apidog-orders: - archiveLocations x-apidog-orders: - data example: data: archiveLocations: bulkEditTaskId: null clientMutationId: null errors: null result: - errors: null locationId: TG9jYXRpb246MTE3MTM4OQ== status: ARCHIVE_SCHEDULED success: true - errors: null locationId: TG9jYXRpb246MTE4MzMzMA== status: ARCHIVE_SCHEDULED success: true success: null headers: {} x-apidog-name: OK '400': description: Bad request - invalid input content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Bad Request '401': description: Unauthorized - invalid or missing API key content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Unauthorized '403': description: Forbidden - insufficient permissions content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Forbidden security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13659698-run /locations/advanced-search-filters: get: summary: Available advanced filter values deprecated: false description: '
Returns the distinct values available for the advanced location filters across the account''s locations: countries, states, cities, postal (zip) codes, and custom attribute names. Use these values to populate the advanced filter controls before calling Filter locations. ' operationId: advancedSearchFilters tags: - Locations parameters: - name: Synup-Version in: header description: API version date (YYYY-MM-DD). required: true example: '2026-04-17' schema: type: string - name: Authorization in: header description: API key for authentication. required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: object properties: advancedSearchFilters: $ref: '#/components/schemas/LocationAdvancedSearchFilterType' x-apidog-orders: - advancedSearchFilters x-apidog-ignore-properties: [] x-apidog-orders: - data x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' '401': description: Unauthorized - Invalid or missing API key content: application/json: schema: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051636-run /locations/search-filters: get: summary: Available search filter values deprecated: false description: '
Returns the distinct values available for the standard location filters across the account''s accessible locations: tags, folders, categories, additional categories, and Google Business Profile (GBP) categories (primary and additional). Use these values to populate the filter controls before calling Filter locations. ' operationId: searchFilters tags: - Locations parameters: - name: Synup-Version in: header description: API version date (YYYY-MM-DD). required: true example: '2026-04-17' schema: type: string - name: Authorization in: header description: API key for authentication. required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: object properties: searchFilters: $ref: '#/components/schemas/LocationSearchFilterType' x-apidog-orders: - searchFilters x-apidog-ignore-properties: [] x-apidog-orders: - data x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' '401': description: Unauthorized - Invalid or missing API key content: application/json: schema: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051651-run /locations/cancel_archive: post: summary: Cancel scheduled location archival deprecated: false description: "\nUse this API to cancel the archival of locations that are scheduled for archival but have not yet been processed.\n \n:::info[]\n \n\n**Important Notes:**\n- This endpoint can only cancel archival for locations that are in **ARCHIVE_SCHEDULED** status\n- Once canceled, the location will return to **ACTIVE** status and can be updated as usual.\n- Billing for the location will continue as per the standard cycle.\n \n \n:::\n " operationId: cancelLocationsArchive tags: - Locations parameters: - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string - name: Content-Type in: header description: '' required: true example: application/json schema: type: string requestBody: content: application/json: schema: type: object properties: input: type: object required: - locationIds properties: locationIds: type: array description: Array of location Node IDs to cancel archival for items: type: string x-apidog-orders: - locationIds x-apidog-orders: - input example: input: locationIds: - TG9jYXRpb246MTE4MzMzMA== responses: '200': description: Location archival cancellation successful content: application/json: schema: type: object properties: data: type: object properties: cancelLocationsArchive: type: object properties: bulkEditTaskId: type: - string - 'null' description: ID of bulk edit task if multiple locations are involved clientMutationId: type: - string - 'null' errors: type: - array - 'null' items: type: string result: type: array items: type: object properties: errors: type: - array - 'null' items: type: string locationId: type: string description: Node ID of the location status: type: string enum: - ACTIVE description: Status after cancellation success: type: boolean description: Whether the operation was successful x-apidog-orders: - errors - locationId - status - success success: type: - boolean - 'null' x-apidog-orders: - bulkEditTaskId - clientMutationId - errors - result - success x-apidog-orders: - cancelLocationsArchive x-apidog-orders: - data example: data: cancelLocationsArchive: bulkEditTaskId: null clientMutationId: null errors: null result: - errors: null locationId: TG9jYXRpb246MTE4MzMzMA== status: ACTIVE success: true success: null headers: {} x-apidog-name: OK '400': description: Bad request - invalid input content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Bad Request '401': description: Unauthorized - invalid or missing API key content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Unauthorized '403': description: Forbidden - insufficient permissions content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Forbidden '404': description: Location not found or not in ARCHIVE_SCHEDULED status content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Record Not Found security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13659850-run /locations/photos/requests/{requestId}: get: summary: Check Bulk Photo Upload Status deprecated: false description: "\n\nThis API monitors the progress of uploading multiple photos to a location, which is particularly useful when the upload involves more than 30 photos.\n \nRetrieve the current status of a bulk image upload request for a location. Use the requestId returned in the Upload Photos API to fetch the status.\n \nFor more details, refer to [Manage photos for your location](https://developer.synup.com/doc-833258.md). \n" operationId: checkBulkPhotoUploadStatus tags: - Locations parameters: - name: requestId in: path description: Request ID returned from bulk upload photos API required: true example: '' schema: type: string format: uuid examples: - d5673c0a-f9ca-4588-84fa-528ff7feac56 - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successfully retrieved upload status content: application/json: schema: type: object properties: data: type: object properties: getLocationPhotosUploadStatus: type: object properties: status: type: string description: 'Current status of the upload process: * PROCESSING - Image Upload in progress. Check again later. * SUCCESS - Image Upload successfully completed. * ERROR - Image upload process failed. ' enum: - PROCESSING - SUCCESS - ERROR examples: - PROCESSING - SUCCESS - ERROR x-apidog-enum: - value: PROCESSING name: '' description: '' - value: SUCCESS name: '' description: '' - value: ERROR name: '' description: '' requestId: type: string description: The ID of the bulk upload request format: uuid examples: - e6c2d9d9-9a18-4015-88cf-9a4e19a6f49a x-apidog-orders: - status - requestId x-apidog-orders: - getLocationPhotosUploadStatus x-apidog-orders: - data example: data: getLocationPhotosUploadStatus: requestId: e6c2d9d9-9a18-4015-88cf-9a4e19a6f49a status: SUCCESS headers: {} x-apidog-name: OK security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13642386-run /locations: post: summary: Create a new business location deprecated: false description: "\nA **Location** represents a physical business entity within your account and serves as the foundation for managing and interacting with the API’s features. Each Location acts as a centralized hub for managing and accessing data related to that specific business, including:\n \n- **Listings Management**: Maintain accurate and consistent business details across multiple publishers.\n- **Review Monitoring**: Track and respond to customer feedback associated with the location.\n- **Performance Insights**: Analyze key metrics related to visibility, engagement, and growth.\n- **SEO Optimization**: Enhance local search presence and improve rankings.\n\n
\n \n\n**_See the Request Section for a detailed data schema of Supported Fields. Here’s a key detail to keep in mind:_**\n
\n\n\n:::info []\n\n**Processing Time for Location Updates**\nUpdates to any location attributes, including `enabledSiteIds` or `submissionDisabledSiteIds`, are processed asynchronously before they are accurately reflected across all publishers and within the system.\n\n For example, If the business hours for a location are updated in the system, the changes are processed asynchronously before being reflected across all publishers. \n \n\n:::\n" operationId: createLocation tags: - Locations parameters: - name: Authorization in: header description: 'API key for authentication ' required: true example: API T9V35W3xxxxxxxxxxx schema: type: string requestBody: content: application/json: schema: type: object properties: input: type: object properties: name: type: string description: Name of the business storeId: type: - string - 'null' description: Unique store identifier. Must be unique across all locations. street: type: string description: Street address of the business street1: type: string description: Additional street address information city: type: string description: City where the business is located postalCode: type: string description: Postal code of the business location phone: type: string title: '' description: "- Must follow the international **E.164 format**. [Ref here.](https://www.twilio.com/docs/glossary/what-e164)\n- Do not include the `+` sign or country code.\n- Remove parentheses and special characters.\n- Example:\n - **Incorrect**: `(123)-456-7890`, `+1-123-456-7890`\n - **Correct**: `1234567890`" examples: - '1234567890' stateIso: type: string description: State ISO code. Refer to the Places API for valid ISOs. countryIso: type: string description: Country ISO code. Refer to the Places API for valid ISOs. ownerEmail: type: string description: Email of the business owner ownerName: type: string description: Name of the business owner subCategoryId: type: integer description: 'ID of the subcategory the business belongs to ' description: type: string description: Detailed description of the business bizUrl: type: string description: URL of the business website facebookUrl: type: string description: URL of the business's Facebook page twitterUrl: type: string description: URL of the business's Twitter page linkedinUrl: type: string description: URL of the business's LinkedIn page instagramUrl: type: string description: URL of the business's Instagram page youtubeUrl: type: string description: URL of the business's YouTube page tiktokUrl: type: string description: URL of the business's TikTok page pinterestUrl: type: string description: URL of the business's Pinterest page tagline: type: string description: Tagline of the business paymentMethods: type: array items: type: string enum: - VISA - MASTERCARD - AMEX - CASH - CHEQUE - CRYPTO - DINERS_CLUB - DISCOVER - FINANCING - INVOICE - TRAVELERS_CHECK - APPLE_PAY - SAMSUNG_PAY - PAYPAL - ANDROID_PAY x-apidog-enum: - value: VISA name: '' description: '' - value: MASTERCARD name: '' description: '' - value: AMEX name: '' description: '' - value: CASH name: '' description: '' - value: CHEQUE name: '' description: '' - value: CRYPTO name: '' description: '' - value: DINERS_CLUB name: '' description: '' - value: DISCOVER name: '' description: '' - value: FINANCING name: '' description: '' - value: INVOICE name: '' description: '' - value: TRAVELERS_CHECK name: '' description: '' - value: APPLE_PAY name: '' description: '' - value: SAMSUNG_PAY name: '' description: '' - value: PAYPAL name: '' description: '' - value: ANDROID_PAY name: '' description: '' description: Accepted payment methods ("VISA", "MASTERCARD", "AMEX", "CASH", "CHEQUE", "CRYPTO", "DINERS_CLUB", "DISCOVER", "FINANCING", "INVOICE", "TRAVELERS_CHECK", "APPLE_PAY", "SAMSUNG_PAY", "PAYPAL", "ANDROID_PAY" ) yearOfIncorporation: type: integer description: Year the business was established hideAddress: type: boolean description: Set to true if location is a Service Area Business businessHours: type: array description: Business hours for each day of the week items: type: object properties: day: type: string description: Day of the week enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY x-apidog-enum: - value: MONDAY name: '' description: '' - value: TUESDAY name: '' description: '' - value: WEDNESDAY name: '' description: '' - value: THURSDAY name: '' description: '' - value: FRIDAY name: '' description: '' - value: SATURDAY name: '' description: '' - value: SUNDAY name: '' description: '' slots: type: array items: type: object properties: start: type: string description: 'Opening time. Valid formats: `:am` OR `:pm` ' end: type: string description: 'Closing time. Valid formats: `:am` OR `:pm` ' x-apidog-orders: - start - end title: '' x--orders: - start - end x--ignore-properties: [] description: Array of time slots (minimum 1, maximum 2). Required only if type is OPEN. title: '' type: type: string description: Type of business hours (e.g., OPEN, CLOSED, OPEN_24x7) enum: - OPEN - OPEN_24x7 - CLOSED x-apidog-enum: - value: OPEN name: '' description: '' - value: OPEN_24x7 name: '' description: '' - value: CLOSED name: '' description: '' x-apidog-orders: - day - slots - type required: - day - slots - type x--orders: - day - slots - type x--ignore-properties: [] additionalCategoryIds: type: array description: Additional category IDs for the business items: type: integer videos: type: array description: List of valid video URLs items: type: string tenure: type: string description: 'Required when an account has multiple subscriptions. Specifies the tenure (e.g., Monthly). For accounts with multiple subscriptions, specify the tenure of the corresponding subscription. Refer to [Subscriptions](https://developer.synup.com/list-active-subscriptions-api-13639877.md) for details.' writeOnly: true examples: - Monthly - Yearly enabledSiteIds: type: array description: List of site IDs where the business details should be published items: type: integer submissionDisabledSiteIds: type: array description: List of site IDs where the business details should not be published items: type: integer temporarilyClosed: type: boolean description: Set to true if the location's business hours should be marked as closed additionalPhones: type: array description: Additional contact phone numbers items: type: string googleAdsPhone: type: string description: Google Ads-specific phone number bookingUrl: type: - string - 'null' description: URL for booking appointments. Applicable only for Food industry businesses offeringsUrl: type: - string - 'null' description: URL for listing business offerings. Applicable only for food industry businesses reservationUrl: type: - string - 'null' description: URL for making reservations. Applicable only for restaurant only businesses. placeActionLinks: type: array items: type: object properties: placeActionType: type: string description: One of the valid types. enum: - APPOINTMENT - ONLINE_APPOINTMENT - DINING_RESERVATION - FOOD_ORDERING - FOOD_DELIVERY - FOOD_TAKEOUT - SHOP_ONLINE x-apidog-enum: - value: APPOINTMENT name: '' description: '' - value: ONLINE_APPOINTMENT name: '' description: '' - value: DINING_RESERVATION name: '' description: '' - value: FOOD_ORDERING name: '' description: '' - value: FOOD_DELIVERY name: '' description: '' - value: FOOD_TAKEOUT name: '' description: '' - value: SHOP_ONLINE name: '' description: '' uri: type: string description: Destination URL. isPreferred: type: boolean description: Marks this link preferred for its type. At most one preferred per type. x-apidog-orders: - placeActionType - isPreferred - uri required: - placeActionType - uri x--orders: - placeActionType - uri - isPreferred x--ignore-properties: [] description: 'Manage a location''s Place Action Links ' x-apidog-orders: - tenure - storeId - subCategoryId - name - street - street1 - city - postalCode - phone - stateIso - countryIso - description - ownerEmail - ownerName - bizUrl - facebookUrl - twitterUrl - linkedinUrl - instagramUrl - youtubeUrl - tiktokUrl - pinterestUrl - tagline - paymentMethods - yearOfIncorporation - hideAddress - businessHours - additionalCategoryIds - videos - enabledSiteIds - submissionDisabledSiteIds - temporarilyClosed - additionalPhones - googleAdsPhone - bookingUrl - offeringsUrl - reservationUrl - placeActionLinks required: - name - street - city - postalCode - phone - stateIso - countryIso - subCategoryId - description x--orders: - name - storeId - street - street1 - city - postalCode - phone - stateIso - countryIso - ownerEmail - ownerName - subCategoryId - description - bizUrl - facebookUrl - twitterUrl - linkedinUrl - instagramUrl - youtubeUrl - tiktokUrl - pinterestUrl - tagline - paymentMethods - yearOfIncorporation - hideAddress - businessHours - additionalCategoryIds - videos - tenure - enabledSiteIds - submissionDisabledSiteIds - temporarilyClosed - additionalPhones - googleAdsPhone - bookingUrl - offeringsUrl - reservationUrl - placeActionLinks x--ignore-properties: [] x-apidog-orders: - input x--orders: - input x--ignore-properties: [] example: input: tenure: Monthly name: Whisk & Bloom Bakery street: 123 Maple Avenue street1: Suite 202 city: San Francisco postalCode: '94107' phone: (415) 555-1239 stateIso: CA countryIso: US ownerEmail: lana@whiskbloom.com ownerName: Lana Thompson subCategoryId: 10 description: Whisk & Bloom Bakery offers a delightful selection of organic and gluten-free baked goods. Our mission is to provide fresh, handmade pastries and cakes crafted with love and the finest ingredients. Visit us for a cozy experience and enjoy our special seasonal treats! bizUrl: https://www.whisknbloombakery.com/ facebookUrl: https://www.facebook.com/whisknbloomBakery/ linkedinUrl: https://www.linkedin.com/company/whisknbloombakery twitterUrl: https://twitter.com/whisknbloomBakery instagramUrl: https://www.instagram.com/whisknbloombakery/ youtubeUrl: null tiktokUrl: null pinterestUrl: https://www.pinterest.com/whisknbloombakery/ tagline: Fresh. Organic. Delicious. paymentMethods: - VISA - CASH yearOfIncorporation: 2015 hideAddress: false businessHours: - day: MONDAY slots: - start: 08:00am end: 12:00pm - start: 01:00pm end: 06:00pm type: OPEN - day: TUESDAY slots: - start: 08:00am end: 06:00pm type: OPEN - day: WEDNESDAY slots: - start: 08:00am end: 06:00pm type: OPEN - day: THURSDAY slots: - start: 08:00am end: 06:00pm type: OPEN - day: FRIDAY slots: - start: 08:00am end: 06:00pm type: OPEN - day: SATURDAY slots: - start: 08:00am end: 04:00pm type: OPEN - day: SUNDAY slots: [] type: CLOSED additionalCategoryIds: [] videos: [] enabledSiteIds: [] submissionDisabledSiteIds: [] temporarilyClosed: false additionalPhones: - (415) 555-5678 - (415) 555-9012 googleAdsPhone: (415) 555-3456 bookingUrl: https://www.whisknbloombakery.com/reservations offeringsUrl: https://www.whisknbloombakery.com/menu reservationUrl: https://www.whisknbloombakery.com/book storeId: null placeActionLinks: - placeActionType: FOOD_ORDERING uri: https://order.example.com isPreferred: true - placeActionType: FOOD_DELIVERY uri: https://deliver.example.com responses: '200': description: Location created successfully content: application/json: schema: type: object properties: data: type: object description: Contains the response data for the create location request. properties: createLocation: type: object description: Encapsulates details about the created location. properties: errors: type: 'null' description: Errors encountered during the location creation process, if any. Null if no errors. location: description: Details of the created location. type: object x-apidog-refs: 01JW6KY3NPVTMY6C967CGDPRQ7: $ref: '#/components/schemas/LocationResponseSchema' x-apidog-overrides: errors: null x-apidog-orders: - 01JW6KY3NPVTMY6C967CGDPRQ7 properties: {} x--orders: [] x--ignore-properties: [] success: type: boolean description: Indicates whether the location creation was successful. warnings: type: array description: List of warnings generated during the request processing, if any. items: type: string x-apidog-orders: - errors - location - success - warnings x--orders: - errors - location - success - warnings x--ignore-properties: [] x-apidog-orders: - createLocation x--orders: - createLocation x--ignore-properties: [] message: type: string description: Response message indicating the result of the operation. examples: - Location created successfully x-apidog-orders: - data - message x--orders: - data - message x--ignore-properties: [] examples: '1': summary: Success value: data: createLocation: clientMutationId: null errors: null location: accountId: 16154 additionalCategoryIds: [] additionalInfo: null additionalPhones: - '4155555678' - '4155559012' archived: false archivedAt: null billingPeriod: null bizUrl: https://www.greenleafbakery.com/ bookingUrl: https://www.greenleafbakery.com/reservations businessHours: - day: SUNDAY slots: null specialDate: null type: CLOSED - day: MONDAY slots: - end: 12:00pm start: 08:00am - end: 06:00pm start: 01:00pm specialDate: null type: OPEN - day: TUESDAY slots: - end: 06:00pm start: 08:00am specialDate: null type: OPEN - day: WEDNESDAY slots: - end: 06:00pm start: 08:00am specialDate: null type: OPEN - day: THURSDAY slots: - end: 06:00pm start: 08:00am specialDate: null type: OPEN - day: FRIDAY slots: - end: 06:00pm start: 08:00am specialDate: null type: OPEN - day: SATURDAY slots: - end: 04:00pm start: 08:00am specialDate: null type: OPEN categoryId: 15 city: San Francisco countryIso: US customAttributes: - archived: false enumValues: [] name: bollean01 slug: bollean01 type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: KAM slug: kam type: STRING value: - '' - archived: false enumValues: [] name: P_Test01 slug: p_test01 type: STRING value: - one12 - archived: false enumValues: [] name: ABC slug: abc type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: NJL slug: njl type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: ZZZ slug: zzz type: STRING value: [] - archived: false enumValues: [] name: ALL slug: all type: STRING value: - ss - archived: false enumValues: - gulab jamun - rasgulla - ras malai - jalebi name: Dessets slug: dessets type: ENUM value: - gulab jamun - archived: false enumValues: [] name: Attrs slug: attrs type: STRING value: [] - archived: false enumValues: [] name: Attrs2 slug: attrs2 type: STRING value: [] - archived: false enumValues: [] name: Toll-free Number slug: toll-free_number type: INTEGER value: - '80044637' - archived: false enumValues: [] name: amenities slug: amenities type: ARRAY value: - wifi - wheelchair - welcoming ceremony - archived: false enumValues: [] name: amenities02 slug: amenities02 type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Amenities-check slug: amenities-check type: BOOLEAN value: - 'false' - archived: false enumValues: - Atr1 - atr2 - atr3 name: Prod_Attribute slug: prod_attribute type: ENUM value: - Atr1 - archived: false enumValues: [] name: wifi available slug: wifi_available type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: QQQQQQQ slug: qqqqqqq type: INTEGER value: - '123' - archived: false enumValues: [] name: int02 slug: int02 type: INTEGER value: [] - archived: false enumValues: [] name: Tasty slug: tasty type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: dhdop slug: dhdop type: STRING value: [] - archived: false enumValues: [] name: Abstract slug: abstract type: ARRAY value: - abs1 - abs2 - abs3 - archived: false enumValues: [] name: Senior Hours Required? slug: senior_hours_required? type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: kafka_check_attribute slug: kafka_check_attribute type: ARRAY value: - one - two - three - archived: false enumValues: [] name: Parking slug: parking type: BOOLEAN value: - 'false' - archived: false enumValues: [] name: googlePlaceId slug: googleplaceid type: STRING value: [] - archived: false enumValues: [] name: hoursComments slug: hourscomments type: STRING value: [] - archived: false enumValues: [] name: isOpen slug: isopen type: BOOLEAN value: [] - archived: false enumValues: [] name: has_bicycle_rack? slug: has_bicycle_rack? type: BOOLEAN value: [] - archived: false enumValues: - one - two name: quick slug: quick type: ENUM value: - one - archived: false enumValues: [] name: instagramUrl slug: instagramurl type: STRING value: [] - archived: false enumValues: [] name: analyticsTrackingFireEvent slug: analyticstrackingfireevent type: STRING value: [] - archived: false enumValues: [] name: placeholderText slug: placeholdertext type: STRING value: [] - archived: false enumValues: - FRND - MENMENMEN - BARNEY name: TV slug: tv type: ENUM value: - FRND - archived: false enumValues: [] name: notificationEmails slug: notificationemails type: ARRAY value: [] - archived: false enumValues: [] name: joinUrl slug: joinurl type: STRING value: [] - archived: false enumValues: [] name: account_att slug: account_att type: ARRAY value: - '1' - '2' - '4' - '3' - archived: false enumValues: [] name: Post v2 slug: post_v2 type: STRING value: [] - archived: false enumValues: [] name: testingthetest slug: testingthetest type: INTEGER value: - '0' - archived: false enumValues: [] name: int0 slug: int0 type: INTEGER value: - '0' - archived: false enumValues: [] name: url_appointment slug: url_appointment type: STRING value: [] - archived: false enumValues: [] name: Slug slug: slug type: STRING value: [] - archived: false enumValues: [] name: New Name slug: new_name type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: test200 slug: test200 type: STRING value: - test test - archived: false enumValues: [] name: Name slug: name type: STRING value: [] - archived: false enumValues: [] name: 'Test Department ' slug: test_department_ type: ARRAY value: [] - archived: false enumValues: [] name: 'Fresh Fish Section ' slug: fresh_fish_section_ type: STRING value: [] - archived: false enumValues: [] name: Test 28 11 22 slug: test_28_11_22 type: STRING value: - Test 28 - archived: false enumValues: [] name: accepts reservation slug: accepts_reservation type: BOOLEAN value: [] - archived: false enumValues: [] name: blablacar slug: blablacar type: STRING value: [] - archived: false enumValues: [] name: requires temperature check customers slug: requires_temperature_check_customers type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Custom Tee Point slug: custom_tee_point type: STRING value: - tess - archived: false enumValues: [] name: appointment_required slug: appointment_required type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: requires masks customers slug: requires_masks_customers type: BOOLEAN value: [] - archived: false enumValues: [] name: is black owned slug: is_black_owned type: BOOLEAN value: [] - archived: false enumValues: [] name: BewAttribute slug: bewattribute type: STRING value: [] - archived: false enumValues: [] name: 'Pets 2 ' slug: pets_2_ type: ARRAY value: [] - archived: false enumValues: [] name: test214122 slug: test214122 type: STRING value: - test2 - archived: false enumValues: [] name: Test123 slug: test123 type: STRING value: [] - archived: false enumValues: [] name: ohiiiignore slug: ohiiiignore type: STRING value: [] - archived: false enumValues: [] name: yesnotest slug: yesnotest type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: account_leve_test_for_ext slug: account_leve_test_for_ext type: STRING value: [] - archived: false enumValues: [] name: Custom location ID slug: custom_location_id type: STRING value: [] - archived: false enumValues: [] name: Account Attr slug: account_attr type: ARRAY value: - one - two - three - archived: false enumValues: - b - a - c name: enum01 slug: enum01 type: ENUM value: - a - archived: false enumValues: [] name: Paneer Speciality slug: paneer_speciality type: STRING value: - https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/be9eafc1-78ca-4515-a164-005a28db4e69.jpg - archived: false enumValues: [] name: welcomes_lgbtq slug: welcomes_lgbtq type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Lgbtq+ friendly slug: lgbtq+_friendly type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: analyticsTrackingScript slug: analyticstrackingscript type: STRING value: [] - archived: false enumValues: [] name: url_menu slug: url_menu type: STRING value: [] databaseId: 1181652 description: Greenleaf Bakery offers a delightful selection of organic and gluten-free baked goods. Our mission is to provide fresh, handmade pastries and cakes crafted with love and the finest ingredients. Visit us for a cozy experience and enjoy our special seasonal treats! facebookUrl: https://www.facebook.com/GreenleafBakery/ folderId: 401228fe-8ee9-4914-a08a-db7cda490ec9 folderName: root googleAdsPhone: '4155553456' googleplusUrl: null hideAddress: false id: TG9jYXRpb246MTE4MTY1Mg== instagramUrl: https://www.instagram.com/greenleafbakery/ isRestaurant: true latitude: 37.7618242 linkedinUrl: https://www.linkedin.com/company/greenleafbakery locationPhotos: [] longitude: -122.3985871 moreHours: [] name: 𝗚𝗿𝗲𝗲𝗻𝗹𝗲𝗮𝗳 𝗕𝗮𝗸𝗲𝗿𝘆 & 𝗖𝗮𝗸𝗲 offeringsUrl: https://www.greenleafbakery.com/menu ownerEmail: info@greenleafbakery.com ownerName: Emma Thompson package: PREMIUM paymentMethods: - VISA - CASH phone: '4155551239' pinterestUrl: https://www.pinterest.com/greenleafbakery/ planId: 86 planName: V2 Premium Slow + Fast Sites postalCode: '94107' publisherAttributes: [] reservationUrl: https://www.greenleafbakery.com/book serviceItems: [] stateIso: CA storeId: null street: 123 Maple Avenue street1: 'Suite #202' subCategory: databaseId: 1432 id: U3ViQ2F0ZWdvcnk6MTQzMg== name: Restaurants primary: true subCategoryId: 1432 subCategoryName: Restaurants tagline: Fresh. Organic. Delicious. tags: - all temporarilyClosed: false tiktokUrl: null toplineMessage: null toplineMessageText: null twitterUrl: https://twitter.com/GreenleafBakery videos: [] yearOfIncorporation: 2015 youtubeUrl: null placeActionLinks: - placeActionType: FOOD_ORDERING uri: https://order.example.com isPreferred: true name: null submissionStatus: null - placeActionType: FOOD_DELIVERY uri: https://deliver.example.com isPreferred: false name: null submissionStatus: null success: true warnings: [] '2': summary: 'Validation Errors: Missing or Invalid Fields' value: data: createLocation: clientMutationId: null errors: - code: SY10011 contextInfo: - key: street value: '' message: Street can't be blank - code: SY10015 contextInfo: - key: phone value: '' message: Phone Number is invalid - code: SY10005 contextInfo: - key: description value: Greenleaf Bakery offers a delightful selection message: Description is too short (minimum is 200 characters) location: null success: false warnings: null '3': summary: Missing Tenure in Multi-Subscription value: data: createLocation: clientMutationId: null errors: - code: SY10087 contextInfo: - key: tenure value: null message: Tenure is required location: null success: false warnings: null headers: {} x-apidog-name: OK '400': description: Bad request, invalid input content: application/json: schema: type: object properties: {} x-apidog-orders: [] x--orders: [] x--ignore-properties: [] headers: {} x-apidog-name: Bad Request security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13603961-run get: summary: List all locations deprecated: false description: "
\n\n\nThis API retrieves a paginated list of locations within the account, allowing for efficient data retrieval when managing multiple locations.\n \n" operationId: listLocations tags: - Locations parameters: - name: first in: query description: Number of records to fetch from the most recent ones (i.e., from the end). Defaults to 50 if not provided. required: false example: 2 schema: type: integer minimum: 1 examples: - 2 - name: last in: query description: Number of records to fetch from the earliest ones (i.e., from the beginning). required: false example: 1 schema: type: integer minimum: 1 - name: after in: query description: Cursor to fetch records after required: false example: TG9jYXRpb246MTAw schema: type: string - name: before in: query description: Cursor to fetch records before required: false example: '' schema: type: string - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: object properties: allLocations: type: object properties: edges: type: array items: type: object x-apidog-refs: {} x-apidog-orders: - cursor - node properties: cursor: type: string node: $ref: '#/components/schemas/LocationResponseSchema' x-apidog-ignore-properties: [] pageInfo: $ref: '#/components/schemas/PageInfo' x-apidog-orders: - edges - pageInfo x-apidog-ignore-properties: [] x-apidog-orders: - allLocations x-apidog-ignore-properties: [] x-apidog-orders: - data x-apidog-ignore-properties: [] example: data: allLocations: edges: - cursor: TG9jYXRpb246MTE5NTI1OA== node: accountId: 16154 addOns: [] additionalCategoryIds: - 43 additionalCategoryNames: - Playgrounds additionalInfo: null additionalPhones: [] approved: APPROVED archivalScheduledAt: null archived: false archivedAt: null bizUrl: https://headsupcatchme.com/ bizUrlUtm: false bookingUrl: null businessHours: - day: SUNDAY slots: null specialDate: null type: CLOSED - day: MONDAY slots: - end: 05:00pm start: 09:00am specialDate: null type: OPEN - day: TUESDAY slots: - end: 09:00pm start: 09:00am specialDate: null type: OPEN - day: WEDNESDAY slots: - end: 11:30am start: 09:00am - end: 05:00pm start: 01:00pm - end: 09:30pm start: 06:00pm specialDate: null type: OPEN - day: THURSDAY slots: null specialDate: null type: OPEN_24x7 - day: FRIDAY slots: null specialDate: null type: CLOSED - day: SATURDAY slots: null specialDate: null type: CLOSED cancellationScheduledAt: null categoryId: 59 city: Setauket- East Setauket countryIso: US createErrors: - fieldName: base messages: - A Location with same name, phone number and zip code has already been added. - fieldName: storeId messages: - Store has already been taken createdDate: February 19, 2025 customAttributes: - archived: false enumValues: [] name: bollean01 slug: bollean01 type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: KAM slug: kam type: STRING value: - '' - archived: false enumValues: [] name: P_Test01 slug: p_test01 type: STRING value: - one12 - archived: false enumValues: [] name: ABC slug: abc type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: NJL slug: njl type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: ZZZ slug: zzz type: STRING value: [] - archived: false enumValues: [] name: ALL slug: all type: STRING value: - ss - archived: false enumValues: - gulab jamun - rasgulla - ras malai - jalebi name: Dessets slug: dessets type: ENUM value: - gulab jamun - archived: false enumValues: [] name: Attrs slug: attrs type: STRING value: [] - archived: false enumValues: [] name: Attrs2 slug: attrs2 type: STRING value: [] - archived: false enumValues: [] name: Toll-free Number slug: toll-free_number type: INTEGER value: - '80044637' - archived: false enumValues: [] name: amenities slug: amenities type: ARRAY value: - wifi - wheelchair - welcoming ceremony - archived: false enumValues: [] name: amenities02 slug: amenities02 type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Amenities-check slug: amenities-check type: BOOLEAN value: - 'false' - archived: false enumValues: [] name: is owned by veterans slug: is_owned_by_veterans type: BOOLEAN value: - 'true' - archived: false enumValues: - Atr1 - atr2 - atr3 name: Prod_Attribute slug: prod_attribute type: ENUM value: - Atr1 - archived: false enumValues: [] name: wifi available slug: wifi_available type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: QQQQQQQ slug: qqqqqqq type: INTEGER value: - '123' - archived: false enumValues: [] name: int02 slug: int02 type: INTEGER value: [] - archived: false enumValues: [] name: Tasty slug: tasty type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: dhdop slug: dhdop type: STRING value: [] - archived: false enumValues: [] name: Abstract slug: abstract type: ARRAY value: - abs1 - abs2 - abs3 - archived: false enumValues: [] name: Senior Hours Required? slug: senior_hours_required? type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: kafka_check_attribute slug: kafka_check_attribute type: ARRAY value: - one - two - three - archived: false enumValues: [] name: Parking slug: parking type: BOOLEAN value: - 'false' - archived: false enumValues: [] name: googlePlaceId slug: googleplaceid type: STRING value: [] - archived: false enumValues: [] name: hoursComments slug: hourscomments type: STRING value: [] - archived: false enumValues: [] name: isOpen slug: isopen type: BOOLEAN value: [] - archived: false enumValues: [] name: has_bicycle_rack? slug: has_bicycle_rack? type: BOOLEAN value: [] - archived: false enumValues: - one - two name: quick slug: quick type: ENUM value: - one - archived: false enumValues: [] name: instagramUrl slug: instagramurl type: STRING value: [] - archived: false enumValues: [] name: analyticsTrackingFireEvent slug: analyticstrackingfireevent type: STRING value: [] - archived: false enumValues: [] name: placeholderText slug: placeholdertext type: STRING value: [] - archived: false enumValues: - FRND - MENMENMEN - BARNEY name: TV slug: tv type: ENUM value: - FRND - archived: false enumValues: [] name: notificationEmails slug: notificationemails type: ARRAY value: [] - archived: false enumValues: [] name: joinUrl slug: joinurl type: STRING value: [] - archived: false enumValues: [] name: account_att slug: account_att type: ARRAY value: - '1' - '2' - '4' - '3' - archived: false enumValues: [] name: Post v2 slug: post_v2 type: STRING value: [] - archived: false enumValues: [] name: testingthetest slug: testingthetest type: INTEGER value: - '0' - archived: false enumValues: [] name: int0 slug: int0 type: INTEGER value: - '0' - archived: false enumValues: [] name: url_appointment slug: url_appointment type: STRING value: [] - archived: false enumValues: [] name: Slug slug: slug type: STRING value: [] - archived: false enumValues: [] name: New Name slug: new_name type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: test200 slug: test200 type: STRING value: - test test - archived: false enumValues: [] name: Name slug: name type: STRING value: [] - archived: false enumValues: [] name: 'Test Department ' slug: test_department_ type: ARRAY value: [] - archived: false enumValues: [] name: 'Fresh Fish Section ' slug: fresh_fish_section_ type: STRING value: [] - archived: false enumValues: [] name: Test 28 11 22 slug: test_28_11_22 type: STRING value: - Test 28 - archived: false enumValues: [] name: blablacar slug: blablacar type: STRING value: [] - archived: false enumValues: [] name: requires temperature check customers slug: requires_temperature_check_customers type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Custom Tee Point slug: custom_tee_point type: STRING value: - tess - archived: false enumValues: [] name: appointment_required slug: appointment_required type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: requires masks customers slug: requires_masks_customers type: BOOLEAN value: [] - archived: false enumValues: [] name: is black owned slug: is_black_owned type: BOOLEAN value: [] - archived: false enumValues: [] name: BewAttribute slug: bewattribute type: STRING value: [] - archived: false enumValues: [] name: 'Pets 2 ' slug: pets_2_ type: ARRAY value: [] - archived: false enumValues: [] name: test214122 slug: test214122 type: STRING value: - test2 - archived: false enumValues: [] name: Test123 slug: test123 type: STRING value: [] - archived: false enumValues: [] name: ohiiiignore slug: ohiiiignore type: STRING value: [] - archived: false enumValues: [] name: yesnotest slug: yesnotest type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: account_leve_test_for_ext slug: account_leve_test_for_ext type: STRING value: [] - archived: false enumValues: [] name: Custom location ID slug: custom_location_id type: STRING value: [] - archived: false enumValues: [] name: Account Attr slug: account_attr type: ARRAY value: - one - two - three - archived: false enumValues: - b - a - c name: enum01 slug: enum01 type: ENUM value: - a - archived: false enumValues: [] name: Paneer Speciality slug: paneer_speciality type: STRING value: - https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/be9eafc1-78ca-4515-a164-005a28db4e69.jpg - archived: false enumValues: [] name: welcomes_lgbtq slug: welcomes_lgbtq type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Lgbtq+ friendly slug: lgbtq+_friendly type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: analyticsTrackingScript slug: analyticstrackingscript type: STRING value: [] - archived: false enumValues: [] name: is owned by women slug: is_owned_by_women type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: has wheelchair accessible seating slug: has_wheelchair_accessible_seating type: BOOLEAN value: - 'false' - archived: false enumValues: [] name: has restroom slug: has_restroom type: BOOLEAN value: - 'false' - archived: false enumValues: [] name: has_wheelchair_accessible_restroom slug: has_wheelchair_accessible_restroom type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: has restroom unisex slug: has_restroom_unisex type: BOOLEAN value: - 'false' - archived: false enumValues: [] name: is transgender safespace slug: is_transgender_safespace type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: welcomes_lgbtq slug: welcomes_lgbtq type: BOOLEAN value: - 'true' databaseId: 1195258 description: About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business enabledSiteIds: [] facebookUrl: null folderId: 401228fe-8ee9-4914-a08a-db7cda490ec9 folderName: root franchise: false googleAdsPhone: '6314848881' googleVerificationStatus: message: null status: null googleplusUrl: null hideAddress: false id: TG9jYXRpb246MTE5NTI1OA== instagramUrl: null isRestaurant: false lastUpdatedDate: February 19, 2025 latitude: '40.9366839' linkedinUrl: https://www.linkedin.com/in/ac-slater-hey/ locationPhotos: - databaseId: 6020661 fileSize: 44693 id: TWVkaWFGaWxlOjYwMjA2NjE= name: 43700ee9-5291-4e5e-bf8a-165f724f55b4.jpg starred: false thumbnailUrl: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/200x200/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/4a64cfad-a6b3-4de9-9238-ffbd89aaa7b2.jpg type: LOGO url: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/250x250/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/4a64cfad-a6b3-4de9-9238-ffbd89aaa7b2.jpg - databaseId: 6020659 fileSize: 138594 id: TWVkaWFGaWxlOjYwMjA2NTk= name: 7ead4509-01c0-4c59-85ac-9c710fed53f2.jpg starred: false thumbnailUrl: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/200x200/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/cf49f33f-1220-429e-9f86-4f64ade0a7be.jpg type: COVER url: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/250x250/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/cf49f33f-1220-429e-9f86-4f64ade0a7be.jpg longitude: '-73.1081977' managedServiceSiteBuckets: [] managedServiceSites: [] moreHours: [] name: Benjamin Auditor House offeringsUrl: null ownerEmail: null ownerName: null package: PREMIUM paymentMethods: [] phone: '6314848880' pinterestUrl: null planId: 86 planName: V2 Premium Slow + Fast Sites postalCode: '11733' publisherAttributes: [] reservationUrl: null serviceItems: - categoryId: '3996' currencyCode: USD description: simple menu id: 01c522d6-9e9b-4234-9978-61c10f35e4ef languageCode: null name: Buffet price: 100 - categoryId: '3996' currencyCode: null description: null id: 4360744c-26fa-46f8-9aea-b3a104e1f0b3 languageCode: null name: Swing price: null - categoryId: '3996' currencyCode: null description: null id: 13675b09-88a7-48c1-901f-f455e7be1994 languageCode: null name: Drive Through price: null - categoryId: '3996' currencyCode: null description: Fine dining or whatever just have food and go home!!! id: 4ccff7cd-a292-429a-a7d0-49101b91db1d languageCode: null name: Fine Dining price: null - categoryId: '3996' currencyCode: USD description: A happy-sounding, but soul-stirring music that will have you hum it for hours after you have got off the carousel! id: cf786095-edba-4ef2-820f-4fe198834742 languageCode: null name: Merry-go-round price: 10 stateIso: NY stateName: New York storeId: shop_code_benji street: '1368 Route 25A, United States, 100 NY-25A, #22' street1: null subCategoryId: 3996 subCategoryName: International airport tagline: null tags: - all - label_in_google temporarilyClosed: false tiktokUrl: null toplineMessage: null toplineMessageText: null twitterUrl: https://twitter.com/journeymus uid: 716d9b63-0158-4463-83a2-ee1014a13cec updatedAt: '2025-02-19T07:24:51.689Z' videos: [] voiceStatus: 1 yearOfIncorporation: null youtubeUrl: https://www.youtube.com/@JayGuldekar2.0 - cursor: TG9jYXRpb246MTE5NTI1Mg== node: accountId: 16154 addOns: [] additionalCategoryIds: [] additionalCategoryNames: [] additionalInfo: null additionalPhones: [] approved: APPROVED archivalScheduledAt: null archived: false archivedAt: null bizUrl: http://valencarestaurantnj.com/ bizUrlUtm: false bookingUrl: null businessHours: [] cancellationScheduledAt: null categoryId: 15 city: Elizabeth countryIso: US createErrors: [] createdDate: February 19, 2025 customAttributes: - archived: false enumValues: [] name: bollean01 slug: bollean01 type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: KAM slug: kam type: STRING value: - '' - archived: false enumValues: [] name: P_Test01 slug: p_test01 type: STRING value: - one12 - archived: false enumValues: [] name: ABC slug: abc type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: NJL slug: njl type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: ZZZ slug: zzz type: STRING value: [] - archived: false enumValues: [] name: ALL slug: all type: STRING value: - ss - archived: false enumValues: - gulab jamun - rasgulla - ras malai - jalebi name: Dessets slug: dessets type: ENUM value: - gulab jamun - archived: false enumValues: [] name: Attrs slug: attrs type: STRING value: [] - archived: false enumValues: [] name: Attrs2 slug: attrs2 type: STRING value: [] - archived: false enumValues: [] name: Toll-free Number slug: toll-free_number type: INTEGER value: - '80044637' - archived: false enumValues: [] name: amenities slug: amenities type: ARRAY value: - wifi - wheelchair - welcoming ceremony - archived: false enumValues: [] name: amenities02 slug: amenities02 type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Amenities-check slug: amenities-check type: BOOLEAN value: - 'false' - archived: false enumValues: - Atr1 - atr2 - atr3 name: Prod_Attribute slug: prod_attribute type: ENUM value: - Atr1 - archived: false enumValues: [] name: wifi available slug: wifi_available type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: QQQQQQQ slug: qqqqqqq type: INTEGER value: - '123' - archived: false enumValues: [] name: int02 slug: int02 type: INTEGER value: [] - archived: false enumValues: [] name: Tasty slug: tasty type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: dhdop slug: dhdop type: STRING value: [] - archived: false enumValues: [] name: Abstract slug: abstract type: ARRAY value: - abs1 - abs2 - abs3 - archived: false enumValues: [] name: Senior Hours Required? slug: senior_hours_required? type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: kafka_check_attribute slug: kafka_check_attribute type: ARRAY value: - one - two - three - archived: false enumValues: [] name: Parking slug: parking type: BOOLEAN value: - 'false' - archived: false enumValues: [] name: googlePlaceId slug: googleplaceid type: STRING value: [] - archived: false enumValues: [] name: hoursComments slug: hourscomments type: STRING value: [] - archived: false enumValues: [] name: isOpen slug: isopen type: BOOLEAN value: [] - archived: false enumValues: [] name: has_bicycle_rack? slug: has_bicycle_rack? type: BOOLEAN value: [] - archived: false enumValues: - one - two name: quick slug: quick type: ENUM value: - one - archived: false enumValues: [] name: instagramUrl slug: instagramurl type: STRING value: [] - archived: false enumValues: [] name: analyticsTrackingFireEvent slug: analyticstrackingfireevent type: STRING value: [] - archived: false enumValues: [] name: placeholderText slug: placeholdertext type: STRING value: [] - archived: false enumValues: - FRND - MENMENMEN - BARNEY name: TV slug: tv type: ENUM value: - FRND - archived: false enumValues: [] name: notificationEmails slug: notificationemails type: ARRAY value: [] - archived: false enumValues: [] name: joinUrl slug: joinurl type: STRING value: [] - archived: false enumValues: [] name: account_att slug: account_att type: ARRAY value: - '1' - '2' - '4' - '3' - archived: false enumValues: [] name: Post v2 slug: post_v2 type: STRING value: [] - archived: false enumValues: [] name: testingthetest slug: testingthetest type: INTEGER value: - '0' - archived: false enumValues: [] name: int0 slug: int0 type: INTEGER value: - '0' - archived: false enumValues: [] name: url_appointment slug: url_appointment type: STRING value: [] - archived: false enumValues: [] name: Slug slug: slug type: STRING value: - /new-york/elizabeth/665-monroe-ave - archived: false enumValues: [] name: New Name slug: new_name type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: test200 slug: test200 type: STRING value: - test test - archived: false enumValues: [] name: Name slug: name type: STRING value: [] - archived: false enumValues: [] name: 'Test Department ' slug: test_department_ type: ARRAY value: [] - archived: false enumValues: [] name: 'Fresh Fish Section ' slug: fresh_fish_section_ type: STRING value: [] - archived: false enumValues: [] name: Test 28 11 22 slug: test_28_11_22 type: STRING value: - Test 28 - archived: false enumValues: [] name: accepts reservation slug: accepts_reservation type: BOOLEAN value: [] - archived: false enumValues: [] name: blablacar slug: blablacar type: STRING value: [] - archived: false enumValues: [] name: requires temperature check customers slug: requires_temperature_check_customers type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Custom Tee Point slug: custom_tee_point type: STRING value: - tess - archived: false enumValues: [] name: appointment_required slug: appointment_required type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: requires masks customers slug: requires_masks_customers type: BOOLEAN value: [] - archived: false enumValues: [] name: is black owned slug: is_black_owned type: BOOLEAN value: [] - archived: false enumValues: [] name: BewAttribute slug: bewattribute type: STRING value: [] - archived: false enumValues: [] name: 'Pets 2 ' slug: pets_2_ type: ARRAY value: [] - archived: false enumValues: [] name: test214122 slug: test214122 type: STRING value: - test2 - archived: false enumValues: [] name: Test123 slug: test123 type: STRING value: [] - archived: false enumValues: [] name: ohiiiignore slug: ohiiiignore type: STRING value: [] - archived: false enumValues: [] name: yesnotest slug: yesnotest type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: account_leve_test_for_ext slug: account_leve_test_for_ext type: STRING value: [] - archived: false enumValues: [] name: Custom location ID slug: custom_location_id type: STRING value: [] - archived: false enumValues: [] name: Account Attr slug: account_attr type: ARRAY value: - one - two - three - archived: false enumValues: - b - a - c name: enum01 slug: enum01 type: ENUM value: - a - archived: false enumValues: [] name: Paneer Speciality slug: paneer_speciality type: STRING value: - https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/be9eafc1-78ca-4515-a164-005a28db4e69.jpg - archived: false enumValues: [] name: welcomes_lgbtq slug: welcomes_lgbtq type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Lgbtq+ friendly slug: lgbtq+_friendly type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: analyticsTrackingScript slug: analyticstrackingscript type: STRING value: [] - archived: false enumValues: [] name: url_menu slug: url_menu type: STRING value: [] databaseId: 1195252 description: '' enabledSiteIds: [] facebookUrl: null folderId: 401228fe-8ee9-4914-a08a-db7cda490ec9 folderName: root franchise: false googleAdsPhone: null googleVerificationStatus: message: null status: NOT_CONNECTED googleplusUrl: null hideAddress: false id: TG9jYXRpb246MTE5NTI1Mg== instagramUrl: null isRestaurant: true lastUpdatedDate: February 19, 2025 latitude: '40.6770873' linkedinUrl: null locationPhotos: [] longitude: '-74.2031927' managedServiceSiteBuckets: [] managedServiceSites: [] moreHours: [] name: Valenca Restaurant offeringsUrl: null ownerEmail: null ownerName: null package: PREMIUM paymentMethods: [] phone: '9083544024' pinterestUrl: null planId: 86 planName: V2 Premium Slow + Fast Sites postalCode: '07201' publisherAttributes: [] reservationUrl: null serviceItems: [] stateIso: NY stateName: New York storeId: null street: 665 Monroe Ave street1: null subCategoryId: 1432 subCategoryName: Restaurants tagline: null tags: - all temporarilyClosed: false tiktokUrl: null toplineMessage: null toplineMessageText: null twitterUrl: null uid: b49e138a-430d-4b88-9b0b-e24de2708c69 updatedAt: '2025-02-19T06:01:46.686Z' videos: [] voiceStatus: 3 yearOfIncorporation: null youtubeUrl: null placeActionLinks: - placeActionType: FOOD_ORDERING uri: https://order.example.com isPreferred: true name: locations/1944.../placeActionLinks/54ada85bc246058a submissionStatus: success submissionMessage: Already up to date on Google. lastSubmittedAt: '2026-07-08T12:14:36Z' discoveredPlaceActionLinks: - placeActionType: APPOINTMENT uri: https://book.example.com isPreferred: false name: locations/1944.../placeActionLinks/abc123 providerType: MERCHANT isEditable: true pageInfo: endCursor: TG9jYXRpb246MTE5NTI1Mg== hasNextPage: true hasPreviousPage: false total: 4989 headers: {} x-apidog-name: OK '400': description: Bad location ID or invalid parameters content: application/json: schema: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] headers: {} x-apidog-name: Bad Request security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13651646-run /locations/photos/remove: post: summary: Delete Location Photos deprecated: false description: "\n\nThis API allows you to delete one or more photos of type ADDITIONAL from a specified location.\n\n:::info[] \n **Note** \nOnly ADDITIONAL photo types can be removed.\nLOGO and COVER photo types cannot be deleted using this endpoint.\n:::\n\nFor more details, refer to [Manage photos for your location](https://developer.synup.com/doc-833258.md).\t\n\n" operationId: deleteLocationPhotos tags: - Locations parameters: - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string requestBody: content: application/json: schema: type: object required: - input properties: input: type: object required: - photoIds - locationId properties: locationId: type: string description: ID of the location to remove photos from examples: - TG9jYXRpb246MTM5NTc= photoIds: type: array description: List of Photo IDs to be deleted items: type: string examples: - - TG9jYXRpb25QaG90bzoxMjI2MA== x-apidog-orders: - locationId - photoIds x-apidog-orders: - input example: '' responses: '200': description: 'Logo/Cover Cannot Be Starred: If a request includes photos of type LOGO or COVER, the operation will fail for those photos.' content: application/json: schema: type: object properties: data: type: object properties: removeLocationPhotos: type: object properties: success: type: boolean errors: type: 'null' photos: type: array items: type: object properties: databaseId: type: integer fileSize: type: integer id: type: string name: type: string starred: type: boolean thumbnailUrl: type: string type: type: string url: type: string publisherOverride: type: string x-apidog-orders: - databaseId - fileSize - id - name - starred - thumbnailUrl - type - url - publisherOverride clientMutationId: type: 'null' required: - success - errors - photos - clientMutationId x-apidog-orders: - success - errors - photos - clientMutationId required: - removeLocationPhotos x-apidog-orders: - removeLocationPhotos required: - data x-apidog-orders: - data examples: '1': summary: Success value: data: removeLocationPhotos: success: true errors: null photos: - databaseId: 5638205 fileSize: 95636 id: TWVkaWFGaWxlOjU2MzgyMDU= name: 090f5748-2f84-405e-bd04-6cd42dad2496 starred: false thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/thumbnail_7c7fdefb-c50d-4478-8b8e-957011444445.jpg type: ADDITIONAL url: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/7c7fdefb-c50d-4478-8b8e-957011444445.jpg publisherOverride: '' clientMutationId: null '2': summary: Exception value: data: removeLocationPhotos: success: false errors: - message: 'SY15014: Can not remove Logo/Cover' contextInfo: - key: null value: null code: SY15014 photos: null clientMutationId: null headers: {} x-apidog-name: OK security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13642416-run /locations/download: get: summary: Download locations deprecated: false description: '
Generates a CSV export of the selected locations and returns a download URL. The export runs asynchronously — the response confirms the request was accepted, and the user is notified by email when the CSV is ready. Use `selectionType` to choose between all matching locations (`ALL_ITEMS`) or an explicit set (`SELECTED_ITEMS` with `locationIds`). The `filterInput` parameter accepts the same JSON-encoded filter object as Filter locations. ' operationId: downloadLocations tags: - Locations parameters: - name: filterInput in: query description: JSON-encoded filter object. Defaults to an empty filter (all locations). required: false example: '{"tags":["priority"]}' schema: type: string - name: selectionType in: query description: Whether to export all matching locations or an explicit selection. required: false example: ALL_ITEMS schema: type: string enum: - ALL_ITEMS - SELECTED_ITEMS - name: locationIds in: query description: Location IDs to export when selectionType is SELECTED_ITEMS. required: false example: '' schema: type: array items: type: string - name: emails in: query description: Email addresses to notify when the CSV is ready. required: false example: '' schema: type: array items: type: string - name: archived in: query description: Filter by archived state (true/false). required: false example: '' schema: type: boolean - name: approved in: query description: Filter by approved state (true/false). required: false example: '' schema: type: boolean - name: archivalScheduledAt in: query description: Return only locations scheduled for archival. required: false example: '' schema: type: boolean - name: Synup-Version in: header description: API version date (YYYY-MM-DD). required: true example: '2026-04-17' schema: type: string - name: Authorization in: header description: API key for authentication. required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: object properties: downloadLocations: $ref: '#/components/schemas/DownloadLocationsInBulkType' x-apidog-orders: - downloadLocations x-apidog-ignore-properties: [] x-apidog-orders: - data x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' '401': description: Unauthorized - Invalid or missing API key content: application/json: schema: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051637-run /locations/filter: get: summary: Filter locations deprecated: false description: '
Returns a paginated list of locations that match the supplied filters. The filter criteria are passed as a single JSON-encoded object in the `input` query parameter. Supported filter keys include name/store/phone search (`query`, `storeId`, `phone`), location identifiers (`ids`), package tier (`package`), `tags`, `folders`, `categories`, address filters (`postalCode`, `city`, `stateIso`), custom attributes (`customAttributes`), GBP categories (`primaryGbpSiteCategories`, `additionalGbpSiteCategories`), add-ons (`addOnIds`), Google verification status (`googleVerificationStatus`), and client account scoping (`clientIds`). Results are returned as a Relay-style connection (`edges` + `pageInfo`). Use the `first`/`after` (or `last`/`before`) parameters to page through results. ' operationId: filterLocations tags: - Locations parameters: - name: input in: query description: JSON-encoded filter object. See the description for supported keys. Defaults to an empty filter (all locations). required: false example: '{"tags":["priority"],"city":["Austin"]}' schema: type: string - name: first in: query description: Number of records to return from the start of the result set. required: false example: 50 schema: type: integer - name: after in: query description: Cursor to fetch records after. required: false example: '' schema: type: string - name: last in: query description: Number of records to return from the end of the result set. required: false example: 0 schema: type: integer - name: before in: query description: Cursor to fetch records before. required: false example: '' schema: type: string - name: archived in: query description: Filter by archived state (true/false). required: false example: '' schema: type: boolean - name: approved in: query description: Filter by approved state (true/false). required: false example: '' schema: type: boolean - name: hasErrors in: query description: Return only locations that currently have errors. required: false example: '' schema: type: boolean - name: archivalScheduledAt in: query description: Return only locations scheduled for archival. required: false example: '' schema: type: boolean - name: blacklistIds in: query description: Location IDs to exclude from the result set. required: false example: '' schema: type: array items: type: string - name: sortByNameAsc in: query description: Sort results by location name ascending. required: false example: '' schema: type: boolean - name: Synup-Version in: header description: API version date (YYYY-MM-DD). required: true example: '2026-04-17' schema: type: string - name: Authorization in: header description: API key for authentication. required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: object properties: filterLocations: $ref: '#/components/schemas/LocationSummaryConnectionType' x-apidog-orders: - filterLocations x-apidog-ignore-properties: [] x-apidog-orders: - data x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' '400': description: Bad request - Invalid filter or parameters content: application/json: schema: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' '401': description: Unauthorized - Invalid or missing API key content: application/json: schema: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051643-run /countries: get: summary: Get a list of supported countries and their states deprecated: false description: ' This API fetches a list of supported countries, including their database IDs, ISO codes, and states. The retrieved ISO codes should be used as input values when creating or updating locations. ' tags: - Locations parameters: - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successfully retrieved the list of countries and their states content: application/json: schema: type: object properties: data: type: object properties: supportedCountries: type: array description: List of supported countries items: type: object properties: databaseId: type: integer description: Unique identifier for the country in the database. examples: - 13 id: type: string description: Base64 encoded unique country identifier. examples: - Q291bnRyeToxMw== iso: type: string description: ISO 3166-1 alpha-2 country code. examples: - AU name: type: string description: Name of the country. examples: - Australia states: type: array description: List of states within the country (if available). items: type: object properties: countryId: type: integer description: Unique identifier of the country associated with the state. examples: - 13 id: type: string description: Unique identifier for the state. examples: - '136' iso: type: string description: State ISO code (if applicable). examples: - WA name: type: string description: Name of the state. examples: - Western Australia x-apidog-orders: - countryId - id - iso - name x-apidog-orders: - databaseId - id - iso - name - states x-apidog-orders: - supportedCountries x-apidog-orders: - data headers: {} x-apidog-name: OK '401': description: Unauthorized. API key is missing or invalid. content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Unauthorized '500': description: Internal server error. content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Server Error security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13600948-run /locations-by-store-codes: get: summary: Get locations by store codes deprecated: false description: '
This API retrieves location details based on specified store codes. Using unique store codes, allows businesses to fetch location-specific information such as name, address, contact details, business hours, and other relevant attributes. ' operationId: getLocationsByStoreCodes tags: - Locations parameters: - name: storeCodes in: query description: Array of store codes in JSON string format. required: true example: '["storeCode1", "storeCode2"]' schema: type: string - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: object properties: getLocationsByStoreCodes: type: array items: type: object properties: accountId: type: integer addOns: type: array items: type: string additionalCategoryIds: type: array items: type: string additionalCategoryNames: type: array items: type: string additionalInfo: type: 'null' additionalPhones: type: array items: type: string approved: type: string archivalScheduledAt: type: 'null' archived: type: boolean archivedAt: type: 'null' bizUrl: type: string bizUrlUtm: type: boolean bookingUrl: type: 'null' businessHours: type: array items: type: string cancellationScheduledAt: type: 'null' categoryId: type: integer city: type: string contentPreferredLanguage: type: string countryCode: type: string countryIso: type: string createErrors: type: array items: type: string createdDate: type: string customAttributes: type: array items: type: object properties: archived: type: boolean enumValues: type: array items: type: string name: type: string slug: type: string type: type: string value: type: array items: type: string required: - archived - enumValues - name - slug - type - value x-apidog-orders: - archived - enumValues - name - slug - type - value databaseId: type: integer description: type: string enabledSiteIds: type: array items: type: string facebookUrl: type: 'null' folderId: type: string folderName: type: string franchise: type: boolean googleAdsPhone: type: 'null' googleVerificationStatus: type: object properties: message: type: 'null' status: type: string required: - message - status x-apidog-orders: - message - status googleplusUrl: type: 'null' hideAddress: type: boolean id: type: string instagramUrl: type: 'null' isRestaurant: type: boolean lastUpdatedDate: type: string latitude: type: string linkedinUrl: type: 'null' locationPhotos: type: array items: type: object properties: databaseId: type: integer fileSize: type: integer id: type: string name: type: string starred: type: boolean thumbnailUrl: type: string type: type: string url: type: string required: - databaseId - fileSize - id - name - starred - thumbnailUrl - type - url x-apidog-orders: - databaseId - fileSize - id - name - starred - thumbnailUrl - type - url longitude: type: string managedServiceSiteBuckets: type: array items: type: string managedServiceSites: type: array items: type: string moreHours: type: array items: type: string name: type: string offeringsUrl: type: 'null' ownerEmail: type: 'null' ownerName: type: 'null' package: type: string paymentMethods: type: array items: type: string phone: type: 'null' pinterestUrl: type: 'null' planId: type: integer planName: type: string postalCode: type: string publisherAttributes: type: array items: type: string reservationUrl: type: 'null' serviceItems: type: array items: type: object properties: categoryId: type: string countryIso: type: 'null' currencyCode: type: 'null' description: type: 'null' id: type: string languageCode: type: 'null' name: type: string price: type: 'null' required: - categoryId - countryIso - currencyCode - description - id - languageCode - name - price x-apidog-orders: - categoryId - countryIso - currencyCode - description - id - languageCode - name - price stateIso: type: string stateName: type: string storeId: type: string street: type: 'null' street1: type: 'null' subCategoryId: type: integer subCategoryName: type: string tagline: type: 'null' tags: type: array items: type: string temporarilyClosed: type: boolean tiktokUrl: type: 'null' toplineMessage: type: 'null' toplineMessageText: type: 'null' twitterUrl: type: 'null' uid: type: string updatedAt: type: string videos: type: array items: type: string voiceStatus: type: integer yearOfIncorporation: type: 'null' youtubeUrl: type: 'null' x-apidog-orders: - accountId - addOns - additionalCategoryIds - additionalCategoryNames - additionalInfo - additionalPhones - approved - archivalScheduledAt - archived - archivedAt - bizUrl - bizUrlUtm - bookingUrl - businessHours - cancellationScheduledAt - categoryId - city - contentPreferredLanguage - countryCode - countryIso - createErrors - createdDate - customAttributes - databaseId - description - enabledSiteIds - facebookUrl - folderId - folderName - franchise - googleAdsPhone - googleVerificationStatus - googleplusUrl - hideAddress - id - instagramUrl - isRestaurant - lastUpdatedDate - latitude - linkedinUrl - locationPhotos - longitude - managedServiceSiteBuckets - managedServiceSites - moreHours - name - offeringsUrl - ownerEmail - ownerName - package - paymentMethods - phone - pinterestUrl - planId - planName - postalCode - publisherAttributes - reservationUrl - serviceItems - stateIso - stateName - storeId - street - street1 - subCategoryId - subCategoryName - tagline - tags - temporarilyClosed - tiktokUrl - toplineMessage - toplineMessageText - twitterUrl - uid - updatedAt - videos - voiceStatus - yearOfIncorporation - youtubeUrl required: - getLocationsByStoreCodes x-apidog-orders: - getLocationsByStoreCodes required: - data x-apidog-orders: - data example: data: getLocationsByStoreCodes: - accountId: 11073 name: Sample Store storeId: jio678 city: Chicago countryIso: US headers: {} x-apidog-name: OK '400': description: Bad request - Invalid store codes format content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Bad Request '401': description: Unauthorized - Invalid or missing API key content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Unauthorized '404': description: One or more store codes not found content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Record Not Found security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13651265-run /locations/{locationId}/photos: get: summary: Get Photos by Location IDs deprecated: false description: "
\n\n\nThis API allows returns all media files of a specific location. \n\nFor more details, refer to `Photo specifications for your business location` markdown.\n\n\n" tags: - Locations parameters: - name: locationId in: path description: Location ID should be provided in Base64 encoded format. Must be in the format Location: required: true example: TG9jYXRpb246MTIzNA== schema: type: string - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: '' content: application/json: schema: type: object properties: data: type: object properties: mediaFilesOfLocation: type: array items: type: object properties: id: type: string url: type: string uploadedBy: type: 'null' fileName: type: string fileSize: type: string fileType: type: string fileExtension: type: string archived: type: boolean accountId: type: integer thumbnailUrl: type: string starred: type: boolean category: type: object properties: name: type: string id: type: - integer - 'null' required: - name - id x-apidog-orders: - name - id mediaLabels: type: array items: type: string fileDimensions: type: object properties: height: type: integer width: type: integer required: - height - width x-apidog-orders: - height - width uploadedAt: type: string locationId: type: string publisherOverride: type: string required: - id - url - uploadedBy - fileName - fileSize - fileType - fileExtension - archived - accountId - thumbnailUrl - starred - category - mediaLabels - fileDimensions - uploadedAt - locationId - publisherOverride x-apidog-orders: - id - url - uploadedBy - fileName - fileSize - fileType - fileExtension - archived - accountId - thumbnailUrl - starred - category - mediaLabels - fileDimensions - uploadedAt - locationId - publisherOverride required: - mediaFilesOfLocation x-apidog-orders: - mediaFilesOfLocation required: - data x-apidog-orders: - data examples: '1': summary: Success value: data: mediaFilesOfLocation: - id: TWVkaWFGaWxlOjE1MjQxMTI2 url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/4bfe278e-20b6-452d-9452-78bcf1b42c23.jpg uploadedBy: null fileName: f806ffe20422997c10679184617176a0_7f6c96df7edcda94fa06671f91503400_615cc436-7ecd-4b88-a877-69cd732e09c7.jpg fileSize: '1896470' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/thumbnail_4bfe278e-20b6-452d-9452-78bcf1b42c23.jpg starred: false category: name: Logo id: 4 mediaLabels: [] fileDimensions: height: 2016 width: 1512 uploadedAt: '2025-08-13T07:23:08.513340' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MzE= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/2f01e5b9-3ef0-46c0-915f-5ffbd86ffda0.png uploadedBy: null fileName: a19b5ecb-a02d-4bb6-9d98-8b8d93692051 fileSize: '2452380' fileType: image fileExtension: .png archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_2f01e5b9-3ef0-46c0-915f-5ffbd86ffda0.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 1069 width: 1901 uploadedAt: '2023-12-06T11:49:10.330065' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MzA= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/c4da92af-8a3e-4efc-ac93-308125e263c2.jpg uploadedBy: null fileName: ce07c65e-bccf-44c4-a316-bdf684ebc200 fileSize: '226346' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_c4da92af-8a3e-4efc-ac93-308125e263c2.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 720 width: 1280 uploadedAt: '2023-12-06T11:49:09.259954' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3Mjk= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/4f261548-7af1-4587-854f-88be3bba1daf.png uploadedBy: null fileName: 2f417f09-35b7-439c-ab2d-a1e5336bc6b6 fileSize: '1459771' fileType: image fileExtension: .png archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_4f261548-7af1-4587-854f-88be3bba1daf.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 802 width: 1338 uploadedAt: '2023-12-06T11:49:08.723470' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3Mjg= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/e9020dee-71f9-473e-8cae-00346ade05c9.jpg uploadedBy: null fileName: c591d809-31c8-4988-b8c2-512f8b256488 fileSize: '59008' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_e9020dee-71f9-473e-8cae-00346ade05c9.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 683 width: 455 uploadedAt: '2023-12-06T11:49:07.836766' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3Mjc= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/5e37f2c2-8c3e-4953-aadd-6e7d7cef31b5.jpg uploadedBy: null fileName: 0fbc2cd3-61cf-4bc0-8aca-219505fb02d6 fileSize: '276873' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_5e37f2c2-8c3e-4953-aadd-6e7d7cef31b5.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 2160 width: 2160 uploadedAt: '2023-12-06T11:49:07.366851' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MjY= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/910e353a-985a-4895-b8a4-6b847f7b30a7.jpg uploadedBy: null fileName: 11d1c85f-5985-42e3-9fc7-976d71cc3708 fileSize: '366584' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_910e353a-985a-4895-b8a4-6b847f7b30a7.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 2160 width: 2160 uploadedAt: '2023-12-06T11:49:06.792830' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MjU= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/d965c352-5b20-4e3a-bfe0-8f10459e5094.jpg uploadedBy: null fileName: bd96d2fd-6a55-4977-a23f-5362ad8da319 fileSize: '1310166' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_d965c352-5b20-4e3a-bfe0-8f10459e5094.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 3144 width: 4192 uploadedAt: '2023-12-06T11:49:06.061264' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MjQ= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/1bf2e45e-3703-43dd-b99e-f0f88005415c.jpg uploadedBy: null fileName: 9171f53a-0df3-4fa0-a3da-633571b30e8e fileSize: '1494683' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_1bf2e45e-3703-43dd-b99e-f0f88005415c.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 3144 width: 4192 uploadedAt: '2023-12-06T11:49:05.353684' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MjM= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/b248c6e6-004f-4dc9-9355-c3e32a01e706.jpg uploadedBy: null fileName: 624d6f54-8dfe-46aa-bbe9-ebe8db84eedb fileSize: '318968' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_b248c6e6-004f-4dc9-9355-c3e32a01e706.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 3144 width: 4192 uploadedAt: '2023-12-06T11:49:04.623145' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MjI= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/2e7e3cf0-79d9-4403-8f96-89c4e26513c5.jpg uploadedBy: null fileName: a8abe39b-19a2-4b02-b53c-78676d9074b2 fileSize: '993481' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_2e7e3cf0-79d9-4403-8f96-89c4e26513c5.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 3144 width: 3643 uploadedAt: '2023-12-06T11:49:03.893841' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MjE= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/53920a3a-20a4-4bcd-ae1a-43570f9b1d0b.jpg uploadedBy: null fileName: cc842fca-de80-4ff3-97d7-4ba11c1f1061 fileSize: '484178' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_53920a3a-20a4-4bcd-ae1a-43570f9b1d0b.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 1920 width: 1080 uploadedAt: '2023-12-06T11:49:03.029109' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MjA= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/f48e6ef9-dfcc-4b0b-8d2f-f2fdef8993be.jpg uploadedBy: null fileName: e3ee068d-867a-4866-b304-d7ad8ffbbf83 fileSize: '1879575' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_f48e6ef9-dfcc-4b0b-8d2f-f2fdef8993be.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 4032 width: 3024 uploadedAt: '2023-12-06T11:49:02.426044' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MTk= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/9e8ba38c-220c-432c-bae2-4f7205b3468c.jpg uploadedBy: null fileName: fff7df60-cdb1-40f2-ad15-2e94089d3b78 fileSize: '1575003' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_9e8ba38c-220c-432c-bae2-4f7205b3468c.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 3024 width: 4032 uploadedAt: '2023-12-06T11:49:01.552470' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MTg= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/5cd440ed-feef-42f3-a4d9-a748b247d9c1.jpg uploadedBy: null fileName: 9d9f26f5-4f28-4ed6-8d5c-458c0288a5b0 fileSize: '1657470' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_5cd440ed-feef-42f3-a4d9-a748b247d9c1.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 4032 width: 3024 uploadedAt: '2023-12-06T11:49:00.724307' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MTc= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/71082d63-7561-4763-b314-a5231983a2ff.jpg uploadedBy: null fileName: c7fe3d56-39a4-4b77-8fe5-1984a31c0e53 fileSize: '378419' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_71082d63-7561-4763-b314-a5231983a2ff.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 1080 width: 1080 uploadedAt: '2023-12-06T11:48:59.946546' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MTY= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/cd4b8199-67b1-42ba-8c08-55780c3e4001.jpg uploadedBy: null fileName: 5082cc86-758f-4e56-8225-47e12b57e813 fileSize: '282591' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_cd4b8199-67b1-42ba-8c08-55780c3e4001.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 1080 width: 1080 uploadedAt: '2023-12-06T11:48:59.461815' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MTU= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/f046f63c-ecd9-473a-abda-d47cf074a7d0.jpg uploadedBy: null fileName: a452303e-12bc-4ea2-8395-a99424036cbe fileSize: '335318' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_f046f63c-ecd9-473a-abda-d47cf074a7d0.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 1080 width: 1080 uploadedAt: '2023-12-06T11:48:58.852016' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MTQ= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/aaf681f3-890d-4407-bf5a-1c1919f115b2.jpg uploadedBy: null fileName: 79983baa-f9a3-4626-8a37-6fd73b892e2b fileSize: '440938' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_aaf681f3-890d-4407-bf5a-1c1919f115b2.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 1080 width: 1080 uploadedAt: '2023-12-06T11:48:58.283919' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MTM= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/98c5e768-8da8-4964-ac7a-96eb55cf50d7.jpg uploadedBy: null fileName: 5aa03377-dfb0-434d-94b6-29b6933a9e4e fileSize: '563862' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_98c5e768-8da8-4964-ac7a-96eb55cf50d7.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 1080 width: 1080 uploadedAt: '2023-12-06T11:48:57.680234' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MTI= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/ef51ecf2-c010-43b8-9447-08a1d8aedc51.jpg uploadedBy: null fileName: f4bba2af-3cb9-40fe-b601-84ff702ea987 fileSize: '573764' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_ef51ecf2-c010-43b8-9447-08a1d8aedc51.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 1080 width: 1080 uploadedAt: '2023-12-06T11:48:57.133572' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MTE= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/b1072b33-4d84-47e8-8888-7b7bebae9bb0.jpg uploadedBy: null fileName: af802979-df73-49cb-b2e9-ba270457f0d7 fileSize: '582601' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_b1072b33-4d84-47e8-8888-7b7bebae9bb0.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 1080 width: 1080 uploadedAt: '2023-12-06T11:48:56.544375' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MTA= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/266cbdc0-3fac-4b56-891f-e6b12e21dac1.jpg uploadedBy: null fileName: 6cd94c35-2e1c-488d-b315-bffa5b774a0b fileSize: '497151' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_266cbdc0-3fac-4b56-891f-e6b12e21dac1.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 1080 width: 1080 uploadedAt: '2023-12-06T11:48:55.922416' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MDk= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/f1546b09-4a4a-4ed9-96cb-86ea4cbf0908.jpg uploadedBy: null fileName: f009bd88-b6c1-4532-b4ea-b792feed4878 fileSize: '829582' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_f1546b09-4a4a-4ed9-96cb-86ea4cbf0908.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 1599 width: 1599 uploadedAt: '2023-12-06T11:48:55.238518' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MDg= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/b58b4b93-aea1-4510-a269-f4e257128597.jpg uploadedBy: null fileName: dc0f7924-d902-40a7-8794-9f17318dd8c9 fileSize: '618821' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_b58b4b93-aea1-4510-a269-f4e257128597.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 1440 width: 1440 uploadedAt: '2023-12-06T11:48:54.356440' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MDc= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/f67453e5-9565-4cb0-bb45-0b9ca2c8aed2.jpg uploadedBy: null fileName: d872a936-9f0e-4f64-84bc-0acc3e987a83 fileSize: '1544154' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_f67453e5-9565-4cb0-bb45-0b9ca2c8aed2.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 3144 width: 3401 uploadedAt: '2023-12-06T11:48:53.608816' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MDY= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/02d3f12b-5718-4f20-aebf-4ace1c701881.jpg uploadedBy: null fileName: b014d63e-cf9a-4b53-917a-395a974c3800 fileSize: '1405208' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_02d3f12b-5718-4f20-aebf-4ace1c701881.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 3144 width: 4192 uploadedAt: '2023-12-06T11:48:52.815885' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MDU= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/b3a04d3d-c631-407d-b70a-cb7975ae879e.jpg uploadedBy: null fileName: 0561c93b-a50c-42da-a408-126b86bf4ed6 fileSize: '1394506' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_b3a04d3d-c631-407d-b70a-cb7975ae879e.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 3144 width: 4192 uploadedAt: '2023-12-06T11:48:51.992469' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MDQ= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/54b1f926-4f6c-4404-b72b-baafa533fe21.jpg uploadedBy: null fileName: 34a2a3ab-4d1d-4850-855b-ca89d39ff0bb fileSize: '1574232' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_54b1f926-4f6c-4404-b72b-baafa533fe21.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 4192 width: 3144 uploadedAt: '2023-12-06T11:48:51.272334' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MDM= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/d23144d8-0d3f-4f97-909a-3a91b16cab0c.jpg uploadedBy: null fileName: b911981b-6a94-4979-8abe-c89a53226a59 fileSize: '469757' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_d23144d8-0d3f-4f97-909a-3a91b16cab0c.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 720 width: 960 uploadedAt: '2023-12-06T11:48:50.474788' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MDI= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/c4d61240-ae6c-418c-9d7b-a2c8fdee85ba.jpg uploadedBy: null fileName: fa760e19-3408-47b9-ad5c-8aef2a97e11e fileSize: '365922' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_c4d61240-ae6c-418c-9d7b-a2c8fdee85ba.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 720 width: 960 uploadedAt: '2023-12-06T11:48:49.876063' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MDE= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/bf4a69e6-1a00-4385-9240-edf74ff1f2ea.jpg uploadedBy: null fileName: 2fb10d5c-147d-4ac5-869d-fdd496281bd7 fileSize: '1082353' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_bf4a69e6-1a00-4385-9240-edf74ff1f2ea.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 2904 width: 2904 uploadedAt: '2023-12-06T11:48:49.333250' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA3MDA= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/c21a79f2-f48f-4f95-9049-993fd4a7b3fe.jpg uploadedBy: null fileName: 7604609c-65bf-49a6-bbfa-3ba919eb60ea fileSize: '1256619' fileType: image fileExtension: .jpg archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_c21a79f2-f48f-4f95-9049-993fd4a7b3fe.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 1280 width: 1280 uploadedAt: '2023-12-06T11:48:48.596824' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA2OTk= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/7d8c51a8-7c38-41aa-9602-6aef19fa8397.png uploadedBy: null fileName: 7e8589ef-74f0-4201-aa80-2582ebeb7b1b fileSize: '36149' fileType: image fileExtension: .png archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_7d8c51a8-7c38-41aa-9602-6aef19fa8397.jpg starred: false category: name: Uncategorised id: null mediaLabels: [] fileDimensions: height: 878 width: 1532 uploadedAt: '2023-12-06T11:48:47.962359' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' - id: TWVkaWFGaWxlOjQwNTA2OTg= url: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/608bdbe4-0b2a-4a63-98b9-c53b081ba71b.png uploadedBy: null fileName: b9a58c9f-6035-45e0-a7f7-e8a30c924678 fileSize: '65296' fileType: image fileExtension: .png archived: false accountId: 16154 thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/thumbnail_608bdbe4-0b2a-4a63-98b9-c53b081ba71b.jpg starred: false category: name: Cover id: 2 mediaLabels: [] fileDimensions: height: 374 width: 1110 uploadedAt: '2023-12-06T11:48:47.274561' locationId: TG9jYXRpb246NzAzNTY1 publisherOverride: '' '2': summary: When no media Files value: data: mediaFilesOfLocation: [] headers: {} x-apidog-name: Example Response '400': description: '' content: application/json: schema: type: object properties: message: type: string examples: - Variable "$input" got invalid value {"locationId":"TG9jYXRpb246MTA4NzIxMQ==","photos":[{"photo":"https://pngimg.com/uploads/minus/minus_PNG40.png","type":"NON EXISTENT"}]}; Expected type LocationMediaType at value.photos[0].type. required: - message x-apidog-orders: - message headers: {} x-apidog-name: Invalid input x-200:Example Response (Over 30 Photos): description: '' content: application/json: schema: type: object properties: data: type: object properties: addLocationPhotos: type: object properties: success: type: boolean errors: type: 'null' photos: type: array items: type: string request: type: object properties: requestId: type: string status: type: string required: - requestId - status x-apidog-orders: - requestId - status clientMutationId: type: 'null' required: - success - errors - photos - request - clientMutationId x-apidog-orders: - success - errors - photos - request - clientMutationId required: - addLocationPhotos x-apidog-orders: - addLocationPhotos required: - data x-apidog-orders: - data example: data: addLocationPhotos: success: true errors: null photos: [] request: requestId: e6c2d9d9-9a18-4015-88cf-9a4e19a6f49a status: PROCCESSING clientMutationId: null headers: {} x-apidog-name: Example Response (Over 30 Photos) security: [] x-apidog-folder: Locations x-apidog-status: developing x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-23089104-run /plan-sites: get: summary: Get Site Details for Your Plan deprecated: false description: "\nThis API retrieves all site details associated with a specific plan, including:\n\n- Unique identifiers for each site\n- Supported countries where the plan is available\n- Site URLs for access and management \n" tags: - Locations parameters: - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successfully retrieved site details for the plan content: application/json: schema: type: object properties: data: type: object properties: planSites: type: array items: type: object properties: hideAddressSupportedCountries: type: array items: type: string description: Countries where Service Area Business (SAB) is supported id: type: integer description: Unique identifier for the site name: type: string description: Name of the site supportedCountries: type: array items: type: string description: ISO codes of countries where the site is supported url: type: string description: URL of the site required: - hideAddressSupportedCountries - id - name - supportedCountries - url x-apidog-orders: - id - name - url - supportedCountries - hideAddressSupportedCountries description: List of sites associated with the plan required: - planSites x-apidog-orders: - planSites required: - data x-apidog-orders: - data example: data: planSites: - hideAddressSupportedCountries: [] id: 224 name: Thumbtack supportedCountries: - US url: thumbtack.com - hideAddressSupportedCountries: - FR - DE - NL - IE - US - CA - AU - NZ - ES - GB id: 2 name: Yelp supportedCountries: - FR - DE - NL - IE - US - CA - AU - NZ - ES - BE - GB - IT - CH - SE - PL - AT url: yelp.com headers: {} x-apidog-name: OK '401': description: Unauthorized. API key is missing or invalid. content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Unauthorized '500': description: Internal server error. content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Server Error security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13602957-run /sub-categories: get: summary: Get SubCategories and AdditionalCategories deprecated: false description: ' This API retrieves a list of the latest subcategories and additional categories available in the system. ' tags: - Locations parameters: - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successfully retrieved categories. content: application/json: schema: type: object properties: data: type: object properties: subcategories: type: array items: type: object properties: databaseId: type: integer description: Subcategory ID. id: type: string description: Base64 encoded value of subcategory ID. name: type: string description: Name of the subcategory. primary: type: boolean description: If true, it is a subcategory that can be used as a primary category. If false, it is an additional category and cannot be used as a primary category. x-apidog-orders: - databaseId - id - name - primary required: - databaseId - id - name - primary required: - subcategories x-apidog-orders: - subcategories required: - data x-apidog-orders: - data examples: '1': summary: Success value: data: subcategories: - databaseId: 639 id: U3ViQ2F0ZWdvcnk6NjM5 name: 3D Printing primary: true '2': summary: Exception value: data: null errors: - message: SY90005:Invalid Token headers: {} x-apidog-name: OK '401': description: Unauthorized. Invalid or missing API key. content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Unauthorized '500': description: Internal Server Error. content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Server Error security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13636558-run /locations/google-verification-stats: get: summary: Google verification location stats deprecated: false description: '
Returns aggregated Google (Google Business Profile) verification status counts across the filtered set of locations — for example how many are verified, under review, pending verification, suspended, duplicate, or not connected. Use `filterInput`/`selectionType`/`locationIds` to scope the set, identical to Filter locations. ' operationId: googleVerificationLocationStats tags: - Locations parameters: - name: filterInput in: query description: JSON-encoded filter object. Defaults to an empty filter (all locations). required: false example: '{}' schema: type: string - name: selectionType in: query description: Whether to include all matching locations or an explicit selection. required: false example: ALL_ITEMS schema: type: string enum: - ALL_ITEMS - SELECTED_ITEMS - name: locationIds in: query description: Location IDs to include when selectionType is SELECTED_ITEMS. required: false example: '' schema: type: array items: type: string - name: Synup-Version in: header description: API version date (YYYY-MM-DD). required: true example: '2026-04-17' schema: type: string - name: Authorization in: header description: API key for authentication. required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: object properties: googleVerificationLocationStats: $ref: '#/components/schemas/GoogleVerificationLocationStats' x-apidog-orders: - googleVerificationLocationStats x-apidog-ignore-properties: [] x-apidog-orders: - data x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' '401': description: Unauthorized - Invalid or missing API key content: application/json: schema: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051645-run /subscriptions: get: summary: List Active Subscriptions deprecated: false description: ' This API retrieves a list of all active subscriptions or tenures associated with your account ' tags: - Locations parameters: - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/SubscriptionsResponse' example: data: activeSubscriptions: - name: Premium plan - Monthly paymentSubscriptionId: b8b5075f-35ff-4aaf-9580-44271e0dde34 planId: premium-1month tenure: Monthly - name: Standard plan - Yearly paymentSubscriptionId: c8b5078h-36ff-4aaf-1380-33281a0eeg34 planId: standard-year tenure: Yearly headers: {} x-apidog-name: OK security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13639877-run /locations-by-ids: get: summary: List particular locations deprecated: false description: "
\n\nThis API retrieves **detailed information** for one or more **specified location IDs**. \n\nIt provides comprehensive data about each location, including its name, address, contact details, business hours, categories, nedia and other relevant attributes. \nIt support for both active and archived locations.\n" operationId: getLocationsByIds tags: - Locations parameters: - name: ids in: query description: 'Array of location IDs in JSON string format. ' required: true example: - '["TG9jYXRpb246MQ==", "TG9jYXRpb246Mg=="]' schema: type: array items: type: string uniqueItems: true - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: '' content: application/json: schema: type: object properties: data: type: object properties: getLocationsByIds: type: array items: type: object properties: accountId: type: integer addOns: type: array items: type: object properties: id: type: string name: type: string x-apidog-orders: - id - name additionalCategoryIds: type: array items: type: integer additionalCategoryNames: type: array items: type: string additionalInfo: type: 'null' additionalPhones: type: array items: type: string approved: type: string archivalScheduledAt: type: 'null' archived: type: boolean archivedAt: type: 'null' bizUrl: type: string bizUrlUtm: type: boolean bookingUrl: type: 'null' businessHours: type: array items: type: object properties: day: type: string slots: type: - array - 'null' items: type: object properties: end: type: string start: type: string required: - end - start x-apidog-orders: - end - start specialDate: type: 'null' type: type: string required: - day - slots - specialDate - type x-apidog-orders: - day - slots - specialDate - type cancellationScheduledAt: type: 'null' categoryId: type: integer city: type: string contentPreferredLanguage: type: string countryCode: type: string countryIso: type: string createErrors: type: array items: type: string createdDate: type: string customAttributes: type: array items: type: object properties: archived: type: boolean enumValues: type: array items: type: string name: type: string slug: type: string type: type: string value: type: array items: type: string required: - archived - enumValues - name - slug - type - value x-apidog-orders: - archived - enumValues - name - slug - type - value databaseId: type: integer description: type: string enabledSiteIds: type: array items: type: string facebookUrl: type: string folderId: type: string folderName: type: string franchise: type: 'null' googleAdsPhone: type: string googleVerificationStatus: type: object properties: message: type: 'null' status: type: 'null' required: - message - status x-apidog-orders: - message - status googleplusUrl: type: 'null' hideAddress: type: boolean id: type: string instagramUrl: type: string isRestaurant: type: boolean lastUpdatedDate: type: string latitude: type: string linkedinUrl: type: string locationPhotos: type: array items: type: string longitude: type: string managedServiceSiteBuckets: type: array items: type: string managedServiceSites: type: array items: type: string moreHours: type: array items: type: string name: type: string offeringsUrl: type: 'null' ownerEmail: type: string ownerName: type: string package: type: string paymentMethods: type: array items: type: string phone: type: string pinterestUrl: type: string planId: type: integer planName: type: 'null' postalCode: type: string publisherAttributes: type: array items: type: string reservationUrl: type: 'null' serviceItems: type: array items: type: string stateIso: type: string stateName: type: string storeId: type: string street: type: string street1: type: 'null' subCategoryId: type: integer subCategoryName: type: string tagline: type: string tags: type: array items: type: string temporarilyClosed: type: boolean tiktokUrl: type: 'null' toplineMessage: type: 'null' toplineMessageText: type: 'null' twitterUrl: type: string uid: type: string updatedAt: type: string videos: type: array items: type: string voiceStatus: type: integer yearOfIncorporation: type: integer youtubeUrl: type: 'null' placeActionLinks: type: array items: type: object properties: placeActionType: type: string uri: type: string isPreferred: type: boolean name: type: string submissionStatus: type: string submissionMessage: type: string lastSubmittedAt: type: string x-apidog-orders: - placeActionType - uri - isPreferred - name - submissionStatus - submissionMessage - lastSubmittedAt required: - placeActionType - uri discoveredPlaceActionLinks: type: array items: type: object properties: placeActionType: type: string uri: type: string isPreferred: type: string name: type: string providerType: type: string isEditable: type: string x-apidog-orders: - placeActionType - uri - isPreferred - name - providerType - isEditable required: - placeActionType - uri - name - isEditable - providerType - isPreferred x-apidog-orders: - accountId - addOns - additionalCategoryIds - additionalCategoryNames - additionalInfo - additionalPhones - approved - archivalScheduledAt - archived - archivedAt - bizUrl - bizUrlUtm - bookingUrl - businessHours - cancellationScheduledAt - categoryId - city - contentPreferredLanguage - countryCode - countryIso - createErrors - createdDate - customAttributes - databaseId - description - enabledSiteIds - facebookUrl - folderId - folderName - franchise - googleAdsPhone - googleVerificationStatus - googleplusUrl - hideAddress - id - instagramUrl - isRestaurant - lastUpdatedDate - latitude - linkedinUrl - locationPhotos - longitude - managedServiceSiteBuckets - managedServiceSites - moreHours - name - offeringsUrl - ownerEmail - ownerName - package - paymentMethods - phone - pinterestUrl - planId - planName - postalCode - publisherAttributes - reservationUrl - serviceItems - stateIso - stateName - storeId - street - street1 - subCategoryId - subCategoryName - tagline - tags - temporarilyClosed - tiktokUrl - toplineMessage - toplineMessageText - twitterUrl - uid - updatedAt - videos - voiceStatus - yearOfIncorporation - youtubeUrl - placeActionLinks - discoveredPlaceActionLinks required: - getLocationsByIds x-apidog-orders: - getLocationsByIds required: - data x-apidog-orders: - data example: data: getLocationsByIds: - accountId: 11073 addOns: - id: '1' name: Yelp Lite additionalCategoryIds: - 609 additionalCategoryNames: - Framing additionalInfo: null additionalPhones: - '6036610058' approved: APPROVED archivalScheduledAt: null archived: false archivedAt: null bizUrl: www.easports222.com bizUrlUtm: false bookingUrl: null businessHours: - day: SUNDAY slots: null specialDate: null type: CLOSED - day: MONDAY slots: - end: 05:00pm start: 09:00am specialDate: null type: OPEN - day: TUESDAY slots: - end: 01:00pm start: 09:00am - end: 05:00pm start: 02:00pm specialDate: null type: OPEN - day: WEDNESDAY slots: null specialDate: null type: OPEN_24x7 - day: THURSDAY slots: null specialDate: null type: OPEN_24x7 - day: FRIDAY slots: null specialDate: null type: CLOSED - day: SATURDAY slots: null specialDate: null type: CLOSED cancellationScheduledAt: null categoryId: 1 city: New York contentPreferredLanguage: ENGLISH countryCode: '1' countryIso: US createErrors: [] createdDate: December 15, 2025 customAttributes: - archived: false enumValues: [] name: Atributo slug: atributo type: STRING value: [] - archived: false enumValues: [] name: offers_online_appointments slug: offers_online_appointments type: BOOLEAN value: - 'false' - archived: false enumValues: [] name: welcomes_lgbtq slug: welcomes_lgbtq type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: has wheelchair slug: has_wheelchair type: BOOLEAN value: [] - archived: false enumValues: [] name: utm slug: utm type: STRING value: [] - archived: false enumValues: [] name: Slug slug: slug type: STRING value: [] - archived: false enumValues: [] name: Name slug: name type: STRING value: [] - archived: false enumValues: [] name: accept digital rupee slug: accept_digital_rupee type: INTEGER value: [] - archived: false enumValues: [] name: has_onsite_parking slug: has_onsite_parking type: BOOLEAN value: [] - archived: false enumValues: [] name: Test 23 slug: test_23 type: STRING value: [] - archived: false enumValues: [] name: lead_photo_drive slug: lead_photo_drive type: STRING value: [] - archived: false enumValues: [] name: Test French Locale 4 slug: test_french_locale_4 type: STRING value: [] databaseId: 88350 description: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor. This is a sample description which is used to complete the 200 characters. Let us believe this has exceeded the character limit otherwise it is going to be a headache to go and change it again. But still to be on the careful side, I am adding a few more line of characters because of which this is going to work. enabledSiteIds: [] facebookUrl: https://www.facebook.com/journeywithanthony/ folderId: 57e34303-e9fd-422d-ad39-383849df7ea9 folderName: hello12341 franchise: null googleAdsPhone: '8289989989' googleVerificationStatus: message: null status: null googleplusUrl: null hideAddress: false id: TG9jYXRpb246ODgzNTA= instagramUrl: https://www.instagram.com/rajinikanth/ isRestaurant: false lastUpdatedDate: December 15, 2025 latitude: '40.712775' linkedinUrl: https://www.linkedin.com/company/synup/ locationPhotos: [] longitude: '-74.005973' managedServiceSiteBuckets: [] managedServiceSites: [] moreHours: [] name: Spinka Group offeringsUrl: null ownerEmail: pttqa1+212@gmail.com ownerName: John Doe package: PREMIUM paymentMethods: - VISA - MASTERCARD - AMEX - CASH - CHEQUE - CRYPTO - DINERS_CLUB - DISCOVER - FINANCING - INVOICE - TRAVELERS_CHECK - APPLE_PAY - SAMSUNG_PAY - PAYPAL - ANDROID_PAY phone: '6036610058' pinterestUrl: https://pinterest.com/cozylivin77/ planId: 59 planName: null postalCode: '60605' publisherAttributes: [] reservationUrl: null serviceItems: [] stateIso: NY stateName: New York storeId: 995si street: 123 Jump Street street1: null subCategoryId: 20 subCategoryName: Pilates tagline: We Exist tags: - all - pk temporarilyClosed: false tiktokUrl: null toplineMessage: null toplineMessageText: null twitterUrl: https://twitter.com/elonmusk uid: 0afc0561-04e0-4e72-b679-318310c1a8f1 updatedAt: '2025-12-15T10:06:47.776Z' videos: - https://www.youtube.com/watch?v=QKmrDUJFRkM voiceStatus: 1 yearOfIncorporation: 1179 youtubeUrl: null placeActionLinks: - placeActionType: FOOD_ORDERING uri: https://order.example.com isPreferred: true name: locations/1944.../placeActionLinks/54ada85bc246058a submissionStatus: success submissionMessage: Already up to date on Google. lastSubmittedAt: '2026-07-08T12:14:36Z' discoveredPlaceActionLinks: - placeActionType: APPOINTMENT uri: https://book.example.com isPreferred: false name: locations/1944.../placeActionLinks/abc123 providerType: MERCHANT isEditable: true headers: {} x-apidog-name: Success response '400': description: Bad request - Invalid location IDs format content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Bad Request '401': description: Unauthorized - Invalid or missing API key content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Unauthorized '404': description: One or more location IDs not found content: application/json: schema: type: object properties: {} x-apidog-orders: [] headers: {} x-apidog-name: Record Not Found security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13646679-run /locations/add-on-count: get: summary: Location add-on count deprecated: false description: '
Returns how many locations in the filtered set have the specified add-on enabled vs disabled, along with counts for other add-ons in the same product umbrella. Scope the set with `filterInput`/`selectionType`/`locationIds`, identical to Filter locations. ' operationId: locationAddOnCount tags: - Locations parameters: - name: addOnId in: query description: ID of the add-on to count enablement for. required: true example: QWRkT246MTIz schema: type: string - name: filterInput in: query description: JSON-encoded filter object. Defaults to an empty filter (all locations). required: false example: '{}' schema: type: string - name: selectionType in: query description: Whether to include all matching locations or an explicit selection. required: false example: ALL_ITEMS schema: type: string enum: - ALL_ITEMS - SELECTED_ITEMS - name: locationIds in: query description: Location IDs to include when selectionType is SELECTED_ITEMS. required: false example: '' schema: type: array items: type: string - name: Synup-Version in: header description: API version date (YYYY-MM-DD). required: true example: '2026-04-17' schema: type: string - name: Authorization in: header description: API key for authentication. required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: object properties: locationAddOnCount: $ref: '#/components/schemas/LocationAddOnCount' x-apidog-orders: - locationAddOnCount x-apidog-ignore-properties: [] x-apidog-orders: - data x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' '401': description: Unauthorized - Invalid or missing API key content: application/json: schema: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051647-run /locations/{locationId}/indexing-rate: get: summary: Location Indexing Rate deprecated: false description: '' tags: - Locations parameters: - name: locationId in: path description: '' required: true example: TG9jYXRpb246MTE1NTQxMw== schema: type: string - name: fromDate in: query description: '' required: true example: '2019-05-20' schema: type: string - name: toDate in: query description: '' required: true example: '2025-10-20' schema: type: string - name: Authorization in: header description: '' required: true example: API qgl5Ri2YH7x7LA0cufuH8vGd6E0 schema: type: string responses: '200': description: '' content: application/json: schema: type: object properties: {} headers: {} x-apidog-name: Success security: [] x-apidog-folder: Locations x-apidog-status: developing x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-21817244-run /locations/package-count: get: summary: Location package count deprecated: false description: '
Returns the number of locations in the filtered set by package tier — freemium vs premium. Scope the set with `filterInput`/`selectionType`/`locationIds`, identical to Filter locations. ' operationId: locationPackageCount tags: - Locations parameters: - name: filterInput in: query description: JSON-encoded filter object. Defaults to an empty filter (all locations). required: false example: '{}' schema: type: string - name: selectionType in: query description: Whether to include all matching locations or an explicit selection. required: false example: ALL_ITEMS schema: type: string enum: - ALL_ITEMS - SELECTED_ITEMS - name: locationIds in: query description: Location IDs to include when selectionType is SELECTED_ITEMS. required: false example: '' schema: type: array items: type: string - name: archived in: query description: Filter by archived state (true/false). required: false example: '' schema: type: boolean - name: approved in: query description: Filter by approved state (true/false). required: false example: '' schema: type: boolean - name: archivalScheduledAt in: query description: Return only locations scheduled for archival. required: false example: '' schema: type: boolean - name: Synup-Version in: header description: API version date (YYYY-MM-DD). required: true example: '2026-04-17' schema: type: string - name: Authorization in: header description: API key for authentication. required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: object properties: locationPackageCount: $ref: '#/components/schemas/LocationPackageCount' x-apidog-orders: - locationPackageCount x-apidog-ignore-properties: [] x-apidog-orders: - data x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' '401': description: Unauthorized - Invalid or missing API key content: application/json: schema: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] headers: {} x-apidog-name: '' security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-40051649-run /locations/search: get: summary: Search locations deprecated: false description: '
This API returns a list of locations that match a given keyword. The search can be performed on the following fields: - Location Name - Street Address - Store ID If no specific fields are provided, the API will search across all available fields by default. ' operationId: searchLocations tags: - Locations parameters: - name: query in: query description: Search keyword required: true example: test schema: type: string - name: fields in: query description: 'Specific fields to search against. If not provided, searches across all fields. ' required: false example: - store_id schema: type: array items: type: string - name: first in: query description: Number of records to fetch from the most recent ones (i.e., from the end). Defaults to 50 if not provided. required: false example: 50 schema: type: integer - name: last in: query description: Number of records to fetch from the earliest ones (i.e., from the beginning). required: false example: 50 schema: type: integer - name: after in: query description: Cursor to fetch records after required: false schema: type: string - name: before in: query description: Cursor to fetch records before required: false schema: type: string - name: archived in: query description: 'Filter locations archived true/false ' required: false example: 'false' schema: type: string - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: object properties: searchLocations: type: object properties: edges: type: array items: type: object properties: cursor: type: string node: type: object properties: accountId: type: integer addOns: type: array items: type: string additionalCategoryIds: type: array items: type: integer additionalCategoryNames: type: array items: type: string additionalInfo: type: 'null' additionalPhones: type: array items: type: string approved: type: string archivalScheduledAt: type: 'null' archived: type: boolean archivedAt: type: 'null' bizUrl: type: 'null' bizUrlUtm: type: boolean bookingUrl: type: 'null' businessHours: type: array items: type: object properties: day: type: string slots: type: array items: type: object properties: end: type: string start: type: string required: - end - start x-apidog-orders: - end - start specialDate: type: 'null' type: type: string required: - day - slots - specialDate - type x-apidog-orders: - day - slots - specialDate - type cancellationScheduledAt: type: 'null' categoryId: type: integer city: type: string contentPreferredLanguage: type: string countryCode: type: string countryIso: type: string createErrors: type: array items: type: string createdDate: type: string customAttributes: type: array items: type: object properties: archived: type: boolean enumValues: type: array items: type: string name: type: string slug: type: string type: type: string value: type: array items: type: string required: - archived - enumValues - name - slug - type - value x-apidog-orders: - archived - enumValues - name - slug - type - value databaseId: type: integer description: type: string enabledSiteIds: type: array items: type: string facebookUrl: type: - string - 'null' folderId: type: string folderName: type: string franchise: type: boolean googleAdsPhone: type: - string - 'null' googleVerificationStatus: type: object properties: message: type: 'null' status: type: string required: - message - status x-apidog-orders: - message - status googleplusUrl: type: 'null' hideAddress: type: boolean id: type: string instagramUrl: type: 'null' isRestaurant: type: boolean lastUpdatedDate: type: string latitude: type: string linkedinUrl: type: - string - 'null' locationPhotos: type: array items: type: object properties: databaseId: type: integer fileSize: type: integer id: type: string name: type: string starred: type: boolean thumbnailUrl: type: string type: type: string url: type: string required: - databaseId - fileSize - id - name - starred - thumbnailUrl - type - url x-apidog-orders: - databaseId - fileSize - id - name - starred - thumbnailUrl - type - url longitude: type: string managedServiceSiteBuckets: type: array items: type: string managedServiceSites: type: array items: type: string moreHours: type: array items: type: string name: type: string offeringsUrl: type: 'null' ownerEmail: type: - string - 'null' ownerName: type: - string - 'null' package: type: string paymentMethods: type: array items: type: string phone: type: string pinterestUrl: type: 'null' planId: type: integer planName: type: string postalCode: type: string publisherAttributes: type: array items: type: object properties: attributeName: type: string publisherName: type: string value: type: array items: type: string x-apidog-orders: - attributeName - publisherName - value reservationUrl: type: 'null' serviceItems: type: array items: type: string stateIso: type: string stateName: type: string storeId: type: string street: type: string street1: type: string subCategoryId: type: integer subCategoryName: type: string tagline: type: - string - 'null' tags: type: array items: type: string temporarilyClosed: type: boolean tiktokUrl: type: 'null' toplineMessage: type: 'null' toplineMessageText: type: 'null' twitterUrl: type: - string - 'null' uid: type: string updatedAt: type: string videos: type: array items: type: string voiceStatus: type: integer yearOfIncorporation: type: - integer - 'null' youtubeUrl: type: 'null' required: - accountId - addOns - additionalCategoryIds - additionalCategoryNames - additionalInfo - additionalPhones - approved - archivalScheduledAt - archived - archivedAt - bizUrl - bizUrlUtm - bookingUrl - businessHours - cancellationScheduledAt - categoryId - city - contentPreferredLanguage - countryCode - countryIso - createErrors - createdDate - customAttributes - databaseId - description - enabledSiteIds - facebookUrl - folderId - folderName - franchise - googleAdsPhone - googleVerificationStatus - googleplusUrl - hideAddress - id - instagramUrl - isRestaurant - lastUpdatedDate - latitude - linkedinUrl - locationPhotos - longitude - managedServiceSiteBuckets - managedServiceSites - moreHours - name - offeringsUrl - ownerEmail - ownerName - package - paymentMethods - phone - pinterestUrl - planId - planName - postalCode - publisherAttributes - reservationUrl - serviceItems - stateIso - stateName - storeId - street - street1 - subCategoryId - subCategoryName - tagline - tags - temporarilyClosed - tiktokUrl - toplineMessage - toplineMessageText - twitterUrl - uid - updatedAt - videos - voiceStatus - yearOfIncorporation - youtubeUrl x-apidog-orders: - accountId - addOns - additionalCategoryIds - additionalCategoryNames - additionalInfo - additionalPhones - approved - archivalScheduledAt - archived - archivedAt - bizUrl - bizUrlUtm - bookingUrl - businessHours - cancellationScheduledAt - categoryId - city - contentPreferredLanguage - countryCode - countryIso - createErrors - createdDate - customAttributes - databaseId - description - enabledSiteIds - facebookUrl - folderId - folderName - franchise - googleAdsPhone - googleVerificationStatus - googleplusUrl - hideAddress - id - instagramUrl - isRestaurant - lastUpdatedDate - latitude - linkedinUrl - locationPhotos - longitude - managedServiceSiteBuckets - managedServiceSites - moreHours - name - offeringsUrl - ownerEmail - ownerName - package - paymentMethods - phone - pinterestUrl - planId - planName - postalCode - publisherAttributes - reservationUrl - serviceItems - stateIso - stateName - storeId - street - street1 - subCategoryId - subCategoryName - tagline - tags - temporarilyClosed - tiktokUrl - toplineMessage - toplineMessageText - twitterUrl - uid - updatedAt - videos - voiceStatus - yearOfIncorporation - youtubeUrl required: - cursor - node x-apidog-orders: - cursor - node pageInfo: type: object properties: endCursor: type: string hasNextPage: type: boolean hasPreviousPage: type: boolean total: type: integer required: - endCursor - hasNextPage - hasPreviousPage - total x-apidog-orders: - endCursor - hasNextPage - hasPreviousPage - total required: - edges - pageInfo x-apidog-orders: - edges - pageInfo required: - searchLocations x-apidog-orders: - searchLocations required: - data x-apidog-orders: - data example: data: searchLocations: edges: - cursor: TG9jYXRpb246NTI3NDY5 node: accountId: 16154 addOns: [] additionalCategoryIds: [] additionalCategoryNames: [] additionalInfo: null additionalPhones: [] approved: NOT_APPROVED archivalScheduledAt: null archived: false archivedAt: null bizUrl: null bizUrlUtm: false bookingUrl: null businessHours: [] cancellationScheduledAt: null categoryId: 15 city: Sacramento contentPreferredLanguage: ENGLISH countryCode: '1' countryIso: US createErrors: [] createdDate: February 23, 2021 customAttributes: - archived: false enumValues: [] name: ABC slug: abc type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: NJL slug: njl type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: ZZZ slug: zzz type: STRING value: [] - archived: false enumValues: [] name: ALL slug: all type: STRING value: - ss - archived: false enumValues: - gulab jamun - rasgulla - ras malai - jalebi name: Dessets slug: dessets type: ENUM value: - gulab jamun - archived: false enumValues: [] name: Attrs slug: attrs type: STRING value: [] - archived: false enumValues: [] name: Attrs2 slug: attrs2 type: STRING value: [] - archived: false enumValues: [] name: Toll-free Number slug: toll-free_number type: INTEGER value: - '80044637' - archived: false enumValues: [] name: amenities slug: amenities type: ARRAY value: - wifi - wheelchair - welcoming ceremony - archived: false enumValues: [] name: amenities02 slug: amenities02 type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Amenities-check slug: amenities-check type: BOOLEAN value: - 'false' - archived: false enumValues: - Atr1 - atr2 - atr3 name: Prod_Attribute slug: prod_attribute type: ENUM value: - Atr1 - archived: false enumValues: [] name: wifi available slug: wifi_available type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: QQQQQQQ slug: qqqqqqq type: INTEGER value: - '123' - archived: false enumValues: [] name: int02 slug: int02 type: INTEGER value: [] - archived: false enumValues: [] name: Tasty slug: tasty type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: dhdop slug: dhdop type: STRING value: [] - archived: false enumValues: [] name: Abstract slug: abstract type: ARRAY value: - abs1 - abs2 - abs3 - archived: false enumValues: [] name: Senior Hours Required? slug: senior_hours_required? type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: kafka_check_attribute slug: kafka_check_attribute type: ARRAY value: - one - two - three - archived: false enumValues: [] name: Parking slug: parking type: BOOLEAN value: - 'false' - archived: false enumValues: [] name: googlePlaceId slug: googleplaceid type: STRING value: [] - archived: false enumValues: [] name: hoursComments slug: hourscomments type: STRING value: [] - archived: false enumValues: [] name: isOpen slug: isopen type: BOOLEAN value: [] - archived: false enumValues: [] name: has_bicycle_rack? slug: has_bicycle_rack? type: BOOLEAN value: [] - archived: false enumValues: - one - two name: quick slug: quick type: ENUM value: - one - archived: false enumValues: [] name: instagramUrl slug: instagramurl type: STRING value: [] - archived: false enumValues: [] name: analyticsTrackingFireEvent slug: analyticstrackingfireevent type: STRING value: [] - archived: false enumValues: [] name: placeholderText slug: placeholdertext type: STRING value: [] - archived: false enumValues: - FRND - MENMENMEN - BARNEY name: TV slug: tv type: ENUM value: - FRND - archived: false enumValues: [] name: notificationEmails slug: notificationemails type: ARRAY value: [] - archived: false enumValues: [] name: joinUrl slug: joinurl type: STRING value: [] - archived: false enumValues: [] name: account_att slug: account_att type: ARRAY value: - '1' - '2' - '4' - '3' - archived: false enumValues: [] name: Post v2 slug: post_v2 type: STRING value: [] - archived: false enumValues: [] name: testingthetest slug: testingthetest type: INTEGER value: - '0' - archived: false enumValues: [] name: int0 slug: int0 type: INTEGER value: - '0' - archived: false enumValues: [] name: url_appointment slug: url_appointment type: STRING value: [] - archived: false enumValues: [] name: Slug slug: slug type: STRING value: [] - archived: false enumValues: [] name: New Name slug: new_name type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: test200 slug: test200 type: STRING value: - test test - archived: false enumValues: [] name: Name slug: name type: STRING value: [] - archived: false enumValues: [] name: 'Test Department ' slug: test_department_ type: ARRAY value: [] - archived: false enumValues: [] name: 'Fresh Fish Section ' slug: fresh_fish_section_ type: STRING value: [] - archived: false enumValues: [] name: Test 28 11 22 slug: test_28_11_22 type: STRING value: - Test 28 - archived: false enumValues: [] name: blablacar slug: blablacar type: STRING value: [] - archived: false enumValues: [] name: requires temperature check customers slug: requires_temperature_check_customers type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Custom Tee Point slug: custom_tee_point type: STRING value: - tess - archived: false enumValues: [] name: appointment_required slug: appointment_required type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: requires masks customers slug: requires_masks_customers type: BOOLEAN value: [] - archived: false enumValues: [] name: is black owned slug: is_black_owned type: BOOLEAN value: [] - archived: false enumValues: [] name: BewAttribute slug: bewattribute type: STRING value: [] - archived: false enumValues: [] name: 'Pets 2 ' slug: pets_2_ type: ARRAY value: [] - archived: false enumValues: [] name: test214122 slug: test214122 type: STRING value: - test2 - archived: false enumValues: [] name: Test123 slug: test123 type: STRING value: [] - archived: false enumValues: [] name: ohiiiignore slug: ohiiiignore type: STRING value: [] - archived: false enumValues: [] name: yesnotest slug: yesnotest type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: account_leve_test_for_ext slug: account_leve_test_for_ext type: STRING value: [] - archived: false enumValues: [] name: Custom location ID slug: custom_location_id type: STRING value: [] - archived: false enumValues: [] name: Account Attr slug: account_attr type: ARRAY value: - one - two - three - archived: false enumValues: - b - a - c name: enum01 slug: enum01 type: ENUM value: - a - archived: false enumValues: [] name: Paneer Speciality slug: paneer_speciality type: STRING value: - https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/be9eafc1-78ca-4515-a164-005a28db4e69.jpg - archived: false enumValues: [] name: welcomes_lgbtq slug: welcomes_lgbtq type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Lgbtq+ friendly slug: lgbtq+_friendly type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: analyticsTrackingScript slug: analyticstrackingscript type: STRING value: [] - archived: false enumValues: [] name: test-os-attr3 slug: test-os-attr3 type: STRING value: [] - archived: false enumValues: [] name: lead_photo_drive slug: lead_photo_drive type: STRING value: [] - archived: false enumValues: [] name: parcel slug: parcel type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: test-os-attr1 slug: test-os-attr1 type: INTEGER value: [] - archived: false enumValues: [] name: global-attr-2 slug: global-attr-2 type: STRING value: - 'testing ' - archived: false enumValues: [] name: bollean03 slug: bollean03 type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: global-attr-1 slug: global-attr-1 type: STRING value: - '11111' - archived: false enumValues: [] name: KAM slug: kam type: STRING value: - default text databaseId: 527469 description: About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business About The Business enabledSiteIds: [] facebookUrl: null folderId: 401228fe-8ee9-4914-a08a-db7cda490ec9 folderName: root franchise: false googleAdsPhone: null googleVerificationStatus: message: null status: NOT_CONNECTED googleplusUrl: null hideAddress: false id: TG9jYXRpb246NTI3NDY5 instagramUrl: null isRestaurant: true lastUpdatedDate: December 13, 2025 latitude: '38.5934167' linkedinUrl: null locationPhotos: [] longitude: '-121.4015013' managedServiceSiteBuckets: [] managedServiceSites: [] moreHours: [] name: TEST offeringsUrl: null ownerEmail: null ownerName: null package: PREMIUM paymentMethods: [] phone: '2003004000' pinterestUrl: null planId: 191 planName: Local Basic Monthly postalCode: '95825' publisherAttributes: [] reservationUrl: null serviceItems: [] stateIso: AZ stateName: Arizona storeId: TEST street: Fulton Ave street1: '2330' subCategoryId: 641 subCategoryName: Absinthe Bars tagline: null tags: - all temporarilyClosed: false tiktokUrl: null toplineMessage: null toplineMessageText: null twitterUrl: null uid: 46e975b4-0e11-40fa-b949-43d84a1fa7c0 updatedAt: '2025-12-13T16:56:58.979Z' videos: [] voiceStatus: 1 yearOfIncorporation: null youtubeUrl: null - cursor: TG9jYXRpb246NzEyMzAx node: accountId: 16154 addOns: [] additionalCategoryIds: - 1943 - 1904 additionalCategoryNames: - Bookkeeping Service - Certified Public Accountants additionalInfo: null additionalPhones: [] approved: APPROVED archivalScheduledAt: null archived: false archivedAt: null bizUrl: null bizUrlUtm: false bookingUrl: null businessHours: - day: SUNDAY slots: - end: 05:00pm start: 09:00am specialDate: null type: OPEN - day: MONDAY slots: - end: 05:00pm start: 09:00am specialDate: null type: OPEN - day: TUESDAY slots: - end: 05:00pm start: 09:00am specialDate: null type: OPEN - day: WEDNESDAY slots: - end: 05:00pm start: 09:00am specialDate: null type: OPEN - day: THURSDAY slots: - end: 05:00pm start: 09:00am specialDate: null type: OPEN - day: FRIDAY slots: - end: 09:30pm start: 09:00am specialDate: null type: OPEN - day: SATURDAY slots: - end: 05:00pm start: 09:00am specialDate: null type: OPEN cancellationScheduledAt: null categoryId: 13 city: Ranchi contentPreferredLanguage: ENGLISH countryCode: '91' countryIso: IN createErrors: [] createdDate: March 29, 2022 customAttributes: - archived: false enumValues: [] name: ABC slug: abc type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: NJL slug: njl type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: ZZZ slug: zzz type: STRING value: [] - archived: false enumValues: [] name: ALL slug: all type: STRING value: - ss - archived: false enumValues: - gulab jamun - rasgulla - ras malai - jalebi name: Dessets slug: dessets type: ENUM value: - gulab jamun - archived: false enumValues: [] name: Attrs slug: attrs type: STRING value: [] - archived: false enumValues: [] name: Attrs2 slug: attrs2 type: STRING value: [] - archived: false enumValues: [] name: Toll-free Number slug: toll-free_number type: INTEGER value: - '80044637' - archived: false enumValues: [] name: amenities slug: amenities type: ARRAY value: - wifi - wheelchair - welcoming ceremony - archived: false enumValues: [] name: amenities02 slug: amenities02 type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Amenities-check slug: amenities-check type: BOOLEAN value: - 'false' - archived: false enumValues: - Atr1 - atr2 - atr3 name: Prod_Attribute slug: prod_attribute type: ENUM value: - Atr1 - archived: false enumValues: [] name: wifi available slug: wifi_available type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: QQQQQQQ slug: qqqqqqq type: INTEGER value: - '123' - archived: false enumValues: [] name: int02 slug: int02 type: INTEGER value: [] - archived: false enumValues: [] name: Tasty slug: tasty type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: dhdop slug: dhdop type: STRING value: [] - archived: false enumValues: [] name: Abstract slug: abstract type: ARRAY value: - abs1 - abs2 - abs3 - archived: false enumValues: [] name: Senior Hours Required? slug: senior_hours_required? type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: kafka_check_attribute slug: kafka_check_attribute type: ARRAY value: - one - two - three - archived: false enumValues: [] name: Parking slug: parking type: BOOLEAN value: - 'false' - archived: false enumValues: [] name: googlePlaceId slug: googleplaceid type: STRING value: [] - archived: false enumValues: [] name: hoursComments slug: hourscomments type: STRING value: [] - archived: false enumValues: [] name: isOpen slug: isopen type: BOOLEAN value: [] - archived: false enumValues: [] name: has_bicycle_rack? slug: has_bicycle_rack? type: BOOLEAN value: [] - archived: false enumValues: - one - two name: quick slug: quick type: ENUM value: - one - archived: false enumValues: [] name: instagramUrl slug: instagramurl type: STRING value: [] - archived: false enumValues: [] name: analyticsTrackingFireEvent slug: analyticstrackingfireevent type: STRING value: [] - archived: false enumValues: [] name: placeholderText slug: placeholdertext type: STRING value: [] - archived: false enumValues: - FRND - MENMENMEN - BARNEY name: TV slug: tv type: ENUM value: - FRND - archived: false enumValues: [] name: notificationEmails slug: notificationemails type: ARRAY value: [] - archived: false enumValues: [] name: joinUrl slug: joinurl type: STRING value: [] - archived: false enumValues: [] name: account_att slug: account_att type: ARRAY value: - '1' - '2' - '4' - '3' - archived: false enumValues: [] name: Post v2 slug: post_v2 type: STRING value: [] - archived: false enumValues: [] name: testingthetest slug: testingthetest type: INTEGER value: - '0' - archived: false enumValues: [] name: Test Attribute slug: test_attribute type: STRING value: [] - archived: false enumValues: [] name: int0 slug: int0 type: INTEGER value: - '0' - archived: false enumValues: [] name: url_appointment slug: url_appointment type: STRING value: [] - archived: false enumValues: [] name: Slug slug: slug type: STRING value: [] - archived: false enumValues: [] name: New Name slug: new_name type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: test200 slug: test200 type: STRING value: - test test - archived: false enumValues: [] name: Name slug: name type: STRING value: [] - archived: false enumValues: [] name: 'Test Department ' slug: test_department_ type: ARRAY value: [] - archived: false enumValues: [] name: 'Fresh Fish Section ' slug: fresh_fish_section_ type: STRING value: [] - archived: false enumValues: [] name: Test 28 11 22 slug: test_28_11_22 type: STRING value: - Test 28 - archived: false enumValues: [] name: blablacar slug: blablacar type: STRING value: [] - archived: false enumValues: [] name: requires temperature check customers slug: requires_temperature_check_customers type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Custom Tee Point slug: custom_tee_point type: STRING value: - tess - archived: false enumValues: [] name: appointment_required slug: appointment_required type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: requires masks customers slug: requires_masks_customers type: BOOLEAN value: [] - archived: false enumValues: [] name: is black owned slug: is_black_owned type: BOOLEAN value: [] - archived: false enumValues: [] name: BewAttribute slug: bewattribute type: STRING value: [] - archived: false enumValues: [] name: 'Pets 2 ' slug: pets_2_ type: ARRAY value: [] - archived: false enumValues: [] name: test214122 slug: test214122 type: STRING value: - test2 - archived: false enumValues: [] name: Test123 slug: test123 type: STRING value: [] - archived: false enumValues: [] name: ohiiiignore slug: ohiiiignore type: STRING value: [] - archived: false enumValues: [] name: yesnotest slug: yesnotest type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: account_leve_test_for_ext slug: account_leve_test_for_ext type: STRING value: [] - archived: false enumValues: [] name: Custom location ID slug: custom_location_id type: STRING value: [] - archived: false enumValues: [] name: Account Attr slug: account_attr type: ARRAY value: - one - two - three - archived: false enumValues: - b - a - c name: enum01 slug: enum01 type: ENUM value: - a - archived: false enumValues: [] name: Paneer Speciality slug: paneer_speciality type: STRING value: - https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/be9eafc1-78ca-4515-a164-005a28db4e69.jpg - archived: false enumValues: [] name: welcomes_lgbtq slug: welcomes_lgbtq type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Lgbtq+ friendly slug: lgbtq+_friendly type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: analyticsTrackingScript slug: analyticstrackingscript type: STRING value: [] - archived: false enumValues: [] name: test-os-attr3 slug: test-os-attr3 type: STRING value: [] - archived: false enumValues: [] name: lead_photo_drive slug: lead_photo_drive type: STRING value: [] - archived: false enumValues: [] name: parcel slug: parcel type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: test-os-attr1 slug: test-os-attr1 type: INTEGER value: [] - archived: false enumValues: [] name: global-attr-2 slug: global-attr-2 type: STRING value: - 'testing ' - archived: false enumValues: [] name: bollean03 slug: bollean03 type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: global-attr-1 slug: global-attr-1 type: STRING value: - '11111' - archived: false enumValues: [] name: KAM slug: kam type: STRING value: - default text databaseId: 712301 description: We're taking strict measures to ensure that we secure the highest quality of safety assurance. While we have resumed services we're operating with a limited team. Thanks for your patience, as it may take longer than usual to connect with us. enabledSiteIds: [] facebookUrl: '' folderId: be3603fb-0f2b-4821-829f-187c74af94f1 folderName: sanity32 franchise: false googleAdsPhone: '9804011221' googleVerificationStatus: message: null status: NOT_CONNECTED googleplusUrl: null hideAddress: false id: TG9jYXRpb246NzEyMzAx instagramUrl: null isRestaurant: false lastUpdatedDate: December 13, 2025 latitude: '23.0620179' linkedinUrl: '' locationPhotos: - databaseId: 2675502 fileSize: 112456 id: TWVkaWFGaWxlOjI2NzU1MDI= name: 75f5d498-2b00-455b-9061-5a0ce5c1ade2.jpg starred: false thumbnailUrl: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/200x200/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/61ad13a4-014d-43de-a994-214a4978ebd5.jpg type: ADDITIONAL url: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/250x250/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/59c670a3536b937ec7910f7619ee3304/61ad13a4-014d-43de-a994-214a4978ebd5.jpg - databaseId: 3162494 fileSize: 28449 id: TWVkaWFGaWxlOjMxNjI0OTQ= name: Found_faces starred: false thumbnailUrl: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/200x200/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/e939ba52-1625-40a0-817a-79b759e10b5c.jpg type: LOGO url: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/250x250/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/e939ba52-1625-40a0-817a-79b759e10b5c.jpg - databaseId: 14165890 fileSize: 62140 id: TWVkaWFGaWxlOjE0MTY1ODkw name: Screenshot_2025-07-17_at_9.00.07 PM.png starred: false thumbnailUrl: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/200x200/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/70b2b948b071e12cfd298916316b3732/d487dab1-609f-481e-9f12-f59713208364.png type: ADDITIONAL url: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/250x250/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/70b2b948b071e12cfd298916316b3732/d487dab1-609f-481e-9f12-f59713208364.png - databaseId: 3460831 fileSize: 87871 id: TWVkaWFGaWxlOjM0NjA4MzE= name: insta_5_-16 starred: false thumbnailUrl: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/200x200/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/33ef7986-96ed-47f3-9242-f8ee2a1d44c0.jpg type: COVER url: https://t2.verifymybiz.com/unsafe/adaptive-full-fit-in/250x250/filters:format(png)/https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/33ef7986-96ed-47f3-9242-f8ee2a1d44c0.jpg longitude: '84.9594127' managedServiceSiteBuckets: [] managedServiceSites: [] moreHours: [] name: ZEwxc offeringsUrl: null ownerEmail: akshay@synup.com ownerName: '' package: PREMIUM paymentMethods: - VISA - MASTERCARD - APPLE_PAY - PAYPAL - ANDROID_PAY phone: '1234567890' pinterestUrl: null planId: 86 planName: V2 Premium Slow + Fast Sites postalCode: '835234' publisherAttributes: - attributeName: Additional categories publisherName: GOOGLE value: - gcid:food_and_beverage_exporter reservationUrl: null serviceItems: [] stateIso: JH stateName: Jharkhand storeId: Aksh-test street: House No 5, VILL Tapkara, PO-Mahugaon, PS, near paddy procurement godown, Lapung street1: '' subCategoryId: 618 subCategoryName: Restaurant Supplies tagline: '' tags: - all - india - bulk_adding - abc - sachit_test - helloworld - '20' - teston30622 - adding - 20bulkedit - all380 - customdomain12 - space tag - photos - jrew01 temporarilyClosed: false tiktokUrl: null toplineMessage: null toplineMessageText: null twitterUrl: '' uid: 03b78ddf-13af-40c9-b9a8-ffd2262304d5 updatedAt: '2025-12-13T17:00:50.670Z' videos: [] voiceStatus: 3 yearOfIncorporation: 1990 youtubeUrl: null pageInfo: endCursor: TG9jYXRpb246NzEyMzAx hasNextPage: true hasPreviousPage: true total: 22 headers: {} x-apidog-name: OK security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13651538-run /locations/photos/star: post: summary: Star/Unstar Location Photos deprecated: false description: "\nThis API allows you to star or unstar photo(s) for a specific location. A starred photo highlights its importance and increases its visibility in certain displays.\n \n:::caution[]\n\nA location can have a maximum of 4 starred images. Attempting to star additional photos will result in an error.\nOnly additional photo types can be starred or unstarred. The logo and cover image cannot be starred. \n\n:::\n\nFor more details, refer to [Manage photos for your location](https://developer.synup.com/doc-833258.md). \n\n" operationId: starUnstarLocationPhotos tags: - Locations parameters: - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string requestBody: content: application/json: schema: type: object required: - input properties: input: type: object required: - locationId - photoIds - starred properties: locationId: type: string description: ID of the location containing the photos examples: - TG9jYXRpb246NTIxMzI0 photoIds: type: array description: 'List of Photo IDs to be starred/unstarred, which can found from query locations ' items: type: string examples: - - TWVkaWFGaWxlOjg4MjY5Nw== - TWVkaWFGaWxlOjg4MjY5OA== starred: type: boolean description: true to star; false to unstar x-apidog-orders: - locationId - photoIds - starred x-apidog-orders: - input example: input: locationId: TG9jYXRpb246MTA4NzIxMQ== photoIds: - TWVkaWFGaWxlOjU2MzgyMDU= starred: true responses: '200': description: The response will provide details of the photos that were processed, whether successfully starred or unstarred. If any errors occur, the response will include error information. content: application/json: schema: type: object properties: data: type: object properties: starUnstarLocationPhotos: type: object properties: success: type: boolean error: type: 'null' photos: type: array items: type: object properties: databaseId: type: integer fileSize: type: integer id: type: string name: type: string starred: type: boolean thumbnailUrl: type: string type: type: string url: type: string publisherOverride: type: string x-apidog-orders: - databaseId - fileSize - id - name - starred - thumbnailUrl - type - url - publisherOverride required: - success - error - photos x-apidog-orders: - success - error - photos required: - starUnstarLocationPhotos x-apidog-orders: - starUnstarLocationPhotos required: - data x-apidog-orders: - data examples: '1': summary: Success value: data: starUnstarLocationPhotos: success: true error: null photos: - databaseId: 5638205 fileSize: 95636 id: TWVkaWFGaWxlOjU2MzgyMDU= name: 090f5748-2f84-405e-bd04-6cd42dad2496 starred: true thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/thumbnail_7c7fdefb-c50d-4478-8b8e-957011444445.jpg type: ADDITIONAL url: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/7c7fdefb-c50d-4478-8b8e-957011444445.jpg publisherOverride: '' '2': summary: Exception value: data: starUnstarLocationPhotos: success: false error: message: 'SY15013: Only additional photo types can be starred or unstarred' contextInfo: - key: null value: null code: SY15013 photos: [] headers: {} x-apidog-name: OK security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13642393-run /locations/update: post: summary: Update business location deprecated: false description: ' ## Update Location This API allows you to modify the attributes of an existing location within your account. It enables businesses to keep their location data up to date by updating key details such as address, contact information, business hours, categories, and other metadata. :::info [] **Processing Time for Location Updates** Updates to location attributes including `enabledSiteIds` or `submissionDisabledSiteIds`, are processed asynchronously before they are accurately reflected across all publishers and within the system. Allow this time for updates to be reflected accurately. ::: ' operationId: createLocation tags: - Locations parameters: - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string requestBody: content: application/json: schema: type: object properties: input: type: object properties: id: type: string description: Unique identifier in Base64 encoded format. Must be in the format `Location:` name: type: string description: Name of the business archived: type: boolean description: Indicates if the location is archived. Read-only. readOnly: true archivedAt: type: - string - 'null' format: date-time description: Timestamp when the location was archived. Read-only. readOnly: true billingPeriod: type: - string - 'null' description: Billing cycle period. Read-only. readOnly: true bizUrl: type: string description: URL of the business website bookingUrl: type: 'null' description: URL for booking appointments. Applicable only for Food industry businesses businessHours: type: array description: Business hours for each day of the week items: type: object properties: day: type: string description: Day of the week | Special enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY - SPECIAL x-apidog-enum: - value: MONDAY name: '' description: '' - value: TUESDAY name: '' description: '' - value: WEDNESDAY name: '' description: '' - value: THURSDAY name: '' description: '' - value: FRIDAY name: '' description: '' - value: SATURDAY name: '' description: '' - value: SUNDAY name: '' description: '' - value: SPECIAL name: '' description: '' slots: type: array items: type: object properties: start: type: string description: 'Opening time. Valid formats: `:am` OR `:pm` ' end: type: string description: 'Closing time. Valid formats: `:am` OR `:pm` ' x-apidog-orders: - start - end title: '' x-apidog-ignore-properties: [] description: Array of time slots (minimum 1, maximum 2). Required only if type is OPEN. title: '' type: type: string description: Type of business hours (e.g., OPEN, CLOSED, OPEN_24x7) enum: - OPEN - OPEN_24x7 - CLOSED x-apidog-enum: - value: OPEN name: '' description: '' - value: OPEN_24x7 name: '' description: '' - value: CLOSED name: '' description: '' specialDate: type: string description: "Day should be `SPECIAL`. Regular hours is mandatory. \n**Regular hours is mandatory for special hours to be allowed **" x-apidog-orders: - day - slots - type - specialDate required: - day - slots - type x-apidog-ignore-properties: [] city: type: string description: City where the business is located countryIso: type: string description: Country ISO code. Refer to the Places API for valid ISOs. customAttributes: type: array items: type: object properties: archived: type: boolean enumValues: type: array items: type: string name: type: string slug: type: string type: type: string value: type: array items: type: string x-apidog-orders: - archived - enumValues - name - slug - type - value x-apidog-ignore-properties: [] description: type: string description: Detailed description of the business facebookUrl: type: string description: URL of the business's Facebook page googleAdsPhone: type: string description: Google Ads-specific phone number hideAddress: type: boolean description: Set to true if location is a Service Area Business instagramUrl: type: string description: URL of the business's Instagram page linkedinUrl: type: string description: URL of the business's LinkedIn page offeringsUrl: type: 'null' description: URL for listing business offerings. Applicable only for food industry businesses ownerEmail: type: string description: Email of the business owner ownerName: type: string description: Name of the business owner paymentMethods: type: array items: type: string description: Accepted payment methods ("VISA", "MASTERCARD", "AMEX", "CASH", "CHEQUE", "CRYPTO", "DINERS_CLUB", "DISCOVER", "FINANCING", "INVOICE", "TRAVELERS_CHECK", "APPLE_PAY", "SAMSUNG_PAY", "PAYPAL", "ANDROID_PAY" ) phone: type: string description: "- Must follow the international **E.164 format**. [Ref here.](https://www.twilio.com/docs/glossary/what-e164)\n- Do not include the `+` sign or country code.\n- Remove parentheses and special characters.\n- Example:\n - **Incorrect**: `(123)-456-7890`, `+1-123-456-7890`\n - **Correct**: `1234567890`" additionalPhones: type: array items: type: string description: Additional contact phone numbers pinterestUrl: type: string description: URL of the business's Pinterest page postalCode: type: string description: Postal code of the business location reservationUrl: type: 'null' description: URL for making reservations. Applicable only for restaurant only businesses. serviceItems: type: array items: type: string stateIso: type: string description: State ISO code. Refer to the Places API for valid ISOs. storeId: type: 'null' description: Unique store identifier. Must be unique across all locations. street: type: string description: Street address of the business street1: type: string description: Additional street address information subCategoryId: type: integer description: 'ID of the subcategory the business belongs to ' additionalCategoryIds: type: array items: type: string description: Additional category IDs for the business tagline: type: string description: Tagline of the business tags: type: array items: type: string temporarilyClosed: type: boolean description: Set to true if the location's business hours should be marked as closed tiktokUrl: type: 'null' description: URL of the business's TikTok page twitterUrl: type: string description: URL of the business's Twitter page videos: type: array items: type: string description: List of valid video URLs yearOfIncorporation: type: integer description: Year the business was established youtubeUrl: type: 'null' description: URL of the business's YouTube page enabledSiteIds: type: array description: List of site IDs where the business details should be published items: type: integer submissionDisabledSiteIds: type: array description: List of site IDs where the business details should not be published items: type: integer placeActionLinks: type: array items: type: object properties: placeActionType: type: string enum: - APPOINTMENT - ONLINE_APPOINTMENT - DINING_RESERVATION - FOOD_ORDERING - FOOD_DELIVERY - FOOD_TAKEOUT x-apidog-enum: - value: APPOINTMENT name: '' description: '' - value: ONLINE_APPOINTMENT name: '' description: '' - value: DINING_RESERVATION name: '' description: '' - value: FOOD_ORDERING name: '' description: '' - value: FOOD_DELIVERY name: '' description: '' - value: FOOD_TAKEOUT name: '' description: '' description: One of the valid types. isPreferred: type: boolean description: Marks this link preferred for its type. At most one preferred per type. uri: type: string description: Destination URL. name: type: string description: The link's identifier, returned by the read endpoints once the link has synced to Google. Optional on write — include it (when available) to target a specific saved link most accurately. action: type: string description: add (default) or delete (for deleting saved uri) x-apidog-orders: - placeActionType - isPreferred - uri - name - action required: - placeActionType - isPreferred - uri x-apidog-ignore-properties: [] required: - id - placeActionLinks x-apidog-orders: - id - name - archived - archivedAt - billingPeriod - bizUrl - bookingUrl - 01JJYTM5NADNB62HTXK88E2KE0 - city - countryIso - customAttributes - description - facebookUrl - googleAdsPhone - hideAddress - instagramUrl - linkedinUrl - offeringsUrl - ownerEmail - ownerName - paymentMethods - phone - additionalPhones - pinterestUrl - postalCode - reservationUrl - serviceItems - stateIso - storeId - street - street1 - subCategoryId - additionalCategoryIds - tagline - tags - temporarilyClosed - tiktokUrl - twitterUrl - videos - yearOfIncorporation - youtubeUrl - enabledSiteIds - submissionDisabledSiteIds - placeActionLinks x-apidog-refs: 01JJYTM5NADNB62HTXK88E2KE0: $ref: '#/components/schemas/Business%20hours' x-apidog-ignore-properties: - businessHours required: - input x-apidog-orders: - input x-apidog-ignore-properties: [] example: input: id: TG9jYXRpb246MTE4MjcxOA== name: Greenleaf Bakery 2 businessHours: - day: SUNDAY slots: null specialDate: null type: CLOSED - day: MONDAY slots: - end: 12:00pm start: 08:00am - end: 06:00pm start: 01:00pm specialDate: null type: OPEN - day: TUESDAY slots: - end: 06:00pm start: 08:00am specialDate: null type: OPEN - day: WEDNESDAY slots: - end: 06:00pm start: 08:00am specialDate: null type: OPEN - day: THURSDAY slots: - end: 06:00pm start: 08:00am specialDate: null type: OPEN - day: FRIDAY slots: - end: 06:00pm start: 08:00am specialDate: null type: OPEN - day: SATURDAY slots: - end: 04:00pm start: 08:00am specialDate: null type: OPEN - day: SPECIAL slots: - end: 04:00pm start: 08:00am specialDate: '2025-07-12' type: OPEN placeActionLinks: - placeActionType: FOOD_ORDERING uri: https://order.example.com name: action: delete - placeActionType: FOOD_ORDERING uri: https://new-order.example.com isPreferred: true action: add - placeActionType: FOOD_ORDERING uri: https://ordering.sample_discovered_url.com isPreferred: false action: add responses: '200': description: Location created successfully content: application/json: schema: type: object properties: data: type: object properties: updateLocation: type: object properties: clientMutationId: type: 'null' errors: type: - array - 'null' items: type: object properties: code: type: string contextInfo: type: array items: type: object properties: key: type: string value: type: string x-apidog-orders: - key - value x-apidog-ignore-properties: [] message: type: string x-apidog-orders: - code - contextInfo - message x-apidog-ignore-properties: [] description: Errors encountered during the location creation process, if any. Null if no errors. location: type: object properties: accountId: type: integer description: Unique identifier of the account associated with the location. additionalCategoryIds: type: array items: type: string description: List of additional category IDs assigned to the location. additionalInfo: type: 'null' description: Additional information about the location, if applicable. additionalPhones: type: array items: type: string description: List of additional phone numbers associated with the location. archived: type: boolean description: Indicates whether the location has been archived. archivedAt: type: 'null' description: Timestamp indicating when the location was archived, if applicable. billingPeriod: type: 'null' description: Billing period associated with the location, if applicable. bizUrl: type: string description: URL of the business website. bookingUrl: type: 'null' description: URL for booking appointments with the business. businessHours: type: array items: type: object properties: day: type: string description: Day of the week. slots: type: array items: type: object properties: end: type: string description: Closing time of the slot. start: type: string description: Opening time of the slot. required: - end - start x-apidog-orders: - end - start x-apidog-ignore-properties: [] description: Time slots indicating when the business is open. specialDate: type: - string - 'null' description: Special date for business hours, if applicable. type: type: string description: Type of business hour entry (e.g., OPEN, CLOSED). required: - day - slots - specialDate - type x-apidog-orders: - day - slots - specialDate - type x-apidog-ignore-properties: [] description: List of business hours for each day of the week. categoryId: type: integer description: ID of the primary category assigned to the business. city: type: string description: City where the business is located. countryIso: type: string description: Country ISO code of the business location. customAttributes: type: array items: type: object properties: archived: type: boolean enumValues: type: array items: type: string name: type: string slug: type: string type: type: string value: type: array items: type: string required: - archived - enumValues - name - slug - type - value x-apidog-orders: - archived - enumValues - name - slug - type - value x-apidog-ignore-properties: [] databaseId: type: integer description: Internal id description: type: string description: Detailed description of the business. facebookUrl: type: string description: URL of the business's Facebook page. folderId: type: string folderName: type: string googleAdsPhone: type: string googleplusUrl: type: 'null' hideAddress: type: boolean description: If the location is an SAB id: type: string description: Encoded Location Id in base64 format. Location: instagramUrl: type: string description: URL of the business's Instagram profile. isRestaurant: type: boolean latitude: type: number linkedinUrl: type: string description: URL of the business's LinkedIn profile. locationPhotos: type: array items: type: string longitude: type: number moreHours: type: array items: type: string description: 'The time periods during which a location is open for certain types of business. Only for Google' name: type: string description: Name of the business. offeringsUrl: type: 'null' description: Menu URL ownerEmail: type: string description: Email of the business owner. ownerName: type: string package: type: string paymentMethods: type: array items: type: string description: 'Accepted payment methods ("VISA", "MASTERCARD", "AMEX", "CASH", "CHEQUE", "CRYPTO", "DINERS_CLUB", "DISCOVER", "FINANCING", "INVOICE", "TRAVELERS_CHECK", "APPLE_PAY", "SAMSUNG_PAY", "PAYPAL", "ANDROID_PAY" ) ' phone: type: string description: Primary contact phone number. pinterestUrl: type: string planId: type: integer planName: type: string postalCode: type: string publisherAttributes: type: array items: type: string reservationUrl: type: 'null' serviceItems: type: array items: type: string stateIso: type: string description: State ISO code of the business location. storeId: type: 'null' description: Unique store identifier, if applicable. street: type: string description: Street address of the business. street1: type: string subCategory: type: object properties: databaseId: type: integer id: type: string name: type: string primary: type: boolean required: - databaseId - id - name - primary x-apidog-orders: - databaseId - id - name - primary x-apidog-ignore-properties: [] subCategoryId: type: integer subCategoryName: type: string tagline: type: string tags: type: array items: type: string temporarilyClosed: type: boolean description: Indicates whether the business is temporarily closed. tiktokUrl: type: 'null' toplineMessage: type: 'null' toplineMessageText: type: 'null' twitterUrl: type: string description: URL of the business's Twitter profile. videos: type: array items: type: string yearOfIncorporation: type: integer description: Year in which the business was established. youtubeUrl: type: 'null' required: - accountId - additionalCategoryIds - additionalInfo - additionalPhones - archived - archivedAt - billingPeriod - bizUrl - bookingUrl - businessHours - categoryId - city - countryIso - customAttributes - databaseId - description - facebookUrl - folderId - folderName - googleAdsPhone - googleplusUrl - hideAddress - id - instagramUrl - isRestaurant - latitude - linkedinUrl - locationPhotos - longitude - moreHours - name - offeringsUrl - ownerEmail - ownerName - package - paymentMethods - phone - pinterestUrl - planId - planName - postalCode - publisherAttributes - reservationUrl - serviceItems - stateIso - storeId - street - street1 - subCategory - subCategoryId - subCategoryName - tagline - tags - temporarilyClosed - tiktokUrl - toplineMessage - toplineMessageText - twitterUrl - videos - yearOfIncorporation - youtubeUrl x-apidog-orders: - accountId - additionalCategoryIds - additionalInfo - additionalPhones - archived - archivedAt - billingPeriod - bizUrl - bookingUrl - businessHours - categoryId - city - countryIso - customAttributes - databaseId - description - facebookUrl - folderId - folderName - googleAdsPhone - googleplusUrl - hideAddress - id - instagramUrl - isRestaurant - latitude - linkedinUrl - locationPhotos - longitude - moreHours - name - offeringsUrl - ownerEmail - ownerName - package - paymentMethods - phone - pinterestUrl - planId - planName - postalCode - publisherAttributes - reservationUrl - serviceItems - stateIso - storeId - street - street1 - subCategory - subCategoryId - subCategoryName - tagline - tags - temporarilyClosed - tiktokUrl - toplineMessage - toplineMessageText - twitterUrl - videos - yearOfIncorporation - youtubeUrl description: Details of the created location. x-apidog-ignore-properties: [] success: type: boolean description: Indicates whether the location creation was successful. warnings: type: array items: type: string description: List of warnings generated during the request processing, if any. code: type: string required: - clientMutationId - errors - location - success - warnings - code x-apidog-orders: - clientMutationId - errors - location - success - warnings - code description: Encapsulates details about the created location. x-apidog-ignore-properties: [] required: - updateLocation x-apidog-orders: - updateLocation description: Contains the response data for the create location request. x-apidog-ignore-properties: [] required: - data x-apidog-orders: - data x-apidog-ignore-properties: [] examples: '1': summary: Success value: data: updateLocation: clientMutationId: null errors: null location: accountId: 16154 additionalCategoryIds: [] additionalInfo: null additionalPhones: - (415) 555-5678 - (415) 555-9012 archived: false archivedAt: null billingPeriod: null bizUrl: https://www.greenleafbakery.com/ bookingUrl: null businessHours: - day: SUNDAY slots: null specialDate: null type: CLOSED - day: MONDAY slots: - end: 12:00pm start: 08:00am - end: 06:00pm start: 01:00pm specialDate: null type: OPEN - day: TUESDAY slots: - end: 06:00pm start: 08:00am specialDate: null type: OPEN - day: WEDNESDAY slots: - end: 06:00pm start: 08:00am specialDate: null type: OPEN - day: THURSDAY slots: - end: 06:00pm start: 08:00am specialDate: null type: OPEN - day: FRIDAY slots: - end: 06:00pm start: 08:00am specialDate: null type: OPEN - day: SATURDAY slots: - end: 04:00pm start: 08:00am specialDate: null type: OPEN - day: SPECIAL slots: - end: 04:00pm start: 08:00am specialDate: '2025-07-12' type: OPEN categoryId: 1 city: San Francisco countryIso: US customAttributes: - archived: false enumValues: [] name: bollean01 slug: bollean01 type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: KAM slug: kam type: STRING value: - '' - archived: false enumValues: [] name: P_Test01 slug: p_test01 type: STRING value: - one12 - archived: false enumValues: [] name: ABC slug: abc type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: NJL slug: njl type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: ZZZ slug: zzz type: STRING value: [] - archived: false enumValues: [] name: ALL slug: all type: STRING value: - ss - archived: false enumValues: - gulab jamun - rasgulla - ras malai - jalebi name: Dessets slug: dessets type: ENUM value: - gulab jamun - archived: false enumValues: [] name: Attrs slug: attrs type: STRING value: [] - archived: false enumValues: [] name: Attrs2 slug: attrs2 type: STRING value: [] - archived: false enumValues: [] name: Toll-free Number slug: toll-free_number type: INTEGER value: - '80044637' - archived: false enumValues: [] name: amenities slug: amenities type: ARRAY value: - wifi - wheelchair - welcoming ceremony - archived: false enumValues: [] name: amenities02 slug: amenities02 type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Amenities-check slug: amenities-check type: BOOLEAN value: - 'false' - archived: false enumValues: - Atr1 - atr2 - atr3 name: Prod_Attribute slug: prod_attribute type: ENUM value: - Atr1 - archived: false enumValues: [] name: wifi available slug: wifi_available type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: QQQQQQQ slug: qqqqqqq type: INTEGER value: - '123' - archived: false enumValues: [] name: int02 slug: int02 type: INTEGER value: [] - archived: false enumValues: [] name: Tasty slug: tasty type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: dhdop slug: dhdop type: STRING value: [] - archived: false enumValues: [] name: Abstract slug: abstract type: ARRAY value: - abs1 - abs2 - abs3 - archived: false enumValues: [] name: Senior Hours Required? slug: senior_hours_required? type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: kafka_check_attribute slug: kafka_check_attribute type: ARRAY value: - one - two - three - archived: false enumValues: [] name: Parking slug: parking type: BOOLEAN value: - 'false' - archived: false enumValues: [] name: googlePlaceId slug: googleplaceid type: STRING value: [] - archived: false enumValues: [] name: hoursComments slug: hourscomments type: STRING value: [] - archived: false enumValues: [] name: isOpen slug: isopen type: BOOLEAN value: [] - archived: false enumValues: [] name: has_bicycle_rack? slug: has_bicycle_rack? type: BOOLEAN value: [] - archived: false enumValues: - one - two name: quick slug: quick type: ENUM value: - one - archived: false enumValues: [] name: instagramUrl slug: instagramurl type: STRING value: [] - archived: false enumValues: [] name: analyticsTrackingFireEvent slug: analyticstrackingfireevent type: STRING value: [] - archived: false enumValues: [] name: placeholderText slug: placeholdertext type: STRING value: [] - archived: false enumValues: - FRND - MENMENMEN - BARNEY name: TV slug: tv type: ENUM value: - FRND - archived: false enumValues: [] name: notificationEmails slug: notificationemails type: ARRAY value: [] - archived: false enumValues: [] name: joinUrl slug: joinurl type: STRING value: [] - archived: false enumValues: [] name: account_att slug: account_att type: ARRAY value: - '1' - '2' - '4' - '3' - archived: false enumValues: [] name: Post v2 slug: post_v2 type: STRING value: [] - archived: false enumValues: [] name: testingthetest slug: testingthetest type: INTEGER value: - '0' - archived: false enumValues: [] name: int0 slug: int0 type: INTEGER value: - '0' - archived: false enumValues: [] name: url_appointment slug: url_appointment type: STRING value: [] - archived: false enumValues: [] name: Slug slug: slug type: STRING value: [] - archived: false enumValues: [] name: New Name slug: new_name type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: test200 slug: test200 type: STRING value: - test test - archived: false enumValues: [] name: Name slug: name type: STRING value: [] - archived: false enumValues: [] name: 'Test Department ' slug: test_department_ type: ARRAY value: [] - archived: false enumValues: [] name: 'Fresh Fish Section ' slug: fresh_fish_section_ type: STRING value: [] - archived: false enumValues: [] name: Test 28 11 22 slug: test_28_11_22 type: STRING value: - Test 28 - archived: false enumValues: [] name: blablacar slug: blablacar type: STRING value: [] - archived: false enumValues: [] name: requires temperature check customers slug: requires_temperature_check_customers type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Custom Tee Point slug: custom_tee_point type: STRING value: - tess - archived: false enumValues: [] name: appointment_required slug: appointment_required type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: requires masks customers slug: requires_masks_customers type: BOOLEAN value: [] - archived: false enumValues: [] name: is black owned slug: is_black_owned type: BOOLEAN value: [] - archived: false enumValues: [] name: BewAttribute slug: bewattribute type: STRING value: [] - archived: false enumValues: [] name: 'Pets 2 ' slug: pets_2_ type: ARRAY value: [] - archived: false enumValues: [] name: test214122 slug: test214122 type: STRING value: - test2 - archived: false enumValues: [] name: Test123 slug: test123 type: STRING value: [] - archived: false enumValues: [] name: ohiiiignore slug: ohiiiignore type: STRING value: [] - archived: false enumValues: [] name: yesnotest slug: yesnotest type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: account_leve_test_for_ext slug: account_leve_test_for_ext type: STRING value: [] - archived: false enumValues: [] name: Custom location ID slug: custom_location_id type: STRING value: [] - archived: false enumValues: [] name: Account Attr slug: account_attr type: ARRAY value: - one - two - three - archived: false enumValues: - b - a - c name: enum01 slug: enum01 type: ENUM value: - a - archived: false enumValues: [] name: Paneer Speciality slug: paneer_speciality type: STRING value: - https://sy-media-store.s3-us-west-2.amazonaws.com/f5c4e13cfb1ad0bb962adf283472dc97/ba2a41b19668c5cba709dd63ff2e7f30/be9eafc1-78ca-4515-a164-005a28db4e69.jpg - archived: false enumValues: [] name: welcomes_lgbtq slug: welcomes_lgbtq type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: Lgbtq+ friendly slug: lgbtq+_friendly type: BOOLEAN value: - 'true' - archived: false enumValues: [] name: analyticsTrackingScript slug: analyticstrackingscript type: STRING value: [] databaseId: 1182718 description: Greenleaf Bakery offers a delightful selection of organic and gluten-free baked goods. Our mission is to provide fresh, handmade pastries and cakes crafted with love and the finest ingredients. Visit us for a cozy experience and enjoy our special seasonal treats! facebookUrl: https://www.facebook.com/GreenleafBakery/ folderId: 401228fe-8ee9-4914-a08a-db7cda490ec9 folderName: root googleAdsPhone: '4155553456' googleplusUrl: null hideAddress: false id: TG9jYXRpb246MTE4MjcxOA== instagramUrl: https://www.instagram.com/greenleafbakery/ isRestaurant: false latitude: 37.8273838 linkedinUrl: https://www.linkedin.com/company/greenleafbakery locationPhotos: [] longitude: -122.3699943 moreHours: [] name: Greenleaf Bakery 2 offeringsUrl: null ownerEmail: info@greenleafbakery.com ownerName: Emma Thompson package: PREMIUM paymentMethods: - VISA - CASH phone: '4155551239' pinterestUrl: https://www.pinterest.com/greenleafbakery/ planId: 86 planName: V2 Premium Slow + Fast Sites postalCode: '94107' publisherAttributes: [] reservationUrl: null serviceItems: [] stateIso: CA storeId: null street: 123 Maple Avenue 1 street1: Suite 2021 subCategory: databaseId: 10 id: U3ViQ2F0ZWdvcnk6MTA= name: Climbing primary: true subCategoryId: 10 subCategoryName: Climbing tagline: Fresh. Organic. Delicious. tags: - all - uiuu - 110331jan225 temporarilyClosed: false tiktokUrl: null toplineMessage: null toplineMessageText: null twitterUrl: https://twitter.com/GreenleafBakery videos: [] yearOfIncorporation: 2015 youtubeUrl: null success: true warnings: [] '2': summary: Exception - Missing business_hours value: data: updateLocation: clientMutationId: null errors: - code: SY10031 contextInfo: - key: business_hours value: '{"days"=>{"Monday"=>{"type"=>"split", "slots"=>[{"start"=>"08:00am", "end"=>"12:00pm"}, {"start"=>"01:00pm", "end"=>"06:00pm"}]}, "Tuesday"=>{"type"=>"open", "slots"=>[{"start"=>"08:00am", "end"=>"06:00pm"}]}, "Wednesday"=>{"type"=>"open", "slots"=>[{"start"=>"08:00am", "end"=>"06:00pm"}]}, "Thursday"=>{"type"=>"open", "slots"=>[{"start"=>"08:00am", "end"=>"06:00pm"}]}, "Friday"=>{"type"=>"open", "slots"=>[{"start"=>"08:00am", "end"=>"06:00pm"}]}, "Saturday"=>{"type"=>"open", "slots"=>[{"start"=>"08:00am", "end"=>"04:00pm"}]}, "2025-07-12"=>{"type"=>"open", "slots"=>[{"start"=>"08:00am", "end"=>"04:00pm"}]}}}' message: All days of the week should be included in the business hours location: null success: false warnings: null '3': summary: 'Invalid Business Hours: All Days Required' value: data: updateLocation: clientMutationId: null errors: - code: SY10092 contextInfo: - key: business_hours value: '{"days"=>{"Sunday"=>{"type"=>"closed"}}}' message: Operational hours can not be closed for all days of the week location: null success: false warnings: null '4': summary: Exception value: errors: - message: Variable "$input" got invalid value {"tenure":"Yearly","id":"TG9jYXRpb246MTE5NTI1OQ==","name":"Greenleaf Bakery 2","businessHours":[{"day":"SUNDAY","slots":null,"specialDate":null,"type":"CLOSED"},{"day":"MONDAY","slots":[{"end":"12:00pm","start":"08:00am"},{"end":"06:00pm","start":"01:00pm"}],"specialDate":null,"type":"OPEN"},{"day":"TUESDAY","slots":[{"end":"06:00pm","start":"08:00am"}],"specialDate":null,"type":"OPEN"},{"day":"WEDNESDAY","slots":[{"end":"06:00pm","start":"08:00am"}],"specialDate":null,"type":"OPEN"},{"day":"THURSDAY","slots":[{"end":"06:00pm","start":"08:00am"}],"specialDate":null,"type":"OPEN"},{"day":"FRIDAY","slots":[{"end":"06:00pm","start":"08:00am"}],"specialDate":null,"type":"OPEN"},{"day":"SATURDAY","slots":[{"end":"04:00pm","start":"08:00am"}],"specialDate":null,"type":"OPEN"},{"day":"SPECIAL","slots":[{"end":"04:00pm","start":"08:00am"}],"specialDate":"2025-07-12","type":"OPEN"}]}; Field "tenure" is not defined by type UpdateLocationInput. headers: {} x-apidog-name: OK '400': description: '' content: application/json: schema: type: object properties: {} x-apidog-orders: [] x-apidog-ignore-properties: [] headers: {} x-apidog-name: Bad Request security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13640375-run /locations/photos: post: summary: Upload Photos to a Location deprecated: false description: "
\n\n\nThis API allows you to add photos to a specific location. Photos can be of different types, including logos, cover photos, and additional images. \n\n\n:::info[]\n Each location can only have one logo and one cover photo.\n:::\n\nFor more details, refer to [Manage photos for your location](https://developer.synup.com/doc-833258.md).\n\n\n\n\n\n" operationId: uploadSingleLocationPhoto tags: - Locations parameters: - name: Authorization in: header description: API key for authentication required: true example: API T9V35W3xxxxxxxxxxx schema: type: string requestBody: content: application/json: schema: type: object required: - input properties: input: type: object required: - locationId - photos properties: locationId: type: string description: The ID of the location for which photos will be added examples: - TG9jYXRpb246MTA4NzIxMQ== photos: type: array items: type: object required: - photo - type properties: photo: type: string format: uri description: URL of the image examples: - https://via.placeholder.com/250?text=LOGO+Placeholder - https://via.placeholder.com/800x400?text=COVER+Placeholder - https://via.placeholder.com/600x400?text=ADDITIONAL+Image x-apidog-mock: '{{$image.url}}' type: type: string description: Type of photo enum: - LOGO - COVER - ADDITIONAL examples: - LOGO - COVER - ADDITIONAL x-apidog-enum: - value: LOGO name: '' description: Business logo image. - value: COVER name: '' description: Main cover photo for the business. - value: ADDITIONAL name: '' description: Additional images of the business. x-apidog-mock: LOGO x-apidog-orders: - photo - type x-apidog-orders: - locationId - photos x-apidog-orders: - input example: input: locationId: TG9jYXRpb246MTA4NzIxMQ== photos: - photo: https://via.placeholder.com/250?text=LOGO+Placeholder type: LOGO - photo: https://via.placeholder.com/800x400?text=COVER+Placeholder type: COVER - photo: https://via.placeholder.com/600x400?text=ADDITIONAL+Image type: ADDITIONAL responses: '200': description: '' content: application/json: schema: type: object properties: data: type: object properties: addLocationPhotos: type: object properties: success: type: boolean errors: type: 'null' photos: type: array items: type: object properties: databaseId: type: integer fileSize: type: integer id: type: string name: type: string starred: type: 'null' thumbnailUrl: type: string type: type: string url: type: string publisherOverride: type: string required: - databaseId - fileSize - id - name - starred - thumbnailUrl - type - url - publisherOverride x-apidog-orders: - databaseId - fileSize - id - name - starred - thumbnailUrl - type - url - publisherOverride request: type: object properties: requestId: type: 'null' status: type: 'null' required: - requestId - status x-apidog-orders: - requestId - status clientMutationId: type: 'null' required: - success - errors - photos - request - clientMutationId x-apidog-orders: - success - errors - photos - request - clientMutationId required: - addLocationPhotos x-apidog-orders: - addLocationPhotos required: - data x-apidog-orders: - data examples: '1': summary: Success value: data: addLocationPhotos: success: true errors: null photos: - databaseId: 5878931 fileSize: 48796 id: TWVkaWFGaWxlOjU4Nzg5MzE= name: 24ac8063-9289-43ef-9324-56627f7e1df1 starred: null thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/thumbnail_f47d62a6-fe4a-432d-a20a-db41c4c04d51.jpg type: LOGO url: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/f47d62a6-fe4a-432d-a20a-db41c4c04d51.jpg publisherOverride: '' - databaseId: 5878932 fileSize: 95636 id: TWVkaWFGaWxlOjU4Nzg5MzI= name: dd443241-48e5-43d2-83f6-a7e4bd2bb86f starred: null thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/thumbnail_ef4ffb12-aeb8-41b5-b03f-fbefa8106f79.jpg type: COVER url: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/ef4ffb12-aeb8-41b5-b03f-fbefa8106f79.jpg publisherOverride: '' - databaseId: 5878933 fileSize: 95636 id: TWVkaWFGaWxlOjU4Nzg5MzM= name: a460e19a-24ef-4cab-abb1-f7f0227f1b84 starred: null thumbnailUrl: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/thumbnail_8f734e46-ed72-41e2-8d70-e19b275f23e3.jpg type: ADDITIONAL url: https://sy-media-store.s3-us-west-2.amazonaws.com/f868bb3ff3898a2dc349ea61ca4d8a67/59c670a3536b937ec7910f7619ee3304/8f734e46-ed72-41e2-8d70-e19b275f23e3.jpg publisherOverride: '' request: requestId: null status: null clientMutationId: null '2': summary: Exception value: data: addLocationPhotos: success: false errors: message: 'SY10067: Logo/Cover image size should be between 10KB and 5MB' headers: {} x-apidog-name: Example Response '400': description: '' content: application/json: schema: type: object properties: message: type: string examples: - Variable "$input" got invalid value {"locationId":"TG9jYXRpb246MTA4NzIxMQ==","photos":[{"photo":"https://pngimg.com/uploads/minus/minus_PNG40.png","type":"NON EXISTENT"}]}; Expected type LocationMediaType at value.photos[0].type. required: - message x-apidog-orders: - message headers: {} x-apidog-name: Invalid input x-200:Example Response (Over 30 Photos): description: '' content: application/json: schema: type: object properties: data: type: object properties: addLocationPhotos: type: object properties: success: type: boolean errors: type: 'null' photos: type: array items: type: string request: type: object properties: requestId: type: string status: type: string required: - requestId - status x-apidog-orders: - requestId - status clientMutationId: type: 'null' required: - success - errors - photos - request - clientMutationId x-apidog-orders: - success - errors - photos - request - clientMutationId required: - addLocationPhotos x-apidog-orders: - addLocationPhotos required: - data x-apidog-orders: - data example: data: addLocationPhotos: success: true errors: null photos: [] request: requestId: e6c2d9d9-9a18-4015-88cf-9a4e19a6f49a status: PROCCESSING clientMutationId: null headers: {} x-apidog-name: Example Response (Over 30 Photos) security: [] x-apidog-folder: Locations x-apidog-status: released x-run-in-apidog: https://app.apidog.com/web/project/797384/apis/api-13642280-run components: schemas: Subscription: type: object properties: name: type: string description: The display name of the subscription plan examples: - Premium plan - Monthly paymentSubscriptionId: type: string description: Unique identifier for the subscription examples: - b8b5075f-35ff-4aaf-9580-44271e0dde34 planId: type: string description: Identifier for the subscription plan examples: - premium-1month tenure: type: string description: The subscription period examples: - Monthly x-apidog-orders: - name - paymentSubscriptionId - planId - tenure required: - name - paymentSubscriptionId - planId - tenure x-apidog-ignore-properties: [] x-apidog-folder: '' LocationAddOnCount: type: object properties: enabled: type: integer description: Locations with the add-on enabled. disabled: type: integer description: Locations with the add-on disabled. othersEnabled: type: array description: Counts for other add-ons in the same product umbrella. items: $ref: '#/components/schemas/AddOnCount' x-apidog-orders: - enabled - disabled - othersEnabled x-apidog-ignore-properties: [] x-apidog-folder: '' GoogleVerificationLocationStats: type: object properties: total: type: integer verified: type: integer underReview: type: integer pendingVerification: type: integer duplicate: type: integer suspended: type: integer notVerified: type: integer errorWhileFetching: type: integer notConnected: type: integer listingNotPresent: type: integer x-apidog-orders: - total - verified - underReview - pendingVerification - duplicate - suspended - notVerified - errorWhileFetching - notConnected - listingNotPresent x-apidog-ignore-properties: [] x-apidog-folder: '' PageInfo: type: object properties: hasNextPage: type: boolean description: Indicates if there are more pages available hasPreviousPage: type: boolean description: Indicates if there are previous pages available totalPages: type: integer description: Total number of pages available totalRecords: type: integer description: Total number of records across all pages x-apidog-orders: - hasNextPage - hasPreviousPage - totalPages - totalRecords x-apidog-folder: '' LocationPackageCount: type: object properties: freemiumCount: type: integer description: Number of freemium-tier locations. premiumCount: type: integer description: Number of premium-tier locations. x-apidog-orders: - freemiumCount - premiumCount x-apidog-ignore-properties: [] x-apidog-folder: '' SubscriptionsResponse: type: object properties: data: type: object properties: activeSubscriptions: type: array items: $ref: '#/components/schemas/Subscription' x-apidog-orders: - activeSubscriptions required: - activeSubscriptions x-apidog-ignore-properties: [] x-apidog-orders: - data required: - data x-apidog-ignore-properties: [] x-apidog-folder: '' LocationSearchFilterType: type: object properties: tags: type: array items: type: string folders: type: array items: type: string categories: type: array items: type: string additionalCategories: type: array items: type: string primaryGbpSiteCategories: type: array items: $ref: '#/components/schemas/SitePublisherCategory' additionalGbpSiteCategories: type: array items: $ref: '#/components/schemas/SitePublisherCategory' x-apidog-orders: - tags - folders - categories - additionalCategories - primaryGbpSiteCategories - additionalGbpSiteCategories x-apidog-ignore-properties: [] x-apidog-folder: '' SitePublisherCategory: type: object properties: name: type: string description: Name of the category. value: type: integer description: Internal numeric identifier of the category. id: type: string description: GBP site category identifier. x-apidog-orders: - name - value - id x-apidog-ignore-properties: [] x-apidog-folder: '' AddOnCount: type: object properties: id: type: string name: type: string count: type: integer x-apidog-orders: - id - name - count x-apidog-folder: '' DownloadLocationsInBulkType: type: object properties: success: type: boolean description: Whether the export request was accepted. csvUrl: type: string description: URL of the CSV file (populated when the export completes). x-apidog-orders: - success - csvUrl x-apidog-ignore-properties: [] x-apidog-folder: '' LocationAdvancedSearchFilterType: type: object properties: country: type: array description: Countries present across the account's locations. items: type: object x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] state: type: array description: States present across the account's locations. items: type: object x-apidog-orders: [] properties: {} x-apidog-ignore-properties: [] city: type: array items: type: string zipcode: type: array items: type: string customAttrs: type: array description: Custom attribute names defined for the account. items: type: string x-apidog-orders: - country - state - city - zipcode - customAttrs x-apidog-ignore-properties: [] x-apidog-folder: '' LocationResponseSchema: type: object properties: accountId: type: integer additionalCategoryIds: type: array items: type: string additionalInfo: type: 'null' additionalPhones: type: array items: type: string archived: type: boolean archivedAt: type: 'null' billingPeriod: type: 'null' bizUrl: type: - string - 'null' bookingUrl: type: - string - 'null' categoryId: type: integer city: type: string countryIso: type: string customAttributes: type: array items: type: object properties: archived: type: boolean enumValues: type: array items: type: string name: type: string slug: type: string type: type: string value: type: array items: type: string x-apidog-orders: - archived - enumValues - name - slug - type - value x--orders: - archived - enumValues - name - slug - type - value x--ignore-properties: [] databaseId: type: integer description: type: string facebookUrl: type: - string - 'null' folderId: type: string folderName: type: string googleAdsPhone: type: string googleplusUrl: type: 'null' hideAddress: type: boolean id: type: string instagramUrl: type: - string - 'null' isRestaurant: type: boolean latitude: type: number linkedinUrl: type: string locationPhotos: type: array items: type: string longitude: type: number moreHours: type: array items: type: string name: type: string offeringsUrl: type: - string - 'null' ownerEmail: type: string ownerName: type: string package: type: string paymentMethods: type: array items: type: string phone: type: string pinterestUrl: type: string planId: type: integer planName: type: string postalCode: type: string publisherAttributes: type: array items: type: string reservationUrl: type: string serviceItems: type: array items: type: string stateIso: type: string storeId: type: 'null' street: type: string street1: type: string subCategory: type: object properties: databaseId: type: integer id: type: string name: type: string primary: type: boolean required: - databaseId - id - name - primary x-apidog-orders: - databaseId - id - name - primary x--orders: - databaseId - id - name - primary x--ignore-properties: [] subCategoryId: type: integer subCategoryName: type: string tagline: type: string tags: type: array items: type: string temporarilyClosed: type: boolean tiktokUrl: type: 'null' toplineMessage: type: 'null' toplineMessageText: type: 'null' twitterUrl: type: string videos: type: array items: type: string yearOfIncorporation: type: integer youtubeUrl: type: 'null' placeActionLinks: type: array items: type: object properties: placeActionType: type: string enum: - FOOD_ORDERING FOOD_ORDERING - ONLINE_APPOINTMENT - APPOINTMENT - DINING_RESERVATION - FOOD_DELIVERY - FOOD_TAKEOUT - SHOP_ONLINE x-apidog-enum: - value: FOOD_ORDERING FOOD_ORDERING name: '' description: '' - value: ONLINE_APPOINTMENT name: '' description: '' - value: APPOINTMENT name: '' description: '' - value: DINING_RESERVATION name: '' description: '' - value: FOOD_DELIVERY name: '' description: '' - value: FOOD_TAKEOUT name: '' description: '' - value: SHOP_ONLINE name: '' description: '' uri: type: string isPreferred: type: boolean name: type: string submissionStatus: type: string submissionMessage: type: string lastSubmittedAt: type: string isEditable: type: string x-apidog-orders: - placeActionType - uri - isPreferred - name - submissionStatus - submissionMessage - lastSubmittedAt - isEditable required: - placeActionType - uri x--orders: - placeActionType - uri - isPreferred - name - submissionStatus - submissionMessage - lastSubmittedAt - isEditable x--ignore-properties: [] discoveredPlaceActionLinks: type: array items: type: object properties: placeActionType: type: string uri: type: string isPreferred: type: boolean name: type: string providerType: type: string isEditable: type: boolean x-apidog-orders: - placeActionType - uri - isPreferred - name - providerType - isEditable required: - placeActionType - uri - isPreferred - name - providerType - isEditable x--orders: - placeActionType - uri - isPreferred - name - providerType - isEditable x--ignore-properties: [] required: - accountId - additionalCategoryIds - additionalInfo - additionalPhones - archived - archivedAt - billingPeriod - categoryId - city - countryIso - customAttributes - databaseId - description - folderId - folderName - googleAdsPhone - googleplusUrl - hideAddress - id - latitude - locationPhotos - longitude - moreHours - name - ownerEmail - ownerName - package - paymentMethods - phone - pinterestUrl - planId - planName - postalCode - publisherAttributes - reservationUrl - serviceItems - stateIso - storeId - street - street1 - subCategory - subCategoryId - subCategoryName - tagline - tags - temporarilyClosed - tiktokUrl - toplineMessage - toplineMessageText - twitterUrl - videos - yearOfIncorporation - youtubeUrl x-apidog-orders: - accountId - additionalCategoryIds - additionalInfo - additionalPhones - archived - archivedAt - billingPeriod - bizUrl - bookingUrl - categoryId - 01JW6M5BJGNZ18EAK11FHYJF6H - city - countryIso - customAttributes - databaseId - description - facebookUrl - folderId - folderName - googleAdsPhone - googleplusUrl - hideAddress - id - instagramUrl - isRestaurant - latitude - linkedinUrl - locationPhotos - longitude - moreHours - name - offeringsUrl - ownerEmail - ownerName - package - paymentMethods - phone - pinterestUrl - planId - planName - postalCode - publisherAttributes - reservationUrl - serviceItems - stateIso - storeId - street - street1 - subCategory - subCategoryId - subCategoryName - tagline - tags - temporarilyClosed - tiktokUrl - toplineMessage - toplineMessageText - twitterUrl - videos - yearOfIncorporation - youtubeUrl - placeActionLinks - discoveredPlaceActionLinks x-apidog-refs: 01JW6M5BJGNZ18EAK11FHYJF6H: $ref: '#/components/schemas/Business%20hours' x--orders: - accountId - additionalCategoryIds - additionalInfo - additionalPhones - archived - archivedAt - billingPeriod - bizUrl - bookingUrl - categoryId - city - countryIso - customAttributes - databaseId - description - facebookUrl - folderId - folderName - googleAdsPhone - googleplusUrl - hideAddress - id - instagramUrl - isRestaurant - latitude - linkedinUrl - locationPhotos - longitude - moreHours - name - offeringsUrl - ownerEmail - ownerName - package - paymentMethods - phone - pinterestUrl - planId - planName - postalCode - publisherAttributes - reservationUrl - serviceItems - stateIso - storeId - street - street1 - subCategory - subCategoryId - subCategoryName - tagline - tags - temporarilyClosed - tiktokUrl - toplineMessage - toplineMessageText - twitterUrl - videos - yearOfIncorporation - youtubeUrl - placeActionLinks - discoveredPlaceActionLinks x--ignore-properties: [] x-apidog-folder: '' LocationSummaryConnectionType: type: object properties: edges: type: array items: $ref: '#/components/schemas/LocationSummaryEdge' nodes: type: array items: type: string pageInfo: $ref: '#/components/schemas/PageInfo' totalCount: type: integer description: Total number of records matching the filter. x-apidog-orders: - edges - nodes - pageInfo - totalCount x-apidog-ignore-properties: [] x-apidog-folder: '' LocationSummaryEdge: type: object properties: cursor: type: string node: type: string x-apidog-orders: - cursor - node x-apidog-ignore-properties: [] x-apidog-folder: ''