List Company Filters

Endpoint Details

URL: https://api.profileapi.com/2024-03-01/company-filters

HTTP Method: GET

Overview

This endpoint retrieves a list of company filters based on the specified search criteria. These filters are used to classify and analyze company data more efficiently.

Request Parameters

Parameter	Type	Description	Required
query	string	A string containing search terms to filter filters.	Yes
categoryKey	companyFilterCategory.key	The company filter category key.	Yes
limit	integer	Specifies the maximum number of results to return. Maximum is 1000. Default is 10.	No
fields	Array of strings	Name of the fields to include other than filterCategoryKey and name such as description and count	No

Response Structure

The response includes metadata and a data array of Filter objects tailored to company data.

JSON Structure

{
  "meta": {
    "next-start": "string"
  },
  "data": [
    {
      "categoryKey": "businessModelTypes",
      "name": "Business to Business (B2B)",
      "description": "B2B, or business-to-business, refers to transactions or relationships where one company provides products or services to another company, rather than to individual consumers.",
      "count": 3200000
    }
  ]
}

Example Response

{
  "meta": {
    "next-start": "next value"
  },
  "data": [
    {
      "categoryKey": "businessModelTypes",
      "name": "Business to Business (B2B)",
      "description": "Refers to transactions where one company provides products or services to another.",
      "count": 3200000
    }
  ]
}

Notes

• Search Query: The search query includes alternative names in the search results to ensure comprehensive filtering.

Example Usage

cURL

curl '<https://api.profileapi.com/2024-03-01/company-filters?query=business&limit=10>'

Node.js (Using Axios)

const axios = require('axios');

axios.get('<https://api.profileapi.com/2024-03-01/company-filters>', {
    params: {
      query: 'business',
      limit: 10
    }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error('Error fetching data:', error);
});

Python (Using requests)

import requests

params = {
  'query': 'business',
  'limit': 10
}
response = requests.get('<https://api.profileapi.com/2024-03-01/company-filters>', params=params)
if response.status_code == 200:
    print(response.json())
else:
    print('Failed to fetch data:', response.status_code)