Skip to main content

List Company Filters

Endpoint​

The response includes an array of company filter object models.

  • URL: https://api.profileapi.com/2024-03-01/company-filters
  • HTTP Method: GET

Request​

Parameters​

Query​

  • Key: query
  • Data Type: string
  • Description: A string containing search terms to filter filters.
  • Required: true

Category Key​

  • Key: categoryKey
  • Data Type: string
  • Description: The company filter category key.
  • Required: true

Limit​

  • Key: limit
  • Data Type: number
  • Description: Specifies the maximum number of results to return. Maximum is 1000. Default is 10.
  • Default: 10
  • Required: false

Response​

The response includes a list of company filter object models.

Example​

{
  "data": {
    "results": [
      {
        "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."
      }
    ]    
  }
}
info
  • Search Query: The search query includes alternative names in the search results to ensure comprehensive filtering.