Skip to content
aYOUne
← iot API

ScannerDevices

Singular: ScannerDevice — Base URL: https://scan.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "6acf0b83c001ba2966b2b66b",
    "active": true,
    "name": "UGLIEST_GREEN_RATTS TYEREL",
    "paired": false,
    "scanCount": 0,
    "status": "ok",
    "createdBy": "6045f4d25704710012485569",
    "shares": [],
    "createdAt": "2026-10-14T04:56:35.262Z",
    "updatedAt": "2026-10-14T04:56:35.262Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://scan.ayoune.app/scannerdevices/6acf0b83c001ba2966b2b66b",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6acf0b84c001ba2966b2b6a0",
    "errors": [],
    "actions": [],
    "version": {
      "host": "2026.7.0",
      "core": "2026.350.1"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9995",
      "reset": "1791957394",
      "resetDate": "Wed Oct 14 2026"
    },
    "responseTime": 295.163333,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /scannerdevices List with filters/pagination iot.scannerdevices.view
GET /scannerdevices/:id Single record iot.scannerdevices.view
POST /scannerdevices Create new record iot.scannerdevices.new
PUT /scannerdevices Update record iot.scannerdevices.edit
DELETE /scannerdevices/:id Delete record iot.scannerdevices.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.iot.scannerDevices.find().limit(10).exec();

// Single record
const one = await ay.iot.scannerDevices.findById('OBJECT_ID').exec();

// Create
const created = await ay.iot.scannerDevices.create({ name: 'Foo' });

See also