---
title: "Retrieve location list"
method: GET
path: "/locations/"
tags: ["location"]
---

# Retrieve location list

`GET /locations/`

## Request

- Base URL: `https://api.angelcam.com/v1`
- URL: `https://api.angelcam.com/v1/locations/`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://my.angelcam.com/oauth/authorize/`, token URL `https://my.angelcam.com/oauth/token/`
    - Password, token URL `https://api.angelcam.com/oauth/token/`
    - Scopes: `locations_access`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/angelcam/apis/angelcam-api/docs/locations/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Returns location list.

- LocationListResponse
  - `count` integer, required: Total number of locations
  - `next` string, uri, nullable, required: Next page from pagination
  - `previous` string, uri, nullable, required: Previous page from pagination
  - `results` LocationObject[], required: List of locations
    - `id` integer, required: Location ID
    - `name` string, required: Location name
    - `description` string, nullable: Location description/note
    - `is_armed` boolean, required: Whether the location is currently armed
    - `next_arming` string, date-time, nullable, required: Next scheduled arming time
    - `next_disarming` string, date-time, nullable, required: Next scheduled disarming time
    - `cameras_count` integer, required: Number of cameras associated with this location

## Other responses

- `400`: Query params are invalid.
- `401`: Missing or invalid authorization.
- `403`: Missing permission.

---

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