/wttj/companies

POST /api/wttj/companies

Price: 1 credit

Get a Welcome to the Jungle company profile by its slug or profile URL. Returns the company name, logo and cover images, business sectors with their parent groups, office locations with geo coordinates and headquarter flag, employee count, website, workplace-equality indexes, labels and the public profile URL.

How to use it

Get the company profile of one Welcome to the Jungle organization. Pass the company slug or profile URL. Returns one item with name, image (logo), cover, sectors, offices (with coordinates and is_headquarter), employee_count, website_url, equality_index, labels and web_url.

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 slug or profile URL, e.g. 'doctolib' or https://www.welcometothejungle.com/en/companies/doctolib (examples: "doctolib", "https://www.welcometothejungle.com/en/companies/algolia"; minLength: 1)
• language string — Language for localized text fields (default: "en"; one of: "cs", "en", "es", "fr", "sk")

Response

• @type string (default: "WttjCompany")
• name string nullable
• alias string nullable
• reference string nullable
• profile_type string nullable
• default_language string nullable
• image string nullable
• cover string nullable
• sectors array (default: [])
  • @type string (default: "WttjSectorEntity")
  • name string nullable
  • reference string nullable
  • parent_name string nullable
  • parent_reference string nullable
• offices array (default: [])
  • @type string (default: "WttjOffice")
  • address string nullable
  • city string nullable
  • state string nullable
  • district string nullable
  • zip_code string nullable
  • country string nullable
  • country_code string nullable
  • latitude number nullable
  • longitude number nullable
  • is_headquarter boolean nullable
• employee_count integer nullable
• website_url string nullable
• equality_index object nullable
  • @type string (default: "WttjEqualityIndex")
  • equality_index integer nullable
  • gender_pay_gap integer nullable
  • gap_in_promotions integer nullable
  • gap_in_annual_raises integer nullable
  • maternity_leave_return_raise integer nullable
  • equality_among_highest_earners integer nullable
  • workforce_range string nullable
  • year integer nullable
  • published boolean nullable
• labels array (default: [])
• web_url string nullable
• updated_at 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 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.