aYOUne
← Project Management API

Projects

Singular: Project — 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": {
    "telegramSettings": {
      "sendGifs": false,
      "monitorBadWords": false,
      "monitorGoodWords": false
    },
    "dailyScrum": {
      "useDaily": false,
      "createMinutes": false,
      "startTime": 9
    },
    "documentation": {
      "storyEstimates": "<p>Diese Schätzungen stellen eine <strong>grobe</strong> Indikation dar</p>",
      "taskEstimates": "<p>Diese Schätzungen stellen eine <strong>feinere</strong> Indikation im Projektverlauf dar</p>",
      "team": "<p>Für die Umsetzung des Projektes haben wir folgende Teams vorgesehen.</p>",
      "requirements": "<p>Basierend auf den uns vorliegenden Information ergeben sich folgende Anforderungen</p>",
      "milestones": "<p>Das Projekt teilt sich in folgende Meilensteine auf</p>",
      "epics": "<p>Das Projekt teilt sich in folgende Epen auf.</p>",
      "sprints": "<p>Innerhalb des Projektes sind folgende Sprints vorgesehen</p>",
      "stories": "<p></p>",
      "tasks": "<p></p>"
    },
    "projectTimes": {
      "remainingDays": 0,
      "remainingMonths": 0,
      "remainingWeeks": 0,
      "remainingHours": 0,
      "remainingMinutes": 0,
      "remainingSeconds": 0,
      "plannedHours": 0,
      "plannedDays": 0,
      "availableHours": 0,
      "availableDays": 0
    },
    "workingHours": {
      "days": {
        "mon": true,
        "tue": true,
        "wed": true,
        "thu": true,
        "fri": true,
        "sat": false,
        "sun": false
      },
      "dailyHours": 8,
      "nonWorkingDays": []
    },
    "features": {
      "attributes": false,
      "sales": false,
      "requirements": false,
      "stories": false,
      "milestones": false,
      "epics": false,
      "sprints": false,
      "checklists": false,
      "meetingMinutes": false,
      "slides": false,
      "timeTracking": false,
      "retrospectives": false,
      "decisions": false,
      "om": false,
      "seo": false,
      "sea": false,
      "smm": false,
      "gitlab": false,
      "jira": false,
      "bitbucket": false,
      "mongoDB": false,
      "pm2": false,
      "telegram": false,
      "slack": false
    },
    "docGenerationConfig": {
      "strands": {
        "internal": {
          "enabled": false,
          "trigger": "manual"
        },
        "reseller": {
          "enabled": false,
          "trigger": "manual"
        },
        "enduser": {
          "enabled": false,
          "trigger": "manual"
        },
        "developer": {
          "enabled": false,
          "trigger": "manual"
        }
      },
      "enabled": false,
      "locales": []
    },
    "allSkills": [],
    "_id": "65db18eb732abb0012512a92",
    "priority": "normal",
    "type": "Projektmanagement",
    "subject": "Test Projekt",
    "slug": "test-projekt",
    "note": "",
    "status": "open",
    "progress": 0,
    "countOpen": 0,
    "countClosed": 0,
    "count": 0,
    "budget": 0,
    "jiraId": "",
    "jiraKey": "",
    "googleSiteKey": "",
    "googleAnalyticsAccount": "",
    "googleAdsAccount": "",
    "googleAnalyticsProperty": "",
    "gitlabId": "",
    "gitlabKey": "",
    "bitbucketUserName": "",
    "bitbucketAppPassword": "",
    "bitbucketWorkspace": "",
    "travelcost": 0,
    "defaultUnit": "days",
    "defaultDeveloper": "",
    "defaultDocuAuthor": "",
    "defaultReviewer": "",
    "defaultTester": "",
    "defaultDesigner": "",
    "defaultConcept": "",
    "defaultChangeLogger": "",
    "defaultEstimate": 0.5,
    "estimationFormula": "(${estimatedTime}*(${points*total}/1000))*1.5",
    "estimationFormulaTasks": "(${planingtime}*(${points*total}/1000))*1.5",
    "weeklyHours": 0,
    "dailyHours": 0,
    "allskills": [],
    "color": "#003854",
    "requested_by": "",
    "createdBy": "6045f4d25704710012485569",
    "user": "6045f4d25704710012485569",
    "shares": [],
    "teams": [],
    "stages": [],
    "phases": [],
    "positions": [],
    "attributes": [],
    "repositories": [],
    "comments": [],
    "createdAt": "2024-02-25T10:39:39.224Z",
    "updatedAt": "2024-02-25T10:39:47.842Z",
    "projectKey": "TP"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://pm-api.ayoune.app/projects/65db18eb732abb0012512a92",
        "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": "Consumers",
        "title": "MODEL_CONSUMER",
        "href": "https://api.ayoune.app/crm/consumers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.consumers"
      },
      {
        "rel": "ProjectTemplates",
        "title": "MODEL_PROJECTTEMPLATE",
        "href": "https://api.ayoune.app/config/projecttemplates",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.projecttemplates"
      },
      {
        "rel": "Assignments",
        "title": "MODEL_ASSIGNMENT",
        "href": "https://api.ayoune.app/sale/assignments",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "sale.assignments"
      },
      {
        "rel": "Properties",
        "title": "MODEL_PROPERTY",
        "href": "https://api.ayoune.app/config/properties",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.properties"
      },
      {
        "rel": "WebReceivers",
        "title": "MODEL_WEBRECEIVER",
        "href": "https://api.ayoune.app/config/webreceivers",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.webreceivers"
      },
      {
        "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": "KnowledgeBases",
        "title": "MODEL_KNOWLEDGEBASE",
        "href": "https://api.ayoune.app/hub/knowledgebases",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "hub.knowledgebases"
      },
      {
        "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": "KnowledgeBases",
        "title": "MODEL_KNOWLEDGEBASE",
        "href": "https://api.ayoune.app/hub/knowledgebases",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "hub.knowledgebases"
      },
      {
        "rel": "KnowledgeBases",
        "title": "MODEL_KNOWLEDGEBASE",
        "href": "https://api.ayoune.app/hub/knowledgebases",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "hub.knowledgebases"
      }
    ],
    "debugId": "6a619869f0cde3e4594555cb",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_PROJECT",
        "href": "https://api.ayoune.app/pm/projects/65db18eb732abb0012512a92/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_PROJECT",
        "href": "https://api.ayoune.app/pm/projects/65db18eb732abb0012512a92/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.34.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2288",
      "reset": "1784784467",
      "resetDate": "Thu Jul 23 2026"
    },
    "responseTime": 78.32849,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also