aYOUne
← Marketing API

References

Singular: Reference — Base URL: https://marketing-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": "6aa37e5ee7af9185f0f712d5",
    "published": false,
    "name": "VOLUNTARY_SCARLET_DEXTER JETTSTER",
    "lang": "de",
    "createdBy": "6045f4d25704710012485569",
    "shares": [],
    "createdAt": "2026-09-11T04:06:54.632Z",
    "updatedAt": "2026-09-11T04:06:55.159Z",
    "modifiedBy": "6045f4d25704710012485569"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://marketing-api.ayoune.app/references/6aa37e5ee7af9185f0f712d5",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "rel": "Publications",
        "title": "MODEL_PUBLICATION",
        "href": "https://api.ayoune.app/marketing/publications",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "marketing.publications"
      },
      {
        "rel": "Projects",
        "title": "MODEL_PROJECT",
        "href": "https://api.ayoune.app/pm/projects",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.projects"
      },
      {
        "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": "6aa37e5fe7af9185f0f71327",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_REFERENCE",
        "href": "https://api.ayoune.app/marketing/references/6aa37e5ee7af9185f0f712d5/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_REFERENCE",
        "href": "https://api.ayoune.app/marketing/references/6aa37e5ee7af9185f0f712d5",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.38.0",
      "core": "2026.334.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "1528",
      "reset": "1789102955",
      "resetDate": "Fri Sep 11 2026"
    },
    "responseTime": 89.853978,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also