Skip to content
aYOUne
← planning API

PlanningModels

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

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": "6aded56bc3c38029eb3d2d15",
    "name": "STORMY_ROSE_OBI-WAN KENOBI",
    "createdBy": "6045f4d25704710012485569",
    "shares": [],
    "createdAt": "2026-10-26T04:22:03.321Z",
    "updatedAt": "2026-10-26T04:22:03.321Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://planning-api.ayoune.app/planningmodels/6aded56bc3c38029eb3d2d15",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6aded56cc3c38029eb3d2d3d",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PLANNINGMODEL",
        "href": "https://api.ayoune.app/planning/planningmodels/6aded56bc3c38029eb3d2d15/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PLANNINGMODEL",
        "href": "https://api.ayoune.app/planning/planningmodels/6aded56bc3c38029eb3d2d15",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.20.0",
      "core": "2026.365.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9979",
      "reset": "1792991835",
      "resetDate": "Mon Oct 26 2026"
    },
    "responseTime": 212.490914,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also