For AI agents: the docs index is at https://docs.lightcast.io/lightcast-api/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Status Page

Documentation API Reference Changelog

v1.0

Status Page Log In

API Reference

Log In

v1.0Documentation API Reference Changelog

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

Overview - Alumni Pathways 2.0
Status
- Get service statusget
Accounts
- Endpoint Examples
- List of accountsget
Datasets
- Endpoint Examples
- Get dataset metadataget
Sequences
Totals
- Endpoint Examples
- Get account totalspost
Rankings
Taxonomies

Get Tokenpost

Benchmarking Section

Overview - Occupation Benchmark
Glossary
Changelog
Status
- Get Service Statusget
Meta
- Get Service Metadataget
Dimensions

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

Career Coach Section

Overview - Career Coach Canadian Careers
/{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

Overview - Career Coach Canada Jobs
/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

Overview - Career Coach US Jobs
/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

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

Overview - Career Coach UK Careers
/{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

Overview - 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 Scoredel
/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 Scoredel
/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 Scoredel
/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 Scoredel

Overview - Career Coach UK Jobs
/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

Overview - Career Coach US Careers
/{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

Overview - Career Coach Programs
/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 Categorydel
/program-category-mapping/{subdomain}
- Map Programs to Categoriespost
- Unmap Programs from Categoriesdel
/programs-meta-data/{subdomain}
- Get Programs Meta Data for a Subdomainget
/related-programs/{subdomain}/{career}
- Get Related Programs for a Subdomainget

Overview - Classification
Use Cases
General Query Constructs
Changelog
Status
- Endpoint Examples
- Get service statusget
Taxonomies
Mappings
Classifications

Overview - Classification 2.0
How It Works
Status
- Endpoint Examples
- Health checkget
Meta
- Endpoint Examples
- Get service metadataget
Models
Sets
Classification

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

Overview - Company 2.0
Health
- Livenessget
- Readinessget
Metadata
Companies

Compensation Section

Overview - Compensation
Data
Meta

Overview - Market Salary
Changelog
Status
- Endpoint Examples
- Get service statusget
Meta
- Endpoint Examples
- Get service metadataget
Dimensions

Overview - Core LMI (Agnitio)
Usage Guide
Health
- Check service healthget
Status
- Get service statusget
Meta
Data
- Query datasetpost

Overview - Curricular Skills
Changelog
Status
- Get Service Statusget
Courses Search
- Course Searchpost
Groups Search
- Groups Searchpost
Group Types Search
- Group Types Searchpost
Courses
- Upload Coursespost
Courses By ID
Delete Courses
- Delete Multiple Coursesdel
Curricular Units
- Upload Curricular Unitspost
Curricular Units Search
- Search Curricular Unitspost
Curricular units By ID
Delete Curricular Units
- Delete Multiple Curricular Unitsdel
Groups
- Groupspost
Groups By ID
Delete Groups
- Delete Groupsdel
Group Types
- Upload Group Typespost
Group Types By ID
Extract Skills
- Get Skills Extracted by Group IDget
Skills
- Get All Skillsget
- Fetch Skills from Skill ID Listpost
Related Skills
- Find Related Skillspost
Academic Unit
- Create Academic Unitpost
Academic Unit By ID
- Update Academic Unit by IDpatch
- Delete Academic Unit by IDdel
Academic Unit Search
- Search Academic Unitspost
Group Type Class
- Get Group Type Classget

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

Overview - IPEDS
Status
- Get the health of the serviceget
IPEDS Data

Job Postings Section

Overview - Job Postings Global
Use Cases
Changelog
Glossary
Status
- Endpoint Examples
- Get service statusget
Meta
- Endpoint Examples
- Get service metadataget
Totals
- Endpoint Examples
  - Request Parameters - Totals
- Get summary metricspost
Timeseries
- Endpoint Examples
  - Request Parameters - Timeseries
- Slice summary metrics by timepost
Rankings
Postings
Distributions
Taxonomies

Overview - Job Postings US
Use Cases
Changelog
Glossary
Status
- Endpoint Examples
- Get the health of the serviceget
Meta
- Endpoint Examples
- Get service metadataget
Totals
- Endpoint Examples
  - Request Parameters
- Get total postingspost
Timeseries
- Endpoint Examples
  - Request Parameters
- Get total postings over timepost
Rankings
Postings
Distributions
Taxonomies

Overview - Job Postings UK
Use Cases
Changelog
Glossary
Status
- Endpoint Examples
- Get Service Statusget
Meta
- Endpoint Examples
- Get service metadataget
Totals
- Endpoint Examples
  - Request Parameters - Totals
- Get summary metricspost
Timeseries
- Endpoint Examples
  - Request Parameters - Timeseries
- Slice summary metrics by timepost
Rankings
Postings
Distributions
Taxonomies

Overview - Job Postings CA
Use Cases
Important Notes - National Occupation Classification
Changelog
Glossary
Status
- Endpoint Examples
- Get Service Statusget
Meta
- Endpoint Examples
- Get Service Metadataget
Totals
- Endpoint Examples
  - Request Parameters - Totals
- Get summary metricspost
Timeseries
- Endpoint Examples
  - Request Parameters - Timeseries
- Slice summary metrics by timepost
Rankings
Postings
Distributions
Taxonomies

Overview - Job Postings Company
Use Cases
Status
- Endpoint Examples
- Get the health of the serviceget
Meta
- Endpoint Examples
- Get service metadataget
Totals
- Endpoint Examples
- Get total postingspost
Timeseries
- Endpoint Examples
- Get total postings over timepost
Rankings
Postings
Distributions
Taxonomies

Overview - Lighcast ACS
Changelog
Status
- Get Service Statusget
Meta
Level
- Get ACS Data by Geographic Levelget
- Retrieve ACS Data for Specific Areas by Levelpost

Models Section

Overview - Career Pathways
Changelog
Glossary
Status
- Endpoint Examples
- Get Service Statusget
Meta
- Endpoint Examples
- Get Service Metadataget
Dimensions

Overview - Cost of Living Index
Status
- Example Endpoints
- Get Service Statusget
Changelog
Meta
- Endpoint Examples
- Get Service Metadataget
Data

Overview - Defining, Distinguishing & Necessary (DDN)
Changelog
Glossary
Status
- Endpoint Examples
- Get Service Statusget
Meta
- Endpoint Examples
- Get Service Metadataget
Dimensions

Overview - Occupation Automation Index
Changelog
Status
- Get Service Statusget
Nation
Endpoints
- Get list of Endpointsget

Overview - Projected Occupation Growth
Changelog
Status
- Endpoint Examples
- Get Service Statusget
Meta
- Endpoint Examples
- Get Service Metadataget
Dimensions

Overview - Projected Skill Growth
Changelog
Status
- Endpoint Examples
- Get Service Statusget
Meta
- Endpoint Examples
- Get Service Metadataget
Dimensions

Overview - Similarity
Changelog
Status
- Endpoint Examples
- Get Service Statusget
Meta
- Endpoint Examples
- Get Service Metadataget
Models

Overview - Salary Boosting Skills
Changelog
Status
- Endpoint Examples
- Get Service Statusget
Dimensions
Meta
- Endpoint Examples
- Get Service Metadataget

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

Profiles Section

Overview - Profiles Global
Use Cases
Changelog
Filtering
Glossary
Status
- Endpoint Examples
- Get Service Statusget
Meta
- Endpoint Examples
- Get Service Metadataget
Totals
- Endpoint Examples
- Get Summary Metricspost
Rankings
Taxonomies
Samples
- Endpoint Examples
- Sample Profilespost
Search
- Search Profilespost
Profiles
- Endpoint Examples
- Get a Single Profileget
Recency
- Endpoint Examples
- Profile Update Recencypost

Overview - Profiles CA
Use Cases
Changelog
Glossary
Status
- Endpoint Examples
- Get Service Statusget
Meta
- Endpoint Examples
- Get Service Metadataget
Totals
- Endpoint Examples
- Get Summary Metricspost
Rankings
Taxonomies
Profiles
- Endpoint Examples
- Get a Single Profileget
Samples
- Endpoint Examples
- Sample Profilespost
Search
- Search Profilespost
Recency
- Endpoint Examples
- Profile Update Recencypost

Overview - Profiles US
Use Cases
Changelog
Glossary
Status
- Endpoint Examples
- Get Service Statusget
Meta
- Endpoint Examples
- Get Service Metadataget
Totals
- Endpoint Examples
- Get Summary Metricspost
Recency
- Endpoint Examples
- Profile Update Recencypost
Rankings
Samples
- Endpoint Examples
- Sample Profilespost
Taxonomies
Search
- Search Profilespost
Profiles
- Endpoint Examples
- Get a Single Profileget
Distributions

Resumes Section

Overview - Parse
Resume Parser
Job Parser
Converter
- Endpoint Examples
- Binary Converterpost
Canonicalizer
- Endpoint Examples
- XML Canonicalizerpost
Locale Detector
- Endpoint Examples
- Locale Detectorpost

Overview - Resume Classification
Changelog
Parse Status
- Endpoint Examples
- Parse Statusget
Parse Resume
Classify Resume

Overview - Search
Vendor Listing
- Endpoint Examples
- Get Vendors By Criteriaget
Register Resume
- Endpoint Examples
- Resume Registrationpost
Unregister Resume
- Endpoint Examples
- Resume Deletiondel
Resume Search
- Endpoint Examples
- Resume Searchpost
Fetch Resume
- Endpoint Examples
- Fetch Resumeget
Document IDs
- Endpoint Examples
- Get Resume DocIdsget
Register Job
- Endpoint Examples
- Job Registrationpost
Unregister Job
- Endpoint Examples
- Job Deletiondel
Job Search
- Endpoint Examples
- Job Searchpost
Fetch Job
- Endpoint Examples
- Fetch Jobget
Job DocIDs
- Endpoint Examples
- Get Job DocIDsget

Overview - Skills
Use Cases
Changelog
Status
- Endpoint Examples
- Get service statusget
Meta
- Endpoint Examples
- Get service metadataget
Versions
Skills
Related
- Endpoint Examples
- Find related skillspost
Extract

Overview - Titles
Use Cases
Changelog
Status
- Endpoint Examples
- Get service statusget
Meta
- Endpoint Examples
- Get service metadataget
Versions
Status
- Get service statusget
Meta
- Get service metadataget
Versions
- List all versionsget
- Get version metadataget
Changes
Titles
Normalize

Service
Metadata
Data

Compensation Section

Updated about 1 year ago

Get one company

Overview - Compensation

Did this page help you?

Updated about 1 year ago

Get one company

Overview - Compensation

Did this page help you?