v1.0.0 · Stable

API Reference

Integrate PathSync Learning's career readiness data directly into your corporate HR systems or university dashboards using our robust REST API.

POST/api/v1/auth/token

Authentication

Exchange your client credentials for a Bearer token to authorize subsequent API requests.

Request body

{
  "client_id": "string",
  "client_secret": "string"
}

GET/api/v1/users/{uid}

Fetch a student's public profile and metadata. Only accessible if the user has opted into the hiring network.

Response

{
  "uid": "user_123xyz",
  "name": "Alex Chen",
  "role_target": "Backend Engineer"
}

GET/api/v1/users/{uid}/cri

Fetch the latest Career Readiness Index score and breakdown for a specific authenticated user.

Response

{
  "uid": "user_123xyz",
  "cri_score": 84.5,
  "percentile": 92,
  "last_updated": "2026-07-19T12:00:00Z"
}

GET/api/v1/users/{uid}/skills

Fetch the user's completed skill nodes and their proficiency level in each.

Response

{
  "nodes_unlocked": 14,
  "top_skills": ["Node.js", "PostgreSQL", "Redis"]
}