Postings

This is an object representing a job posting when you publish a job ad in SmartRecruiters. A single job can have multiple job ads, and a single job ads can have multiple job postings. You can use the Postings API to retrieve job postings of a company.

{
  "id": "string",
  "uuid": "string",
  "name": "string",
  "applyUrl": "string",
  "postingUrl": "string",
  "referralUrl": "string",
  "refNumber": "string",
  "company": {
    "identifier": "string",
    "name": "string"
  },
  "releasedDate": "2021-07-27T07:52:41.498Z",
  "location": {
    "country": "string",
    "region": "string",
    "city": "string",
    "remote": true
  },
  "industry": {
    "id": "string",
    "label": "string"
  },
  "department": {
    "id": "string",
    "label": "string",
    "description": "string"
  },
  "function": {
    "id": "string",
    "label": "string"
  },
  "typeOfEmployment": {
    "id": "string",
    "label": "string"
  },
  "experienceLevel": {
    "id": "associate",
    "name": "string"
  },
  "customField": [
    {
      "fieldId": "string",
      "fieldLabel": "string",
      "valueId": "string",
      "valueLabel": "string"
    }
  ],
  "ref": "string",
  "creator": {
    "name": "string"
  },
  "jobAd": {
    "sections": {
      "companyDescription": {
        "title": "string",
        "text": "string"
      },
      "jobDescription": {
        "title": "string",
        "text": "string"
      },
      "qualifications": {
        "title": "string",
        "text": "string"
      },
      "additionalInformation": {
        "title": "string",
        "text": "string"
      }
    }
  }
}

The job posting object

id string
Unique posting identifier within a company

uuid string
Unique posting identifier across all SmartRecruiters company

name string
The name of the job posting

applyUrl string
Unique url of the posting which the application will be submitted to

postingUrl string
Unique url of the job posting

referralUrl string
Unique url of the job posting for referees

refNumber string
Reference number of the job posting

company object
Company that offers the job which the job posting is advertising for

  • company.identifier string
    Unique company identifier
  • company.name string
    Name of the company

releaseDate date-time
The time that the posting was created. The value should be ISO8601-formatted date with the following format: yyyy-MM-ddTHH:mm:ss.SSSZZ.

location object
The job's location information

  • location.country string
    Name of the country of the job location. The value is a two-letter, ISO 3166-1 alpha-2 formatted country code.
  • location.countryCode string
    Two-letter, ISO 3166-1 alpha-2 formatted country code of the job location
  • location.region string
    The job area of description, such as state, province or voivodeship.
  • location.city string
    The city of the job location
  • remote boolean
    Whether the job is remote. Set remote=true if the job is remote

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

customField array of objects
An array of custom defined properties

  • properties.jobProperty object
    A custom defined property
    • properties.customProperty.fieldId string
      The unique identifier of the custom property
    • properties.customProperty.fieldLabel string
      The name of the custom property
    • properties.customProperty.valueId string
      The unique identifier of the value of the custom property
    • properties.customProperty.valueLabel string
      The name of the value of the custom property

ref string

creator object
The user who created the job posting

  • creator.name string
    The name of the user who created the job posting

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