Skip to content
aYOUne
← Project Management API

PmRequirements

Singular: PmRequirement — 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": "6aded5af59049eaaff138ac6",
    "name": "LOGICAL_FUCHSIA_JABBA DESILIJIC TIURE",
    "status": "draft",
    "goals": [],
    "outOfScope": [],
    "tags": [],
    "_techWriters": [],
    "createdBy": "6045f4d25704710012485569",
    "assumptions": [],
    "questions": [],
    "shares": [],
    "createdAt": "2026-10-26T04:23:11.033Z",
    "updatedAt": "2026-10-26T04:23:11.033Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://pm-api.ayoune.app/pmrequirements/6aded5af59049eaaff138ac6",
        "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"
      },
      {
        "rel": "Milestones",
        "title": "MODEL_MILESTONE",
        "href": "https://api.ayoune.app/pm/milestones",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.milestones"
      },
      {
        "rel": "Epics",
        "title": "MODEL_EPIC",
        "href": "https://api.ayoune.app/pm/epics",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.epics"
      },
      {
        "rel": "Features",
        "title": "MODEL_FEATURE",
        "href": "https://api.ayoune.app/pm/features",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.features"
      }
    ],
    "debugId": "6aded5af59049eaaff138afc",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PMREQUIREMENT",
        "href": "https://api.ayoune.app/pm/pmrequirements/6aded5af59049eaaff138ac6/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PMREQUIREMENT",
        "href": "https://api.ayoune.app/pm/pmrequirements/6aded5af59049eaaff138ac6",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.77.1",
      "core": "2026.388.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9625",
      "reset": "1792992152",
      "resetDate": "Mon Oct 26 2026"
    },
    "responseTime": 107.469359,
    "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