This section aims at providing examples for the data structures that are used while interacting with SmartRecruiters API. All examples are in JSON.

The top level object is Posting.

Posting

Posting represents a single posting information. A list of Posting objects is returned when using the /postings endpoint.

Example:

{
    "id": "75551135",
    "uuid": "34225731-e7cf-4584-b0b7-78098fe1a66b",
    "name": "Director, Customer Engagement",
    "jobAdId": "106f35bc-a0e6-4e55-96f9-56835e3f8349",
    "refNumber": "REF12345",
    "company": {
        "identifier": "smartrecruiters",
        "name": "SmartRecruiters Inc"
    },
    "releasedDate": "2014-02-19T19:36:42.346Z",
    "location": {
        "city": "San Francisco",
        "region": "CA",
        "country": "us",
        "remote": true,
        "latitude": "28.557071",
        "longitude": "-81.359463"
    },
    "industry": {
        "id": "internet",
        "label": "Internet"
    },
    "department": {
        "id": "18554",
        "label": "Marketing",
        "description": "Marketing Department"
    },
    "function": {
        "id": "marketing",
        "label": "Marketing"
    },
    "typeOfEmployment": {
        "label": "Full-time"
    },
    "experienceLevel": {
        "id": "director",
        "label": "Director"
    },
    "customField": [ ],
    "ref": "https://api.smartrecruiters.com/api-v1/companies/smartrecruiters/postings/900155674",
    "creator": {
        "name": "Renette Youssef"
    }
}

Fields description

Name

Type

Description

id

string

unique string id associated with the posting

uuid

string

universally unique string id associated with the posting

name

string

name of a job associated with the posting

jobAdId

string

id of a job ad

refNumber

string

job reference number

releasedDate

date

date when a posting has been released

creator

object

employee who created a posting. Please check Employee object.

company

object

company associated with a job. Please check Company object.

industry

object

industry associated with a job. Please check Industry object and /industries endpoint

department

object

department associated with a job. Please check Department object.

function

object

function associated with a job. Please check Function object and /functions endpoint

experienceLevel

object

experienceLevel associated with a job. Please check ExperienceLevel object and /levels endpoint

typeOfEmployment

object

typeOfEmployment associated with this job. Please check TypeOfEmployment object.

location

object

jobs location. Please see Location object

customField

object

customField associated with this job. Please see CustomField object

ref

string

URL pointing endpoint with detailed information about the job

PostingDetails

PostingContent represents a single posting detailed information.

Example:

{
    "id": "884352026",
    "uuid": "34225731-e7cf-4584-b0b7-78098fe1a66b",
    "name": "SEO Manager",
    "jobId": "a8fe8118-455c-407e-8e84-b9d0201697b8",
    "jobAdId": "106f35bc-a0e6-4e55-96f9-56835e3f8349",
    "company": {
        "name": "SmartRecruiters Inc",
        "identifier": "smartrecruiters"
    },
    "department": {
        "id": 18554,
        "label": "Marketing",
        "description": "Marketing Department"
    }
    "location": {
        "city": "San Francisco",
        "region": "CA",
        "country": "us",
        "remote": true,
        "latitude": "28.557071",
        "longitude": "-81.359463"
    },
    "industry": {
        "id": "internet",
        "label": "Internet"
    },
    "function": {
        "id": "marketing",
        "label": "Marketing"
    },
    "experienceLevel": {
        "id": "mid_senior_level",
        "label": "Mid-Senior Level"
    },
    customField": [
        {
            "fieldId": "52d95747e4b0ba7acb9217ea",
            "fieldLabel": "Division",
            "valueId": "23aba1d4-4c81-48f7-9ae2-3ab84ee32a80",
            "valueLabel": "Sales EMEA"
        }
    ],
    "creator": {
        "name": "Jerome Ternynck",
        "avatarUrl": "https://www.smartrecruiters.com/web-api/employees/image/Tz22MEbz"
    },
    "applyUrl": "https://www.smartrecruiters.com/smartrecruiters/74944235-experienced-seo-consultant-?oga=true",
    "jobAd": { 
        "sections":  { 
            "companyDescription": { 
                "title": "Company Description", 
                "text": "The best company to work in." 
            }, 
            "jobDescription": {
                "title": "Job Description",
                "text": "It's a rally cool job." 
            },
            "qualifications": { 
                "title": "Qualifications", 
                "text": "a quality coder" 
            },
            "additionalInformation": {
                "title": "Additional Information", 
                "text": "Additional information about this job." 
            },
            "videos": {
                "title": "Videos To Watch", 
                "urls": [
                    "https://www.youtube.com/watch?v=eGb73Obar_c"
            ]
            }
        }
    },
    "active": true
}

Fields description:

Name

Type

Description

id

string

unique string id associated with the posting

uuid

string

universally unique string id associated with the posting

name

string

name of a job associated with the posting

jobId

string

id of a job

jobAdId

string

id of a job ad

releasedDate

date

date when a posting has been released

applyUrl

string

Url which points to an Application Process (OneClick apply).

creator

object

employee who created a posting. Please check Employee object.

company

object

company associated with a job. Please check Company object.

departament

object

department associated with a job. Please check Department object.

industry

object

industry associated with a job. Please check Industry object and /industries endpoint

function

object

function associated with a job. Please check Function object and /functions endpoint

experienceLevel

object

experienceLevel associated with a job. Please check ExperienceLevel object and /levels endpoint

typeOfEmployment

object

typeOfEmployment associated with this job. Please check TypeOfEmployment object.

location

object

jobs location. Please see Location object

customField

object

customField associated with this job. Please see CustomField object

jobAd

object

content of a job ad. Please see JobAd object

active

boolean

indicates whether the posting is live or unpublished

JobAd

JobAd represent job ad content.

Example:

{
"sections":  { 
    "companyDescription": { 
        "title": "Company Description", 
        "text": "The best company to work in." 
    }, 
    "jobDescription": {
        "title": "Job Description",
        "text": "It's a rally cool job." 
    },
    "qualifications": { 
        "title": "Qualifications", 
        "text": "a quality coder" 
    },
    "additionalInformation": {
        "title": "Additional Information", 
        "text": "Additional information about company" 
    }, 
    "videos": { 
        "title": "Videos to watch", 
        "urls": [
              "https://www.youtube.com/watch?v=eGb73Obar_c"
        ] 
    } 
}

Fields description

Name

Type

Description

sections.companyDescription

object

JobAdSection describing company

sections.jobDescription

object

JobAdSection describing job

sections.qualifications

object

JobAdSection describing required qualifications

sections.additionalInformation

object

JobAdSection describing additional information about job

sections.videos

array

JobAdVideosSection describing job related videos (optional)

JobAdSection

JobAdSection represents part of a JobAd. JobAd contains following sections:

  • company description
  • job description
  • qualifications
  • additional information

Example:

{
        "title": "Company Description", 
        "text": "The best company to work in." 
}

Fields description

Name

Type

Description

title

string

title of a section

text

string

content of section. SmartRecruiters supports plain text with basic html tags used for formatting

JobAdVideosSection

JobAdVideosSection represents part of a JobAd.

Example:

{
        "title": "Videos to watch",
        "urls": [
            "https://www.youtube.com/watch?v=eGb73Obar_c"
        ] 
}

Fields description

Name

Type

Description

title

string

title of a section

urls

array

array containing job related video urls


Did this page help you?