---
title: "List Locations"
method: GET
path: "/v1/locations/location"
tags: ["API / Location", "Use case / Master data sync"]
---

# List Locations

`GET /v1/locations/location`

List all locations.

## Query parameters

- `cursor` string, nullable
- `external_id` string, nullable
- `external_id:in` string, nullable

## Response `200`

Successful Response

- ListLocationOutput
  - `next_cursor` string, nullable
  - `items` LocationDetailOutput[], required
    - `latitude` number, nullable — Latitude of the location.
    - `longitude` number, nullable — Longitude of the location.
    - `description` string, nullable — Free-text description of the location.
    - `selectable_on_customer_portal` boolean, nullable — Whether the location can be selected on the customer portal.
    - `code` string, nullable — Technical code for integrations/mapping logic; should be treated as stable once set.
    - `display_name` string, nullable — Human-readable label for a location in operational views.
    - `external_id` string, nullable — Identifier from an external (master data) system.
    - `address` string, nullable — First address line of the location
    - `address_second_line` string, nullable — Second address line of the location
    - `city` string, nullable — City of the location
    - `state` string, nullable — State of the location
    - `country` string, nullable — Country code (ISO 3166-1 alpha-2) of the location
    - `postal_code` string, nullable — Postal code of the location
    - `name` string, nullable — Name of the location
    - `id` string, uuid, nullable — Unique identifier of the location.
    - `opening_hours` WeekSchedule
      - `monday` DaySchedule
        - `enabled` boolean — Whether the location is open on this day.
        - `intervals` TimeInterval[], nullable — Opening intervals for the day. Multiple intervals allow for split opening hours.
          - `start_time` string, nullable — Opening time of the interval, formatted as HH:MM.
          - `end_time` string, nullable — Closing time of the interval, formatted as HH:MM.
      - `tuesday` DaySchedule
        - `enabled` boolean — Whether the location is open on this day.
        - `intervals` TimeInterval[], nullable — Opening intervals for the day. Multiple intervals allow for split opening hours.
          - `start_time` string, nullable — Opening time of the interval, formatted as HH:MM.
          - `end_time` string, nullable — Closing time of the interval, formatted as HH:MM.
      - `wednesday` DaySchedule
        - `enabled` boolean — Whether the location is open on this day.
        - `intervals` TimeInterval[], nullable — Opening intervals for the day. Multiple intervals allow for split opening hours.
          - `start_time` string, nullable — Opening time of the interval, formatted as HH:MM.
          - `end_time` string, nullable — Closing time of the interval, formatted as HH:MM.
      - `thursday` DaySchedule
        - `enabled` boolean — Whether the location is open on this day.
        - `intervals` TimeInterval[], nullable — Opening intervals for the day. Multiple intervals allow for split opening hours.
          - `start_time` string, nullable — Opening time of the interval, formatted as HH:MM.
          - `end_time` string, nullable — Closing time of the interval, formatted as HH:MM.
      - `friday` DaySchedule
        - `enabled` boolean — Whether the location is open on this day.
        - `intervals` TimeInterval[], nullable — Opening intervals for the day. Multiple intervals allow for split opening hours.
          - `start_time` string, nullable — Opening time of the interval, formatted as HH:MM.
          - `end_time` string, nullable — Closing time of the interval, formatted as HH:MM.
      - `saturday` DaySchedule
        - `enabled` boolean — Whether the location is open on this day.
        - `intervals` TimeInterval[], nullable — Opening intervals for the day. Multiple intervals allow for split opening hours.
          - `start_time` string, nullable — Opening time of the interval, formatted as HH:MM.
          - `end_time` string, nullable — Closing time of the interval, formatted as HH:MM.
      - `sunday` DaySchedule
        - `enabled` boolean — Whether the location is open on this day.
        - `intervals` TimeInterval[], nullable — Opening intervals for the day. Multiple intervals allow for split opening hours.
          - `start_time` string, nullable — Opening time of the interval, formatted as HH:MM.
          - `end_time` string, nullable — Closing time of the interval, formatted as HH:MM.

## Other responses

- `400` — Bad Request — invalid input or malformed request
- `401` — Unauthorized — missing or invalid authentication credentials
- `403` — Forbidden — insufficient permissions for this operation
- `422` — Validation Error
- `429` — Too Many Requests — rate limit exceeded. See the `Retry-After` header
- `500` — Internal Server Error
- `503` — Service Unavailable — temporarily unable to handle the request

---

[API](https://skmtc.dev/qargo/apis/qargo-tms-api.md) · [All operations](https://skmtc.dev/qargo/apis/qargo-tms-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/qargo/qargo-tms-api/revisions/17297902e7ce/schema)