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

# List locations

`GET /v1/locations`

## Request

- Base URL: `https://api.workwing.io`
- URL: `https://api.workwing.io/v1/locations`
- Auth: HTTP bearer

List locations with advanced filtering.

- `?locality=eq.London` - Filter by city
- `?postal_code=ilike.SW1*` - Filter by postal code prefix
- `?is_verified=is.true` - Only verified locations
- `?select=id,formatted_address,locality,postal_code` - Field selection
- `?order=created_at.desc` - Sorting

## Query parameters

- `select` string
- `order` string
- `limit` integer
- `offset` integer

## Response `200`

Array of locations

- object: Array of locations
  - `data` object[]
    - `id` string, uuid
    - `customer_id` string, uuid
    - `address_line1` string, nullable
    - `address_line2` string, nullable
    - `premise` string, nullable: Building name or number
    - `thoroughfare` string, nullable: Street name
    - `sublocality` string, nullable: Neighborhood or district
    - `locality` string, nullable: City or town
    - `administrative_area` string, nullable: State or province
    - `administrative_area_code` string, nullable
    - `postal_code` string, nullable
    - `country` string, nullable: ISO country code
    - `country_name` string, nullable
    - `formatted_address` string, nullable: Full formatted address string
    - `latitude` number, nullable
    - `longitude` number, nullable
    - `location_precision` string, nullable
    - `what3words_address` string, nullable
    - `plus_code` string, nullable
    - `location_type` string, nullable
    - `location_notes` string, nullable
    - `is_verified` boolean, nullable
    - `verified_at` string, date-time, nullable
    - `verified_by_user_id` string, uuid, nullable
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
    - `created_by_user_id` string, uuid, nullable
  - `meta` object
    - `request_id` string
    - `timestamp` string, date-time

## Other responses

- `401`: Default Response

---

[API](https://skmtc.dev/workwing/apis/workwing-api.md) · [All operations](https://skmtc.dev/workwing/apis/workwing-api/llms.txt) · [OpenAPI document](https://skmtc.dev/workwing/apis/workwing-api/revisions/54bb14368a35?raw)