Skip to content
aYOUne
← HR API

Employees

Singular: Employee — Base URL: https://hr-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

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": {
    "drivingLicense": {
      "classes": []
    },
    "_id": "6ab22701497e7e1a34056887",
    "createdAt": "2026-09-22T06:58:05.891Z",
    "updatedAt": "2026-09-22T06:58:05.891Z",
    "firstName": "Paul",
    "lastName": "Kranz",
    "email": "paul.kranz@tolinaxdemo.example",
    "phone": "+49 30 23125 53",
    "position": "Supportmitarbeiter",
    "department": "Support",
    "status": "active",
    "hiredAt": "2023-08-02T09:00:00.000Z",
    "personnelNumber": "P-0010",
    "_workCenters": [],
    "workload": [],
    "skills": [],
    "wage": [],
    "children": [],
    "education": [],
    "languages": [],
    "occupationalHealth": [],
    "leavePeriods": [],
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://hr-api.ayoune.app/employees/6ab22701497e7e1a34056887",
        "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": "6adeca4fce0eb0037823225f",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_EMPLOYEE",
        "href": "https://api.ayoune.app/hr/employees/6ab22701497e7e1a34056887/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_EMPLOYEE",
        "href": "https://api.ayoune.app/hr/employees/6ab22701497e7e1a34056887",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.34.1",
      "core": "2026.388.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9816",
      "reset": "1792989227",
      "resetDate": "Mon Oct 26 2026"
    },
    "responseTime": 100.568079,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also