/bayt/jobs/similar

POST /api/bayt/jobs/similar

Price: 5 credits

List the jobs Bayt.com recommends alongside a given job (its 'Similar Jobs', 'People who viewed this job also viewed' and 'People who applied to this job also applied to' rails), identified by job ID or a job detail URL across any supported MENA country site. Each related job carries its id, title, url, posting age, easy-apply flag, hiring company (name, logo) and location (city, country).

How to use it

List Bayt.com's related-job recommendations for a job, by numeric job id or a job detail URL. Set country to choose the national site (UAE, Saudi Arabia, Qatar, ...) and language for English or Arabic. Aggregates Bayt's similar / also-viewed / also-applied rails (deduplicated, excluding the source job); each item includes id, title, url, posted_age, easy_apply, plus nested company (name, image) and location (city, country). Returns an empty list when the job has no recommendation rails.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• job string required — Bayt job ID or a job detail URL containing it (examples: "5464405", "https://www.bayt.com/en/uae/jobs/senior-accountant-5464405/"; minLength: 1)
• count integer required — Max number of results to return (min: 1)
• country string — Bayt country site to query (default: "UAE"; one of: "UAE", "Saudi Arabia", "Qatar", "Kuwait", "Oman", "Bahrain", "Egypt", "Jordan", "Lebanon", "Morocco", "Algeria", "Tunisia", "Libya", "Iraq", "Yemen", "India", "Pakistan", "International")
• language string — Content language (default: "en"; one of: "en", "ar")

Response

• @type string (default: "BaytSimilarJob")
• id integer required
• url string nullable
• country string required (one of: "UAE", "Saudi Arabia", "Qatar", "Kuwait", "Oman", "Bahrain", "Egypt", "Jordan", "Lebanon", "Morocco", "Algeria", "Tunisia", "Libya", "Iraq", "Yemen", "India", "Pakistan", "International")
• posted_age string nullable
• easy_apply boolean (default: false)
• company object nullable
  • @type string (default: "BaytSimilarJobCompany")
  • name string nullable
  • image string nullable
• location object nullable
  • @type string (default: "BaytSimilarJobLocation")
  • city string nullable
  • country 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 — 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.