/totaljobs/jobs/search

POST /api/totaljobs/jobs/search

Price: 20 credits

Search Totaljobs job listings by keyword and filters

How to use it

Search Totaljobs UK job listings by keyword with rich filters — narrow by location and radius, posting recency, direct-employer vs agency, employment type, and minimum salary for a chosen period (annual, daily or hourly); order by relevance, date, or salary. Each result carries the job id, title, hiring company (id, name, logo), location, postal code, salary, a short snippet, and publication date.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• text string required — Search query — job title, skill, or company name (minLength: 1)
• count integer required — Max number of jobs to return (min: 1)
• location string nullable — City, town, or postal code
• radius integer nullable — Search radius around the location in miles (min: 0)
• date_posted string nullable — Restrict to recently posted jobs (one of: "last_24h", "last_3_days", "last_7_days", "last_14_days")
• company_type string nullable — Restrict to direct employers or recruitment agencies (one of: "direct_employer", "agency")
• job_type string nullable — Type of employment (one of: "permanent", "work_from_home", "contract", "part_time", "temporary")
• salary_min integer nullable — Minimum salary threshold (in the chosen period) (min: 0)
• salary_period string — Period the salary_min threshold applies to (default: "annual"; one of: "annual", "daily", "hourly")
• sort string nullable — Result ordering (one of: "relevance", "date", "salary_asc", "salary_desc")

Response

• @type string (default: "TotaljobsSearchItem")
• id integer required
• url string required
• company_id integer nullable
• company_name string nullable
• company_url string nullable
• company_image string nullable
• location string nullable
• postal_code string nullable
• salary string nullable
• text_snippet string nullable
• is_anonymous boolean nullable
• is_sponsored boolean nullable
• is_cross_posted boolean nullable
• source_site string nullable
• published_at string nullable
• global_id 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 — The entity was not found, or a precondition failed 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.