/careerbuilder/jobs/similar

POST /api/careerbuilder/jobs/similar

Price: 20 credits

Get jobs similar to a given CareerBuilder job posting

How to use it

Get a list of CareerBuilder job postings similar to a given job (matched by role and location). For each similar job returns the title, full HTML and plain-text descriptions plus a short summary, salary range with currency and pay unit (flagged when estimated rather than employer-stated), the hiring company (name, logo, website, description, founding year, employee-count band, headquarters), job locations (city, state, country, coordinates), employment types, extracted skills, normalized job title and occupational category, remote/onsite type, industry, the apply method and URL, posting status, and posting and update dates.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• job string required — CareerBuilder job id (GUID), a job-details URL, or the full SEO job id (examples: "7acb453b-4375-4c29-82a5-2d45cffa72fd", "https://www.careerbuilder.com/job-details/business-development-representative-idaho-falls-id--7acb453b-4375-4c29-82a5-2d45cffa72fd"; minLength: 1)
• count integer required — Max number of similar jobs to return (min: 1)

Response

• @type string (default: "CareerbuilderJob")
• id string required
• seo_id string nullable
• url string nullable
• status string nullable
• is_promoted boolean nullable
• job_type string nullable
• provider string nullable
• industry string nullable
• posted_at string nullable
• created_at string nullable
• modified_at string nullable
• posted_age string nullable
• description string nullable
• description_text string nullable
• short_description string nullable
• apply object nullable
  • @type string (default: "CareerbuilderApply")
  • type string nullable
  • url string nullable
• locations array (default: [])
  • @type string (default: "CareerbuilderLocation")
  • city string nullable
  • state string nullable
  • country string nullable
  • postal_code string nullable
  • latitude number nullable
  • longitude number nullable
• salary object nullable
  • @type string (default: "CareerbuilderJobSalary")
  • salary_min number nullable
  • salary_max number nullable
  • currency string nullable
  • unit string nullable
  • is_extracted boolean nullable
• normalized_salary object nullable
  • @type string (default: "CareerbuilderNormalizedSalary")
  • currency string nullable
  • base_type string nullable
• company object nullable
  • @type string (default: "CareerbuilderCompany")
  • name string nullable
  • image string nullable
  • website string nullable
  • description string nullable
  • founded_year string nullable
  • employee_count_band string nullable
  • city string nullable
  • region string nullable
  • country string nullable
• employment_types array (default: [])
• skills array (default: [])
• remote_type string nullable
• normalized_title string nullable
• occupational_category string nullable
• valid_through_at string nullable
• applicant_location_countries array (default: [])
• mesco_codes array (default: [])

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 posting not found or no longer available 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.