aYOUne
← Configuration API

ControlPanels

Singular: ControlPanel — Base URL: https://config-api.ayoune.app — Access: CRUD

play_circle 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": {
    "overview": {
      "calendar": true,
      "tasks": true,
      "resubmissions": true,
      "checklist": true
    },
    "general": {
      "useNewTask": true,
      "useNewProduct": true,
      "useNewIncomeInvoice": true,
      "useNewCampaign": true,
      "useNewTrigger": true,
      "useNewOffer": true,
      "useNewInvoice": true,
      "useNewChance": true,
      "useTimeTracking": true,
      "useBarcode": true,
      "useFunctionSearch": true,
      "useQuestion": true,
      "useDebug": false,
      "useNotification": true,
      "useWatcher": true,
      "useScanToPay": true,
      "useScanToBook": true,
      "useScanToInvoice": true,
      "useScanToShip": true,
      "useIncomingGoods": true,
      "showDate": true,
      "showCalWeek": true,
      "showStates": false,
      "showStateLabels": false,
      "showTime": true,
      "showOnlineStatus": true,
      "showTunnelStatus": true,
      "showThemePicker": false,
      "showTimeTracker": true,
      "useNewAccount": true,
      "showWallboardControls": true
    },
    "published": true,
    "visionboardOnLock": false,
    "visionboardBindingSource": "personal",
    "_id": "65e0aff8121b7d48fe156567",
    "columns": 4,
    "createdBy": "6045f4d25704710012485569",
    "states": [],
    "createdAt": "2024-02-29T16:25:28.639Z",
    "updatedAt": "2024-02-29T16:25:28.639Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/controlpanels/65e0aff8121b7d48fe156567",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "WallBoards",
        "title": "MODEL_WALLBOARD",
        "href": "https://api.ayoune.app/pm/wallboards",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.wallboards"
      },
      {
        "rel": "WorkCenters",
        "title": "MODEL_WORKCENTER",
        "href": "https://api.ayoune.app/production/workcenters",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "production.workcenters"
      },
      {
        "rel": "DashBoards",
        "title": "MODEL_DASHBOARD",
        "href": "https://api.ayoune.app/pm/dashboards",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.dashboards"
      }
    ],
    "debugId": "6a62dd2730b7d778029e7330",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_CONTROLPANEL",
        "href": "https://api.ayoune.app/config/controlpanels/65e0aff8121b7d48fe156567/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_CONTROLPANEL",
        "href": "https://api.ayoune.app/config/controlpanels/65e0aff8121b7d48fe156567/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.94.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2010",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 105.552763,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also