Skip to content
aYOUne
← Project Management API

UseCases

Singular: UseCase — Base URL: https://pm-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": "6ac9c2b619375108206b6a48",
    "title": "OBVIOUS_SAPPHIRE_PALPATINE",
    "published": false,
    "_modules": [],
    "_features": [],
    "_references": [],
    "createdBy": "6045f4d25704710012485569",
    "shares": [],
    "createdAt": "2026-10-10T04:44:38.238Z",
    "updatedAt": "2026-10-10T04:44:38.238Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://pm-api.ayoune.app/usecases/6ac9c2b619375108206b6a48",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "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": "6ac9c2b619375108206b6aae",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_USECASE",
        "href": "https://api.ayoune.app/pm/usecases/6ac9c2b619375108206b6a48/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_USECASE",
        "href": "https://api.ayoune.app/pm/usecases/6ac9c2b619375108206b6a48",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.77.1",
      "core": "2026.368.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9515",
      "reset": "1791611037",
      "resetDate": "Sat Oct 10 2026"
    },
    "responseTime": 47.943097,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also