Retrieve a job

This endpoint allows you to get information about a particular job.

This endpoint requires jobs_r or jobs_rw scope. Availability of candidates counters (total and per stage ones) requires candidates_r or candidates_rw scope and setting the query parameter candidates_count to true. To display office attributes, it requires offices_r

job info

GET https://www.welcomekit.co/api/v1/external/jobs/:reference

Path Parameters

NameTypeDescription

reference*

String

Job reference

Query Parameters

NameTypeDescription

stages

boolean

Returns job stages

office

boolean

Returns associated office description

candidates_count

boolean

Returns candidates counters (total and per stage ones)

application_fields

boolean

Returns application fields

organization

boolean

Returns organization fields

websites

boolean

Returns websites where job is visible

{
  "name" : "Fake Job 2",
  "external_reference" : "PROVIDER_REFERENCE2",
  "organization_reference" : "Pg4eV6k",
  "status" : "draft",
  "profile" : "Fake Job Profile",
  "apply_url" : "http://company.com/jobs/superjob/apply/",
  "company_description" : "Fake Company Description.",
  "contract_duration_min" : null,
  "experience_level" : "1_TO_2_YEARS",
  "department_id" : null,
  "profession_reference" : "sales",
  "cms_sites_references" : "wttj_fr,smgo_fr",
  "contract_duration_max" : null,
  "start_date" : "2016-09-01T00:00:00.000+02:00",
  "description" : "Fake Job Description.",
  "contract_type" : "FULL_TIME",
  "language": "en",
  "salary": {
    "min": "30000",
    "max": "40000",
    "currency": "EUR",
    "period": "yearly"
  },
  "remote" : "fulltime",
  "office_id" : 196,
  "reference" : "WTTJ_gld0A7L",
  "education_level" : "BAC_5",
  "stages" : [
    {
      "visible" : true,
      "reference" : "initial",
      "id" : 5395,
      "name" : "Nouveau",
      "candidates_count": 4
    },
    {
      "reference" : "refused",
      "visible" : true,
      "id" : 5396,
      "name" : "Refusé",
      "candidates_count": 2
    },
    {
      "id" : 5397,
      "name" : "À rencontrer",
      "reference" : null,
      "visible" : true,
      "candidates_count": 1
    },
    ...
  ],
  "candidates_count": 13,
  "created_at" : "2017-11-13T17:15:26.146+01:00",
  "updated_at" : "2017-11-13T17:15:26.146+01:00",
  "published_at" : null,
  "archived_at" : null,
  "websites" : [
     {
        "reference" : "wttj_fr",
        "name" : "Welcome to the Jungle",
        "url" : "http://preprod.welcometothejungle.co/companies/wttj/jobs/fake-job-2"
     },
    ...
  ],
  "application_fields": [
    {"name": "resume", "mode": "mandatory"},
    {"name": "portfolio", "mode": "disabled"},
    ...
  ],
  "organization": {
    "name": "wttj",
    "slug": "wttj",
    "description": "Lorem ipsum",
    "logo": "https://....."
  }
}

Request example

curl -X GET -G "https://www.welcomekit.co/api/v1/external/jobs/WTTJ_ZyDmzZ6" \
    -H "Authorization: Bearer WK_API_KEY" \
    -d "stages=true" \
    -d "websites=true" \
    -d "candidates_count=true" \
    -d "application_fields=true

Last updated