Zum Inhalt springen
aYOUne
← HR API

Employees

Singular: Employee — Base-URL: https://hr-api.ayoune.app — Zugriff: CRUD — Maschinenlesbare Beschreibung (JSON · YAML)

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": {
    "drivingLicense": {
      "classes": []
    },
    "_id": "6ab22701497e7e1a34056884",
    "createdAt": "2026-09-22T06:58:05.891Z",
    "updatedAt": "2026-09-22T06:58:05.891Z",
    "firstName": "Emilia",
    "lastName": "Neumann",
    "email": "emilia.neumann@tolinaxdemo.example",
    "phone": "+49 30 23125 33",
    "position": "Qualitaetssicherung",
    "department": "Fertigung",
    "status": "active",
    "hiredAt": "2023-03-10T09:00:00.000Z",
    "personnelNumber": "P-0009",
    "_workCenters": [],
    "workload": [],
    "skills": [],
    "wage": [],
    "children": [],
    "education": [],
    "languages": [],
    "occupationalHealth": [],
    "leavePeriods": [],
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://hr-api.ayoune.app/employees/6ab22701497e7e1a34056884",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Positions",
        "title": "MODEL_POSITION",
        "href": "https://api.ayoune.app/hr/positions",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "hr.positions"
      },
      {
        "rel": "Documents",
        "title": "MODEL_DOCUMENT",
        "href": "https://api.ayoune.app/crm/documents",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "crm.documents"
      },
      {
        "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"
      },
      {
        "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": "Employees",
        "title": "MODEL_EMPLOYEE",
        "href": "https://api.ayoune.app/hr/employees",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "hr.employees"
      },
      {
        "rel": "CostCenters",
        "title": "MODEL_COSTCENTER",
        "href": "https://api.ayoune.app/accounting/costcenters",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "accounting.costcenters"
      },
      {
        "rel": "CostCenters",
        "title": "MODEL_COSTCENTER",
        "href": "https://api.ayoune.app/accounting/costcenters",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "accounting.costcenters"
      },
      {
        "rel": "WorkCenters",
        "title": "MODEL_WORKCENTER",
        "href": "https://api.ayoune.app/production/workcenters",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "production.workcenters"
      },
      {
        "rel": "Departments",
        "title": "MODEL_DEPARTMENT",
        "href": "https://api.ayoune.app/config/departments",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.departments"
      },
      {
        "rel": "Images",
        "title": "MODEL_IMAGE",
        "href": "https://api.ayoune.app/cms/images",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.images"
      },
      {
        "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": "CodeAgents",
        "title": "MODEL_CODEAGENT",
        "href": "https://api.ayoune.app/coding/codeagents",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "coding.agents"
      },
      {
        "rel": "AIAgents",
        "title": "MODEL_AIAGENT",
        "href": "https://api.ayoune.app/ai/aiagents",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "ai.aiagents"
      }
    ],
    "debugId": "6ac9b52399da55edcd8f0c7f",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_EMPLOYEE",
        "href": "https://api.ayoune.app/hr/employees/6ab22701497e7e1a34056884/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_EMPLOYEE",
        "href": "https://api.ayoune.app/hr/employees/6ab22701497e7e1a34056884",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.34.1",
      "core": "2026.368.1"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9822",
      "reset": "1791607534",
      "resetDate": "Sat Oct 10 2026"
    },
    "responseTime": 1450.233096,
    "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