aYOUne
← Configuration API

Requirements

Singular: Requirement — 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": {
    "_id": "65e0b05f121b7d48fe157de7",
    "description": "Beschreibe die Anforderungen möglichst detailiert",
    "types": [
      "lead",
      "customer",
      "partner",
      "supplier",
      "contact",
      "archive",
      "affiliate",
      "multiplier"
    ],
    "kinds": [
      "main",
      "cp"
    ],
    "models": [
      "consumers"
    ],
    "createdBy": "6045f4d25704710012485569",
    "steps": [],
    "createdAt": "2024-02-29T16:27:11.131Z",
    "updatedAt": "2024-02-29T16:27:11.131Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/requirements/65e0b05f121b7d48fe157de7",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a62de79f27d6098834b01f4",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_REQUIREMENT",
        "href": "https://api.ayoune.app/config/requirements/65e0b05f121b7d48fe157de7/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_REQUIREMENT",
        "href": "https://api.ayoune.app/config/requirements/65e0b05f121b7d48fe157de7/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.95.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "685",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 94.920594,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also