PathLens API v1

Structured pathway intelligence for other products.

The first API exposes the same occupation, pathway, qualification-search, funding, evidence and switch-candidate services used by the public UI. This is the preferred future integration boundary for ClaimHub.

Endpoints

GET /api/v1/occupations/search?q=electrician

GET /api/v1/occupations/<OFO_CODE>

GET /api/v1/occupations/<OFO_CODE>/pathway

GET /api/v1/occupations/<OFO_CODE>/evidence

GET /api/v1/occupations/<OFO_CODE>/switch

GET /api/v1/qualifications/search?q=information+technology

GET /api/v1/providers?type=public_tvet&province=Gauteng

GET /api/v1/providers/summary

GET /api/v1/funding/programmes

POST /api/v1/affordability

GET|POST /api/v1/my-pathways

Provider evidence boundary

Provider results establish source-backed public-provider identity and available geography only. They do not imply that a provider offers a particular qualification, campus, intake, funding route or occupation outcome.

Example affordability payload

{
  "tuition_annual": 70000,
  "funding_annual": 50000,
  "living_monthly": 4500,
  "transport_monthly": 1200,
  "months": 12
}

The API is public-read oriented for current reference data. Authentication, quotas and partner keys should be added before external partner production use.