Manage jobs
recruitment/jobs@1.0.02 providers
List jobs
Returns a paginated collection of your company jobs.
Input
State
Page
Page limit
Result
Jobs
Pagination
Rate limit
1.Choose a provider
2.Use ListJobs 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/jobs@1.0.0');
// Use the profile
const result = await profile
.getUseCase('ListJobs')
.perform({
state: 'published'
}, {
provider: 'mock'
});
// Handle the result
try {
const data = result.unwrap();
console.log(data);
} catch (error) {
console.error(error);
}
}
run();Copied!
Structure details
Input (object)
state
optional
The state to filter jobs with.
enum
draftpublishedclosedarchived
page
optional
Pagination cursor (obtained from `previousPage` or `nextPage`).
string
limit
optional
Maximum number of jobs returned in single page.
number
Example
{
"state": "published"
}Copied!
Result (object)
jobs
optional
List of jobs.
list
id
required
Unique identifier of the job.
string
name
required
The name of the job.
string
description
optional
The description of the job.
string
state
optional
The state of the job.
enum
draftpublishedclosedarchived
departmentName
optional
The name of the department that opened the job.
string
requirements
optional
The requirements of the job for the candidate.
benefits
optional
The benefits of the job for the candidate.
createdAt
optional
The timestamp when was the job created in ISO8601 format.
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
{
"jobs": [
{
"id": "JOB_ID",
"name": "Software engineer",
"description": "We are looking for a Software Engineer who will assist us with design, development and installation of software solutions. Your duties will include development, writing code, and documenting functionality."
}
]
}Copied!