aYOUne
← Project Management API

Retrospectives

Singular: Retrospective — 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": "65e0b193121b7d48fe159b08",
    "showAttendees": false,
    "archive": false,
    "maincolor": "#003854",
    "attendees": [],
    "createdBy": "6045f4d25704710012485569",
    "startDoing": [],
    "stopDoing": [],
    "keepDoing": [],
    "tasks": [],
    "createdAt": "2024-02-29T16:32:19.867Z",
    "updatedAt": "2024-02-29T16:32:19.867Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://pm-api.ayoune.app/retrospectives/65e0b193121b7d48fe159b08",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "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": "Components",
        "title": "MODEL_COMPONENT",
        "href": "https://api.ayoune.app/pm/components",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.components"
      },
      {
        "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": "Sprints",
        "title": "MODEL_SPRINT",
        "href": "https://api.ayoune.app/pm/sprints",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.sprints"
      },
      {
        "rel": "Stories",
        "title": "MODEL_STORY",
        "href": "https://api.ayoune.app/pm/stories",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.stories"
      },
      {
        "rel": "Teams",
        "title": "MODEL_TEAM",
        "href": "https://api.ayoune.app/config/teams",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.teams"
      }
    ],
    "debugId": "6a61986df0cde3e4594556f5",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_RETROSPECTIVE",
        "href": "https://api.ayoune.app/pm/retrospectives/65e0b193121b7d48fe159b08/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_RETROSPECTIVE",
        "href": "https://api.ayoune.app/pm/retrospectives/65e0b193121b7d48fe159b08/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.34.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2272",
      "reset": "1784784467",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 71.771319,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also