ANangelcam
location

Retrieve location details

get/locations/{location_id}/

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.

Path parameters

location_idinteger required

Location ID

Response

Returns location details.

idinteger required

Location ID

namestring required

Location name

descriptionstring nullable

Location description/note

is_armedboolean required

Whether the location is currently armed

next_armingstring date-time nullable required

Next scheduled arming time

next_disarmingstring date-time nullable required

Next scheduled disarming time

cameras_countinteger required

Number of cameras associated with this location

Example response

{
  "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.