Skip to content
aYOUne
← Configuration API

AlertCategories

Singular: AlertCategory — Base URL: https://config-api.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": "6a65e719d375958d8b1c4400",
    "key": "workcenter",
    "active": true,
    "color": "#f97316",
    "createdAt": "2026-07-26T10:53:13.280Z",
    "description": "Arbeitsplatz-bezogene Meldungen: Belegung, Rüstzeiten, offene Rückmeldungen.",
    "icon": "factory",
    "isDraft": true,
    "name": "Arbeitsplätze",
    "sortOrder": 60,
    "updatedAt": "2026-10-11T01:20:27.154Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/alertcategories/6a65e719d375958d8b1c4400",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6acb043b639a90c479270480",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_ALERTCATEGORY",
        "href": "https://api.ayoune.app/config/alertcategories/6a65e719d375958d8b1c4400/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_ALERTCATEGORY",
        "href": "https://api.ayoune.app/config/alertcategories/6a65e719d375958d8b1c4400",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.170.1",
      "core": "2026.368.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "8814",
      "reset": "1791691321",
      "resetDate": "Sun Oct 11 2026"
    },
    "responseTime": 1788.015112,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also