Download OpenAPI specification:Download
The HR Software linking job and applicant without ifs, buts, or maybes.
API Support: support@nobl.ai | Website: www.nobl.ai.
The Nobl Career Planner API follows the principles of REST, providing a straightforward and efficient way to interact with various resources. The API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
The API accepts JSON encoded user profiles and returns career tranisition predicitons.
The Nobl API uses API Keys to authenticate requests. A client_id
and client_secret
will be provided by the Nobl support team allowing for
authentication at the /auth endpoint. Upon successful authentication, a time-limited Access Token will be received and can be used to authorize subsequent
requests by including the header Authorization: {access_token}
. The complete documentation of the authentication POST call is summarized below including
required parameters, data formats, possible responses, and examples.
Authenticates a client with the Nobl API using client_id
and client_secret
.
Content-Type required | string |
X-Amz-Target required | string |
client_id required | string The client ID. |
client_secret required | string The client secret. |
scope | string Default: "api/ALL" The authentication scope. |
type | string (TypeEnum) Default: "client" Enum: "client" "user" The type of user being authenticated. |
{- "client_id": "string",
- "client_secret": "string",
- "scope": "api/ALL",
- "type": "client"
}
The API exposes a number of calls that allow computation of typical previous or next occupations give a query job or profile. It also allows the computation of typical next occupations given a degree. The API calls are described in detail below including their required parameters, data formats, possible responses and examples.
Computes the typical next occupations given a query degree.
required | object The degree of a user. |
transition_type | string Enum: "horizontal" "vertical" "transformational" The type of the transition. Can be either 'horizontal', 'vertical', or 'transformational'. |
limit | integer <= 10 Default: 10 The number of results to return. |
{- "degree": {
- "title": "string",
- "description": "string"
}, - "transition_type": "horizontal",
- "limit": 10
}
{ }
Computes the typical previous or next occupations given a query job.
required | object The source job. |
direction | string Enum: "in" "out" The direction of the typical transitions calculation. Can be either 'in' or 'out'. |
transition_type | string Enum: "horizontal" "vertical" "transformational" The type of the transition. Can be either 'horizontal', 'vertical', or 'transformational'. |
limit | integer <= 10 Default: 10 The number of results to return. |
{- "job": {
- "title": "string",
- "description": "string"
}, - "direction": "in",
- "transition_type": "horizontal",
- "limit": 10
}
{- "occupations": [
- "string"
], - "scores": [
- 0
]
}
Computes the typical previous or next occupations given a query profile.
required | object (Profile) A user profile. |
direction required | string Enum: "in" "out" The direction of the typical transitions calculation. Can be either 'in' or 'out'. |
transition_type | string Enum: "horizontal" "vertical" "transformational" The type of the transition. Can be either 'horizontal', 'vertical', or 'transformational'. |
limit | integer <= 10 Default: 10 The number of results to return. |
{- "profile": {
- "external_id": "string",
- "addresses": [
- "string"
], - "description": "string",
- "skills": [
- "string"
], - "degrees": [
- {
- "title": "string",
- "institution": "string",
- "description": "string",
- "level": "string",
- "attendance_start_datetime": "2019-08-24T14:15:22Z",
- "attendance_end_datetime": "2019-08-24T14:15:22Z"
}
], - "experiences": [
- {
- "title": "string",
- "organization_name": "string",
- "description": "string",
- "job_start_datetime": "2019-08-24T14:15:22Z",
- "job_end_datetime": "2019-08-24T14:15:22Z"
}
], - "last_updated_datetime": "2019-08-24T14:15:22Z",
- "publication_datetime": "2019-08-24T14:15:22Z"
}, - "direction": "in",
- "transition_type": "horizontal",
- "limit": 10
}
{- "occupations": [
- "string"
], - "scores": [
- 0
]
}