/reed/jobs/similar

POST /api/reed/jobs/similar

Price: 10 credits

Get jobs Reed recommends as similar to a given job (by job ID or URL). Returns job cards with the same shape as the job details endpoint: title, description, salary, location, posting company, contract type and flags.

How to use it

Given a Reed job ID or URL, return the jobs Reed lists as similar. Each item has the same fields as reed/jobs (id, url, title, description, salary, location, owner, contract_type, employment flags). Feed any id back into reed/jobs for the full taxonomy/sector/breadcrumbs detail.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• job string required — Reed job ID or a job URL to find similar jobs for (examples: "56531217", "https://www.reed.co.uk/jobs/python-developer/56531217"; minLength: 1)

Response

• @type string (default: "ReedJob")
• id integer required
• url string nullable
• description string nullable
• created_at string nullable
• updated_at string nullable
• display_date string nullable
• expiry_date string nullable
• next_refresh_date string nullable
• taxonomy string nullable
• breadcrumbs array (default: [])
• skills array (default: [])
• screening_questions array (default: [])
  • @type string (default: "ReedScreeningQuestion")
  • id integer nullable
  • text string nullable
  • expected_answer boolean nullable
  • is_reject_on_incorrect_answer boolean nullable
  • sort_order integer nullable
• contract_type string nullable
• cover_letter_preference string nullable
• recruiter_tier string nullable
• application_eligibility string nullable
• is_full_time boolean nullable
• is_part_time boolean nullable
• is_permanent boolean nullable
• is_temp boolean nullable
• is_contract boolean nullable
• is_agency boolean nullable
• is_employer boolean nullable
• is_reed boolean nullable
• is_featured boolean nullable
• is_promoted boolean nullable
• is_graduate boolean nullable
• is_early_bird boolean nullable
• is_easy_apply boolean nullable
• is_training_job boolean nullable
• is_live boolean nullable
• is_public boolean nullable
• is_suspended boolean nullable
• is_redirect boolean nullable
• is_manage_exec boolean nullable
• is_multilingual boolean nullable
• has_eligibility_to_work_in_uk boolean nullable
• salary object nullable
  • @type string (default: "ReedJobSalary")
  • display string nullable
  • currency_id integer nullable
  • salary_from number nullable
  • salary_to number nullable
  • from_per_annum number nullable
  • to_per_annum number nullable
  • type string nullable
  • is_ote boolean nullable
  • has_included_benefits boolean nullable
  • is_pro_rata boolean nullable
  • is_negotiable boolean nullable
• location object nullable
  • @type string (default: "ReedJobLocation")
  • location_name string nullable
  • town_name string nullable
  • county_name string nullable
  • region_name string nullable
  • sub_country_name string nullable
  • country_name string nullable
  • country_code string nullable
  • post_code string nullable
  • is_remote boolean nullable
  • inferred_location_type string nullable
• owner object nullable
  • @type string (default: "ReedJobOwner")
  • ou_id integer nullable
  • ou_name string nullable
  • ou_type integer nullable
  • organisation_id integer nullable
  • profile_id integer nullable
  • profile_name string nullable
  • alias string nullable
  • company_profile_id integer nullable
  • company_profile_url string nullable
  • reference string nullable
  • image string nullable
  • banner string nullable
• sector object nullable
  • @type string (default: "ReedJobSector")
  • id integer nullable
  • name string nullable
  • parent_id integer nullable
  • parent_name 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 — Source job not found (well-formed but nonexistent or expired listing) 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.