> ## Documentation Index
> Fetch the complete documentation index at: https://nayax-44d6e37b-docs-marshall-faq-redistribution.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get All Devices

> Retrieve a list of devices with optional filters such as actor ID, connection status, serial number, and other device attributes.



## OpenAPI

````yaml /openapi/lynx.yaml get /v1/devices
openapi: 3.0.1
info:
  title: Nayax Operational Lynx API
  version: v1
servers:
  - url: https://qa-lynx.nayax.com/operational
security:
  - Authorization: []
paths:
  /v1/devices:
    get:
      tags:
        - Devices
      summary: Get All Devices
      description: >-
        Retrieve a list of devices with optional filters such as actor ID,
        connection status, serial number, and other device attributes.
      operationId: get-devices
      parameters:
        - name: ActorId
          in: query
          description: The unique identifier of the actor associated with the devices.
          schema:
            type: integer
            format: int64
        - name: isConnected
          in: query
          description: Filter devices based on their connection status.
          schema:
            type: boolean
        - name: pageNumber
          in: query
          description: The page number for paginated results. Default is 1.
          schema:
            type: integer
            format: int32
            default: 1
        - name: pageSize
          in: query
          description: The number of results per page. Default is 1000.
          schema:
            type: integer
            format: int32
            default: 1000
        - name: nayaxDeviceSerial
          in: query
          description: The serial number of the Nayax device.
          schema:
            type: string
        - name: orderId
          in: query
          description: Filter devices based on the associated order ID.
          schema:
            type: integer
            format: int32
        - name: statusId
          in: query
          description: Filter devices based on their status ID.
          schema:
            type: integer
            format: int32
        - name: createdDt
          in: query
          description: Filter devices based on their creation date.
          schema:
            type: string
            format: date-time
        - name: updatedDt
          in: query
          description: Filter devices based on the last updated date.
          schema:
            type: string
            format: date-time
        - name: boardSerial
          in: query
          description: The serial number of the device's mainboard.
          schema:
            type: string
        - name: imei
          in: query
          description: The International Mobile Equipment Identity number of the device.
          schema:
            type: string
        - name: chipId
          in: query
          description: The unique identifier for the chip in the device.
          schema:
            type: string
      responses:
        '200':
          description: A list of devices matching the specified filters.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeviceExtra'
components:
  schemas:
    DeviceExtra:
      type: object
      description: >-
        Contains detailed information about a device, including hardware,
        software versions, and operational status.
      properties:
        VposChipId:
          type: string
          nullable: true
          description: The unique identifier for the VPOS chip in the device.
        IsDeviceExists:
          type: boolean
          description: Indicates whether the device exists in the system.
        FWVersionNumber:
          type: string
          nullable: true
          description: The firmware version number of the device.
        VposVersionNumber:
          type: string
          nullable: true
          description: The VPOSS version number installed on the device.
        DeviceID:
          type: integer
          format: int32
          nullable: true
          description: The unique identifier of the device.
        ActorID:
          type: integer
          format: int64
          nullable: true
          description: The identifier of the actor associated with the device.
        DeviceTypeLutID:
          type: integer
          format: int32
          nullable: true
          description: The lookup identifier for the device type.
        DeviceSerial:
          type: string
          nullable: true
          description: The serial number of the device.
        IMEI:
          type: string
          nullable: true
          description: The International Mobile Equipment Identity number of the device.
        DeviceDescription:
          type: string
          nullable: true
          description: A brief description of the device.
        SimCardID:
          type: integer
          format: int64
          nullable: true
          description: The identifier of the SIM card associated with the device.
        FWVersionID:
          type: integer
          format: int64
          nullable: true
          description: The identifier for the firmware version installed on the device.
        RequestedFwID:
          type: integer
          format: int64
          nullable: true
          description: The identifier for the requested firmware update.
        PollInterval:
          type: integer
          format: int64
          nullable: true
          description: The polling interval for the device in seconds.
        StatusID:
          type: integer
          format: int32
          nullable: true
          description: The current status identifier of the device.
        LastUpdated:
          type: string
          format: date-time
          nullable: true
          description: The date and time when the device was last updated.
        IsCollectMultipleParameters:
          type: boolean
          nullable: true
          description: Indicates if the device is set to collect multiple parameters.
        IsLogged:
          type: boolean
          nullable: true
          description: Indicates if the device activity is logged.
        FRequestedNewVersionDate:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time when a new firmware version was requested for the
            device.
        FTookNewVersionDate:
          type: string
          format: date-time
          nullable: true
          description: >-
            The date and time when the new firmware version was applied to the
            device.
        HardwareVersion:
          type: string
          nullable: true
          description: The hardware version of the device.
        IsRental:
          type: boolean
          nullable: true
          description: Indicates if the device is rented.
        RentalEndMonth:
          type: integer
          format: int32
          nullable: true
          description: The month when the device rental period ends.
        RentalEndYear:
          type: integer
          format: int32
          nullable: true
          description: The year when the device rental period ends.
        IsToBeReturned:
          type: boolean
          nullable: true
          description: Indicates if the device is scheduled to be returned.
        FeeCommunicationThreshold:
          type: integer
          format: int32
          nullable: true
          description: The communication fee threshold for the device.
        BillingPlanID:
          type: integer
          format: int32
          nullable: true
          description: The identifier of the billing plan associated with the device.
        BillingPlanActivationDate:
          type: string
          format: date-time
          nullable: true
          description: The date when the billing plan was activated for the device.
        DeviceCreationDate:
          type: string
          format: date-time
          nullable: true
          description: The date when the device was created in the system.
        CreatedBy:
          type: integer
          format: int64
          nullable: true
          description: The identifier of the user who created the device entry.
        UpdatedBy:
          type: integer
          format: int64
          nullable: true
          description: The identifier of the user who last updated the device entry.
        DistributorBillingPlanID:
          type: integer
          format: int32
          nullable: true
          description: >-
            The identifier of the distributor billing plan associated with the
            device.
        ChipID:
          type: string
          nullable: true
          description: The unique identifier for the chip in the device.
        OrderID:
          type: integer
          format: int32
          nullable: true
          description: The identifier of the order associated with the device.
        ExternalFlashSize:
          type: integer
          format: int32
          nullable: true
          description: The size of the external flash memory in the device.
        BoardSerial:
          type: string
          nullable: true
          description: The serial number of the device's mainboard.
        FlashSize:
          type: integer
          format: int32
          nullable: true
          description: The size of the internal flash memory in the device.
        DeviceFamily:
          type: string
          nullable: true
          description: The family classification of the device.
        ModemModel:
          type: string
          nullable: true
          description: The model of the modem installed in the device.
        TrialEndDate:
          type: string
          format: date-time
          nullable: true
          description: The date when the device's trial period ends.
        VerticalTypeID:
          type: integer
          format: int32
          nullable: true
          description: The identifier of the vertical type associated with the device.
        VerticalProductTypeID:
          type: integer
          format: int32
          nullable: true
          description: >-
            The identifier of the vertical product type associated with the
            device.
        VerticalTypeLutID:
          type: integer
          format: int32
          nullable: true
          description: The lookup identifier for the vertical type.
        VerticalProductTypeLutID:
          type: integer
          format: int32
          nullable: true
          description: The lookup identifier for the vertical product type.
        Refs:
          type: object
          nullable: true
          description: A collection of additional references associated with the device.
          additionalProperties:
            type: string
            nullable: true
      additionalProperties: false
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: Enter your Bearer token. It's required to authenticate API requests.

````