/reed/companies

POST /api/reed/companies

Price: 10 credits

Get a Reed company profile and its current job listings by company profile ID (or company job-list URL): company name, alias, logo, banner, total job count and the company's jobs.

How to use it

Fetch a Reed company by profile ID or company job-list URL. Returns one item with id, url, name, alias, company_profile_url, image, banner, job_count (total open jobs) and jobs (the company's listings, same shape as reed/jobs/search items; feed any job id into reed/jobs for full detail). Use count to control how many jobs to return.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Reed company profile ID (with or without the 'p' prefix) or a company job-list URL containing it (examples: "36210", "p36210", "https://www.reed.co.uk/jobs/hays-specialist-recruitment-limited/p36210"; minLength: 1)
• count integer required — Max number of company jobs to return (min: 1)

Response

• @type string (default: "ReedCompany")
• id integer required
• url string nullable
• name string nullable
• alias string nullable
• company_profile_url string nullable
• image string nullable
• banner string nullable
• job_count integer nullable
• jobs array (default: [])
  • @type string (default: "ReedSearchJob")
  • id integer required
  • url string nullable
  • description string nullable
  • created_at string nullable
  • updated_at string nullable
  • display_date string nullable
  • expiry_date string nullable
  • location_name string nullable
  • county string nullable
  • remote_option string nullable
  • job_type integer nullable
  • salary_from number nullable
  • salary_to number nullable
  • salary_type string nullable
  • currency_id integer nullable
  • payment_model string nullable
  • taxonomy_level_1 string nullable
  • taxonomy_level_2 string nullable
  • is_full_time boolean nullable
  • is_part_time boolean nullable
  • is_easy_apply boolean nullable
  • is_promoted boolean nullable
  • is_featured boolean nullable
  • is_training_job boolean nullable
  • is_early_bird boolean nullable
  • is_priority boolean nullable
  • is_top_job boolean nullable
  • is_survey_job boolean nullable
  • is_ats_direct_apply boolean nullable
  • eligible_uk_only boolean nullable
  • external_url string nullable
  • ou_id integer nullable
  • ou_name string nullable
  • ou_type integer nullable
  • ou_tier_id integer nullable
  • ou_url string nullable
  • profile_id integer nullable
  • profile_name string nullable
  • alias string nullable
  • image 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 not found (well-formed but nonexistent profile) 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.