POST /api/builtin/companies/offices
Price: 10 credits
Get the offices of a Built In company, by its slug or URL: the workplace policy (remote, hybrid or on-site and the typical time on-site) and every office with its name, headquarters flag, location line, street address where the company entered one, description, photos and a link to the jobs at that office.
Get the offices of a Built In company by company slug (e.g. dropbox) or company URL, with its workplace policy. address is the street address where the company entered one, else the city or country.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)company string required — Company slug or Built In company URL (examples: "coinbase", "https://builtin.com/company/coinbase"; minLength: 1)@type string (default: "BuiltinCompanyOffices")company_id integer nullablecompany_alias string requiredcompany_name string nullableworkplace_type string nullableworkplace_summary string nullableworkplace_description string nullableonsite_time string nullableoffices array (default: [])@type string (default: "BuiltinOffice")id integer requiredname string nullableshort_name string nullableis_headquarters boolean (default: false)is_us boolean nullablelocation string nullabledescription string nullableaddress string nullableimages array (default: [])jobs_url string nullableprofile_url string required422 — 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.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-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.