/teamtailor/jobs

POST /api/teamtailor/jobs

Price: 5 credits

Get one published job posting from a company's Teamtailor career board by board handle and job id (or a full job URL): title, hiring organisation, the full HTML description, employment type, department, workplace status, the board's own label/value summary rows, structured locations, salary range, publication and expiry dates, and the hosted and apply URLs.

How to use it

A posting is addressed by the pair (company, job_id) — the same id under a different board is a 412, so never carry an id across boards. job_id takes the numeric id or the full job URL, and the company is then read from that URL; the slug in a job URL is cosmetic and the id alone resolves. Call this rather than teamtailor/jobs/search when employment_type, department or workplace_type is needed — those three exist only here. department, workplace_type and location come from a label/value block each board names in its own language, so they are resolved from the board's own department and location links, its remote-status badge and its published facet vocabulary rather than from fixed labels; when one of the three is null, read summary, which carries every row of that block under the board's own labels and may hold the value under a label that could not be classified. hosted_url and apply_url are the board's own canonical host, which is often a custom domain and can differ from the vendor-host URL teamtailor/jobs/search returns for the same job; both forms fetch. If that canonical host cannot be reached, the posting is still served from the board feed, and then those five detail-only fields are all null at once.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Company board. Accepts the Teamtailor handle, a board host, or a full board or job URL (examples: "actavo", "pemo.teamtailor.com", "https://careers.actavo.com/jobs"; minLength: 1)
• job_id string required — Job identifier. Accepts the numeric job id or a full job URL (examples: "8315177", "https://careers.actavo.com/jobs/8315177-accounts-payable-executive"; minLength: 1)

Response

• @type string (default: "TeamtailorJob")
• id integer required
• company string required
• company_name string nullable
• company_url string nullable
• description string nullable
• employment_type string nullable
• department string nullable
• workplace_type string nullable
• location string nullable
• locations array (default: [])
  • @type string (default: "TeamtailorAddress")
  • locality string nullable
  • region string nullable
  • country string nullable
  • postal_code string nullable
  • street string nullable
• salary_range object nullable
  • @type string (default: "TeamtailorSalaryRange")
  • currency string nullable
  • interval string nullable
  • min number nullable
  • max number nullable
• published_at integer nullable
• valid_through_at integer nullable
• summary array (default: [])
  • @type string (default: "TeamtailorSummaryRow")
  • label string required
  • value string nullable
• hosted_url string nullable
• apply_url 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 — Company board not found, the job is unknown or no longer published, or the host given does not serve a Teamtailor board 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.