---
updatedAt: 2025-05-19T20:07:16.000Z
agentTools:
  projectIndex: https://developer.ayyeka.com/llms.txt
---

# getDeviceBySerialNumber device

Returns information about the device corresponding to the specified serial number

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "RESTAPI Service",
    "description": "RESTful API",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://restapi.ayyeka.com/v2.0"
    }
  ],
  "paths": {
    "/device/{serialNumber}": {
      "get": {
        "tags": [
          "device"
        ],
        "summary": "getDeviceBySerialNumber device",
        "description": "Returns information about the device corresponding to the specified serial number",
        "operationId": "device#getDeviceBySerialNumber",
        "parameters": [
          {
            "name": "serialNumber",
            "in": "path",
            "description": "Serial number of the device whose information should be returned",
            "required": true,
            "schema": {
              "type": "string",
              "description": "Serial number of the device whose information should be returned",
              "example": "24EB9B03590BE71A"
            },
            "example": "24EB9B03590BE71A"
          }
        ],
        "responses": {
          "200": {
            "description": "OK response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AkapiStoredDevice"
                },
                "example": {
                  "akid": "W4C016201630164EU",
                  "display_name": "W4C018074024200205EU",
                  "firmware_version": "AK3SGSTM__v1.51_20140212T081829",
                  "iccid": "C2510S067000000000RA",
                  "iccid2": "C2510S067000000000RA",
                  "id": 123,
                  "meid": "359677060121128",
                  "model_number": "Wavelet Water Overflow 5100",
                  "serial_number": "W4C018074024200205EU",
                  "site_display_name": "Orange Canary12",
                  "site_id": 24
                }
              }
            }
          },
          "400": {
            "description": "bad_request: Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Unauthorized"
                }
              }
            }
          },
          "401": {
            "description": "unauthorized: Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Unauthorized"
                }
              }
            }
          },
          "403": {
            "description": "forbidden: Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Unauthorized"
                }
              }
            }
          },
          "404": {
            "description": "not_found: Device not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Unauthorized"
                }
              }
            }
          },
          "429": {
            "description": "too_many_requests: Too many requests",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Unauthorized"
                }
              }
            }
          },
          "500": {
            "description": "internal_server_error: System error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Unauthorized"
                }
              }
            }
          }
        },
        "security": [
          {
            "jwt_header_Authorization": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "AkapiStoredDevice": {
        "type": "object",
        "properties": {
          "akid": {
            "type": "string",
            "description": "Device HW ID",
            "example": "W4C016201630164EU",
            "maxLength": 50
          },
          "display_name": {
            "type": "string",
            "description": "Device name",
            "example": "W4C018074024200205EU",
            "maxLength": 256
          },
          "firmware_version": {
            "type": "string",
            "description": "Firmware version",
            "example": "AK3SGSTM__v1.51_20140212T081829",
            "maxLength": 90
          },
          "iccid": {
            "type": "string",
            "description": "Cellular ICCID",
            "example": "C2510S067000000000RA",
            "maxLength": 30
          },
          "iccid2": {
            "type": "string",
            "description": "Cellular ICCID",
            "example": "C2510S067000000000RA",
            "maxLength": 30
          },
          "id": {
            "type": "integer",
            "description": "ID is the unique id of the device.",
            "example": 123,
            "format": "int64"
          },
          "meid": {
            "type": "string",
            "description": "Cellular ICCID",
            "example": "359677060121128",
            "maxLength": 15
          },
          "model_number": {
            "type": "string",
            "description": "Model number",
            "example": "Wavelet Water Overflow 5100",
            "maxLength": 2048
          },
          "serial_number": {
            "type": "string",
            "description": "Serial number",
            "example": "W4C018074024200205EU",
            "maxLength": 256
          },
          "site_display_name": {
            "type": "string",
            "description": "Site name",
            "example": "Orange Canary12",
            "maxLength": 256
          },
          "site_id": {
            "type": "integer",
            "description": "Site ID of device",
            "example": 24,
            "minimum": 1,
            "format": "int64"
          }
        },
        "example": {
          "akid": "W4C016201630164EU",
          "display_name": "W4C018074024200205EU",
          "firmware_version": "AK3SGSTM__v1.51_20140212T081829",
          "iccid": "C2510S067000000000RA",
          "iccid2": "C2510S067000000000RA",
          "id": 123,
          "meid": "359677060121128",
          "model_number": "Wavelet Water Overflow 5100",
          "serial_number": "W4C018074024200205EU",
          "site_display_name": "Orange Canary12",
          "site_id": 24
        },
        "required": [
          "id",
          "serial_number",
          "display_name",
          "model_number",
          "site_id",
          "site_display_name",
          "akid",
          "iccid",
          "iccid2",
          "meid",
          "firmware_version"
        ]
      },
      "Unauthorized": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Message of error",
            "example": "incorrect credentials"
          },
          "request_id": {
            "type": "string",
            "description": "Request ID",
            "example": "uGv69FKl"
          }
        },
        "description": "Unauthorized",
        "example": {
          "message": "incorrect credentials",
          "request_id": "uGv69FKl"
        },
        "required": [
          "request_id",
          "message"
        ]
      }
    },
    "securitySchemes": {
      "jwt_header_Authorization": {
        "type": "http",
        "description": "Secures endpoint by requiring a valid JWT token retrieved via the signin endpoint.",
        "scheme": "bearer"
      }
    }
  },
  "tags": [
    {
      "name": "device"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```