aYOUne
← Hub API

Faqs

Singular: Faq — Base URL: https://hub-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": "65e06ecc1e1be45a37c62507",
    "lang": "de",
    "published": false,
    "tags": [],
    "createdBy": "6045f4d25704710012485569",
    "products": [],
    "tasks": [],
    "questions": [],
    "contents": [],
    "wikiPages": [],
    "createdAt": "2024-02-29T11:47:24.961Z",
    "updatedAt": "2024-02-29T11:47:24.961Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://hub-api.ayoune.app/faqs/65e06ecc1e1be45a37c62507",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Websites",
        "title": "MODEL_WEBSITE",
        "href": "https://api.ayoune.app/cms/websites",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.websites"
      },
      {
        "rel": "SenderBrands",
        "title": "MODEL_SENDERBRAND",
        "href": "https://api.ayoune.app/config/senderbrands",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.senderbrands"
      },
      {
        "rel": "Documents",
        "title": "MODEL_DOCUMENT",
        "href": "https://api.ayoune.app/crm/documents",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.documents"
      },
      {
        "rel": "Images",
        "title": "MODEL_IMAGE",
        "href": "https://api.ayoune.app/cms/images",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.images"
      }
    ],
    "debugId": "6a62e04b2b20d6ae273bf245",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_FAQ",
        "href": "https://api.ayoune.app/hub/faqs/65e06ecc1e1be45a37c62507/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_FAQ",
        "href": "https://api.ayoune.app/hub/faqs/65e06ecc1e1be45a37c62507/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.11.3",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2446",
      "reset": "1784868426",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 84.362306,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also