/ctgoodjobs/jobs

POST /api/ctgoodjobs/jobs

Price: 1 credit

Get a CTgoodjobs (Hong Kong job board) listing by job id. Returns the job title, highlights, the full description in both plain text and HTML, the employer (id, name, profile url, description, logo, banners, video), salary, required experience, job functions and sub-areas, industries, employment terms, career levels, education, benefits, work model, work locations with coordinates and Chinese names, licences, service types, travel requirements, skill tags, keywords, application urls, reference numbers, publication and expiry timestamps, the total view count, and whether the listing has expired. Expired listings stay retrievable with their full content.

How to use it

Get full details of a Hong Kong CTgoodjobs listing by its job id (an 8-digit string that may keep leading zeros) or by a job URL. Returns job_title, highlights, description and description_html, the employer (company_id, company_name, company_url, company_description, image, banners, video_id), salary in HKD, required experience, job_areas, industries, employment_types, career_levels, educations, benefits, work_models, locations with latitude, longitude and Chinese names, licenses, service_types, travel_requirements, skills, keywords, apply_url and whatsapp_url, job_ref_no and employer_job_ref_no, published_at, posted_at and expires_at as unix seconds, view_count and is_expired. Listings that already expired still return their full content, so historical postings stay readable.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• job string required — CTgoodjobs job id, or a job URL containing it (examples: "09520465", "https://jobs.ctgoodjobs.hk/job/09520465/account-manager-advertising-branding"; minLength: 1)

Response

• @type string (default: "CtgoodjobsJob")
• id string required
• url string required
• job_title string required
• description string nullable
• description_html string nullable
• highlights array (default: [])
• company_id string nullable
• company_name string nullable
• company_url string nullable
• industry_label string nullable
• company_description string nullable
• company_description_html string nullable
• image string nullable
• banners array (default: [])
• video_id string nullable
• apply_url string nullable
• whatsapp_url string nullable
• client_id string nullable
• job_ref_no string nullable
• employer_job_ref_no string nullable
• published_at integer nullable
• published_display string nullable
• posted_at integer nullable
• expires_at integer nullable
• is_expired boolean nullable
• view_count integer nullable
• salary object nullable
  • @type string (default: "CtgoodjobsSalary")
  • display string nullable
  • min number nullable
  • max number nullable
  • currency string nullable
  • unit string nullable
  • is_negotiable boolean nullable
  • has_commission boolean nullable
• experience_from integer nullable
• experience_to integer nullable
• experience_display string nullable
• job_areas array (default: [])
  • @type string (default: "CtgoodjobsJobArea")
  • id string nullable
  • name string required
  • function string nullable
  • area string nullable
  • url string nullable
  • function_url string nullable
  • skill_tag_path string nullable
• related_job_areas array (default: [])
  • @type string (default: "CtgoodjobsJobArea")
  • id string nullable
  • name string required
  • function string nullable
  • area string nullable
  • url string nullable
  • function_url string nullable
  • skill_tag_path string nullable
• industries array (default: [])
  • @type string (default: "CtgoodjobsTaxonomyItem")
  • id string nullable
  • name string required
  • url string nullable
• employment_types array (default: [])
  • @type string (default: "CtgoodjobsTaxonomyItem")
  • id string nullable
  • name string required
  • url string nullable
• career_levels array (default: [])
  • @type string (default: "CtgoodjobsTaxonomyItem")
  • id string nullable
  • name string required
  • url string nullable
• educations array (default: [])
  • @type string (default: "CtgoodjobsTaxonomyItem")
  • id string nullable
  • name string required
  • url string nullable
• benefits array (default: [])
  • @type string (default: "CtgoodjobsTaxonomyItem")
  • id string nullable
  • name string required
  • url string nullable
• work_models array (default: [])
  • @type string (default: "CtgoodjobsTaxonomyItem")
  • id string nullable
  • name string required
  • url string nullable
• locations array (default: [])
  • @type string (default: "CtgoodjobsJobLocation")
  • id string nullable
  • name string required
  • name_zh string nullable
  • latitude number nullable
  • longitude number nullable
• licenses array (default: [])
• channels array (default: [])
  • @type string (default: "CtgoodjobsTaxonomyItem")
  • id string nullable
  • name string required
  • url string nullable
• service_types array (default: [])
  • @type string (default: "CtgoodjobsServiceType")
  • id string nullable
  • name string required
  • category string nullable
• travel_requirements array (default: [])
  • @type string (default: "CtgoodjobsTaxonomyItem")
  • id string nullable
  • name string required
  • url string nullable
• skills array (default: [])
  • @type string (default: "CtgoodjobsJobSkill")
  • id string nullable
  • name string required
  • url string nullable
• keywords array (default: [])
• is_cv_optional boolean nullable
• is_crawled boolean nullable
• is_company_hidden boolean nullable
• translated_lang 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 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.