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

# List Locations

`GET /api/v1/locations`

## Request

- Base URL: `https://api.flexiple.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.flexiple.com/api/v1/locations`
- Auth: one of:
  - none
  - HTTP bearer

## Query parameters

- `q` string
- `ids[]` integer[]
- `location_types[]` string[]
- `country_codes[]` string[]
- `dropdown` boolean
- `include_groups` boolean
- `page` integer
- `page_size` integer

## Response `200`

All locations

- object
  - `data` union[], required
    - union
      - DropdownLocation
        - `value` integer, required
        - `label` string, required
      - DropdownEntityGroup
        - `value` integer, required
        - `label` string, required
        - `member_ids` integer[], required
      - Location
        - `id` integer, required
        - `osm_id` integer, nullable, required
        - `osm_type` string, nullable, required
        - `city` string, nullable, required
        - `state` string, nullable, required
        - `country` string, nullable, required
        - `country_code` string, nullable, required
        - `formatted` string, required
        - `location_type` 'country' | 'state' | 'city', required
  - `meta` PaginationMeta, nullable
    - `total_count` integer
    - `total_pages` integer
    - `next_page` integer, nullable
    - `prev_page` integer, nullable
    - `current_page` integer
    - `page_size` integer

---

[API](https://skmtc.dev/flexiple/apis/flexiple-platform-api-v1.md) - [All operations](https://skmtc.dev/flexiple/apis/flexiple-platform-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/flexiple/apis/flexiple-platform-api-v1/revisions/27e7987859f2?raw)