Retrieve Companies
recruitment/list-companies@1.0.014 providers
List Companies
Returns a list of companies.
Result
Companies
Rate Limit
1.Choose a provider
2.Use ListCompanies 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-companies@1.0.0');
// Use the profile
const result = await profile
.getUseCase('ListCompanies')
.perform({}, {
provider: 'mock'
});
// Handle the result
try {
const data = result.unwrap();
console.log(data);
} catch (error) {
console.error(error);
}
}
run();Copied!
Structure details
Result (object)
companies
required
List of companies.
list
id
required
Unique identifier of the company.
string
name
required
Name of the company.
string
description
optional
Description of the company.
string
createdAt
optional
ISO8601 timestamp when was a candidate created.
string
updatedAt
optional
ISO8601 timestamp when was a candidate lastly updated.
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
{
"companies": [
{
"id": "1",
"name": "Superface",
"description": "Superface is technology startup, based in Czech Republic, which connects applications through APIs.",
"createdAt": "2021-01-01T12:00:00.000Z",
"updatedAt": "2022-10-01T14:00:00.000Z"
}
]
}Copied!