Bridges

GET /bridges

Changed on Nov 3, 2026

A list of bridges can be retrieved using this endpoint. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available bridges, not the number of bridges resulting from the query string.

Request

Base URL
https://api.cxxx.eagleeyenetworks.com/api/v3.0
URL
https://api.cxxx.eagleeyenetworks.com/api/v3.0/bridges
Auth
HTTP bearer

Query parameters

includestring[]

sortstring[]

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

pageTokenstring

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.

pageSizeinteger

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.

locationId__instring[]

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

[
  "2428fda3-389f-48ce-b062-85875dd6b2e2"
]

tags__containsstring[]

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

[
  "string"
]

tags__anystring[]

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

[
  "string"
]

name__containsstring

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

name__instring[]

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

namestring

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

id__instring[]

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

id__containsstring

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

qstring

Example:entrance

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: id, accountId, name, notes, tags, timeZone.zone, devicePosition.floor, and metadata of important linked resources such as the location.

qRelevance__gtenumber float

Example:0.5

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).

status__inDeviceConnectionStatus[]

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

status__neDeviceConnectionStatus[]

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

Response

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

totalSizeinteger required

Size of the total result set.

Example response

{
  "results": [
    {
      "id": "1002bc5a",
      "accountId": "00001106",
      "name": "My new device",
      "locationId": "2428fda3-389f-48ce-b062-85875dd6b2e2",
      "createTimestamp": "2023-04-04T09:38:37.372Z",
      "statusV2": {
        "cloudConnectionStatus": "connected",
        "edgeReportedDeviceStatus": "operational",
        "deviceSpecificError": "generalDeviceError"
      },
      "timeZone": {
        "zone": "America/Chicago"
      },
      "notes": "Painted black to better blend with its environment.",
      "devicePosition": {
        "latitude": 52.3074013,
        "longitude": 4.9459903,
        "floor": 50
      },
      "networkInfo": {
        "globalIP": "10.143.55.140",
        "adapters": [
          {
            "macAddress": "8A:D4:AD:09:DF:91",
            "ipAddress": "10.143.55.140"
          }
        ]
      },
      "deviceInfo": {
        "serialNumber": "100000009061f5db",
        "guid": "ddfa5b34-5d04-431e-8287-110fe87edf71"
      },
      "resourceCounts": {
        "cameras": 23,
        "speakers": 1,
        "multiCameras": 1
      },
      "qRelevance": 0.5
    }
  ]
}

Changes

Nov 3, 2026c57fdb07bd73 Revision changes
- breaking
  removed the enum value address from the property items/ of the query request parameter include
- breaking
  removed the enum value childLocationCount from the property items/ of the query request parameter include
- breaking
  removed the enum value geometry from the property items/ of the query request parameter include
- breaking
  the /////// response's property type changed from no type to object for status
- breaking
  the /////// response's property type changed from no type to object for status
- breaking
  the /////// response's property type changed from no type to object for status
- info
  for the query request parameter sort, the maxItems was increased from 1 to 3
- info
  for the query request parameter name, the minLength was decreased from 1 to 0
- info
  for the query request parameter name__contains, the minLength was decreased from 3 to 0
- info
  added the enum value +locationSummary.name to the property items/ of the query request parameter sort
- info
  added the enum value +qRelevance to the property items/ of the query request parameter sort
- info
  added the enum value -locationSummary.name to the property items/ of the query request parameter sort
- info
  added the enum value -qRelevance to the property items/ of the query request parameter sort
- info
  added the enum value deviceAddress to the property items/ of the query request parameter include
- info
  added the enum value deviceInfo to the property items/ of the query request parameter include
- info
  added the enum value devicePosition to the property items/ of the query request parameter include
- info
  added the enum value locationSummary to the property items/ of the query request parameter include
- info
  added the enum value networkInfo to the property items/ of the query request parameter include
- info
  added the enum value status to the property items/ of the query request parameter include
- info
  added the enum value statusV2 to the property items/ of the query request parameter include
- info
  added the enum value tags to the property items/ of the query request parameter include
- info
  added the enum value timeZone to the property items/ of the query request parameter include
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  the response optional property /////// became read-only for the status
- info
  the response optional property /////// became read-only for the status
- info
  the response optional property /////// became read-only for the status
- info
  removed subschema #2 from the /////// response property allOf list for the response status
- info
  removed subschema #2 from the /////// response property allOf list for the response status
- info
  removed subschema #2 from the /////// response property allOf list for the response status

Operation history