aYOUne
← Project Management API

Epics

Singular: Epic — 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": "6a619855f0cde3e459454d87",
    "name": "POOR_TURQUOISE_AYLA SECURA",
    "color": "#165bff",
    "startCondition": "direct",
    "endCondition": "dynamic",
    "relative": "after",
    "count": 0,
    "countOpen": 0,
    "countClosed": 0,
    "progress": 0,
    "tags": [],
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2026-07-23T04:28:05.475Z",
    "updatedAt": "2026-07-23T04:28:05.475Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://pm-api.ayoune.app/epics/6a619855f0cde3e459454d87",
        "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": "Repositories",
        "title": "MODEL_REPOSITORY",
        "href": "https://api.ayoune.app/devops/repositories",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "devops.repositories"
      }
    ],
    "debugId": "6a619855f0cde3e459454db3",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_EPIC",
        "href": "https://api.ayoune.app/pm/epics/6a619855f0cde3e459454d87/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_EPIC",
        "href": "https://api.ayoune.app/pm/epics/6a619855f0cde3e459454d87/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.34.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2399",
      "reset": "1784784467",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 85.085299,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also