List locations with their cameras

Returns details of all cameras within the organization, grouped by location and by the core they are connected to. Optionally filtered with status to the cameras in a given state: that shortens the cameras lists without removing any location or core, so the shape of the answer does not depend on the filter.

Required scope: read:locations

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Set to true to include the health status of the camera components.

boolean
Defaults to false

Set to true to include core local network configuration (DNS proxy URLs) for each camera. Defaults to false.

status
array of strings

Comma-separated list of camera statuses to keep: online, offline, unhealthy. Returns only the cameras whose status is one of these; offline,unhealthy is everything that needs attention. The shape of the answer does not change — every location and core is still returned, with a shorter cameras list — so an empty cameras array means that core has no camera in the requested state, not that it has no cameras. Cores keep their own status and are never filtered. Omit it to return every camera.

status
Allowed:
Responses

500

Server error. Could not return the data.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*