Retrieve Stage Changes
recruitment/list-stage-changes@1.0.014 providers
List Stage Changes
Retrieves a list of stages for specific candidate or lead throughout the recruitment process
Input
Candidate Id
Job Id
Result
Stages
Rate limit
1.Choose a provider
2.Use ListStageChanges with mock in your code
Below instructions are for our Node.js SDK. Use OneService for other languages.
npm i @superfaceai/one-sdk
Copied!
const { SuperfaceClient } = require('@superfaceai/one-sdk');
// You can manage tokens here: https://superface.ai/insights
const sdk = new SuperfaceClient({ sdkAuthToken: '<< Login to get your token >>' });
async function run() {
// Load the profile
const profile = await sdk.getProfile('recruitment/list-stage-changes@1.0.0');
// Use the profile
const result = await profile
.getUseCase('ListStageChanges')
.perform({
candidateId: 'CANDIDATE_ID'
}, {
provider: 'mock'
});
// Handle the result
try {
const data = result.unwrap();
console.log(data);
} catch (error) {
console.error(error);
}
}
run();Copied!
Structure details
Input (object)
candidateId
required
Unique identifier of a candidate or sourced lead.
string
jobId
optional
The unique identifier of a job that the candidate is linked with.
string
Example
{
"candidateId": "CANDIDATE_ID"
}Copied!
Result (object)
changes
required
List of stages relevant to the candidate or lead.
list
id
required
Unique identifier of a stage change
string
stageId
required
Identifier of a stage where candidate moved to.
string
name
required
Human readable name of a stage.
string
description
optional
Description of a stage change. Can contain reason for moving to this stage.
string
current
optional
Whether candidate is in this stage currently.
boolean
createdAt
required
ISO8601 timestamp when candidate moved to this stage.
string
rateLimit
optional
Rate limit details.
object
bucket
optional
Different parts of API may have different rate limits.
Bucket identifies to which part of API the rate limits apply.
string
totalRequests
optional
Total requests available in the time window.
number
remainingRequests
optional
Remaining requests available in the time window.
number
remainingRequestsPercentage
optional
Remaining requests available in the time window in percents.
number
resetTimestamp
optional
Timestamp when the rate limits will reset (in Unix Timestamp format). Available only for providers without rolling rate limit window.
number
Example
{
"changes": [
{
"id": "1",
"stageId": "sourced",
"name": "Sourced",
"description": "Sourced from LinkedIn",
"current": false,
"createdAt": "2022-12-06T15:20:11Z"
}
]
}Copied!