> This is Payabli documentation. For a complete page index, fetch https://docs.payabli.com/llms.txt — append .md to any page URL for lightweight markdown. For section-level indexes, query parameters, and other AI-optimized access methods, see https://docs.payabli.com/ai-agents.md

# List devices by paypoint

GET https://api-sandbox.payabli.com/api/Query/devices/{entry}

Returns a list of cloud devices for a single paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.

Reference: https://docs.payabli.com/developers/api-reference/cloud/get-list-of-devices-for-a-paypoint

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: payabliApi-oas
  version: 1.0.0
paths:
  /Query/devices/{entry}:
    get:
      operationId: list-devices
      summary: Get list of devices for a paypoint
      description: >-
        Returns a list of cloud devices for a single paypoint. Use filters to
        limit results. Include the `exportFormat` query parameter to return the
        results as a file instead of a JSON response.
      tags:
        - subpackage_query
      parameters:
        - name: entry
          in: path
          description: >-
            The entity's entrypoint identifier. [Learn
            more](/developers/api-reference/api-overview#entrypoint-vs-entry)
          required: true
          schema:
            $ref: '#/components/schemas/Entry'
        - name: exportFormat
          in: query
          description: >-
            Export format for file downloads. When specified, returns data as a
            file instead of JSON.
          required: false
          schema:
            $ref: '#/components/schemas/ExportFormat'
        - name: fromRecord
          in: query
          description: >-
            The number of records to skip before starting to collect the result
            set.
          required: false
          schema:
            type: integer
            default: 0
        - name: limitRecord
          in: query
          description: >-
            Max number of records to return for the query. Use `0` or negative
            value to return all records.
          required: false
          schema:
            type: integer
            default: 20
        - name: parameters
          in: query
          description: >-
            Collection of field names, conditions, and values used to filter

            the query.


            <Info>
              **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**

              Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.

              For example:

              --url https://api-sandbox.payabli.com/api/Query/devices/8cfec329267?parameters=status=1&limitRecord=20

              should become:

              --url https://api-sandbox.payabli.com/api/Query/devices/8cfec329267?status=1&limitRecord=20
            </Info>


            See [Filters and Conditions

            Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)

            for more information.


            **List of field names accepted:**



            - `deviceId` (eq, ne, ct, nct)


            - `serialNumber` (eq, ne, ct, nct)


            - `friendlyName` (eq, ne, ct, nct)


            - `description` (eq, ne, ct, nct)


            - `model` (eq, ne, ct, nct)


            - `make` (eq, ne, ct, nct)


            - `macAddress` (eq, ne, ct, nct)


            - `registrationCode` (eq, ne, ct, nct)


            - `status` (eq, ne, in, nin)


            - `deviceType` (eq, ne, in, nin)


            - `deviceOs` (eq, ne, in, nin)


            - `activationAttempts` (eq, ne, gt, ge, lt, le)


            - `createdDate` (gt, ge, lt, le, eq, ne)


            - `updatedDate` (gt, ge, lt, le, eq, ne)


            - `lastHealthCheck` (gt, ge, lt, le, eq, ne)


            - `activationExpiry` (gt, ge, lt, le, eq, ne). This filter
            corresponds to the `activationCodeExpiry` response field.


            - `paypointId` (eq, ne)


            - `paypointDba` (eq, ne, ct, nct)


            - `paypointLegal` (eq, ne, ct, nct)


            - `paypointEntry` (eq, ne, ct, nct)


            - `externalPaypointId` (eq, ne, ct, nct)


            - `parentOrgId` (eq, ne)


            - `parentOrgName` (eq, ne, ct, nct)



            **List of comparison operators accepted:**


            - `eq` or empty => equal


            - `gt` => greater than


            - `ge` => greater or equal


            - `lt` => less than


            - `le` => less or equal


            - `ne` => not equal


            - `ct` => contains


            - `nct` => not contains


            - `in` => inside array


            - `nin` => not inside array
          required: false
          schema:
            type: object
            additionalProperties:
              type:
                - string
                - 'null'
        - name: sortBy
          in: query
          description: >-
            The field name to use for sorting results. Use `desc(field_name)` to
            sort descending by `field_name`, and use `asc(field_name)` to sort
            ascending by `field_name`.
          required: false
          schema:
            type: string
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryDeviceResponse'
        '400':
          description: Bad request / invalid data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliErrorBody'
        '401':
          description: Unauthorized request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliErrorBody'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliErrorBody'
        '503':
          description: Database connection error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliErrorBody'
servers:
  - url: https://api-sandbox.payabli.com/api
    description: Sandbox
  - url: https://api.payabli.com/api
    description: Production
components:
  schemas:
    Entry:
      type: string
      description: >
        The entity's entrypoint identifier.

        [Learn
        more](/developers/api-reference/api-overview#entrypoint-vs-entry).
      title: Entry
    ExportFormat:
      type: string
      enum:
        - csv
        - xlsx
      description: |
        Export format for file downloads. When specified, returns data as a file
        instead of JSON.
      title: ExportFormat
    PageIdentifier:
      type: string
      description: Auxiliary validation used internally by payment pages and components.
      title: PageIdentifier
    Pagesize:
      type: integer
      description: Number of records on each response page.
      title: Pagesize
    Totalrecords:
      type: integer
      description: Total number of records in response.
      title: Totalrecords
    QuerySummary:
      type: object
      properties:
        pageIdentifier:
          $ref: '#/components/schemas/PageIdentifier'
        pageSize:
          $ref: '#/components/schemas/Pagesize'
        totalAmount:
          type: number
          format: double
          description: Total amount for the records.
        totalNetAmount:
          type: number
          format: double
          description: Total net amount for the records.
        totalPages:
          $ref: '#/components/schemas/Totalrecords'
        totalRecords:
          $ref: '#/components/schemas/Totalrecords'
      title: QuerySummary
    DeviceQueryRecord:
      type: object
      properties:
        deviceId:
          type:
            - string
            - 'null'
          description: Unique identifier for the cloud device.
        idCloud:
          type:
            - integer
            - 'null'
          description: Internal cloud device record ID.
        description:
          type:
            - string
            - 'null'
          description: Description of the device.
        serialNumber:
          type:
            - string
            - 'null'
          description: Serial number of the device.
        friendlyName:
          type:
            - string
            - 'null'
          description: Human-readable name for the device.
        make:
          type:
            - string
            - 'null'
          description: Manufacturer of the device.
        model:
          type:
            - string
            - 'null'
          description: Model name of the device.
        deviceType:
          type:
            - integer
            - 'null'
          description: Type of device.
        deviceStatus:
          type:
            - integer
            - 'null'
          description: Current status of the device.
        deviceOs:
          type:
            - integer
            - 'null'
          description: Operating system of the device.
        macAddress:
          type:
            - string
            - 'null'
          description: MAC address of the device.
        lastHealthCheck:
          type:
            - string
            - 'null'
          description: Timestamp of the last health check from the device.
        registrationCode:
          type:
            - string
            - 'null'
          description: Registration code used to activate the device.
        activationAttempts:
          type:
            - integer
            - 'null'
          description: Number of activation attempts for the device.
        activationCodeExpiry:
          type:
            - string
            - 'null'
          description: Expiration timestamp for the device activation code.
        createdAt:
          type:
            - string
            - 'null'
          description: Timestamp when the device record was created.
        updatedAt:
          type:
            - string
            - 'null'
          description: Timestamp when the device record was last updated.
        paypointId:
          type:
            - integer
            - 'null'
          description: Numeric identifier for the paypoint.
        paypointDba:
          type:
            - string
            - 'null'
          description: DBA name for the paypoint.
        paypointLegal:
          type:
            - string
            - 'null'
          description: Legal name for the paypoint.
        paypointEntry:
          type:
            - string
            - 'null'
          description: Entry identifier for the paypoint.
        externalPaypointId:
          type:
            - string
            - 'null'
          description: External identifier for the paypoint.
        parentOrgId:
          type:
            - integer
            - 'null'
          description: Numeric identifier for the parent organization.
        parentOrgName:
          type:
            - string
            - 'null'
          description: Name of the parent organization.
      required:
        - deviceId
        - idCloud
        - description
        - serialNumber
        - friendlyName
        - make
        - model
        - deviceType
        - deviceStatus
        - deviceOs
        - macAddress
        - lastHealthCheck
        - registrationCode
        - activationAttempts
        - activationCodeExpiry
        - createdAt
        - updatedAt
        - paypointId
        - paypointDba
        - paypointLegal
        - paypointEntry
        - externalPaypointId
        - parentOrgId
        - parentOrgName
      title: DeviceQueryRecord
    QueryDeviceResponse:
      type: object
      properties:
        Summary:
          $ref: '#/components/schemas/QuerySummary'
        Records:
          type: array
          items:
            $ref: '#/components/schemas/DeviceQueryRecord'
      required:
        - Summary
        - Records
      description: Response body for queries about cloud devices.
      title: QueryDeviceResponse
    PayabliErrorBodyResponseData:
      type: object
      properties:
        explanation:
          type: string
          description: Human-readable explanation of what happened.
        todoAction:
          type: string
          description: Suggested resolution.
      description: Object with detailed error context.
      title: PayabliErrorBodyResponseData
    PayabliErrorBody:
      type: object
      properties:
        isSuccess:
          type: boolean
          description: Always `false` for error responses.
        responseCode:
          type: integer
          description: |
            Code for the response. Learn more in
            [API Response Codes](/developers/api-reference/api-responses).
        responseText:
          type: string
          description: Error text describing what went wrong.
        responseData:
          $ref: '#/components/schemas/PayabliErrorBodyResponseData'
          description: Object with detailed error context.
      required:
        - isSuccess
        - responseText
      description: |
        Shape returned by every Payabli API error response. The `responseData`
        object carries human-readable error context.
      title: PayabliErrorBody
  securitySchemes:
    APIKeyAuth:
      type: apiKey
      in: header
      name: requestToken

```

## Examples



**Response**

```json
{
  "Summary": {
    "pageIdentifier": null,
    "pageSize": 20,
    "totalAmount": 0,
    "totalNetAmount": 0,
    "totalPages": 2,
    "totalRecords": 28
  },
  "Records": [
    {
      "deviceId": "499585-389fj484-3jcj8hj3",
      "idCloud": 142,
      "description": "Front Counter Terminal",
      "serialNumber": "SN-90210-XR",
      "friendlyName": "Front Counter Terminal",
      "make": "Ingenico",
      "model": "LK2500",
      "deviceType": 1,
      "deviceStatus": 1,
      "deviceOs": null,
      "macAddress": "1A2B3C4D5E6F",
      "lastHealthCheck": "2026-04-09T14:49:42Z",
      "registrationCode": "REG-A1B2C3D4",
      "activationAttempts": 0,
      "activationCodeExpiry": "2026-04-09T14:49:42Z",
      "createdAt": "2026-04-09T01:14:37Z",
      "updatedAt": "2026-04-09T14:49:42Z",
      "paypointId": 3040,
      "paypointDba": "Gruzya Adventure Outfitters",
      "paypointLegal": "Gruzya Adventure Outfitters, LLC",
      "paypointEntry": "8cfec329267",
      "externalPaypointId": "GRUZYA-01",
      "parentOrgId": 100,
      "parentOrgName": "Example Corp"
    }
  ]
}
```

**SDK Code**

```typescript
import { PayabliClient } from "@payabli/sdk-node";

async function main() {
    const client = new PayabliClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.query.listDevices("8cfec329267", {
        fromRecord: 0,
        limitRecord: 20,
        sortBy: "desc(createdAt)",
    });
}
main();

```

```python
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY_HERE",
)

client.query.list_devices(
    entry="8cfec329267",
    from_record=0,
    limit_record=20,
    sort_by="desc(createdAt)",
)

```

```java
package com.example.usage;

import io.github.payabli.api.PayabliPayabliApiOasClient;
import io.github.payabli.api.resources.query.requests.ListDevicesRequest;

public class Example {
    public static void main(String[] args) {
        PayabliPayabliApiOasClient client = PayabliPayabliApiOasClient
            .builder()
            .apiKey("YOUR_API_KEY_HERE")
            .build();

        client.query().listDevices(
            "8cfec329267",
            ListDevicesRequest
                .builder()
                .fromRecord(0)
                .limitRecord(20)
                .sortBy("desc(createdAt)")
                .build()
        );
    }
}
```

```ruby
require "payabli"

client = Payabli::Client.new(api_key: "YOUR_API_KEY_HERE")

client.query.list_devices(
  entry: "8cfec329267",
  from_record: 0,
  limit_record: 20,
  sort_by: "desc(createdAt)"
)

```

```csharp
using PayabliPayabliApiOas;
using System.Threading.Tasks;

namespace Usage;

public class Example
{
    public async Task Do() {
        var client = new PayabliPayabliApiOasClient(
            apiKey: "YOUR_API_KEY_HERE"
        );

        await client.Query.ListDevicesAsync(
            "8cfec329267",
            new ListDevicesRequest {
                FromRecord = 0,
                LimitRecord = 20,
                SortBy = "desc(createdAt)"
            }
        );
    }

}

```

```go
package example

import (
    context "context"

    payabli "github.com/payabli/sdk-go"
    client "github.com/payabli/sdk-go/client"
    option "github.com/payabli/sdk-go/option"
)

func do() {
    client := client.NewClient(
        option.WithApiKey(
            "YOUR_API_KEY_HERE",
        ),
    )
    request := &payabli.ListDevicesRequest{
        FromRecord: payabli.Int(
            0,
        ),
        LimitRecord: payabli.Int(
            20,
        ),
        SortBy: payabli.String(
            "desc(createdAt)",
        ),
    }
    client.Query.ListDevices(
        context.TODO(),
        "8cfec329267",
        request,
    )
}

```

```php
<?php

namespace Example;

use Payabli\PayabliClient;
use Payabli\Query\Requests\ListDevicesRequest;

$client = new PayabliClient(
    apiKey: 'YOUR_API_KEY_HERE',
);
$client->query->listDevices(
    '8cfec329267',
    new ListDevicesRequest([
        'fromRecord' => 0,
        'limitRecord' => 20,
        'sortBy' => 'desc(createdAt)',
    ]),
);

```

```swift
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Query/devices/8cfec329267?fromRecord=0&limitRecord=20&sortBy=desc%28createdAt%29")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```