Jump to Content

Home Documentation API Reference Changelog

Status Page Log In

API Reference

Home Documentation API Reference Changelog

Quickstart

Introduction
Postman Collection
Sign Up for API Credentials
How to Use Interactive Docs

Authentication

Get Tokenpost

Open Skills

Open Skills Section

Skills API

Overview - Skills
Changelog
Status
- Get service statusget
Meta
- Get service metadataget
Versions
Skills
Related
- Find related skillspost
Extract
- Extract skills from documentpost
- Extract skills with source tracingpost

Titles API

Changelog
Status
- Get service statusget
Meta
- Get service metadataget
Versions
- List all versionsget
- Get version metadataget
Changes
- Get version changesget
Titles
Normalize

Companies

Changelog
Status
- Get service statusget
Meta
- Get service metadataget
Versions
- List versionsget
- Version metaget
Companies
Normalize

Classification API

Changelog
Status
- Get service statusget
Taxonomies
Mappings
Classifications

Core LMI (Agnitio)

Health
- Check service healthget
Status
- Get service statusget
Meta
Data
- Query datasetpost

Job Postings

Job Postings Section

Job Postings - Global

Changelog
Status
- Get service statusget
Meta
- Get service metadataget
Totals
- Get summary metricspost
Timeseries
- Slice summary metrics by timepost
Rankings
Postings
- Get postingspost
- Get a single postingget
Distributions
- List distribution facetsget
- Get distributions on facetpost
Taxonomies

Job Postings - US

Changelog
Status
- Get the health of the serviceget
Meta
- Get service metadataget
Totals
- Get total postingspost
Timeseries
- Get total postings over timepost
Rankings
Postings
- /postingspost
- /postings/{postingId}get
Distributions
- /distributionsget
- /distributions/{distributionFacet}post
Taxonomies

Job Postings - UK

Changelog
Status
- Get Service Statusget
Meta
- Get service metadataget
Totals
- Get summary metricspost
Timeseries
- Slice summary metrics by timepost
Rankings
Postings
- Get postingspost
- Get a single postingget
Distributions
- List distribution facetsget
- Get distributions on facetpost
Taxonomies

Job Postings - CA

Changelog
Important Notes - National Occupation Classification
Status
- Get Service Statusget
Meta
- Get Service Metadataget
Totals
- Get summary metricspost
Timeseries
- Slice summary metrics by timepost
Rankings
Postings
- Get postingspost
- Get a single postingget
Distributions
- List facetsget
- Get distributions on facetpost
Taxonomies

Profiles

Profiles Section

Profiles - Global

Changelog
Status
- Get service statusget
Meta
- Get service metadataget
Totals
- Get summary metricspost
Rankings
Taxonomies
Transitions
- Get job transitionsget
- Job transitions matrixpost
Internal

Profiles - CA

Changelog
Status
- Get Service Statusget
Meta
- Get Service Metadataget
Totals
- Get summary metricspost
Rankings
Taxonomies
Transitions
- Get job transitionsget
- Job transitions matrixpost
Internal

Profiles - US

Changelog
Status
- Get service statusget
Meta
- Get Service Metadataget
Totals
- Get summary metricspost
Recency
- Profile update recencypost
Rankings
- List facetsget
- Rank profiles by facetspost
Samples
- Sample profilespost
Transitions
- Get job transitionsget
- Job transitions matrixpost
Taxonomies
Internal
Distributions
- List facetsget
- Get distributions on facetpost

Models

Models Section

Cost of Living Index

Changelog
Status
- Get service statusget
Meta
- Get service metadataget
Data
- Get the cost of living index for all available countiesget
- Get cost of living index for requested set of countiespost

Defining, Distinguishing & Necessary Skills

Changelog
Status
- Get service healthget
Meta
- Get service metadataget
Dimensions

Career Pathways API

Changelog
Status
- Get service healthget
Meta
- Get service metadataget
Dimensions

Occupational Earnings API

Changelog
Status
- Get the health of the serviceget
Meta
- Available Datarun Versionsget
- Available Earning Yearsget
Earnings Data

Projected Occupation Growth

Changelog
Status
- Get service statusget
Meta
- Get service metadataget
Dimensions

Projected Skill Growth

Changelog
Status
- Get service statusget
Meta
- Get service metadataget
Dimensions

Salary Boosting Skills API

Changelog
Status
- Get service statusget
Meta
- Get service metadataget
Dimensions

Career Coach

Career Coach Section

Career Coach Careers API CA

/{level}/{geoId}
- List All Careersget
/{level}
- List All Careers by POSTpost
/{level}/{geoId}/{nocId}
- Single Career By NOC IDget
/{level}/{nocId}
- Single Career by NOC ID and GeoIdspost
/{level}/{geoId}/title/{titleSlug}
- Single Career by Title Slugget
/{level}/title/{titleSlug}
- Single Career by Title Slug and GeoIdspost
/categories
- List All Categoriesget
/categories/{categoryId}
- Single Category by Category IDget
/pathways
- List All Pathwaysget
/pathways/{pathwayId}
- Single Pathway by Pathway IDget
/meta/datarun
- Returns current career meta dataget
/search
- Search for a Careerget
/lot/{level}/{geoId}
- List All LOT Careersget
/lot/{level}
- List All LOT Careers by POSTpost
/lot/{level}/{geoId}/{lotId}
- Single Career By LOT IDget
/lot/{level}/{lotId}
- Single Career by LOT ID and GeoIdspost
/lot/{level}/{geoId}/title/{titleSlug}
- Single Career by Title Slugget
/lot/{level}/title/{titleSlug}
- Single Career by LOT Title Slug and GeoIdspost
/lot/categories
- List All LOT Categoriesget
/lot/categories/{categoryId}
- Single LOT Category by LOT Category IDget
/lot/pathways
- List All LOT Pathwaysget
/lot/pathways/{pathwayId}
- Single LOT Pathway by Pathway IDget
/lot/meta/datarun
- Returns current LOT career meta dataget
/lot/search
- Search for a LOT Careerget
/geo-search/{level}
- Search for Geosget

Career Coach CA Jobs API

/jobs-meta-data/ca
- View Meta Dataget
/jobs/ca/{level}/{geoId}/{careerCode}/companies
- Get Companies Posting Jobs for a Careerget
/jobs/ca/{level}/{careerCode}/companies
- List Companies Posting Jobs for a Career by POSTpost
/jobs/ca/{level}/{geoId}/{careerCode}/postings
- Get Job Postings for a Careerget
/jobs/ca/{level}/{careerCode}/postings
- List Job Postings for a Career by POSTpost
/jobs/ca/{level}/{geoId}/{careerCode}/skills
- Get Desired Skills for a Careerget
/jobs/ca/{level}/{careerCode}/skills
- List Desired Skills for a Career by POSTpost
/skill-search/ca
- Search for Skillsget
/jobs/ca/{level}/{geoId}/{careerCode}/timeseries
- Get Job Posting Timeseries for a Careerget
/jobs/ca/{level}/{careerCode}/timeseries
- List Job Posting Timeseries for a Career by POSTpost
/jobs/ca/{level}/{geoId}/{careerCode}/titles
- Get Companies Posting Titles for a Careerget
/jobs/ca/{level}/{careerCode}/titles
- List Companies Posting Titles for a Career by POSTpost

Career Coach US Jobs API

/jobs-meta-data
- View Meta Dataget
/jobs/us/{level}/{geoId}/{careerCode}/companies
- Get Companies Posting Jobs for a Careerget
/jobs/us/{level}/{geoId}/{careerCode}/postings
- Get Job Postings for a Careerget
/jobs/us/{level}/{geoId}/{careerCode}/skills
- Get Desired Skills for a Careerget
/skill-search
- Search for Skillsget
/jobs/us/{level}/{geoId}/{careerCode}/timeseries
- Get Job Posting Timeseries for a Careerget
/jobs/us/{level}/{geoId}/{careerCode}/titles
- Get Companies Posting Titles for a Careerget

Career Coach Profiles API

/profiles/{subdomain}
- List All Profiles Associated with a Subdomainget
/profiles/{subdomain}/{profileId}
- Get a Profileget

Career Coach Careers API UK

/{level}/{geoId}
- List All Careersget
/{level}
- List All Careers by POSTpost
/{level}/{geoId}/{socId}
- Get a Career By SOC IDget
/{level}/{socId}
- Get a Career By SOC IDpost
/{level}/{geoId}/title/{titleSlug}
- Get a Career By Title Slugget
/{level}/title/{titleSlug}
- Get a Career By Title Slug and GeoIdspost
/categories
- List All Categoriesget
/categories/{categoryId}
- Get a Single Categoryget
/pathways
- List All Pathwaysget
/pathways/{pathwayId}
- Get a Single Pathwayget
/meta/datarun
- Returns current career meta dataget
/search
- Search for a Careerget
/lot/{level}/{geoId}
- List All LOT Careersget
/lot/{level}
- List All LOT Careers by POSTpost
/lot/{level}/{geoId}/{lotId}
- Single Career By LOT IDget
/lot/{level}/{lotId}
- Single Career by LOT ID and GeoIdspost
/lot/{level}/{geoId}/title/{titleSlug}
- Single Career by Title Slugget
/lot/{level}/title/{titleSlug}
- Single Career by LOT Title Slug and GeoIdspost
/lot/categories
- List All LOT Categoriesget
/lot/categories/{categoryId}
- Single LOT Category by LOT Category IDget
/lot/pathways
- List All LOT Pathwaysget
/lot/pathways/{pathwayId}
- Single LOT Pathway by Pathway IDget
/lot/meta/datarun
- Returns current LOT career meta dataget
/lot/search
- Search for a LOT Careerget
/geo-search/{level}
- Search for Geosget

Career Coach Assessments

/assessments/questions
- List All Questionsget
/assessments/questions/{questionSet}
- List All Questions in a Specific Setget
/assessments/traits
- List All Traitsget
/assessments/traits/{traitId}
- Get Trait Detailsget
/assessments/results
- Submit Results to Score an Assessmentpost
/assessments/results/{assessmentId}
- Get Results for a Single Assessment Score by Idget
- Remove an Assessment Scoredelete
/assessments/questions/uk
- List All UK Assessment Questionsget
/assessments/questions/uk/{questionSet}
- List All UK Questions in a Specific Setget
/assessments/traits/uk
- List All UK Traitsget
/assessments/traits/uk/{traitId}
- Get UK Trait Detailsget
/assessments/results/uk
- Submit Results to Score an Assessmentpost
/assessments/results/uk/{assessmentId}
- Get Results for a Single Assessment Score by Idget
- Remove an Assessment Scoredelete
/assessments/questions/ca
- List All Canadian Assessment Questionsget
/assessments/questions/ca/{questionSet}
- List All Canadian Questions in a Specific Setget
/assessments/traits/ca
- List All Canadian Traitsget
/assessments/traits/ca/{traitId}
- Get Canadian Trait Detailsget
/assessments/results/ca
- Submit Results to Score an Assessmentpost
/assessments/results/ca/{assessmentId}
- Get Results for a Single Assessment Score by Idget
- Remove an Assessment Scoredelete
/assessments/results/lot
- Submit Results to Score an Assessment with results mapped to the Lightcast Occupation Taxonomypost
/assessments/results/lot/{assessmentId}
- Get Results for a Single Assessment Score by Idget
- Remove an Assessment Scoredelete

Career Coach UK Jobs API

/jobs-meta-data/uk
- View Meta Dataget
/jobs/uk/{level}/{geoId}/{careerCode}/companies
- Get Companies Posting Jobs for a Careerget
/jobs/uk/{level}/{geoId}/{careerCode}/postings
- Get Job Postings for a Careerget
/jobs/uk/{level}/{geoId}/{careerCode}/skills
- Get Desired Skills for a Careerget
/skill-search/uk
- Search for Skillsget
/jobs/uk/{level}/{geoId}/{careerCode}/timeseries
- Get Job Posting Timeseries for a Careerget
/jobs/uk/{level}/{geoId}/{careerCode}/titles
- Get Companies Posting Titles for a Careerget

Career Coach Careers API

/{level}/{geoId}
- List All Careersget
/{level}
- List All Careers by POSTpost
/{level}/{geoId}/{onetId}
- Get a Career By O*NET IDget
/{level}/{onetId}
- Get a Career By O*NET IDpost
/{level}/{geoId}/title/{titleSlug}
- Get a Career By Title Slugget
/{level}/title/{titleSlug}
- Get a Career By Title Slugpost
/{level}/{geoId}/{onetId}/related
- List Careers Related to a given O*NET IDget
/categories
- List All Categoriesget
/categories/{categoryId}
- Get a Single Categoryget
/pathways
- List All Pathwaysget
/pathways/{pathwayId}
- Get a Single Pathwayget
/regions/{subdomainId}
- List All Regions Per Accountget
/meta/datarun
- Returns current career meta dataget
/search
- Search for a Careerget
/lot/{level}/{geoId}
- List All LOT Careersget
/lot/{level}
- List All LOT Careers by POSTpost
/lot/{level}/{geoId}/{lotId}
- Single LOT Career By LOT IDget
/lot/{level}/{lotId}
- Single LOT Career by LOT ID and GeoIdspost
/lot/{level}/{geoId}/title/{titleSlug}
- Single LOT Career by Title Slugget
/lot/{level}/title/{titleSlug}
- Single LOT Career by LOT Title Slug and GeoIdspost
/lot/{level}/{geoId}/{lotId}/related
- List Careers Related to a given LOT codeget
/lot/categories
- List All LOT Categoriesget
/lot/categories/{categoryId}
- Single LOT Category by LOT Category IDget
/lot/pathways
- List All LOT Pathwaysget
/lot/pathways/{pathwayId}
- Single LOT Pathway by Pathway IDget
/lot/meta/datarun
- Returns current LOT career meta dataget
/lot/search
- Search for a LOT Careerget
/geo-search/{level}
- Search for Geosget

Career Coach Programs API

/programs/{subdomain}
- List All Programs Associated with a Subdomainget
- Create a New Programpost
/programs/{subdomain}/{programSlug}
/programs/{subdomain}/{programSlug}/
/programs/{subdomain}/get-programs-by-slug
- Get Programs With a List of Slugspost
/program-categories/{subdomain}
- List All Categories for a Subdomainget
- Create a New Categorypost
/program-categories/{subdomain}/{categorySlug}
- Get a Categoryget
- Remove a Categorydelete
/program-category-mapping/{subdomain}
- Map Programs to Categoriespost
- Unmap Programs from Categoriesdelete
/programs-meta-data/{subdomain}
- Get Programs Meta Data for a Subdomainget
/related-programs/{subdomain}/{career}
- Get Related Programs for a Subdomainget

Lightcast ACS API

Changelog
Status
- Get service statusget
Meta
Level
- Get ACS data for all available areasget
- Get ACS data for the requested setpost

Resume Classification

Status
- Health checkget
Parse
- Parse Resumepost
- Classify Resumepost

Similarity API

Changelog
Status
- Get service statusget
Meta
- Get service metadataget
Models
- Get available modelsget
- Get similarity mappingspost

Benchmarking

Benchmarking Section

Talent Benchmark

Learn More
Changelog
Status
- Get service statusget
Meta
- Get service metadataget
Supply
- Get supply benchmark datapost
Summary
- Get benchmark summarypost
Demand
- Get demand benchmark datapost
Compensation
- Get compensation benchmark datapost
Diversity
- Get diversity benchmark datapost
Skills
- Get skills benchmark datapost

Occupation Benchmark

Status
- Get service statusget
Meta
- Get service metadataget
Dimensions

Taxonomies

Taxonomies Section

Geography (GIS)

Status
- Get service statusget
Discovery
- Get available countriesget
- Get levels and versions for countryget
Regions
Internal

IPEDS API

Status
- Get the health of the serviceget
IPEDS Data

Compensation

Compensation Section

Compensation API

Data
Meta
Internal

Market Salary API

Changelog
Status
- Get service statusget
Meta
- Get service metadataget
Dimensions

Occupation dimension

get https://api.lightcast.io/career-pathways/dimensions/{dimension}

Language

Credentials

OAuth2

Bearer

Click Try It! to start a request and see the response here!