aYOUne
← Project Management API

PmRequirements

Singular: PmRequirement — Base URL: https://pm-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": "6a619882f0cde3e459455eee",
    "name": "CONSERVATIVE_INDIGO_GREEDO",
    "status": "draft",
    "goals": [],
    "outOfScope": [],
    "tags": [],
    "createdBy": "6045f4d25704710012485569",
    "assumptions": [],
    "questions": [],
    "createdAt": "2026-07-23T04:28:50.666Z",
    "updatedAt": "2026-07-23T04:28:50.666Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://pm-api.ayoune.app/pmrequirements/6a619882f0cde3e459455eee",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Projects",
        "title": "MODEL_PROJECT",
        "href": "https://api.ayoune.app/pm/projects",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.projects"
      }
    ],
    "debugId": "6a619883f0cde3e459455f20",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PMREQUIREMENT",
        "href": "https://api.ayoune.app/pm/pmrequirements/6a619882f0cde3e459455eee/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PMREQUIREMENT",
        "href": "https://api.ayoune.app/pm/pmrequirements/6a619882f0cde3e459455eee/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.34.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2121",
      "reset": "1784784467",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 108.16694,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also