/icims/jobs/search

POST /api/icims/jobs/search

Price: 20 credits

List the job postings of one company's iCIMS career board by board handle, optionally narrowed by free-text keywords, category, brand, city, state, country or location line. Every row is the full posting: title, HTML and plain-text description, qualifications, responsibilities, category, employment type, hiring organization and brand, the full location breakdown with coordinates, additional locations, posting and expiry dates, salary values when the board publishes them, board tags and the apply URL.

How to use it

Lists one company's board — iCIMS publishes no cross-company directory, so company must be the handle from a career-site URL rather than a display name. The row is already the whole posting, so there is no need to follow up with icims/jobs unless you started from an id. category, brand, city, state, country and location must match the board's own spelling exactly ('Texas', not 'TX'; 'HEB', not 'H-E-B'); a value the board does not use returns zero rows rather than an error, so an empty result usually means the spelling is wrong; keywords is free text and can legitimately return nothing. internal=true switches to the postings the board publishes only to its own staff, which is a different set and on some boards a larger one. count is capped at 3000, and a larger board is served as its first 3000 rows in the board's own order, which the API accepts no parameter to change.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• company string required — Board handle from the career-site URL ({company}.jibeapply.com) (examples: "heb", "pepsico", "githubinc"; minLength: 1)
• count integer required — Max number of job postings to return (min: 1; max: 3000)
• keywords string nullable — Free-text search over the postings (examples: "Cashier", "software engineer"; minLength: 1)
• category string nullable — One of the categories the board uses, spelled exactly as the postings spell it (examples: "Manufacturing", "Engineering"; minLength: 1)
• brand string nullable — One of the brands the board uses, spelled exactly as the postings spell it (examples: "HEB", "Central Market"; minLength: 1)
• city string nullable — City, spelled exactly as the postings spell it (examples: "Austin", "Houston"; minLength: 1)
• state string nullable — State or region, spelled out in full as the postings spell it (examples: "Texas", "New York"; minLength: 1)
• country string nullable — Country, spelled out in full as the postings spell it (examples: "United States", "Canada"; minLength: 1)
• location string nullable — Combined location line as the postings spell it (examples: "Austin, TX", "Plano, TX"; minLength: 1)
• internal boolean — Return the board's internal-only postings instead of the public ones (default: false)

Response

• @type string (default: "IcimsJob")
• id string required
• company string required
• alias string nullable
• ats_code string nullable
• description string nullable
• description_text string nullable
• qualifications string nullable
• responsibilities string nullable
• category array (default: [])
• categories array (default: [])
• department string nullable
• employment_type string nullable
• hiring_organization string nullable
• hiring_organization_logo string nullable
• hiring_flow_name string nullable
• brand string nullable
• location_name string nullable
• full_location string nullable
• short_location string nullable
• street_address string nullable
• city string nullable
• state string nullable
• postal_code string nullable
• country string nullable
• country_code string nullable
• latitude number nullable
• longitude number nullable
• location_type string nullable
• multiple_locations boolean nullable
• additional_locations array (default: [])
  • @type string (default: "IcimsLocation")
  • location_name string nullable
  • full_location string nullable
  • short_location string nullable
  • street_address string nullable
  • city string nullable
  • state string nullable
  • postal_code string nullable
  • country string nullable
  • country_code string nullable
  • latitude number nullable
  • longitude number nullable
  • location_type string nullable
• posted_at integer nullable
• created_at integer nullable
• updated_at integer nullable
• expires_at integer nullable
• salary_min_value number nullable
• salary_max_value number nullable
• salary_value number nullable
• salary_currency string nullable
• salary_frequency string nullable
• promotion_value integer nullable
• language string nullable
• languages array (default: [])
• tags array (default: [])
• tag_groups array (default: [])
  • @type string (default: "IcimsTagGroup")
  • name string required
  • values array (default: [])
• applyable boolean nullable
• li_easy_applyable boolean nullable
• external boolean nullable
• internal boolean nullable
• searchable boolean nullable
• is_front_line_ai_job boolean nullable
• source string nullable
• client_code string nullable
• apply_url 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 board 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.