---
title: "List Locations"
method: GET
path: "/public/v3/Locations"
tags: ["Locations"]
---

# List Locations

`GET /public/v3/Locations`

List all locations within the specified account.

## Query parameters

- `Name` string
- `LoadTiveProvidedLocations` boolean
- `OnlySavedLocations` boolean
- `PageSize` integer
- `PageNumber` integer

## Headers

- `x-tive-account-id` integer, required

## Response `200`

The requested locations

- LocationDetailResponsePaginatedResponse
  - `totalRecords` integer
  - `pageNumber` integer
  - `pageSize` integer
  - `data` LocationDetailResponse[], nullable
    - `name` string, nullable
    - `coordinates` CoordinateResponse
      - `latitude` number, double
      - `longitude` number, double
    - `address` AddressResponse
      - `street` string, nullable
      - `sublocality` string, nullable
      - `locality` string, nullable
      - `state` string, nullable
      - `country` string, nullable
      - `postalCode` string, nullable
    - `formattedAddress` string, nullable
    - `locationMethod` string, nullable
    - `locationOrigin` 1 | 2 | 3 | 4
    - `nodeType` 'Warehouse' | 'ConsumerPickupPoint' | 'DistributionCenter' | 'RiskZone' | 'Airport' | 'Seaport' | 'ProductionFacility' | 'Terminal' | 'BorderCrossing' | 'ServiceStop'
    - `shareLocation` boolean
    - `shareLocationExternally` boolean
    - `includeCollaboratorsWhenSharing` boolean
    - `labels` Label[], nullable
      - `labelId` integer
      - `labelText` string, nullable
    - `id` integer
    - `numberOfShipmentsUsing` integer
    - `accountId` integer
    - `radius` RadiusResponse
      - `radiusValue` number, double
      - `selectedRadiusUnit` string, nullable
    - `collaborators` LocationCollaboratorResponse[], nullable
      - `email` string, nullable
      - `roleName` string, nullable
    - `alertPresets` LocationAlertPresetResponse[], nullable
      - `alertPresetId` integer
      - `name` string, nullable
  - `next` string, nullable
  - `previous` string, nullable

## Other responses

- `400` — The requested locations are not available
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/tive/apis/tive-public-api.md) · [All operations](https://skmtc.net/tive/apis/tive-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tive/tive-public-api/revisions/9a8d869e3cdc/schema)