← HR API
Applicants
Singular: Applicant — Base URL: https://hr-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)
Try it now
beta
Response (live)
Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.
Endpoints
| Method | Path | Description | Right |
|---|---|---|---|
| GET | /applicants |
List with filters/pagination | hr.applicants.view |
| GET | /applicants/:id |
Single record | hr.applicants.view |
| POST | /applicants |
Create new record | hr.applicants.new |
| PUT | /applicants |
Update record | hr.applicants.edit |
| DELETE | /applicants/:id |
Delete record | hr.applicants.delete |
SDK
import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');
// List all
const list = await ay.hr.applicants.find().limit(10).exec();
// Single record
const one = await ay.hr.applicants.findById('OBJECT_ID').exec();
// Create
const created = await ay.hr.applicants.create({ name: 'Foo' });