getCompanies

This method retrieves all companies based on the provided query parameters.

Parameters

• cmsProjectId (string, optional): The CMS project identifier.
• currentPage (any, optional): The current page of results.
• limit (any, optional): The number of results per page.
• fromDate (date-time, optional): The start date for filtering results.
• toDate (date-time, optional): The end date for filtering results.
• onBoardingLevel (string, optional): The onboarding level of the companies. Possible values: Onboarding, KYB, Onboarded.
• softDeletedBefore (date-time, optional): Filter for companies soft deleted before this date.
• search (string, optional): A search term to filter the companies.

Returns

A JSON object containing the total count and an array of company data.

Usage Example

const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.nexera.id/companies',
  headers: { 
    'Accept': 'application/json', 
    'Authorization': 'Bearer <TOKEN>'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});