Jump to Content
Status Page
Documentation
API Reference
Changelog
v1.0
Status Page
Log In
API Reference
Log In
v1.0
Documentation
API Reference
Changelog
How to Use Interactive Docs
All
Pages
Start typing to search…
JUMP TO
Quickstart
Introduction
Postman Collection
Sign Up for API Credentials
How to Use Interactive Docs
Authentication
Get Token
post
Open Skills
Open Skills Section
Skills API
Overview
Changelog
Status
Get service status
get
Skills
List all skills
get
List requested skills
post
Get a skill by ID
get
Related
Find related skills
post
Meta
Get service metadata
get
Extract
Extract skills from document
post
Extract skills with source tracing
post
Versions
List all versions
get
Get version metadata
get
Get version changes
get
Titles API
Overview
Changelog
Status
Get service status
get
Meta
Get service metadata
get
Versions
List all versions
get
Get version metadata
get
Changes
Get version changes
get
Titles
List all titles
get
List requested titles
post
Get a title by ID
get
Normalize
Normalize a title
post
Inspect title normalization
post
Normalize titles in bulk
post
Companies
Overview
Changelog
Versions
List versions
get
Version meta
get
Companies
List all companies
get
List requested companies
post
Get a company by ID
get
Status
Get service status
get
Meta
Get service metadata
get
Normalize
Normalize a company
post
Inspect company normalization
post
Normalize Companies in Bulk
post
Classification API
Overview
General Query Constructs
Changelog
Classifications
List classifier releases
get
List available data source types
get
List available operations
get
Classify to occupation
post
Classify job posting
post
Get skills extractor metadata
get
Extract skills
post
Extract from file
post
Normalize titles
post
Normalize titles from file
post
Normalize companies
post
Normalize companies from file
post
Status
Get service status
get
Taxonomies
List taxonomies
get
Get version metadata
get
Get taxonomy versions
get
Get taxonomy metadata
get
List taxonomy concepts
get
Search concepts
post
Get concept by ID
get
Search related concepts
post
Mappings
List available mappings
get
Map concept
post
Get mapping changes
get
Core LMI (Agnitio)
Overview
Usage Guide
Health
Check service health
get
Status
Get service status
get
Meta
Get available datasets
get
Get definitions
get
Get versions
get
Get version metadata
get
Get dimension hierarchy
get
Search by predicate
get
Data
Query dataset
post
Job Postings
Job Postings Section
Job Postings - Global
Overview
Changelog
Glossary
Status
Get service status
get
Meta
Get service metadata
get
Totals
Get summary metrics
post
Timeseries
Slice summary metrics by time
post
Rankings
List facets
get
Rank postings by facets
post
Get timeseries on rankings
post
/rankings/{rankingFacet}/distributions/{distributionFacet}
post
Get nested rankings on rankings
post
Postings
Get postings
post
Get a single posting
get
Distributions
List distribution facets
get
Get distributions on facet
post
Taxonomies
List taxonomies
get
Search taxonomies
get
Look up taxonomies
post
Job Postings - US
Status
Get the health of the service
get
Meta
Get service metadata
get
Rankings
Get a list of current available ranking facets.
get
/rankings/{rankingFacet}
post
/rankings/{rankingFacet}/timeseries
post
/rankings/{rankingFacet}/distributions/{distributionFacet}
post
/rankings/{rankingFacet}/rankings/{nestedRankingFacet}
post
Overview
Changelog
Glossary
Totals
Get total postings
post
Timeseries
Get total postings over time
post
Postings
/postings
post
/postings/{postingId}
get
Distributions
/distributions
get
/distributions/{distributionFacet}
post
Taxonomies
/taxonomies
get
/taxonomies/{facet}
get
/taxonomies/{facet}/lookup
post
Job Postings - UK
Overview
Changelog
Glossary
Status
Get Service Status
get
Taxonomies
List taxonomies
get
Search taxonomies
get
Look up taxonomies
post
Meta
Get service metadata
get
Totals
Get summary metrics
post
Timeseries
Slice summary metrics by time
post
Rankings
List facets
get
Rank postings by facets
post
Get timeseries on rankings
post
Get distribution on rankings
post
Get nested rankings on rankings
post
Postings
Get postings
post
Get a single posting
get
Distributions
List distribution facets
get
Get distributions on facet
post
Job Postings - CA
Overview
Important Notes - National Occupation Classification
Totals
Get summary metrics
post
Changelog
Glossary
Timeseries
Slice summary metrics by time
post
Status
Get Service Status
get
Meta
Get Service Metadata
get
Rankings
List facets
get
Rank postings by facets
post
Get timeseries on rankings
post
Get distribution on rankings
post
Get nested rankings on rankings
post
Postings
Get postings
post
Get a single posting
get
Distributions
List facets
get
Get distributions on facet
post
Taxonomies
List taxonomies
get
Search taxonomies
get
Look up taxonomies
post
Job Postings - Company
Status
Get the health of the service
get
Meta
Get service metadata
get
Totals
Get total postings
post
Timeseries
Get total postings over time
post
Rankings
Get a list of current available ranking facets.
get
/rankings/{rankingFacet}
post
/rankings/{rankingFacet}/timeseries
post
/rankings/{rankingFacet}/distributions/{distributionFacet}
post
/rankings/{rankingFacet}/rankings/{nestedRankingFacet}
post
Postings
/postings
post
/postings/{postingId}
get
Distributions
/distributions
get
/distributions/{distributionFacet}
post
Taxonomies
/taxonomies
get
/taxonomies/{facet}
get
/taxonomies/{facet}/lookup
post
Profiles
Profiles Section
Profiles - Global
Overview
Changelog
Glossary
Status
Get service status
get
Meta
Get service metadata
get
Totals
Get summary metrics
post
Recency
Profile update recency
post
Rankings
List facets
get
Rank profiles by facets
post
Nested rankings
post
Taxonomies
List taxonomy facets
get
Search taxonomies
get
Look up taxonomies
post
Samples
Sample profiles
post
Profiles - CA
Overview
Changelog
Glossary
Status
Get Service Status
get
Meta
Get Service Metadata
get
Totals
Get summary metrics
post
Recency
Profile update recency
post
Rankings
List facets
get
Rank profiles by facets
post
Nested rankings
post
Taxonomies
List taxonomies
get
Search taxonomies
get
Look up taxonomies
post
Samples
Sample profiles
post
Profiles - US
Overview
Changelog
Glossary
Status
Get service status
get
Meta
Get Service Metadata
get
Totals
Get summary metrics
post
Recency
Profile update recency
post
Rankings
List facets
get
Rank profiles by facets
post
Nested rankings
post
Taxonomies
List taxonomies
get
Search taxonomies
get
Look up taxonomies
post
Distributions
List facets
get
Get distributions on facet
post
Samples
Sample profiles
post
Occupational Earnings API
Overview
Changelog
Status
Get the health of the service
get
Meta
Available Datarun Versions
get
Available Earning Years
get
Earnings Data
Percentile Wages
post
Employment at Wage
post
Employment at Wage by Occupation
post
Career Coach
Career Coach Section
Career Coach Careers API CA
Overview
/{level}/{geoId}
List All Careers
get
/{level}
List All Careers by POST
post
/{level}/{geoId}/{nocId}
Single Career By NOC ID
get
/{level}/{nocId}
Single Career by NOC ID and GeoIds
post
/{level}/{geoId}/title/{titleSlug}
Single Career by Title Slug
get
/{level}/title/{titleSlug}
Single Career by Title Slug and GeoIds
post
/categories
List All Categories
get
/categories/{categoryId}
Single Category by Category ID
get
/pathways
List All Pathways
get
/pathways/{pathwayId}
Single Pathway by Pathway ID
get
/meta/datarun
Returns current career meta data
get
/search
Search for a Career
get
/lot/{level}/{geoId}
List All LOT Careers
get
/lot/{level}
List All LOT Careers by POST
post
/lot/{level}/{geoId}/{lotId}
Single Career By LOT ID
get
/lot/{level}/{lotId}
Single Career by LOT ID and GeoIds
post
/lot/{level}/{geoId}/title/{titleSlug}
Single Career by Title Slug
get
/lot/{level}/title/{titleSlug}
Single Career by LOT Title Slug and GeoIds
post
/lot/categories
List All LOT Categories
get
/lot/categories/{categoryId}
Single LOT Category by LOT Category ID
get
/lot/pathways
List All LOT Pathways
get
/lot/pathways/{pathwayId}
Single LOT Pathway by Pathway ID
get
/lot/meta/datarun
Returns current LOT career meta data
get
/lot/search
Search for a LOT Career
get
/geo-search/{level}
Search for Geos
get
Career Coach CA Jobs API
Overview
/jobs-meta-data/ca
View Meta Data
get
/jobs/ca/{level}/{geoId}/{careerCode}/companies
Get Companies Posting Jobs for a Career
get
/jobs/ca/{level}/{careerCode}/companies
List Companies Posting Jobs for a Career by POST
post
/jobs/ca/{level}/{geoId}/{careerCode}/postings
Get Job Postings for a Career
get
/jobs/ca/{level}/{careerCode}/postings
List Job Postings for a Career by POST
post
/jobs/ca/{level}/{geoId}/{careerCode}/skills
Get Desired Skills for a Career
get
/jobs/ca/{level}/{careerCode}/skills
List Desired Skills for a Career by POST
post
/skill-search/ca
Search for Skills
get
/jobs/ca/{level}/{geoId}/{careerCode}/timeseries
Get Job Posting Timeseries for a Career
get
/jobs/ca/{level}/{careerCode}/timeseries
List Job Posting Timeseries for a Career by POST
post
/jobs/ca/{level}/{geoId}/{careerCode}/titles
Get Companies Posting Titles for a Career
get
/jobs/ca/{level}/{careerCode}/titles
List Companies Posting Titles for a Career by POST
post
Career Coach US Jobs API
Overview
/jobs-meta-data
View Meta Data
get
/jobs/us/{level}/{geoId}/{careerCode}/companies
Get Companies Posting Jobs for a Career
get
/jobs/us/{level}/{geoId}/{careerCode}/postings
Get Job Postings for a Career
get
/jobs/us/{level}/{geoId}/{careerCode}/skills
Get Desired Skills for a Career
get
/skill-search
Search for Skills
get
/jobs/us/{level}/{geoId}/{careerCode}/timeseries
Get Job Posting Timeseries for a Career
get
/jobs/us/{level}/{geoId}/{careerCode}/titles
Get Companies Posting Titles for a Career
get
Career Coach Profiles API
Overview
/profiles/{subdomain}
List All Profiles Associated with a Subdomain
get
/profiles/{subdomain}/{profileId}
Get a Profile
get
Career Coach Careers API UK
Overview
/{level}/{geoId}
List All Careers
get
/{level}
List All Careers by POST
post
/{level}/{geoId}/{socId}
Get a Career By SOC ID
get
/{level}/{socId}
Get a Career By SOC ID
post
/{level}/{geoId}/title/{titleSlug}
Get a Career By Title Slug
get
/{level}/title/{titleSlug}
Get a Career By Title Slug and GeoIds
post
/categories
List All Categories
get
/categories/{categoryId}
Get a Single Category
get
/pathways
List All Pathways
get
/pathways/{pathwayId}
Get a Single Pathway
get
/meta/datarun
Returns current career meta data
get
/search
Search for a Career
get
/lot/{level}/{geoId}
List All LOT Careers
get
/lot/{level}
List All LOT Careers by POST
post
/lot/{level}/{geoId}/{lotId}
Single Career By LOT ID
get
/lot/{level}/{lotId}
Single Career by LOT ID and GeoIds
post
/lot/{level}/{geoId}/title/{titleSlug}
Single Career by Title Slug
get
/lot/{level}/title/{titleSlug}
Single Career by LOT Title Slug and GeoIds
post
/lot/categories
List All LOT Categories
get
/lot/categories/{categoryId}
Single LOT Category by LOT Category ID
get
/lot/pathways
List All LOT Pathways
get
/lot/pathways/{pathwayId}
Single LOT Pathway by Pathway ID
get
/lot/meta/datarun
Returns current LOT career meta data
get
/lot/search
Search for a LOT Career
get
/geo-search/{level}
Search for Geos
get
Career Coach Assessments
Overview
/assessments/questions
List All Questions
get
/assessments/questions/{questionSet}
List All Questions in a Specific Set
get
/assessments/traits
List All Traits
get
/assessments/traits/{traitId}
Get Trait Details
get
/assessments/results
Submit Results to Score an Assessment
post
/assessments/results/{assessmentId}
Get Results for a Single Assessment Score by Id
get
Remove an Assessment Score
del
/assessments/questions/uk
List All UK Assessment Questions
get
/assessments/questions/uk/{questionSet}
List All UK Questions in a Specific Set
get
/assessments/traits/uk
List All UK Traits
get
/assessments/traits/uk/{traitId}
Get UK Trait Details
get
/assessments/results/uk
Submit Results to Score an Assessment
post
/assessments/results/uk/{assessmentId}
Get Results for a Single Assessment Score by Id
get
Remove an Assessment Score
del
/assessments/questions/ca
List All Canadian Assessment Questions
get
/assessments/questions/ca/{questionSet}
List All Canadian Questions in a Specific Set
get
/assessments/traits/ca
List All Canadian Traits
get
/assessments/traits/ca/{traitId}
Get Canadian Trait Details
get
/assessments/results/ca
Submit Results to Score an Assessment
post
/assessments/results/ca/{assessmentId}
Get Results for a Single Assessment Score by Id
get
Remove an Assessment Score
del
/assessments/results/lot
Submit Results to Score an Assessment with results mapped to the Lightcast Occupation Taxonomy
post
/assessments/results/lot/{assessmentId}
Get Results for a Single Assessment Score by Id
get
Remove an Assessment Score
del
Career Coach UK Jobs API
Overview
/jobs-meta-data/uk
View Meta Data
get
/jobs/uk/{level}/{geoId}/{careerCode}/companies
Get Companies Posting Jobs for a Career
get
/jobs/uk/{level}/{geoId}/{careerCode}/postings
Get Job Postings for a Career
get
/jobs/uk/{level}/{geoId}/{careerCode}/skills
Get Desired Skills for a Career
get
/skill-search/uk
Search for Skills
get
/jobs/uk/{level}/{geoId}/{careerCode}/timeseries
Get Job Posting Timeseries for a Career
get
/jobs/uk/{level}/{geoId}/{careerCode}/titles
Get Companies Posting Titles for a Career
get
Career Coach Careers API
Overview
/{level}/{geoId}
List All Careers
get
/{level}
List All Careers by POST
post
/{level}/{geoId}/{onetId}
Get a Career By O*NET ID
get
/{level}/{onetId}
Get a Career By O*NET ID
post
/{level}/{geoId}/title/{titleSlug}
Get a Career By Title Slug
get
/{level}/title/{titleSlug}
Get a Career By Title Slug
post
/{level}/{geoId}/{onetId}/related
List Careers Related to a given O*NET ID
get
/categories
List All Categories
get
/categories/{categoryId}
Get a Single Category
get
/pathways
List All Pathways
get
/pathways/{pathwayId}
Get a Single Pathway
get
/regions/{subdomainId}
List All Regions Per Account
get
/meta/datarun
Returns current career meta data
get
/search
Search for a Career
get
/lot/{level}/{geoId}
List All LOT Careers
get
/lot/{level}
List All LOT Careers by POST
post
/lot/{level}/{geoId}/{lotId}
Single LOT Career By LOT ID
get
/lot/{level}/{lotId}
Single LOT Career by LOT ID and GeoIds
post
/lot/{level}/{geoId}/title/{titleSlug}
Single LOT Career by Title Slug
get
/lot/{level}/title/{titleSlug}
Single LOT Career by LOT Title Slug and GeoIds
post
/lot/{level}/{geoId}/{lotId}/related
List Careers Related to a given LOT code
get
/lot/categories
List All LOT Categories
get
/lot/categories/{categoryId}
Single LOT Category by LOT Category ID
get
/lot/pathways
List All LOT Pathways
get
/lot/pathways/{pathwayId}
Single LOT Pathway by Pathway ID
get
/lot/meta/datarun
Returns current LOT career meta data
get
/lot/search
Search for a LOT Career
get
/geo-search/{level}
Search for Geos
get
Career Coach Programs API
Overview
/programs/{subdomain}
List All Programs Associated with a Subdomain
get
Create a New Program
post
/programs/{subdomain}/{programSlug}
Get a Program
get
Update a Program
patch
Remove a Program
del
/programs/{subdomain}/{programSlug}/
Get a Single Program for Multi-Institution Clients
get
Update a Single Program for Multi-Institution Clients
patch
Remove a Single Program for Multi-Institution Clients
del
/programs/{subdomain}/get-programs-by-slug
Get Programs With a List of Slugs
post
/program-categories/{subdomain}
List All Categories for a Subdomain
get
Create a New Category
post
/program-categories/{subdomain}/{categorySlug}
Get a Category
get
Remove a Category
del
/program-category-mapping/{subdomain}
Map Programs to Categories
post
Unmap Programs from Categories
del
/programs-meta-data/{subdomain}
Get Programs Meta Data for a Subdomain
get
/related-programs/{subdomain}/{career}
Get Related Programs for a Subdomain
get
Benchmarking
Benchmarking Section
Talent Benchmark
Overview
Learn More
Supply
Get supply benchmark data
post
Summary
Get benchmark summary
post
Demand
Get demand benchmark data
post
Changelog
Status
Get service status
get
Compensation
Get compensation benchmark data
post
Diversity
Get diversity benchmark data
post
Meta
Get service metadata
get
Skills
Get skills benchmark data
post
Occupation Benchmark
Overview
Glossary
Changelog
Status
Get service status
get
Meta
Get service metadata
get
Dimensions
Get available dimensions
get
Get dimension metadata
get
Benchmark an occupation
post
Taxonomies
Taxonomies Section
Geography (GIS)
Overview
Status
Discovery
Get available countries
get
Get levels and versions for country
get
Regions
Search for regions
post
Search for closest region
post
Search for region by point
post
Find centroid(s)
post
Find bounding rectangle
post
Find bounding circle
post
Get GeoJson
post
Create SVG
post
Search for regions within travel time
post
Status
Get service status
get
IPEDS API
Overview
IPEDS Data
Get institutions data
post
Institutions by zip code
get
Institutions by FIPS code
get
Institutions by name
get
Search institutions data
post
List institutions
get
Convert CIP to SOC
post
Convert SOC to CIP
post
Status
Get the health of the service
get
Compensation
Compensation Section
Compensation API
Overview
Data
Get estimate
post
Get estimates by experience
post
Get estimates by MSAs
post
Meta
Get geographies
get
Get datarun
get
Get SOC version
get
Market Salary API
Overview
Changelog
Status
Get service status
get
Meta
Get service metadata
get
Dimensions
Get supported dimensions
get
Get dimension information
get
Get the salary information for an occupation
post
Models
Models Section
Defining, Distinguishing & Necessary Skills
Overview
Changelog
Glossary
Status
Get service health
get
Meta
Get service metadata
get
Dimensions
Get supported dimensions
get
Get dimension information
get
Get DDN skills
post
Get multiple lists of DDN skills
post
Get occupations
post
Career Pathways API
Overview
Changelog
Glossary
Status
Get service health
get
Meta
Get service metadata
get
Dimensions
Get supported dimensions
get
Occupation dimension
get
Occupation dimension used for modeling
post
Occupation dimension used for modeling Career Pathways
post
Get next step jobs by id
post
Get feeder and next step responses
post
Projected Skill Growth
Overview
Changelog
Status
Get service status
get
Meta
Get service metadata
get
Dimensions
Get a list of supported dimensions
get
Get dimension information
get
Get projected growth
post
Projected Occupation Growth
Overview
Changelog
Status
Get service status
get
Meta
Get service metadata
get
Dimensions
Get a list of supported dimensions
get
Get dimension information
get
Get the projected growth for a given occupation
post
Status
Get service status
get
Meta
Get service metadata
get
Dimensions
Get a list of supported dimensions
get
Get dimension information
get
Get the projected growth for a given occupation
post
Salary Boosting Skills API
Overview
Changelog
Status
Get service status
get
Meta
Get service metadata
get
Dimensions
Get a list of supported dimensions
get
Get dimension information
get
List of salary boosting skills
post
Similarity API
Overview
Changelog
Status
Get service status
get
Meta
Get service metadata
get
Models
Get available models
get
Get similarity mappings
post
Cost of Living Index
Data
Get the cost of living index for all available counties
get
Get cost of living index for requested set of counties
post
Overview
Changelog
Status
Get service status
get
Meta
Get service metadata
get
Occupation Automation Index
Overview
Changelog
Endpoints
Get list of Endpoints
get
Status
Get service status
get
Nation
List available nation endpoints
get
Get service metadata
get
Get the occupation automation index
get
Get the occupation automation index
post
Lightcast ACS API
Overview
Changelog
Status
Get service health
get
Meta
Get service metadata
get
Get Metrics Metadata
get
Get Single Metric Metadata
get
Level
Get ACS Data by Geographic Level
get
Retrieve ACS Data for Specific Areas by Level
post
Search API
Overview
Endpoints
Vendor Listing
get
Endpoints
Resume Registration
post
Resume Deletion
del
Resume Search
post
Fetch Resume
get
Document IDs
get
Job Registration
post
Job Deletion
del
Job Search
post
Fetch Job
get
Job DocIDs
get
Parse API
Overview
Endpoints
Binary Converter
post
XML Canonicalizer
post
esume Field Extraction
post
Posting Field Extraction
post
BGXML RTF Posting
post
BGXML HTM Posting
post
Locale Detector
post
Endpoints
BGT Resume Parsing
post
Structured BGT Resume
post
HR-XML Resume
post
BGXML RTF Resume
post
BGXML HTM Resume
post
BGT Job Parsing
post
Structured BGT Job
post
Resume Classification
Overview
Changelog
Parse status
Parse status
get
Parse Resume
Parse Resume
post
Classify Resume
post
NaaS API
Overview
Changelog
Status
Health Check
get
Meta
API Information and Attribution
get
Endpoints
Retrieve the Lightcast skills
post
Normalize title names to taxonomy values.
post
Curricular Skills API
Overview
Changelog
Status
Get Service Status
get
Courses Search
Course Search
post
Groups Search
Groups Search
post
Group Types Search
Group Types Search
post
Courses
Upload Courses
post
Courses By ID
Get Course by ID
get
Update Course
patch
Delete Course
del
Delete Courses
Delete Multiple Courses
del
Curricular Units
Upload Curricular Units
post
Curricular Units Search
Search Curricular Units
post
Curricular units By ID
Update Curricular Unit
patch
Get Curricular Unit
get
Groups
Groups
post
Groups By ID
Get Group By ID
get
Update Group
patch
Delete Group
del
Delete Groups
Delete Groups
del
Group Types
Upload Group Types
post
Group Types By ID
Group Types By ID
get
Delete Group Type
del
Update Group Type
patch
Extract Skills
Get Skills Extracted by Group ID
get
Skills
Get All Skills
get
Fetch Skills from Skill ID List
post
Related Skills
Find Related Skills
post
Academic Unit
Create Academic Unit
post
Academic Unit By ID
Update Academic Unit by ID
patch
Delete Academic Unit by ID
del
Academic Unit Search
Search Academic Units
post
Group Type Class
Get Group Type Class
get
Enriched Document Store API - Curricular Skills
Status
Get service status
get
Meta
Get Service Metadata
get
Documents
Get the list of Document IDs
get
Create a document
post
update the document with ID
patch
Get the Document by ID
get
Delete the curricular skills document by Unique ID
del
Search the documents with Filters
post
Get the list of Document IDs
get
Create a document
post
update the document with ID
patch
Get the Document by ID
get
Delete the curricular skills document by Unique ID
del
Search the documents with Filters
post
Bulk
Create the Multiple documents
post
Update the Multiple documents
patch
Create the Multiple documents
post
Update the Multiple documents
patch
Totals
Get the total count of documents matched with filter
post
Schemas
List all the dataset schemas
get
Create a new schema
post
Get a schema details by ID
get
Update the existing schema
patch
Delete the schema by ID
del
List all the dataset schemas
get
Create a new schema
post
Get a schema details by ID
get
Update the existing schema
patch
Delete the schema by ID
del
Overview
Changelog
Enriched Document Store API - Company Datastore
Status
Get service status
get
Meta
Get Service Metadata
get
Documents
Get the list of Document IDs
get
Create a document
post
update the document with ID
patch
Get the Document by ID
get
Delete the document by Unique ID
del
Search the documents with Filters
post
Bulk
Create the Multiple documents
post
Update the Multiple documents
patch
Totals
Get the total count of documents matched with filter
post
Schemas
List all the dataset schemas
get
Create a new schema
post
Get a schema details by ID
get
Update the existing schema
patch
Delete the schema by ID
del
Overview
Changelog
How to Use Interactive Docs
