# /icims/jobs

`POST /api/icims/jobs`

Price: 1 credit

Get one job posting from a company's iCIMS career board by board handle and posting id (or a full posting URL): title, HTML and plain-text description, qualifications, responsibilities, category, employment type, hiring organization and brand, the full location breakdown with coordinates and additional locations, posting, update and expiry dates, salary values when the board publishes them, board tags, the apply URL and the canonical posting URL.

## How to use it

Identity is (company, req_id): a posting id belongs to one board only, and the same id on another company's board resolves to nothing rather than to the wrong job, so company must always be the board the id came from. Passing a full posting URL fills company in by itself. A posting the board has closed disappears from the board entirely and returns 412, so a 412 means 'gone or wrong board', not a bad request. The rows icims/jobs/search returns already carry every field this endpoint returns, so call this one only when the id is your starting point.

## 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)
- `req_id` (string, required) — Posting identifier. Accepts the bare id or a full posting URL (examples: "229977", "https://heb.jibeapply.com/careers-home/jobs/229977"; minLength: 1)

## Response

### 200 — Successful 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 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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, or the board has no posting with this id

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.