Skip to main content
GET
Get job by ID
Retrieves a specific job posting by ID, including all details such as skills requirements, location, salary, and status.

Overview

Returns everything held about one job posting — useful before attaching a contact to it, for checking its configuration, or for displaying it in your own application.

Use Cases

  • Job Details Display: Show complete job information in your UI
  • Pre-flight check: confirm the job exists and is reachable by your key before attaching contacts
  • Job Configuration Review: Inspect job settings and requirements
  • Integration Validation: Confirm job details match external systems

Response Data

The response includes all job information:
  • Basic details (title, description, status)
  • Skills requirements (required and nice-to-have)
  • Location and work mode
  • Salary information
  • Language requirements
  • Timestamps (created, updated)

Company Isolation

You can only access jobs that belong to your API key’s company. A job from another company answers 404 Not Found — the same status and the same body as an id that exists nowhere, so the response never confirms that an id exists somewhere else.

Error Scenarios

  • 404 Not Found: No job with that id is available to your API key. It does not exist, it has been deleted, or it belongs to another company — the three are deliberately indistinguishable, so do not branch on this status to detect a permission problem.

Jobs Resource Guide

Learn about job structure and configuration

Update Job

Modify job details

List Jobs

Browse all job postings

Authorizations

Authorization
string
header
required

API key for authentication using Bearer scheme

Path Parameters

id
string<uuid>
required

Query Parameters

companyId
string

Required for ATS API keys to specify which company to access. Ignored for standard company API keys.

Response

id
string
required

Job ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

companyId
string
required

Company ID

Example:

"987e6543-e21b-12d3-a456-426614174000"

title
string
required

Job title

Example:

"Senior TypeScript Developer"

status
enum<string>
required

Job status

Available options:
UNDEFINED,
OPEN,
CLOSED
Example:

"OPEN"

createdAt
string
required

Created timestamp

Example:

"2024-11-16T10:30:00Z"

updatedAt
string
required

Updated timestamp

Example:

"2024-11-16T10:30:00Z"

description
string | null

Job description

Example:

"We are looking for an experienced TypeScript developer..."

jobUrl
string

Job URL

Example:

"https://company.com/careers/senior-typescript-dev"

benefits
string

Benefits

Example:

"Health insurance, remote work, flexible hours"

requiredSkills
string[]

Required skills

Example:
niceToHaveSkills
string[]

Nice-to-have skills

Example:
languageRequirements
object[]

Language requirements with proficiency levels

Example:
education
string[]

Education requirements

Example:
experience
string

Experience level

Example:

"SENIOR"

contractType
string

Contract type

Example:

"FULL_TIME"

location
object

Location information

salary
object

Salary range

Example:
metadata
object

Custom metadata

Example: