Overview

Introduction

The Classification API provides access to Lightcast taxonomies and classifiers. It allows you to:

  • Query Lightcast taxonomies directly through the /taxonomies endpoint.
  • Map between two taxonomies (either two versions of the same taxonomy or two different taxonomies) through the /mappings endpoint.
  • Leverage Lightcast classifiers programmatically through the /classifications endpoint.

Taxonomies served by this API are typically hierarchical datasets describing a particular aspect of the labor market, such as skills, titles, or companies. A complete list of available taxonomies can be accessed through the API.

Note: By default, all clients are allowed a maximum of 5 requests per second. Contact us if you require higher limits.

API Endpoint

There are multiple endpoints within this category. Refer to individual API docs under the Classification section.

You can also customize responses using query options such as search, return fields, filters, and locales. See General Query Constructs for details.

Request Headers

(*) Indicates the action to be required

All requests must include the following headers:

Header KeyValueDescription
*AuthorizationBearer <ACCESS_TOKEN>This is the token obtained from the Authentication API. Include it in this header to authorize the request. (This must be included in all authenticated requests)
Content-Typeapplication/jsonRequired for endpoints that accept a request body. Specifies that the body is in JSON format.

Authentication

All endpoints in this category require an OAuth 2.0 Bearer Token for authentication. Tokens are granted through Lightcast’s Authentication API and are valid for 1 hour.

To access the Classification API, the token must include one of the following scopes:

  • classification_api
  • lightcast_open

Sample Request

curl --request POST \
  --url https://auth.emsicloud.com/connect/token \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data client_id=CLIENT_ID \
  --data client_secret=CLIENT_SECRET \
  --data grant_type=client_credentials \
  --data scope=classification_api

Request Parameters

ParameterTypeDescription
client_idstringThe client ID provided by Lightcast.
client_secretstringThe client secret associated with your client ID.
grant_typestringMust be set to client_credentials.
scopestringUse classification_api or lightcast_open based on your access.

Sample Response

{
  "access_token": "<ACCESS_TOKEN>",
  "expires_in": 3600,
  "token_type": "Bearer"
}

Note that the Tokens expire after 3600 seconds. To maintain uninterrupted access, refresh the token before it expires. To know more about this, refer to the Authentication guide.

Response Parameters

ParameterTypeDescription
access_tokenstringThe token used to authorize the API request.
expires_inintegerNumber of seconds before the token expires.
token_typestringIndicates the type of token. (Always Bearer.

Status Code Summary

CodeMeaningDescription
200OKRequest was successful.
400Bad RequestThe request was unacceptable, often due to missing a required parameter.
401UnauthorizedAuth error.
404Not FoundResource not found.