You are viewing a section of Superface that will be deprecated in Q4 2023. Until then, you can continue to use it as you have before but we recommend that you migrate to our latest version soon. For more details visit superface.ai/docs/migrate.

Retrieve Companies

recruitment/list-companies@1.0.0
14 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

Structure details

Result (object)

companies
List of companies.
id
Unique identifier of the company.
name
Name of the company.
description
Description of the company.
createdAt
ISO8601 timestamp when was a candidate created.
updatedAt
ISO8601 timestamp when was a candidate lastly updated.
rateLimit
Rate limit details.
bucket
Different parts of API may have different rate limits. Bucket identifies to which part of API the rate limits apply.
totalRequests
Total requests available in the time window.
remainingRequests
Remaining requests available in the time window.
remainingRequestsPercentage
Remaining requests available in the time window in percents.
resetTimestamp
Timestamp when the rate limits will reset (in Unix Timestamp format). Available only for providers without rolling rate limit window.

Example

Implementation details

Provider
mock
Use case
ListCompanies
Author
@superface
Source
Verified