---
updatedAt: 2026-05-05T13:44:18.000Z
---

Fetch the complete documentation index at: https://apidocs.eightfold.ai/llms.txt. Use this file to discover all available pages before exploring further.

# Get Skill Gap Analysis

Skill gap analysis data which includes present skills and recommeded skills for the provided role and current user profile

# OpenAPI definition

```json
{
  "servers": [
    {
      "url": "https://apiv2.{domain}.ai",
      "variables": {
        "domain": {
          "default": "eightfold",
          "enum": [
            "eightfold",
            "eightfold-eu",
            "eightfold-gov",
            "eightfold-ca",
            "eightfold-me",
            "eightfold-wu",
            "eightfold-ap"
          ]
        }
      }
    }
  ],
  "paths": {
    "/api/v2/careerhub/career-planner/{userEmail}/skills/skill-gap-analysis": {
      "get": {
        "description": "Skill gap analysis data which includes present skills and recommeded skills for the provided role and current user profile",
        "operationId": "list_careerhub_skill_gap_analysis",
        "parameters": [
          {
            "description": "The secret key to access the api. It starts with the bearer token",
            "in": "header",
            "name": "Authorization",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "User Email",
            "in": "path",
            "name": "userEmail",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "A role selected for current user profile and selected role skills gap recommendation",
            "in": "query",
            "name": "selectedRole",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.",
            "in": "query",
            "name": "exclude",
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.",
            "in": "query",
            "name": "keyList",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CareerPlannerSkillGapSchema"
                }
              }
            },
            "description": "OK"
          }
        },
        "summary": "Get Skill Gap Analysis",
        "tags": [
          "Careerhub"
        ]
      }
    }
  },
  "info": {
    "title": "Api_server_v2_service Service",
    "version": "1.0.0"
  },
  "openapi": "3.0.2",
  "components": {
    "schemas": {
      "NameValueItem": {
        "type": "object",
        "properties": {
          "value": {
            "type": "number",
            "format": "float",
            "readOnly": true,
            "nullable": true,
            "description": "A value of item"
          },
          "name": {
            "type": "string",
            "readOnly": true,
            "nullable": true,
            "description": "A name of item"
          }
        }
      },
      "CareerPlannerSkillGapSchema": {
        "type": "object",
        "properties": {
          "recommendedSkills": {
            "readOnly": true,
            "nullable": true,
            "description": "A list of recommended skills with score value",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/NameValueItem"
            }
          },
          "presentSkills": {
            "type": "array",
            "readOnly": true,
            "nullable": true,
            "description": "List of present skills for a give user profile and selected role pair",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
```