Introduction
The Career Pathways API provides an interface for exploring common career progressions by identifying typical transitions between occupations. It helps you understand how workers advance, move laterally, or transition across occupation groups based on real-world employment and compensation patterns.
The data returned by this API is derived from multiple Lightcast datasets, including the Similarity Model and the Compensation Model, and classifies career transitions into four main categories:
- Advancement
- Lateral Advancement
- Similar
- Lateral Transition
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 Career Pathways API section.
Request Headers
(*) Indicates the action to be required
All requests must include the following headers:
| Header Key | Value | Description |
|---|---|---|
| *Authorization | Bearer <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-Type | application/json | Required 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 Career Pathways API, the token must include the following scope:
career-pathways(for expanded access)
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=career-pathwaysRequest Parameters
| Parameter | Type | Description |
|---|---|---|
| client_id | string | The client ID provided by Lightcast. |
| client_secret | string | The client secret associated with your client ID. |
| grant_type | string | Must be set to client_credentials. |
| scope | string | Use career-pathways based on your access. |
Sample Response
{
"access_token": "<ACCESS_TOKEN>",
"expires_in": 3600,
"token_type": "Bearer"
}Tokens expire after 3600 seconds. To maintain uninterrupted access, refresh the token before it expires. For more information, see the Authentication Guide.
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| access_token | string | The token used to authorize API requests. |
| expires_in | integer | Number of seconds before the token expires. |
| token_type | string | Indicates the type of token. (Always Bearer) |
Status Code Summary
| Code | Meaning | Description |
|---|---|---|
| 200 | OK | Request was successful. |
| 400 | Bad Request | The request was unacceptable, often due to missing a required parameter. |
| 401 | Unauthorized | Authentication error. |
| 404 | Not Found | Resource not found. |
