/bayt/companies

POST /api/bayt/companies

Price: 5 credits

Get a Bayt.com company profile by company ID (or profile URL): name, logo, industry, company size, follower count, website, location, About description, linked social profiles, and recently posted roles. Works for both employer-branded and basic company pages across the Bayt.com network.

How to use it

Fetch a single Bayt.com company by numeric ID or a company profile URL. Set language for English or Arabic content. Returns one item with id, url, name, description, industry, size, follower_count, website, location, image (logo), account_id, socials, and recent_jobs (id, title, location, 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 — Bayt company ID or a company profile URL (examples: "1542258", "https://www.bayt.com/en/company/cognizant-1542258/"; minLength: 1)
• language string — Content language (default: "en"; one of: "en", "ar")

Response

• @type string (default: "BaytCompany")
• id integer required
• url string nullable
• name string nullable
• description string nullable
• industry string nullable
• size string nullable
• follower_count integer nullable
• website string nullable
• location string nullable
• image string nullable
• account_id integer nullable
• socials array (default: [])
• recent_jobs array (default: [])
  • @type string (default: "BaytCompanyJob")
  • id integer nullable
  • location string nullable
  • 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 not found (well-formed but nonexistent company ID) 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.