aYOUne
← Affiliate API

SearchBoxes

Singular: SearchBox — Base URL: https://affiliate-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

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": "65e07d8111cb6213d99d06bc",
    "type": "slider",
    "title": "Vergib einen Titel",
    "placeholder": "Vergib einen Titel",
    "background_color": "#FFFFFF",
    "border_color": "#000000",
    "border_radius": 0,
    "font_color": "#000000",
    "button_color": "#FF0000",
    "font_size": 10,
    "font_type": "Arial",
    "width": 350,
    "height": 300,
    "default_products": [],
    "categorys": "-,-",
    "brands": "-,-",
    "override": 1,
    "locale": "de_DE",
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T12:50:09.105Z",
    "updatedAt": "2024-02-29T12:50:09.105Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://affiliate-api.ayoune.app/searchboxes/65e07d8111cb6213d99d06bc",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Affiliates",
        "title": "MODEL_AFFILIATE",
        "href": "https://api.ayoune.app/config/affiliates",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.affiliates"
      }
    ],
    "debugId": "6aa3713bb1480236a5bd00d6",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_SEARCHBOX",
        "href": "https://api.ayoune.app/affiliate/searchboxes/65e07d8111cb6213d99d06bc/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_SEARCHBOX",
        "href": "https://api.ayoune.app/affiliate/searchboxes/65e07d8111cb6213d99d06bc",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.6.5",
      "core": "2026.334.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2330",
      "reset": "1789099796",
      "resetDate": "Fri Sep 11 2026"
    },
    "responseTime": 181.552345,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also