← API Reference

HR API

Shifts, courses, skills, time tracking, job offers

Base URL: https://hr-api.ayoune.app — 13 entities

Example

cURL

curl -H "Authorization: Bearer pat_your_token" \
  https://hr-api.ayoune.app/accessterminals?limit=10

TypeScript SDK

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

const result = await ay.hr.accessTerminals.find().limit(10).exec();
console.log(result.payload());

Entities

Entity	REST Path	SDK	Access	Right
AccessTerminals	/accessterminals	ay.hr.accessTerminals	CRUD	hr.accessterminals	play_circle
CourseLessons	/courselessons	ay.hr.courseLessons	CRUD	hr.courselessons	play_circle
CourseModules	/coursemodules	ay.hr.courseModules	CRUD	hr.coursemodules	play_circle
CourseQuestions	/coursequestions	ay.hr.courseQuestions	CRUD	hr.coursequestions	play_circle
Courses	/courses	ay.hr.courses	CRUD	hr.courses	play_circle
Employees	/employees	ay.hr.employees	CRUD	hr.employees	play_circle
HRJobs	/hrjobs	ay.hr.hRJobs	CRUD	hr.hrjobs	play_circle
MandatoryTasks	/mandatorytasks	ay.hr.mandatoryTasks	CRUD	hr.mandatorytasks	play_circle
PayrollRuns	/payrollruns	ay.hr.payrollRuns	CRUD	hr.payrollruns	play_circle
Payslips	/payslips	ay.hr.payslips	read-only	hr.payslips	play_circle
Shifts	/shifts	ay.hr.shifts	CRUD	hr.shifts	play_circle
Vacations	/vacations	ay.hr.vacations	CRUD	hr.vacations	play_circle
WageTypes	/wagetypes	ay.hr.wageTypes	CRUD	hr.wagetypes	play_circle