Jobs

This is an object that representing your job in SmartRecruiters. The job object contains some key objects such as the job ad object and position object. You can use the Job API to create, update and delete jobs and job ads, manage job positions and job postings.

{
  "id": "string",
  "title": "string",
  "refNumber": "string",
  "createdOn": "2021-07-26T22:33:37.486Z",
  "updatedOn": "2021-07-26T22:33:37.486Z",
  "lastActivityOn": "2021-07-26T22:33:37.486Z",
  "department": {
    "id": "string",
    "label": "string",
    "description": "string"
  },
  "location": {
    "country": "string",
    "countryCode": "string",
    "regionCode": "string",
    "region": "string",
    "city": "string",
    "address": "string",
    "postalCode": "string",
    "longitude": "string",
    "latitude": "string",
    "manual": true,
    "remote": true
  },
  "status": "CREATED",
  "postingStatus": "PUBLIC",
  "targetHiringDate": "2021-07-26T22:33:37.486Z",
  "industry": {
    "id": "string",
    "label": "string"
  },
  "function": {
    "id": "string",
    "label": "string"
  },
  "typeOfEmployment": {
    "id": "string",
    "label": "string"
  },
  "experienceLevel": {
    "id": "string",
    "label": "string"
  },
  "eeoCategory": {
    "id": "string",
    "label": "string"
  },
  "template": true,
  "creator": {
    "id": "string",
    "firstName": "string",
    "lastName": "string"
  },
  "compensation": {
    "min": 0,
    "max": 0,
    "currency": "string"
  },
  "jobAd": {
    "sections": {
      "companyDescription": {
        "title": "string",
        "text": "string"
      },
      "jobDescription": {
        "title": "string",
        "text": "string"
      },
      "qualifications": {
        "title": "string",
        "text": "string"
      },
      "additionalInformation": {
        "title": "string",
        "text": "string"
      },
      "videos": {
        "urls": [
          "string"
        ]
      }
    },
    "language": {
      "code": "string",
      "label": "string",
      "labelNative": "string"
    }
  },
  "properties": [
    {
      "id": "string",
      "label": "string",
      "value": {
        "id": "string",
        "label": "string"
      }
    }
  ],
  "actions": {
    "hiringTeam": {
      "url": "string",
      "method": "GET"
    },
    "publications": {
      "url": "string",
      "method": "GET"
    },
    "positions": {
      "url": "string",
      "method": "GET"
    },
    "applyOnWeb": {
      "url": "string",
      "method": "GET"
    },
    "details": {
      "url": "string",
      "method": "GET"
    }
  }
}

The job object

id string
Unique job identifier

title string
The title of a job

refNumber string
The reference number of a job

createdOn date-time
The time when the job was created. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.

updatedOn date-time
The time when a property of the job was updated. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.

lastActivityOn date-time

department object
The department in the company of which the job belongs to

  • department.id string
    Unique department identifier
  • department.label string
    The name of the department
  • department.description string
    The description of the department

location object
The job's location information

  • location.country string
    Name of the country of the job location
  • location.countryCode string
    Two-letter, ISO 3166-1 alpha-2 formatted country code of the job location
  • location.regionCode string
    Four-letter ISO 3166-2:US formatted region code for regions in the United State. The regionCode field is not required and not recommend to be used for regions outside of the United States.
  • location.region string
    The job area of description, such as state, province or voivodeship.
  • location.city string
    The city of the job location
  • location.address string
    The address line of the job location
  • location.lat float
    ISO 6709 formatted latitude of the job address
  • location.lng string
    ISO 6709 formatted longitude of the job address
  • manual boolean
  • remote boolean
    Whether the job is remote. Set remote=true if the job is remote

status string
The status of the job. Possible values: CREATED, SOURCING, FILLED, INTERVIEW, OFFER, CANCELLED, ON_HOLD, OTHER

postingStatus string
The overall publication status of job ads of the job. Possible values: PUBLIC, INTERNAL, NOT_PUBLISHED.

industry object
The general category of the job based on the job function within the company (e.g. Legal Services, Government Administration ...etc.)

  • industry.id string
    Unique job industry identifier
  • industry.label string
    The name of the job industry

function object
The general role of the job within the company (e.g. Consulting, Customer Service ...etc.).

  • function.id string
    Unique job function identifier
  • function.label string
    The name of the job function

typeOfEmployment object
The types of employment of the job within the company (e.g. Part-time, Contract ...etc.)

  • typeOfEmployment.id string
    Unique employment type identifier
  • function.label string
    The name of the job employment type

experienceLevel object
The level of experience which the job required (e.g. Associate, Director ...etc.)

  • experienceLevel.id string
    Unique experience level identifier
  • experienceLevel.label string
    The name of the job experience level

eeoCategory object
The Equal Employment Opportunity (EEO) category of the job.

  • eeoCategroy.id string
    Unique eeo category identifier
  • experienceLevel.label string
    The name of the job eeo category

template boolean
Whether the job information is saved as a template. Set template=true if the job information is to be saved as a template

creator object
The user who created the job

  • creator.id string
    Unique user identifier of the user who created the job
  • creator.firstName string
    The first name of the user who created the job
  • creator.lastName string
    The last name of the user who created the job

compensation object
The range of compensation of the job

  • compensation.min number
    Minimum compensation amount.
  • compensation.max number
    Maximum compensation amount
  • compensation.currency string
    Three-letter, ISO 4217 formatted currency code.

jobAd object
The default job ad of the job

  • jobAd.section object
    An object that contains different content section of the job ad
    • jobAd.section.companyDescription object
      A section of the job ad that describes the company
      • jobAd.section.companyDescription.title string
        The title of the Company Description section of the job ad
      • jobAd.section.companyDescription.text string
        The body content of the Company Description section of the job ad
    • jobAd.section.jobDescription object
      A section of the job ad that describes the job
      • jobAd.section.jobDescription.title string
        The title of the Job Description section of the job ad
      • jobAd.section.jobDescription.text string
        The body content of the Job Description section of the job ad
    • jobAd.section.qualification object
      A section of the job ad that describes the qualification of the job
      • jobAd.section.qualification.title string
        The title of the Qualification section of the job ad
      • jobAd.section.qualification.text string
        The body content of the Qualification section of the job ad
    • jobAd.section.additionalInformation object
      A section of the job ad that provides additional information of the job
      • jobAd.section.additionalInformation.title string
        The title of the Additional Information section of the job ad
      • jobAd.section.additionalInformation.text string
        The body content of the Additional Information section of the job ad
    • jobAd.section.videos object
      A section of the job ad which videos of the job or of the company can be attached
      • jobAd.section.videos.urls array of strings
        Video urls of the job ad. More than one urls can be applied at the same time
  • language object
    The language of the job ad
    • language.code string
      The language code that defines the job ad language. Possible values: af, am, ar, az, bg, bn, ca, cs, cy, da, de, el, en, en-GB, es, es-MX, et, eu, fa, fi, fil, fr, fr-CA, ga, gl, gu, he, hi, hr, hu, hy, id, is, it, ja, ka, km, kn, ko, lo, lt, lv, ml, mn, mr, ms, ne, nl, no, pl, pt, pt-BR, ro, ru, si, sk, sl, sr, sv, sw, ta, te, tr, uk, ur, vi, zh-CN, zh-TW, zu
    • language.label string
      The name of the language of the job ad in English
    • language.labelNative string
      The name of the language of the job in the language

properties array of objects
An array of custom defined job properties

  • properties.jobProperty object
    A custom defined job property
    • properties.jobProperty.id string
      The unique identifier of the job property. Possible values can be retrieved from the (Configuration API)[https://dev.smartrecruiters.com/customer-api/live-docs/configuration-api/#/configuration/configuration.job-properties.all]
    • properties.jobProperty.label string
      The name of the job property
    • properties.jobProperty.value object
      The value of custom job property
      • properties.jobProperty.value.id string
        The unique identifier of the job property value. Possible values can be retrieved from the (Configuration API)[https://dev.smartrecruiters.com/customer-api/live-docs/configuration-api/#/configuration/configuration.job-properties.values.get]
      • properties.jobProperty.value.label string
        The name of the job property value

actions object
Different resources of the job, their respective location and method to retrieve them

  • actions.hiringTeam object
    Hiring Team resource location of the job and method to retrieve the resource
    • actions.hiringTeam.url string
    • actions.hiringTeam.method string
  • actions.publications object
    Job publications resource location of the job and method to retrieve the resource
    • actions.publications.url string
    • actions.publications.method string
  • actions.positions object
    Positions resource location of the job and method to retrieve the resource
    • actions.positions.url string
    • actions.positions.method string
  • actions.applyOnWeb object
    • actions.applyOnWeb.url string
    • actions.applyOnWeb.method string
  • actions.details object
    • actions.details.url string
    • actions.details.method string