aYOUne
← HR API

Employees

Singular: Employee — Base-URL: https://hr-api.ayoune.app — Zugriff: CRUD

play_circle Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "payload": {
    "_id": "6a618f4b26b6c912cdf85507",
    "_user": "6045f4d25704710012485569",
    "status": "active",
    "createdBy": "6045f4d25704710012485569",
    "workload": [],
    "skills": [],
    "wage": [],
    "createdAt": "2026-07-23T03:49:31.682Z",
    "updatedAt": "2026-07-23T03:49:31.682Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://hr-api.ayoune.app/employees/6a618f4b26b6c912cdf85507",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Locations",
        "title": "MODEL_LOCATION",
        "href": "https://api.ayoune.app/config/locations",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.locations"
      },
      {
        "rel": "AIAgents",
        "title": "MODEL_AIAGENT",
        "href": "https://api.ayoune.app/ai/aiagents",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "ai.aiagents"
      },
      {
        "rel": "CostCenters",
        "title": "MODEL_COSTCENTER",
        "href": "https://api.ayoune.app/accounting/costcenters",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "accounting.costcenters"
      }
    ],
    "debugId": "6a62e03059e4802b7b80d81e",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_EMPLOYEE",
        "href": "https://api.ayoune.app/hr/employees/6a618f4b26b6c912cdf85507/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_EMPLOYEE",
        "href": "https://api.ayoune.app/hr/employees/6a618f4b26b6c912cdf85507/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.11.0",
      "core": "2026.257.1"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2334",
      "reset": "1784868377",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 100.050328,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /employees Liste mit Filtern/Paginierung hr.employees.view
GET /employees/:id Einzelner Datensatz hr.employees.view
POST /employees Neuen Datensatz erstellen hr.employees.new
PUT /employees Datensatz aktualisieren hr.employees.edit
DELETE /employees/:id Datensatz löschen hr.employees.delete

SDK

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

// Alle abrufen
const list = await ay.hr.employees.find().limit(10).exec();

// Einzelnen Datensatz
const one = await ay.hr.employees.findById('OBJECT_ID').exec();

// Erstellen
const created = await ay.hr.employees.create({ name: 'Foo' });

Weiterführend