---
title: "List All Location Groups"
method: POST
path: "/v1/location-groups/"
tags: ["Locations"]
---

# List All Location Groups

`POST /v1/location-groups/`

Get a full list of all location groups in your Local Falcon account, including the number of locations and the Place IDs contained in each group.

Groups may be nested. A group with a parent is returned with `type` set to `child`, and its `parent` object identifies the containing group by `key` and `name`. Top-level groups are returned with `type` set to `parent`.

If more records exist than is allowed within the set `limit`, a value will be returned under `next_token` that can be used as a parameter to request the next page of results.

## Response `200`

Successful response

- object
  - `code` integer
  - `code_desc` boolean
  - `success` boolean
  - `message` boolean
  - `parameters` object
  - `data` object
    - `total` integer
    - `count` integer
    - `next_token` union
      - string
      - boolean
    - `groups` object[]
      - `key` string
      - `name` string
      - `type` 'parent' | 'child' — `parent` for a top-level group, `child` for a nested group.
      - `parent` object — Present only when `type` is `child`. Identifies the containing group.
        - `key` string
        - `name` string
      - `location_count` integer — The number of locations contained in the group.
      - `place_ids` string[] — The Place IDs of the locations contained in the group.
      - `date_created` string

## Other responses

- `400` — The request was malformed or missing required parameters.
- `401` — The API key is missing, invalid, or does not have permission for the requested resource.
- `429` — You have exceeded the rate limit. Please wait before making additional requests.
- `500` — An unexpected error occurred on the server. Please try again later.

---

[API](https://skmtc.net/localfalcon/apis/local-falcon-api.md) · [All operations](https://skmtc.net/localfalcon/apis/local-falcon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/localfalcon/local-falcon-api/revisions/5487f4bd451b/schema)