aYOUne
← HR API

HRJobs

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

play_circle 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": {
    "applicationForm": {
      "requiredFields": [],
      "questions": []
    },
    "_recruiters": [],
    "_id": "65e06d891e1be45a37c6243f",
    "skills": [],
    "isDraft": true,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T11:42:01.614Z",
    "updatedAt": "2024-02-29T11:42:01.614Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://hr-api.ayoune.app/hrjobs/65e06d891e1be45a37c6243f",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "aYOUneJobTitles",
        "title": "MODEL_AYOUNEJOBTITLE",
        "href": "https://api.ayoune.app/su/ayounejobtitles",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "su.jobtitles"
      },
      {
        "rel": "Workflows",
        "title": "MODEL_WORKFLOW",
        "href": "https://api.ayoune.app/pm/workflows",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.workflows"
      },
      {
        "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": "Departments",
        "title": "MODEL_DEPARTMENT",
        "href": "https://api.ayoune.app/config/departments",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.departments"
      },
      {
        "rel": "CompanyLocations",
        "title": "MODEL_COMPANYLOCATION",
        "href": "https://api.ayoune.app/config/companylocations",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.companylocations"
      }
    ],
    "debugId": "6aa37a8f0b6d9b2fe8252612",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_HRJOB",
        "href": "https://api.ayoune.app/hr/hrjobs/65e06d891e1be45a37c6243f/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_HRJOB",
        "href": "https://api.ayoune.app/hr/hrjobs/65e06d891e1be45a37c6243f",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.32.0",
      "core": "2026.335.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2408",
      "reset": "1789102207",
      "resetDate": "Fri Sep 11 2026"
    },
    "responseTime": 110.707428,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also