← iot API
ScannerDevices
Singular: ScannerDevice — Base URL: https://scan.ayoune.app — Access: CRUD
Try it now
beta
Response (live)
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": "6a6199c8e6998eeed3ed1843",
"active": true,
"name": "INTENSE_PINK_QUI-GON JINN",
"paired": false,
"scanCount": 0,
"status": "ok",
"createdBy": "6045f4d25704710012485569",
"createdAt": "2026-07-23T04:34:16.669Z",
"updatedAt": "2026-07-23T04:34:16.669Z"
},
"meta": {
"links": [
{
"rel": "self",
"href": "https://scan.ayoune.app/scannerdevices/6a6199c8e6998eeed3ed1843",
"method": "get",
"title": "GET",
"types": [
"application/json",
"application/yaml",
"text/csv"
]
}
],
"relations": [],
"debugId": "6a6199c8e6998eeed3ed1862",
"errors": [],
"actions": [],
"version": {
"host": "2026.6.1",
"core": "2026.242.0"
},
"rateLimit": {
"limit": "2500",
"remaining": "2491",
"reset": "1784784728",
"resetDate": "Thu Jul 23 2026"
},
"responseTime": 52.10587,
"code": 200,
"status": "success",
"error": false
}
}
Endpoints
| Method | Path | Description | Right |
|---|---|---|---|
| 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' });