---
title: "All locations that belong to an account."
method: GET
path: "/api/v4/locations"
tags: ["Locations"]
---

# All locations that belong to an account.

`GET /api/v4/locations`

Returns a cursor-paginated list of locations in your account.

## Query parameters

- `first` integer
- `after` string
- `last` integer
- `before` string
- `filter` string — JSON-encoded filter object

## Response `200`

Successful response

- object
  - `edges` object[], required
    - `node` LocationSummaryConnectionType, required — A Relay connection over LocationSummary.
      - `edges` LocationSummaryEdgeType[]
        - `cursor` string, required
        - `node` LocationSummaryType — Summary view of a business location.
          - `id` string, required
          - `databaseId` integer
          - `storeId` string
          - `name` string, required
          - `street` string
          - `city` string
          - `stateIso` string
          - `countryIso` string
          - `postalCode` string
          - `latitude` number, float
          - `longitude` number, float
          - `phone` string
          - `website` string
          - `status` 'ACTIVE' | 'ARCHIVED' | 'PENDING' | 'TEMPORARILY_CLOSED' | 'SCHEDULED_FOR_ARCHIVE' — Lifecycle states of a location.
          - `primaryGbpSiteCategoryId` string
          - `additionalGbpSiteCategoryIds` string[]
          - `serviceArea` ServiceAreaType[]
            - `businessType` string
            - `regionCode` string
            - `placeInfos` PlaceInfoType[]
              - …
          - `tags` TagType[]
            - `id` string, required
            - `name` string, required
          - `folders` FolderType[]
            - `id` string, required
            - `databaseId` integer
            - `name` string, required
            - `parentId` string
            - `root` boolean
            - `path` string
            - `depth` integer
            - `locationCount` integer
          - `placeActionLinks` PlaceActionLinkType[]
            - `placeActionType` string, required
            - `uri` string, required
            - `isPreferred` boolean
            - `name` string
            - `providerType` string
            - `isEditable` boolean
            - `submissionStatus` string
            - `submissionMessage` string
            - `submissionCode` string
            - `lastSubmittedAt` string
          - `discoveredPlaceActionLinks` PlaceActionLinkType[]
            - `placeActionType` string, required
            - `uri` string, required
            - `isPreferred` boolean
            - `name` string
            - `providerType` string
            - `isEditable` boolean
            - `submissionStatus` string
            - `submissionMessage` string
            - `submissionCode` string
            - `lastSubmittedAt` string
      - `nodes` LocationSummaryType[]
        - `id` string, required
        - `databaseId` integer
        - `storeId` string
        - `name` string, required
        - `street` string
        - `city` string
        - `stateIso` string
        - `countryIso` string
        - `postalCode` string
        - `latitude` number, float
        - `longitude` number, float
        - `phone` string
        - `website` string
        - `status` 'ACTIVE' | 'ARCHIVED' | 'PENDING' | 'TEMPORARILY_CLOSED' | 'SCHEDULED_FOR_ARCHIVE' — Lifecycle states of a location.
        - `primaryGbpSiteCategoryId` string
        - `additionalGbpSiteCategoryIds` string[]
        - `serviceArea` ServiceAreaType[]
          - `businessType` string
          - `regionCode` string
          - `placeInfos` PlaceInfoType[]
            - `placeId` string, required
            - `placeName` string
        - `tags` TagType[]
          - `id` string, required
          - `name` string, required
        - `folders` FolderType[]
          - `id` string, required
          - `databaseId` integer
          - `name` string, required
          - `parentId` string
          - `root` boolean
          - `path` string
          - `depth` integer
          - `locationCount` integer
        - `placeActionLinks` PlaceActionLinkType[]
          - `placeActionType` string, required
          - `uri` string, required
          - `isPreferred` boolean
          - `name` string
          - `providerType` string
          - `isEditable` boolean
          - `submissionStatus` string
          - `submissionMessage` string
          - `submissionCode` string
          - `lastSubmittedAt` string
        - `discoveredPlaceActionLinks` PlaceActionLinkType[]
          - `placeActionType` string, required
          - `uri` string, required
          - `isPreferred` boolean
          - `name` string
          - `providerType` string
          - `isEditable` boolean
          - `submissionStatus` string
          - `submissionMessage` string
          - `submissionCode` string
          - `lastSubmittedAt` string
      - `pageInfo` PageInfoType, required — (also defined by notifications) (also defined by reviewfunnel) (also defined by contests) (also defined by social-media)
        - `hasNextPage` boolean, required
        - `hasPreviousPage` boolean, required
        - `startCursor` string
        - `endCursor` string
      - `totalCount` integer
    - `cursor` string, required
  - `pageInfo` object, required
    - `hasNextPage` boolean, required
    - `hasPreviousPage` boolean, required
    - `endCursor` string, nullable
    - `total` integer, nullable
  - `totalCount` integer

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `500` — Server error

---

[API](https://skmtc.net/listingsapi/apis/listings-api.md) · [All operations](https://skmtc.net/listingsapi/apis/listings-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/listingsapi/listings-api/revisions/9274a1eac380/schema)
