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

npm i @superfaceai/one-sdk
const { SuperfaceClient } = require('@superfaceai/one-sdk');

const sdk = new SuperfaceClient();

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();

Structure details

Result (object)

companies
List of companies.
rateLimit
Rate limit details.

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"
    }
  ]
}

Implementation details

Provider
mock
Use case
ListCompanies
Author
@superface
Source
Verified