---
title: "List all Locations"
method: GET
path: "/v1/terminal/locations"
---

# List all Locations

`GET /v1/terminal/locations`

Returns a list of `Location` objects.

## Query parameters

- `ending_before` string
- `expand` string[]
- `limit` integer
- `starting_after` string

## Response `200`

Successful response.

- object
  - `data` TerminalLocation[], required
    - `address` Address, required
      - `city` string, nullable — City, district, suburb, town, or village.
      - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
      - `line1` string, nullable — Address line 1, such as the street, PO Box, or company name.
      - `line2` string, nullable — Address line 2, such as the apartment, suite, unit, or building.
      - `postal_code` string, nullable — ZIP or postal code.
      - `state` string, nullable — State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
    - `address_kana` LegalEntityJapanAddress
      - `city` string, nullable — City/Ward.
      - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
      - `line1` string, nullable — Block/Building number.
      - `line2` string, nullable — Building details.
      - `postal_code` string, nullable — ZIP or postal code.
      - `state` string, nullable — Prefecture.
      - `town` string, nullable — Town/cho-me.
    - `address_kanji` LegalEntityJapanAddress
      - `city` string, nullable — City/Ward.
      - `country` string, nullable — Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
      - `line1` string, nullable — Block/Building number.
      - `line2` string, nullable — Building details.
      - `postal_code` string, nullable — ZIP or postal code.
      - `state` string, nullable — Prefecture.
      - `town` string, nullable — Town/cho-me.
    - `configuration_overrides` string — The ID of a configuration that will be used to customize all readers in this location.
    - `display_name` string, required — The display name of the location.
    - `display_name_kana` string — The Kana variation of the display name of the location.
    - `display_name_kanji` string — The Kanji variation of the display name of the location.
    - `id` string, required — Unique identifier for the object.
    - `livemode` boolean, required — If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
    - `metadata` object, required — Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    - `object` 'terminal.location', required — String representing the object's type. Objects of the same type share the same value.
    - `phone` string — The phone number of the location.
  - `has_more` boolean, required — True if this list has another page of items after this one that can be fetched.
  - `object` 'list', required — String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
  - `url` string, required — The URL where this list can be accessed.

## Other responses

- `default` — Error response.

---

[API](https://skmtc.net/stripe/apis/stripe-api.md) · [All operations](https://skmtc.net/stripe/apis/stripe-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stripe/stripe-api/versions/707de00b0616/schema)