---
title: "List all locations"
method: GET
path: "/locations"
tags: ["Locations"]
---

# List all locations

`GET /locations`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/locations`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/locations/get.ts> (a function with typed inputs; its response is checked against the schema)

This API retrieves a paginated list of locations within the account, allowing for efficient data retrieval when managing multiple locations.

## Query parameters

- `first` integer
- `last` integer
- `after` string
- `before` string

## Headers

- `Authorization` string, required

## Response `200`

Successful response

- object
  - `data` object
    - `allLocations` object
      - `edges` object[]
        - `cursor` string
        - `node` LocationResponseSchema
          - `accountId` integer, required
          - `additionalCategoryIds` string[], required
          - `additionalInfo` unknown, required
          - `additionalPhones` string[], required
          - `archived` boolean, required
          - `archivedAt` unknown, required
          - `billingPeriod` unknown, required
          - `bizUrl` string, nullable
          - `bookingUrl` string, nullable
          - `categoryId` integer, required
          - `businessHours` object[]: Business hours for each day of the week
            - `day` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY' | 'SPECIAL', required: Day of the week | Special
            - `slots` object[], required: Array of time slots (minimum 1, maximum 2). Required only if type is OPEN.
              - …
            - `type` 'OPEN' | 'OPEN_24x7' | 'CLOSED', required: Type of business hours (e.g., OPEN, CLOSED, OPEN_24x7)
            - `specialDate` string: Day should be `SPECIAL`. Regular hours is mandatory. **Regular hours is mandatory for special hours to be allowed **
          - `city` string, required
          - `countryIso` string, required
          - `customAttributes` object[], required
            - `archived` boolean
            - `enumValues` string[]
            - `name` string
            - `slug` string
            - `type` string
            - `value` string[]
          - `databaseId` integer, required
          - `description` string, required
          - `facebookUrl` string, nullable
          - `folderId` string, required
          - `folderName` string, required
          - `googleAdsPhone` string, required
          - `googleplusUrl` unknown, required
          - `hideAddress` boolean, required
          - `id` string, required
          - `instagramUrl` string, nullable
          - `isRestaurant` boolean
          - `latitude` number, required
          - `linkedinUrl` string
          - `locationPhotos` string[], required
          - `longitude` number, required
          - `moreHours` string[], required
          - `name` string, required
          - `offeringsUrl` string, nullable
          - `ownerEmail` string, required
          - `ownerName` string, required
          - `package` string, required
          - `paymentMethods` string[], required
          - `phone` string, required
          - `pinterestUrl` string, required
          - `planId` integer, required
          - `planName` string, required
          - `postalCode` string, required
          - `publisherAttributes` string[], required
          - `reservationUrl` string, required
          - `serviceItems` string[], required
          - `stateIso` string, required
          - `storeId` unknown, required
          - `street` string, required
          - `street1` string, required
          - `subCategory` object, required
            - `databaseId` integer, required
            - `id` string, required
            - `name` string, required
            - `primary` boolean, required
          - `subCategoryId` integer, required
          - `subCategoryName` string, required
          - `tagline` string, required
          - `tags` string[], required
          - `temporarilyClosed` boolean, required
          - `tiktokUrl` unknown, required
          - `toplineMessage` unknown, required
          - `toplineMessageText` unknown, required
          - `twitterUrl` string, required
          - `videos` string[], required
          - `yearOfIncorporation` integer, required
          - `youtubeUrl` unknown, required
          - `placeActionLinks` object[]
            - `placeActionType` 'FOOD_ORDERING FOOD_ORDERING' | 'ONLINE_APPOINTMENT' | 'APPOINTMENT' | 'DINING_RESERVATION' | 'FOOD_DELIVERY' | 'FOOD_TAKEOUT' | 'SHOP_ONLINE', required
            - `uri` string, required
            - `isPreferred` boolean
            - `name` string
            - `submissionStatus` string
            - `submissionMessage` string
            - `lastSubmittedAt` string
            - `isEditable` string
          - `discoveredPlaceActionLinks` object[]
            - `placeActionType` string, required
            - `uri` string, required
            - `isPreferred` boolean, required
            - `name` string, required
            - `providerType` string, required
            - `isEditable` boolean, required
      - `pageInfo` PageInfoV2
        - `hasNextPage` boolean: Indicates if there are more pages available
        - `hasPreviousPage` boolean: Indicates if there are previous pages available
        - `totalPages` integer: Total number of pages available
        - `totalRecords` integer: Total number of records across all pages

## Other responses

- `400`: Bad location ID or invalid parameters

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)