aYOUne
← Configuration API

Properties

Singular: Property — 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": {
    "chat": {
      "useChat": false
    },
    "pushoptin": {
      "usePush": false,
      "title": "Wollen Sie über Neuigkeiten auf dem Laufenden bleiben?",
      "subtitle": "Benachrichtigungen lassen sich jederzeit in den Browser-Einstellungen deaktiviert.",
      "allow": "Ja",
      "disallow": "Nein"
    },
    "_id": "65e0b05a121b7d48fe157d4b",
    "proto": "https://",
    "cookieconsent_position": "bottom",
    "createdBy": "6045f4d25704710012485569",
    "shares": [],
    "createdAt": "2024-02-29T16:27:06.260Z",
    "updatedAt": "2024-02-29T16:27:06.260Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/properties/65e0b05a121b7d48fe157d4b",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Chats",
        "title": "MODEL_CHAT",
        "href": "https://api.ayoune.app/hub/chats",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "hub.chats"
      }
    ],
    "debugId": "6a62de67f27d6098834afd6b",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PROPERTY",
        "href": "https://api.ayoune.app/config/properties/65e0b05a121b7d48fe157d4b/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PROPERTY",
        "href": "https://api.ayoune.app/config/properties/65e0b05a121b7d48fe157d4b/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.95.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "747",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 113.183083,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also