aYOUne
← Configuration API

Forms

Singular: Form — 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": {
    "useIcon": true,
    "invertLogo": true,
    "askForNewsletter": false,
    "askForDataMerge": false,
    "_id": "65e0b019121b7d48fe156f67",
    "type": "Lead",
    "theme": "ayoune",
    "desc": "",
    "desc_done": "",
    "mode": "onestep",
    "rowMode": true,
    "embedMode": "js",
    "postAction": "shownote",
    "redirectURL": "",
    "method": "post",
    "ownHost": false,
    "host": "https://idcadd.ayoune.app/consumer",
    "jsRedirect": false,
    "hideButton": false,
    "btnText": "Absenden",
    "btnCssId": "",
    "btnCssClass": "",
    "btnContainerCssId": "",
    "btnContainerCssClass": "",
    "showHeader": true,
    "headerBackgroundColor": "#3f51b5",
    "headerTextColor": "#ffffff",
    "showLogo": true,
    "showText": true,
    "modern": true,
    "showPreText": true,
    "primaryPalette": "grey",
    "accentPalette": "orange",
    "cssFile": "",
    "cssClass": "",
    "cssClassOuterDiv": "",
    "preHTML": "",
    "postHTML": "",
    "onwCss": "",
    "onwJs": "",
    "useNotification": false,
    "interestChannels": [],
    "brands": [],
    "overwriteGlobalSettings": false,
    "defaultMainType": "main",
    "defaultType": "lead",
    "defaultPrivateBusiness": "business",
    "defaultSalutationType": "formell",
    "framework": "Bootstrap",
    "fieldAppearance": "outline",
    "viewCount": 0,
    "createdBy": "6045f4d25704710012485569",
    "postActions": [],
    "rows": [],
    "notificationUsers": [],
    "createdAt": "2024-02-29T16:26:01.165Z",
    "updatedAt": "2024-02-29T16:26:01.165Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/forms/65e0b019121b7d48fe156f67",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a62dd8230b7d778029e90de",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_FORM",
        "href": "https://api.ayoune.app/config/forms/65e0b019121b7d48fe156f67/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_FORM",
        "href": "https://api.ayoune.app/config/forms/65e0b019121b7d48fe156f67/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.94.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1611",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 231.597013,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also