API Reference
Getting startedVisit een.comMy Application/Login

/cameras

get
https://{BaseUrl}/api/v3.0/cameras

This endpoint allows you to retrieve a list of cameras associated with the account, with the ability to filter by account ID, location ID, bridge ID, multi-camera ID, and tags. It also supports pagination and the ability to include additional information about cameras. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available cameras, not the number of cameras resulting from the query string.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
locationId__in
array of strings

List of Location IDs to filter on that is comma separated.

locationId__in
bridgeId__in
array of strings

List of Bridge IDs to filter on that is comma separated.

bridgeId__in
string

Filter to get cameras with given multiCameraId. multiCameraId=null returns cameras that are not multi camera cameras.

string

Filter to get cameras with multiCameraId that is not equal to given value.

multiCameraId__in
array of strings

List of multi camera IDs to filter on that is comma seperated.

multiCameraId__in
tags__contains
array of strings

Only return cameras that have all tags in the list, separated by commas.

tags__contains
tags__any
array of strings

Only return cameras that have one or more of the tags in the list, separated by commas.

tags__any
packages__contains
array of strings

Only return cameras that have enabled all packages in the list, separated by commas.

packages__contains
string

Filter to get cameras that are part of the given layout.

string

Filter to get the cameras whose the name contains the provided substring. The lookup is exact and case insensitive

name__in
array of strings

Filter to get the cameras whose name is on the provided list. The lookup is exact and case insensitive.

name__in
string

Filter to get the cameras with the specified name. The lookup is exact and case insensitive.

id__in
array of strings

Filter to get the cameras whose id is on the provided list. The lookup is exact and case insensitive.

id__in
id__notIn
array of strings

Filter to exlude the cameras whose ids are in the provided list. The lookup is exact and case insensitive.

id__notIn
string

Filter to get the cameras whose the id contains the provided substring. The lookup is exact and case insensitive

boolean

If set to true, only cameras that are shared with the current account by another account will be returned. If set to false, the cameras that are shared with the current account will be filtered out.

string

Filter to get the cameras that are shared from the provided account.

boolean

If set to true, only cameras that are shared with the current account using the "First responder" feature will be returned. If set to false, the cameras that are shared with the current account using the "First responder" feature will be filtered out.

boolean

If set to true, only cameras that connect directly to the VMS cloud, and not through a bridge will be returned. If set to false, the cameras that connect directly to the VMS cloud will be filtered out.

speakerId__in
array of strings

Filter to get cameras that are a part of the given speaker esn.

speakerId__in
string

Text search that is applied to multiple fields. The fields being searched are defined by the backend and can be changed without warning. Example fields being searched are metadata fields of the camera itself such as id, name, notes, timezone, multiCameraId, speakerId and tags; the important ids such as accountId, bridgeId, and, locationId, and metadata of important linked resources such as the location, bridge, share details, device position, device info and the viewports configured for the camera.

float
0 to 1

Sets the current minimum similarity threshold that is used with the q parameter. The threshold must be between 0 and 1 (float, default is 0.5).

enabledAnalytics__contains
array of strings

Only return cameras that have enabled all analytics in the comma-separated list.

enabledAnalytics__contains
status__in
array of objects

Filter to get the devices with the specified status. The lookup is exact and case insensitive.

status__in
status__ne
array of strings

Filter to get the devices with status that is not equal to the provided value. The lookup is exact and case insensitive.

status__ne
include
array of strings
include
string

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

integer
1 to 500
Defaults to 100

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

sort
array of strings
Defaults to +name

Comma separated list of of fields that should be sorted.

  • sort= - not providing any value will result in error 400
  • sort=+name,+name - same values will result in error 400
  • sort=-name,+name - mutially exclusive values will return error 400
  • maxItem=3 - Only Three values will be accepted, more will return error 400
  • qRelevance is optional ordering parameter which is available if q filter is used, if q filter is not passed qRelevance as ordering parameter will return error 400
sort
Responses

Updated 5 months ago

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

Updated 5 months ago