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

# List locations

`GET /locations`

## Request

- Base URL: `https://public.escape.tech/v3`
- URL: `https://public.escape.tech/v3/locations`
- Auth: API key in header `X-ESCAPE-API-KEY`

List and search locations of the organization.

## Query parameters

- `cursor` string: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.
- `size` integer: The number of items to return per page
- `sortType` 'LAST_SEEN' | 'NAME' | 'TYPE': The type to sort by
- `sortDirection` 'asc' | 'desc': The direction to sort by
- `search` string
- `enabled` 'true' | 'false'
- `type` string[]

## Response `200`

OK

- object
  - `nextCursor` string, nullable, required
  - `totalCount` integer
  - `data` object[], required
    - `id` string, uuid, required: The location ID.
    - `name` string, required: The name of the location.
    - `type` string, required: The type of the location.
    - `enabled` boolean, required: Whether the location is enabled.
    - `lastSeenAt` string, nullable: The date and time the location agent last connected.
    - `ip` string, nullable: The IP address of the location.
    - `region` 'Asia' | 'Canada' | 'Europe' | 'UnitedStates' | 'null', nullable: The region of the location.
    - `isActive` boolean: Whether the location agent is currently active.
    - `tags` object[]: The tags associated with the location.
      - `id` string, uuid, required: The id of the tag
      - `name` string, required: The name of the tag
      - `color` string, required: The color of the tag
    - `links` object, required
      - `locationOverview` string, required: The URL of the location overview.

## Other responses

- `400`: Pagination error

---

[API](https://skmtc.dev/escape/apis/escape-public-api.md) - [All operations](https://skmtc.dev/escape/apis/escape-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/escape/apis/escape-public-api/revisions/2eab35df40c7?raw)