Menu
Docs
Feedback
Login
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
ListCompanies
Returns a list of companies.
Result
Companies
Rate Limit
Integrate
1.
Choose a provider
Mock implementation
Ashby
Breezy
Cornerstone OnDemand
Greenhouse
iCIMS
Jobvite
Lever
PageUp
Recruitee
SAP SuccessFactors
Teamtailor
Workable
Workday
Zoho Recruit
Request a missing 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
Copy
Copied!
Copy
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
Copy
Copied!
Implementation details
Provider
mock
Use case
ListCompanies
Author
@superface
Source
View source
Verified