List the Company Filter Options

GET

https://api.aventure.vc/v1/entities/filters

GET

/v1/entities/filters

curl -G https://api.aventure.vc/v1/entities/filters \
     -d includeDistribution=false

{
  "arrayFilterEntry": [
    {
      "chart": [
        {
          "amount": 1,
          "end": 1,
          "start": 1
        }
      ],
      "choiceOption": [
        {
          "label": "string",
          "value": "string",
          "scope": {
            "max": 1,
            "min": 1
          }
        }
      ],
      "controlType": "checkbox",
      "filterKey": "string",
      "label": "string",
      "choiceOptionTotal": 1,
      "choiceOptionTruncated": true,
      "filterMeta": {
        "ui": {
          "headquartersOption": {
            "country": [
              {
                "country": "string",
                "state": [
                  {
                    "city": [
                      "string"
                    ],
                    "state": "string"
                  }
                ]
              }
            ]
          }
        }
      },
      "scope": {
        "max": 1,
        "min": 1
      }
    }
  ],
  "rangeFilterEntry": [
    {
      "chart": [
        {
          "amount": 1,
          "end": 1,
          "start": 1
        }
      ],
      "choiceOption": [
        {
          "label": "string",
          "value": "string",
          "scope": {
            "max": 1,
            "min": 1
          }
        }
      ],
      "controlType": "checkbox",
      "filterKey": "string",
      "label": "string",
      "choiceOptionTotal": 1,
      "choiceOptionTruncated": true,
      "filterMeta": {
        "ui": {
          "headquartersOption": {
            "country": [
              {
                "country": "string",
                "state": [
                  {
                    "city": [
                      "string"
                    ],
                    "state": "string"
                  }
                ]
              }
            ]
          }
        }
      },
      "scope": {
        "max": 1,
        "min": 1
      }
    }
  ],
  "filtersMeta": {
    "defaultOptionLimit": 1,
    "distributionKey": [
      "string"
    ],
    "generatedAt": "2024-01-15T09:30:00Z",
    "includeDistribution": true,
    "includePrivate": true,
    "includedTypeRecord": [
      "string"
    ],
    "optionMode": "TOP_RESULTS",
    "requestedTypeGroup": "string",
    "defaultTypeGroup": "Organization",
    "typeGroupMembership": [
      {
        "typeGroup": "Organization",
        "typeRecord": [
          "Company"
        ]
      }
    ]
  }
}

Get available filter options

Query parameters

typeGroupenumOptional

Type group for default filter scope. Ignored when typeRecord is provided.

Allowed values:

typeRecordstringOptional

Filter by entity type (Company, Investor, etc.)

includeDistributionbooleanOptionalDefaults to false

Include range distribution charts

distributionKeylist of stringsOptional

Comma-separated or repeated filter keys for chart distribution (for example amountRaised,totalRaised)

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

arrayFilterEntrylist of objects

Array filter entries

rangeFilterEntrylist of objects

Range filter entries

filtersMetaobject or nullOptional

Metadata for the generated filter option set

Errors

400

Bad Request Error

406

Not Acceptable Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error