List candidates
recruitment/list-candidates@1.0.014 providers
List candidates
Returns paginated list of candidates.
Input
Job ID
Page
Page limit
Result
candidates
Pagination
Rate limit
1.Choose a provider
2.Use ListCandidates 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-candidates@1.0.0');
// Use the profile
const result = await profile
.getUseCase('ListCandidates')
.perform({
jobId: 'JOB_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)
jobId
required
Uniquie identifier of the job the candidate is applying for.
string
page
optional
Pagination cursor. Get the cursor from `pagination` field returned in the use case result. Use either `previousPage` or `nextPage` as cursor value.
string
limit
optional
Maximum number of candidates returned in single page.
number
Example
{
"jobId": "JOB_ID"
}Copied!
Result (object)
candidates
optional
list
id
required
ID of the candidate.
string
jobId
required
ID of a job the candidate is applying for. Use recruitment/list-jobs profile to list job IDs.
string
name
required
The name of the candidate.
string
email
required
Email of the candidate.
string
createdAt
optional
ISO8601 timestamp when was thethe candidate created.
string
updatedAt
optional
ISO8601 timestamp when was the candidate lastly updated.
string
pagination
optional
The pagination state.
object
previousPage
optional
Previous page cursor.
nextPage
optional
Next page cursor.
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
{
"candidates": [
{
"id": "CANDIDATE_ID",
"jobId": "JOB_ID",
"name": "John Doe",
"email": "john.doe@acme.com"
}
]
}Copied!