/ctgoodjobs/companies/jobs

POST /api/ctgoodjobs/companies/jobs

Price: 10 credits

List all live CTgoodjobs (Hong Kong job board) listings of one employer, addressed by employer id or employer URL, optionally narrowed by keyword. Returns job cards with id, url, title, employer (id, name, profile url, logo), publication and expiry timestamps, salary, experience range, highlights, job areas, work locations with coordinates and Chinese names, employment types, career levels and listing flags. An employer with no live listing returns 412.

How to use it

List every live job ad an employer currently runs on the Hong Kong board CTgoodjobs. Address the employer by company id (an 8-digit string that may keep leading zeros) or by an employer URL; optionally narrow with keyword and choose sort. Each result carries id, url, job_title, company_id, company_name, company_url, image, published_at and expires_at as unix seconds, salary in HKD, experience_from/to, highlights, job_areas, locations (with latitude, longitude and name_zh), employment_types, career_levels and listing flags. Use it to track an employer's hiring volume and role mix over time.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — CTgoodjobs employer id, or an employer URL containing it (examples: "00001885", "https://jobs.ctgoodjobs.hk/company-jobs/00001885/bank-of-china-hong-kong-limited"; minLength: 1)
• count integer required — Max result count (examples: 20; min: 1; max: 3000)
• keyword string — Restrict to the employer's ads matching this keyword (default: ""; examples: "manager")
• sort string — Result ordering (default: "2"; one of: "1", "2")

Response

• @type string (default: "CtgoodjobsJobCard")
• id string required
• url string required
• job_title string required
• company_id string nullable
• company_name string nullable
• company_url string nullable
• image string nullable
• published_at integer nullable
• expires_at 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
• highlights array (default: [])
• 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
• locations array (default: [])
  • @type string (default: "CtgoodjobsJobLocation")
  • id string nullable
  • name string required
  • name_zh string nullable
  • latitude number nullable
  • longitude number 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
• is_promoted boolean nullable
• is_boosted boolean nullable
• is_featured boolean nullable
• is_high_salary boolean nullable
• is_fresh_grad boolean nullable
• is_cv_optional boolean nullable
• is_whatsapp_apply boolean nullable
• is_ct_message boolean nullable
• is_crawled boolean 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 — Employer not found or currently running no listings 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.