--- title: "GET /bridges" method: GET path: "/bridges" tags: ["Bridges"] --- # GET /bridges `GET /bridges` 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. ## Query parameters - `include` string[] - `sort` string[] - `pageToken` string - `pageSize` integer - `locationId__in` string[] - `tags__contains` string[] - `tags__any` string[] - `name__contains` string - `name__in` string[] - `name` string — Name of the item. - `id__in` string[] - `id__contains` string - `q` string - `qRelevance__gte` number, float - `status__in` DeviceConnectionStatus[] - `status__ne` DeviceConnectionStatus[] ## Response `200` OK - ApiPaginatedBridgeResponse — Used to wrap results for a paginated response, containing information on how to retrieve further pages. - `nextPageToken` string, 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. - `prevPageToken` string, 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. - `results` object[], required — The result set from a collection API call. - `id` string, required — Unique bridge identifier - `accountId` string, required — Account ID specified in as an ESN Type. - `name` string, required — User-defined name for the device. - `locationId` string, nullable — ID Of the location. - `createTimestamp` string, date-time, required - `status` DeviceStatus — Indicates various aspects of the device's status. The statuses defined here should be in sync with the events schema defined for the Device Cloud Status Update. - `connectionStatus` 'online' | 'deviceOffline' | 'invalidCredentials' | 'bridgeOffline' | 'off' | 'error' | 'busy' | 'unknown' — Indicates the connection status of the device: * `online`: The device is online and operational. * `deviceOffline`: The device is offline. * `invalidCredentials`: The known credentials for this device, including the default credentials, are invalid. This is causing the device to appear offline. * `bridgeOffline`: The bridge that connects this device to the cloud is offline. However, both the device and the bridge may still be operational locally, even though the cloud has no visibility into their status. * `off`: The device is online, but has been turned off by the user. * `error`: The device is offline due to some problem that has not been described by any of the other statuses. * `busy`: The device is currently busy and unavailable for other operations. * `unknown`: The device state is unknown for some reason. - `statusV2` DeviceStatusV2 — Status as reported by the edge device. - `cloudConnectionStatus` 'connected' | 'disconnected', required — Socket connection state between device and cloud * `connected`: The device socket connected to cloud. * `disconnected`: The device socket disconnected from cloud. - `edgeReportedDeviceStatus` 'operational' | 'error' | 'disabled' | 'unreachable' | 'unknown' | 'initializing', required — Indicates the operational status of the device. The statuses defined here should be in sync with the DeviceStatus schema. * `operational`: The device is online and operational. * `error`: Device not working (requires error details). * `disabled`: Operational but intentionally not recording telemetry * `unreachable`: The device is not reachable (e.g., offline, out of service). * `unknown`: The device state is unknown for some reason. * `initializing`: The device is in the process of initializing. - `deviceSpecificError` 'disconnectedFromBridge' | 'generalDeviceError' | 'networkError' | 'invalidCredentials' | 'deviceSupportIssue' | 'queuedForConfiguration' | 'configurationInProgress' | 'deviceDisabled' | 'analogNoPower' | 'analogBadSignal' | 'analogIncompatibleSignal' | 'analogNoSignal' — Indicates the detailed error status of a device, grouped by device type: ONVIF Camera / RTSP Camera / Multicamera: * `generalDeviceError`: Camera error * `networkError`: Network error * `invalidCredentials`: Invalid credentials * `deviceSupportIssue`: Device support issue * `queuedForConfiguration`: Queued for configuration * `configurationInProgress`: Configuration in progress * `deviceDisabled`: Device is turned off * `disconnectedFromBridge`: Disconnected from bridge Analog Camera: * `analogNoPower`: Power loss detected * `analogBadSignal`: Signal quality issue * `analogIncompatibleSignal`: Incompatible signal * `analogNoSignal`: No signal * `disconnectedFromBridge`: Disconnected from bridge * `deviceDisabled`: Device is turned off Managed Switch: * `deviceSupportIssue`: Switch support issue * `disconnectedFromBridge`: Disconnected from bridge - `locationSummary` LocationSummary — Summary of location information. - `id` string - `name` string - `address` object - `country` string, nullable - `region` string, nullable - `city` string, nullable - `streetAddress` string, nullable - `streetAddress2` string, nullable - `postalCode` string, nullable - `timeZone` ApiTimeZone - `zone` string — The timezone the device is in. The list of supported timezones is provided by the [/timeZones](https://developer.eagleeyenetworks.com/reference/listtimezones) endpoint. - `deviceAddress` DeviceAddress — Address of the device. - `name` string, nullable - `address` string, nullable - `notes` string - `tags` string[] - `devicePosition` ApiDevicePosition2 - `latitude` number, double, nullable — The latitude of the device. (WGS 84) - `longitude` number, double, nullable — The longitude of the device. (WGS 84). - `floor` integer, nullable - `networkInfo` ApiNetworkInfo - `globalIP` string, nullable - `adapters` ApiAdapterInfo[] - `macAddress` string, nullable - `ipAddress` string, nullable - `deviceInfo` ApiDeviceInfo1 — Base schema for device information. Contains common fields shared across all device types (bridges, sensor gateways, sensor devices). - `icon` string — This field allows UIs to roughly differentiate between device types when displaying a list of devices. * Important: this should not be used in any way to decide on what functionality is available for a device, that logic should be based on the capabilities and possibly the settings endpoints. * Important: more enum values might be added in the future, clients should handle new values by having a fallback icon, eg a generic "device" icon. * Important: The value for a specific model might change without notice. - `serialNumber` string — The serial number of the device. - `guid` string, uuid - `effectivePermissions` EffectiveBridgePermissions - `read` boolean - `delete` boolean - `editBillingSettings` boolean - `editNoBillingSettings` boolean - `resourceCounts` ResourceCounts — Count of resources owned directly by this account. Excludes child account resources (see `childResourceCounts`). - `cameras` integer - `bridges` integer - `multiCameras` integer - `speakers` integer - `users` integer - `accounts` integer - `layouts` integer - `responderCameraProxies` integer — Number of cameras shared with this account as part of the first responder functionality. - `locations` integer - `deviceTags` integer - `sharedCameraProxies` integer — Number of cameras shared with this account as part of the camera sharing functionality. Cameras shared using first responder functionality are not part of this count. - `resourceStatusCounts` ResourceStatusCounts — Count of resources by status owned directly by this account. Excludes child account resources (see `childResourceStatusCounts`). - `cameras` CameraStatusCounts - `online` integer - `deviceOffline` integer - `off` integer - `bridgeOffline` integer - `invalidCredentials` integer - `error` integer - `unknown` integer - `bridges` BridgeStatusCounts - `online` integer - `deviceOffline` integer - `unknown` integer - `users` UserStatusCounts - `active` integer - `blocked` integer - `pending` integer - `accounts` AccountStatusCounts - `active` integer - `loginDisabled` integer - `accountDisabled` integer - `multiCameras` CameraStatusCounts - `online` integer - `deviceOffline` integer - `off` integer - `bridgeOffline` integer - `invalidCredentials` integer - `error` integer - `unknown` integer - `speakers` CameraStatusCounts - `online` integer - `deviceOffline` integer - `off` integer - `bridgeOffline` integer - `invalidCredentials` integer - `error` integer - `unknown` integer - `resourceStatusV2Counts` ResourceStatusV2Counts — Count of resources by cloud connection status and edge-reported device status, owned directly by this account. Excludes child account resources. - `cameras` CameraStatusV2Counts - `cloudConnectionStatus` CloudConnectionStatusCounts - `connected` integer - `disconnected` integer - `edgeReportedDeviceStatus` EdgeReportedDeviceStatusCounts - `operational` integer - `disabled` integer - `unreachable` integer - `error` integer - `unknown` integer - `initializing` integer - `bridges` BridgeStatusV2Counts - `cloudConnectionStatus` CloudConnectionStatusCounts - `connected` integer - `disconnected` integer - `edgeReportedDeviceStatus` EdgeReportedDeviceStatusCounts - `operational` integer - `disabled` integer - `unreachable` integer - `error` integer - `unknown` integer - `initializing` integer - `users` UserStatusCounts - `active` integer - `blocked` integer - `pending` integer - `accounts` AccountStatusCounts - `active` integer - `loginDisabled` integer - `accountDisabled` integer - `multiCameras` CameraStatusV2Counts - `cloudConnectionStatus` CloudConnectionStatusCounts - `connected` integer - `disconnected` integer - `edgeReportedDeviceStatus` EdgeReportedDeviceStatusCounts - `operational` integer - `disabled` integer - `unreachable` integer - `error` integer - `unknown` integer - `initializing` integer - `speakers` CameraStatusV2Counts - `cloudConnectionStatus` CloudConnectionStatusCounts - `connected` integer - `disconnected` integer - `edgeReportedDeviceStatus` EdgeReportedDeviceStatusCounts - `operational` integer - `disabled` integer - `unreachable` integer - `error` integer - `unknown` integer - `initializing` integer - `qRelevance` number, float — Field is only returned when `q` parameter is used and its value indicates the relevance of the bridge in relation to the terms in the `q` parameter. The range of this value is between 0 and 1, higher is better. - `totalSize` integer, required — Size of the total result set. ## Other responses - `400` — The supplied object is invalid. Error detail will contain the validation error. - `401` — You are not authenticated. Please authenticate and try again. - `404` — Referenced resource could not be found. - `500` — Something went wrong in the server. Please try again. --- [API](https://skmtc.net/eagleeyenetworks/apis/devices.md) · [All operations](https://skmtc.net/eagleeyenetworks/apis/devices/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeyenetworks/devices/versions/df57313de545/schema)