aYOUne
← Project Management API

Components

Singular: Component — Base URL: https://pm-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": "6aa236566d8b8aabbb7b91a3",
    "name": "MECHANICAL_OLIVE_GRIEVOUS",
    "color": "#0fff99",
    "count": 0,
    "countOpen": 0,
    "countClosed": 0,
    "progress": 0,
    "tags": [],
    "createdBy": "6045f4d25704710012485569",
    "shares": [],
    "createdAt": "2026-09-10T04:47:18.474Z",
    "updatedAt": "2026-09-10T04:47:18.474Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://pm-api.ayoune.app/components/6aa236566d8b8aabbb7b91a3",
        "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": "Modules",
        "title": "MODEL_MODULE",
        "href": "https://api.ayoune.app/pm/modules",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.modules"
      },
      {
        "rel": "Repositories",
        "title": "MODEL_REPOSITORY",
        "href": "https://api.ayoune.app/devops/repositories",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "devops.repositories"
      },
      {
        "rel": "WikiPages",
        "title": "MODEL_WIKIPAGE",
        "href": "https://api.ayoune.app/hub/wikipages",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "hub.wikipages"
      },
      {
        "rel": "KnowledgeBases",
        "title": "MODEL_KNOWLEDGEBASE",
        "href": "https://api.ayoune.app/hub/knowledgebases",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "hub.knowledgebases"
      },
      {
        "rel": "Employees",
        "title": "MODEL_EMPLOYEE",
        "href": "https://api.ayoune.app/hr/employees",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "hr.employees"
      }
    ],
    "debugId": "6aa236566d8b8aabbb7b9204",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_COMPONENT",
        "href": "https://api.ayoune.app/pm/components/6aa236566d8b8aabbb7b91a3/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_COMPONENT",
        "href": "https://api.ayoune.app/pm/components/6aa236566d8b8aabbb7b91a3",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.73.0",
      "core": "2026.334.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2444",
      "reset": "1789019235",
      "resetDate": "Thu Sep 10 2026"
    },
    "responseTime": 30.839557,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also