---
title: "List locations"
method: GET
path: "/v1/locations"
tags: ["Location"]
---

# List locations

`GET /v1/locations`

Returns a paginated list of locations for the authenticated business.

The business is resolved from the API key (`X-BUSINESS-API-KEY`) or OAuth bearer token.
Cashiers and managers only see locations assigned to them.

## Query parameters

- `keywords` string
- `perPage` integer

## Headers

- `X-BUSINESS-API-KEY` string, required

## Response `200`

Paginated list of locations

- object
  - `data` object[]
    - `id` string, uuid, required — Location ID
    - `business_id` string, uuid, required — Business that owns this location
    - `name` string, required — Name of the location
    - `street` string, required — Street address
    - `city` string, required — City
    - `state` string, required — State or region
    - `country` string, required — Country code or name
    - `postal_code` string, required — Postal code
    - `active` boolean, required — Whether the location is active
    - `pickups` object[] — Pickup configurations linked to this location (empty when not loaded)
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `links` object — pagination links according to current page and per_page value
    - `first` string — the url of the first page according to current base url
    - `last` string — the url of the last page according to current `per_page` value
    - `prev` string — the url of the previous page of the current `page`, NULL if not exists
    - `next` string — the url of the next page of the current `page`, NULL if not exists
  - `meta` object — meta values for listing operations
    - `current_page` number — the current page number
    - `per_page` number — the number of items for show for the current listing response
    - `from` number — the index that current listing page starts
    - `to` number — the index that current listing page ends
    - `total` number — the total of items found that match current listing filter
    - `last_page` number — the number that represents the last page of the listing according to the current `per_page` and filter
    - `path` string — the base listing url that doesn't contain params
    - `links` object[] — the array of pagination link
      - `url` string — the url of the paginated link
      - `label` string — label for this link
      - `active` boolean — is the current link the active page or not

## Other responses

- `401` — Missing or invalid API key / OAuth token

---

[API](https://skmtc.net/hitpayapp/apis/hitpay-api.md) · [All operations](https://skmtc.net/hitpayapp/apis/hitpay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hitpayapp/hitpay-api/revisions/6aae1a736990/schema)