location

Retrieve location list

get/locations/

Request

  • Base URL
    https://api.angelcam.com/v1
  • Auth
    • OAuth 2
      Authorization codehttps://my.angelcam.com/oauth/authorize/, token URL https://my.angelcam.com/oauth/token/
      PasswordToken URL https://api.angelcam.com/oauth/token/
      Scopeslocations_access
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger

Limit result set. Example: 1.

offsetinteger

Return results starting at offset. Example: 10.

Response

Returns location list.

countinteger required

Total number of locations

nextstring uri nullable required

Next page from pagination

previousstring uri nullable required

Previous page from pagination

Example response

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "My house",
      "description": "Main bedroom",
      "is_armed": true,
      "next_arming": "2025-06-28T23:03:00Z",
      "next_disarming": null,
      "cameras_count": 3
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.