Skip to main content
GET
/
jobs
/
{id}
Get job by ID
curl --request GET \
  --url https://api.instaview.sk/jobs/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "companyId": "987e6543-e21b-12d3-a456-426614174000",
  "title": "Senior TypeScript Developer",
  "status": "OPEN",
  "createdAt": "2024-11-16T10:30:00Z",
  "updatedAt": "2024-11-16T10:30:00Z",
  "description": "We are looking for an experienced TypeScript developer...",
  "jobUrl": "https://company.com/careers/senior-typescript-dev",
  "benefits": "Health insurance, remote work, flexible hours",
  "requiredSkills": [
    "TypeScript",
    "React",
    "Node.js"
  ],
  "niceToHaveSkills": [
    "Docker",
    "AWS"
  ],
  "languageRequirements": [
    {
      "language": "EN",
      "proficiency": "B2"
    },
    {
      "language": "SK",
      "proficiency": "C1"
    }
  ],
  "education": [
    "BACHELORS"
  ],
  "experience": "SENIOR",
  "contractType": "FULL_TIME",
  "location": {
    "workMode": "REMOTE",
    "street": "Hlavná 123",
    "city": "Bratislava",
    "postalCode": "81101",
    "countryCode": "SK"
  },
  "salary": {
    "min": 50000,
    "max": 80000,
    "currency": "USD",
    "period": "YEARLY"
  },
  "metadata": {
    "externalJobId": "JOB-12345",
    "department": "Engineering"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.instaview.sk/llms.txt

Use this file to discover all available pages before exploring further.

Retrieves a specific job posting by ID, including all details such as skills requirements, location, salary, and status.

​
Overview

The get job endpoint returns complete information about a single job posting. Use this endpoint to retrieve job details before creating candidates, verify job configuration, or display job information in your application.

​
Use Cases

  • Job Details Display: Show complete job information in your UI
  • Pre-Candidate Validation: Verify job exists and is accessible before creating candidates
  • 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. Attempting to access a job from another company will result in a 403 Forbidden error.

​
Error Scenarios

  • 404 Not Found: Job doesn’t exist or has been deleted
  • 403 Forbidden: Job belongs to a different company

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

200 - application/json
​
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:
["TypeScript", "React", "Node.js"]
​
niceToHaveSkills
string[]

Nice-to-have skills

Example:
["Docker", "AWS"]
​
languageRequirements
object[]

Language requirements with proficiency levels

Example:
[
  { "language": "EN", "proficiency": "B2" },
  { "language": "SK", "proficiency": "C1" }
]
​
education
string[]

Education requirements

Example:
["BACHELORS"]
​
experience
string

Experience level

Example:

"SENIOR"

​
contractType
string

Contract type

Example:

"FULL_TIME"

​
location
object

Location information

​
salary
object

Salary range

Example:
{
  "min": 50000,
  "max": 80000,
  "currency": "USD",
  "period": "YEARLY"
}
​
metadata
object

Custom metadata

Example:
{
  "externalJobId": "JOB-12345",
  "department": "Engineering"
}