/smartrecruiters/jobs/search

POST /api/smartrecruiters/jobs/search

Price: 5 credits

List job postings from a company's SmartRecruiters career board by board handle, optionally narrowed by keyword, country, region, city, department or a custom field. Each posting includes name, reference number, release date, location, industry, function, department, type of employment, experience level, language and custom fields.

How to use it

List the job postings of a specific company's SmartRecruiters career board. company is the board handle (e.g. Visa), case-insensitive; count is how many postings to return. Optional q (keyword), country, region, city, department and custom_field (fieldId:valueId) filters narrow the results. Each item has id, name, ref_number, released_at, location, industry, function, department, type_of_employment, experience_level, language and custom_fields.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Company career-board handle from the careers URL (jobs.smartrecruiters.com/{company}) (examples: "Visa", "BoschGroup"; minLength: 1)
• count integer required — Max number of job postings to return (min: 1)
• q string nullable — Full-text keyword query (examples: "engineer", "data scientist")
• country string nullable — Filter by ISO country code (examples: "us", "de", "in"; minLength: 1)
• region string nullable — Filter by region / state (examples: "TX", "California"; minLength: 1)
• city string nullable — Filter by city (examples: "Austin", "Bengaluru"; minLength: 1)
• department string nullable — Filter by department id (examples: "868639"; minLength: 1)
• custom_field string nullable — Filter by a custom field, formatted as fieldId:valueId (examples: "57ac0c81e4b06e7ab19310e1:TEC"; minLength: 1)

Response

• @type string (default: "SmartRecruitersJob")
• id string required
• name string nullable
• uuid string nullable
• ref_number string nullable
• released_at string nullable
• location object nullable
  • @type string (default: "SmartRecruitersLocation")
  • city string nullable
  • region string nullable
  • country string nullable
  • address string nullable
  • postal_code string nullable
  • remote boolean nullable
  • hybrid boolean nullable
  • hybrid_description string nullable
  • latitude string nullable
  • longitude string nullable
  • full_location string nullable
• industry object nullable
  • @type string (default: "SmartRecruitersLabel")
  • id string nullable
  • label string nullable
• function object nullable
  • @type string (default: "SmartRecruitersLabel")
  • id string nullable
  • label string nullable
• department object nullable
  • @type string (default: "SmartRecruitersLabel")
  • id string nullable
  • label string nullable
• type_of_employment object nullable
  • @type string (default: "SmartRecruitersLabel")
  • id string nullable
  • label string nullable
• experience_level object nullable
  • @type string (default: "SmartRecruitersLabel")
  • id string nullable
  • label string nullable
• language object nullable
  • @type string (default: "SmartRecruitersLanguage")
  • code string nullable
  • label string nullable
  • label_native string nullable
• custom_fields array (default: [])
  • @type string (default: "SmartRecruitersCustomField")
  • field_id string nullable
  • field_label string nullable
  • value_id string nullable
  • value_label string nullable
• job_ad object nullable
  • @type string (default: "SmartRecruitersJobAd")
  • company_description object nullable
    • @type string (default: "SmartRecruitersJobAdSection")
    • text string nullable
  • job_description object nullable
    • @type string (default: "SmartRecruitersJobAdSection")
    • text string nullable
  • qualifications object nullable
    • @type string (default: "SmartRecruitersJobAdSection")
    • text string nullable
  • additional_information object nullable
    • @type string (default: "SmartRecruitersJobAdSection")
    • text string nullable
• creator object nullable
  • @type string (default: "SmartRecruitersCreator")
  • name string nullable
  • image string nullable
• posting_url string nullable
• apply_url string nullable
• referral_url string nullable
• active boolean nullable
• visibility string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Company board not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.