Reference: Job

In this reference we will go over the attributes of the job object and some of the possibilities that you have using the hokify ATS-API.

(For complete documentation, please refer to the Swagger Definition that is auto-generated and up-to-date!)

The "job" object (ICreateOrUpdateJobDTO)

All job data are written via the "job" object (mainly using "params") through the ATS-API.

The job from our Tutorial:


  "sourceId": "hy13720954",

  "params": {

    "name": "Typescript Developer (Focus Backend)",

    "company": "hokify GmbH",

    "descriptionHTML": "<p>We are looking for [...]</p>",

    "contactEmail": "",

    "type": "55d74e5d365315e629446d54",

    "region": "at",

    "address": "Jakov-Lind-Straße 2, 1020 Wien",

    "wage": "min. 3.500 EUR",

    "fields": [






The lifespan of a job revolves around the central element: its ID. (hokify-internally known as "sourceId" as it comes from you, or something in your possession: the source of each job.)

We need a unique ID so that we and you in the system can find the jobs again.

(Similar to creating any data in any software, these IDs must not be re-used for different jobs at later time!)

"params" (IJobAtsEditFields)

All job data are passed as "params" of type IJobAtsEditFields.

For any individual request, no param is strictly required (as createOrUpdateJob may also be used to simply update a single value).

For a job in general, the minimum details required for a job are the following params (besides its sourceId):

Additional information that is advisable:

(All additional information you provide raises job-ad quality and increases the discoverability of your job.)

description / descriptionHTML

The actual description of the job-ad can be submitted either in HTML format (using param descriptionHTML) or plain text (using param description) and will be transformed into the hokify layout. Possible formatting is headings, paragraphs, lists.

About HTML

About plain-text:


The example below shows two different inputs that will result in the same job description in the frontend:

"descriptionHTML": "<p>We are looking for a backend enthusiastic <strong>TYPESCRIPT developer</strong>.</p><h2>Our mission</h2><p>We put good people into good jobs in the fastest, easiest and the most enjoyable way.</p><h4>Our tools</h4><p>We work with:</p><ul><li>Typescript</li><li>Coffee</li></ul>"

"description": "We are looking for a backend enthusiastic TYPESCRIPT developer.\nOUR MISSION\nWe put good people into good jobs in the fastest, easiest and the most enjoyable way.\nOUR TOOLS\nWe work with:\n- Typescript\n- Coffee"


Submit a job image for each job using the separate "jobPic" when creating or updating a job with createOrUpdateJob.

Encode the image as base64 string to pass it to the endpoint. The image is uploaded to our storage servers and scaled to needed dimensions automatically.

Image requirements: