Get Analysis by ID

Retrieve a specific skill gap analysis by its ID

GET /api/v1/job-seekers/me/skill-analysis/:id

Get Analysis by ID

cURL

curl --request GET \
  --url https://api.example.com/api/v1/job-seekers/me/skill-analysis/:id

import requests

url = "https://api.example.com/api/v1/job-seekers/me/skill-analysis/:id"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/api/v1/job-seekers/me/skill-analysis/:id', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/job-seekers/me/skill-analysis/:id",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/job-seekers/me/skill-analysis/:id"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/job-seekers/me/skill-analysis/:id")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/job-seekers/me/skill-analysis/:id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "targetRole": "<string>",
  "status": "<string>",
  "cvScore": 123,
  "strengths": [
    {}
  ],
  "gaps": [
    {
      "skill": "<string>",
      "importance": "<string>",
      "suggestion": "<string>"
    }
  ],
  "recommendations": [
    {}
  ],
  "createdAt": "<string>",
  "completedAt": {}
}

Endpoint

GET /api/v1/job-seekers/me/skill-analysis/:id

Base URL: http://localhost:3000/api/v1

This endpoint requires authentication and Job Seeker role.

Authentication

Include the access token in the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN

URL Parameters

id · string · required

The unique identifier of the skill gap analysis (UUID).

Response

Success Response (200 OK)

{
  "success": true,
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "targetRole": "Senior Software Engineer",
    "status": "COMPLETED",
    "cvScore": 78,
    "strengths": [
      "Strong testing focus: Achieving 80% coverage demonstrates commitment to quality, critical for production systems.",
      "Full-stack proficiency: Experience with MEAN stack and multiple databases provides flexibility across the stack.",
      "Cloud exposure: Hands-on use of AWS and Azure demonstrates ability to deploy and manage services in major cloud platforms."
    ],
    "gaps": [
      {
        "skill": "System Design",
        "importance": "high",
        "suggestion": "Practice designing scalable systems using resources like 'System Design Interview' book"
      },
      {
        "skill": "CI/CD Pipeline",
        "importance": "medium",
        "suggestion": "Set up GitHub Actions or GitLab CI pipelines for personal projects"
      }
    ],
    "recommendations": [
      "Build a side project demonstrating microservices architecture to strengthen system design skills",
      "Contribute to open-source projects to gain visibility and improve collaboration skills"
    ],
    "createdAt": "2026-02-26T17:30:00.000Z",
    "completedAt": "2026-02-26T17:30:15.000Z"
  },
  "message": "Analysis retrieved successfully",
  "meta": {
    "timestamp": "2026-04-23T20:00:00.000Z",
    "path": "/job-seekers/me/skill-analysis/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "method": "GET"
  }
}

Response Fields

id · string

Unique identifier for the analysis (UUID).

targetRole · string

The job title the analysis was performed against.

status · string

Current status of the analysis. Values: PROCESSING, COMPLETED, FAILED

cvScore · number

Overall match score as a percentage (0-100).

strengths · array

List of strengths identified in the candidate’s profile.

gaps · array

List of skill gaps identified.

Show Gap Properties

skill · string

The missing or weak skill.

importance · string

How critical this skill is. Values: high, medium, low

suggestion · string

Actionable advice on how to acquire this skill.

recommendations · array

List of career development recommendations.

createdAt · string

When the analysis was created (ISO 8601).

completedAt · string | null

When the analysis was completed (ISO 8601).

Error Responses

404 Not Found - Analysis Not Found

{
  "success": false,
  "error": {
    "message": "Analysis not found",
    "statusCode": 404,
    "timestamp": "2026-04-23T20:00:00.000Z",
    "path": "/job-seekers/me/skill-analysis/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "method": "GET",
    "details": "Not Found"
  }
}

401 Unauthorized - Not Authenticated

{
  "success": false,
  "error": {
    "message": "Unauthorized",
    "statusCode": 401,
    "timestamp": "2026-04-23T20:00:00.000Z",
    "path": "/job-seekers/me/skill-analysis/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "method": "GET",
    "details": "Unauthorized"
  }
}

Notes

Ownership: The analysis must belong to the authenticated job seeker. You cannot access analyses created by other users.