---
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.

# Search Career Paths

Returns career navigator recommended career paths

# 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-navigator/recommended-paths/{userEmail}": {
      "get": {
        "description": "Returns career navigator recommended career paths",
        "operationId": "get_career_navigator_recommended_paths_by_id",
        "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": "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/CareerNavigatorSearchResponseSchema"
                }
              }
            },
            "description": "OK"
          }
        },
        "summary": "Search Career Paths",
        "tags": [
          "Career Navigator"
        ]
      }
    }
  },
  "info": {
    "title": "Api_server_v2_service Service",
    "version": "1.0.0"
  },
  "openapi": "3.0.2",
  "components": {
    "schemas": {
      "CareerNavigatorAssociatedEmployee": {
        "type": "object",
        "properties": {
          "currentTitle": {
            "type": "string",
            "readOnly": true,
            "nullable": true,
            "description": "Current title of the employee"
          },
          "imageUrl": {
            "type": "string",
            "readOnly": true,
            "nullable": true,
            "description": "URL for the avatar of the employee"
          },
          "encId": {
            "type": "string",
            "readOnly": true,
            "nullable": true,
            "description": "Encoded profile id of the employee"
          },
          "name": {
            "type": "string",
            "readOnly": true,
            "nullable": true,
            "description": "Name of the employee"
          }
        }
      },
      "CareerNavigatorRoleEmployee": {
        "type": "object",
        "properties": {
          "associatedEmployeesCount": {
            "type": "integer",
            "format": "int32",
            "readOnly": true,
            "nullable": true,
            "description": "Number of associated employees for the role"
          },
          "associatedEmployeesProfiles": {
            "readOnly": true,
            "nullable": true,
            "description": "Associated employees profiles limited to 10",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CareerNavigatorAssociatedEmployee"
            }
          }
        }
      },
      "CareerNavigatorSkillData": {
        "type": "object",
        "properties": {
          "requiredSkills": {
            "type": "array",
            "readOnly": true,
            "nullable": true,
            "description": "Skills marked as required in talent design for the role",
            "items": {
              "type": "string"
            }
          },
          "roleSkills": {
            "type": "array",
            "readOnly": true,
            "nullable": true,
            "description": "Skills defined in talent design for the role",
            "items": {
              "type": "string"
            }
          },
          "matchingSkills": {
            "type": "array",
            "readOnly": true,
            "nullable": true,
            "description": "Profile skills expanded with synonyms from skills engine, matching role skills",
            "items": {
              "type": "string"
            }
          },
          "matchingRequiredSkills": {
            "type": "array",
            "readOnly": true,
            "nullable": true,
            "description": "Matching required skills for the role",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "CareerNavigatorRole": {
        "type": "object",
        "properties": {
          "entityId": {
            "type": "integer",
            "format": "int32",
            "readOnly": true,
            "nullable": true,
            "description": "Unique identifier for the role"
          },
          "associatedEmployeesData": {
            "readOnly": true,
            "nullable": true,
            "description": "Associated employees data",
            "allOf": [
              {
                "$ref": "#/components/schemas/CareerNavigatorRoleEmployee"
              }
            ]
          },
          "isCareerInterest": {
            "type": "boolean",
            "readOnly": true,
            "nullable": true,
            "description": "It indicates if the role is added as career interest"
          },
          "encEntityId": {
            "type": "string",
            "readOnly": true,
            "nullable": true,
            "description": "Hashids-encoded role id (matches `Role.get_encoded_employee_role_id()`); use this when constructing role-detail URLs."
          },
          "highlights": {
            "type": "array",
            "readOnly": true,
            "nullable": true,
            "description": "Highlights of the role",
            "items": {
              "type": "string"
            }
          },
          "recommendedPositionsCount": {
            "type": "integer",
            "format": "int32",
            "readOnly": true,
            "nullable": true,
            "description": "Number of recommended positions for the role"
          },
          "title": {
            "type": "string",
            "readOnly": true,
            "nullable": true,
            "description": "Title of the role"
          },
          "skillData": {
            "readOnly": true,
            "nullable": true,
            "description": "Skill data",
            "allOf": [
              {
                "$ref": "#/components/schemas/CareerNavigatorSkillData"
              }
            ]
          }
        },
        "required": [
          "entityId",
          "title"
        ]
      },
      "CareerNavigatorPath": {
        "type": "object",
        "properties": {
          "pathHighlights": {
            "type": "array",
            "readOnly": true,
            "nullable": true,
            "description": "Highlights of the career path",
            "items": {
              "type": "string"
            }
          },
          "roleList": {
            "readOnly": true,
            "nullable": true,
            "description": "List of roles in the career path",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CareerNavigatorRole"
            }
          }
        },
        "required": [
          "pathHighlights",
          "roleList"
        ]
      },
      "CareerNavigatorUserAdditionalData": {
        "type": "object",
        "properties": {
          "currentRole": {
            "readOnly": true,
            "nullable": true,
            "description": "Current role",
            "allOf": [
              {
                "$ref": "#/components/schemas/CareerNavigatorRole"
              }
            ]
          },
          "currentTenure": {
            "type": "string",
            "readOnly": true,
            "nullable": true,
            "description": "Tenure in current role, fallsback to company tenure"
          }
        },
        "required": [
          "currentRole"
        ]
      },
      "CareerNavigatorSearchResponseSchema": {
        "type": "object",
        "properties": {
          "careerPaths": {
            "readOnly": true,
            "nullable": true,
            "description": "List of career paths",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CareerNavigatorPath"
            }
          },
          "userAdditionalData": {
            "readOnly": true,
            "nullable": true,
            "description": "User additional data",
            "allOf": [
              {
                "$ref": "#/components/schemas/CareerNavigatorUserAdditionalData"
              }
            ]
          }
        },
        "required": [
          "careerPaths",
          "userAdditionalData"
        ]
      }
    }
  }
}
```