---
title: "Get gateway"
method: GET
path: "/api/v1/organizations/{organizationId}/gateways/{gatewayId}"
tags: ["/organizations/{organizationId}/gateways"]
---

# Get gateway

`GET /api/v1/organizations/{organizationId}/gateways/{gatewayId}`

## Path parameters

- `organizationId` integer, required
- `gatewayId` integer, required

## Query parameters

- `IncludeFirmwareUpdateInformation` boolean

## Response `200`

OK

- union
  - Gateway
    - `id` integer, required
    - `gatewayHexId` string, required
    - `organizationId` integer, nullable
    - `name` string, required
    - `type` 1, required — 1 = Wifi
    - `firmwareVersion` integer, required
    - `isFirmwareUpdateAvailable` boolean, nullable — Only populated if requested with the query string parameter includeFirmwareUpdateInformation=true or for requests to the API endpoint /organizations/{organizationId}/hardware/tree
    - `hasLatestFirmware` boolean, nullable — Only populated if requested with the query string parameter includeFirmwareUpdateInformation=true or for requests to the API endpoint /organizations/{organizationId}/hardware/tree
    - `firmwareUpdateState` 0 | 1 | 2 | 3 | 4 — 0 = Idle, 1 = Scheduled, 2 = Started, 3 = Finished, 4 = Failed
    - `firmwareUpdatePreviousVersion` integer, nullable
    - `firmwareUpdateVersion` integer, nullable
    - `firmwareUpdateDateScheduled` string, date-time, nullable
    - `firmwareUpdateDateStarted` string, date-time, nullable
    - `firmwareUpdateProgressInPercent` integer, nullable
    - `firmwareUpdateDateFinished` string, date-time, nullable
    - `firmwareUpdateDateFailed` string, date-time, nullable
    - `firmwareUpdateErrorCode` string, nullable
    - `restartDateScheduled` string, date-time, nullable
    - `displayName` string, required
    - `wifiRssi` integer, nullable
    - `wifiRssiUpdated` string, date-time, nullable
    - `isConnected` boolean, nullable
    - `dateConnected` string, date-time, nullable
    - `dateDisconnected` string, date-time, nullable
    - `dateLastActivity` string, date-time, nullable
  - GatewayInfo
    - `id` integer, required
    - `gatewayHexId` string, required
    - `organizationId` integer, nullable
    - `name` string, required
    - `type` 1, required — 1 = Wifi
    - `firmwareVersion` integer, required
    - `isFirmwareUpdateAvailable` boolean, nullable — Only populated if requested with the query string parameter includeFirmwareUpdateInformation=true or for requests to the API endpoint /organizations/{organizationId}/hardware/tree
    - `hasLatestFirmware` boolean, nullable — Only populated if requested with the query string parameter includeFirmwareUpdateInformation=true or for requests to the API endpoint /organizations/{organizationId}/hardware/tree
    - `firmwareUpdateState` 0 | 1 | 2 | 3 | 4 — 0 = Idle, 1 = Scheduled, 2 = Started, 3 = Finished, 4 = Failed
    - `firmwareUpdatePreviousVersion` integer, nullable
    - `firmwareUpdateVersion` integer, nullable
    - `firmwareUpdateDateScheduled` string, date-time, nullable
    - `firmwareUpdateDateStarted` string, date-time, nullable
    - `firmwareUpdateProgressInPercent` integer, nullable
    - `firmwareUpdateDateFinished` string, date-time, nullable
    - `firmwareUpdateDateFailed` string, date-time, nullable
    - `firmwareUpdateErrorCode` string, nullable
    - `restartDateScheduled` string, date-time, nullable
    - `displayName` string, required
    - `wifiRssi` integer, nullable
    - `wifiRssiUpdated` string, date-time, nullable
    - `isConnected` boolean, nullable
    - `dateConnected` string, date-time, nullable
    - `dateDisconnected` string, date-time, nullable
    - `dateLastActivity` string, date-time, nullable

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/kleverkey/apis/kleverkey-api.md) · [All operations](https://skmtc.net/kleverkey/apis/kleverkey-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kleverkey/kleverkey-api/versions/c65c361917fe/schema)